HeartCore Zip アップロード機能マニュアル(JSP 版)

HeartCore
Zip アップロード機能マニュアル(JSP 版)
October 2013 Ver1.1
-1Copyright© 2009-2013 Xyxon, Inc. All Rights Reserved
改訂履歴
改訂日
改訂内容
Ver1.0
2013 年 07 月
マニュアル改訂
Ver1.1
2013 年 10 月
行間の修正
対象ライセンス項目の追加
Ver1.2
2013 年 10 月
フォーマット改訂
-2Copyright© 2009-2013 Xyxon, Inc. All Rights Reserved
目次
1
2
3
4
5
本文書の目的と対象ライセンス ..................................................................................................... - 4 1.1.
目的 ............................................................................................................. - 4 -
1.2.
対象ライセンス .............................................................................................. - 4 -
機能概要 ......................................................................................................................................... - 4 2.1
Zipアップロード機能とは？............................................................................... - 4 -
2.2
Zipアップロード機能の利用目的 ......................................................................... - 4 -
2.3
Zipアップロード機能を利用可能なユーザ権限 ........................................................ - 4 -
2.4
Zipアップロードの流れ .................................................................................... - 5 -
2.5
Zipアップロード機能の制限事項 ......................................................................... - 5 -
Zip アップロード機能導入手順 ..................................................................................................... - 7 3.1
Zipアップロードモジュールの実装手順 ................................................................ - 7 -
3.2
Zipアップロードモジュールの実装手順 ................................................................ - 8 -
Zip アップロード機能利用手順 ..................................................................................................... - 9 4.1
Zipアップロード画面の説明............................................................................... - 9 -
4.2
Zip圧縮ファイルの作成 .................................................................................. - 10 -
4.3
Zipアップロードを行う。 ............................................................................... - 11 -
付録１ HeartCoreの公開方式設定について .................................................................................... - 14 -
-3Copyright© 2009-2013 Xyxon, Inc. All Rights Reserved
1
本文書の目的と対象ライセンス
1.1. 目的
本文書は、弊社がお客様に納品する CMS パッケージ製品「HeartCore」における Zip アップ
ロード機能の実装手順及び操作手順を説明する文書です。
お客様が実際に Zip アップロード機能を利用するにあたり、本文書を参照することで、該当機
能の一通りの操作を行うことができることを目的としております。
1.2. 対象ライセンス
当該機能を提供しているライセンスは以下の通りです。尚、価格は価格表を参照願います。
Professional
Enterprise
Standard
Suite
Standard
Suite
○
●
○
●
Zip アップロード機能
● ：標準装備 ○：オプション装備－：設定なし
2
機能概要
2.1
Zip アップロード機能とは？
HeartCore で利用する WEB コンテンツを、HTML ファイルから HeartCore コンテンツとし
て登録するための機能です。
HTML で作成した複数の WEB コンテンツを Zip 形式で圧縮し、その圧縮したファイルを Zip
アップロード機能でアップロードすることで、圧縮ファイル内の WEB コンテンツがまとめて
HeartCore の WEB コンテンツとして登録されます。
また、圧縮ファイル単位で、HeartCore コンテンツ（イメージ・ファイル）グループ、コンテ
ンツ（イメージ・ファイル）タイプの設定や、コンテンツの公開日時、公開終了日時の設定が可
能です。
2.2
Zip アップロード機能の利用目的
複数の HTML ファイルをまとめて、HeartCore の WEB コンテンツとして登録することがで
きるため、既存 WEB コンテンツの移行作業等の必要工数を削減することができます。
2.3
Zip アップロード機能を利用可能なユーザ権限
Zip アップロード機能を利用することができるユーザは、HeartCore の Super Admin（シス
テム管理者）権限を持ったユーザとなります。
-4Copyright© 2009-2013 Xyxon, Inc. All Rights Reserved
2.4
Zip アップロードの流れ
Zip アップロード機能を利用するための大まかな手順は以下の通りです。
(1) HTML 形式WEB コンテンツ（イメージ・ファイル含む）をZip 形式で圧縮する。
(2) HeartCore のZip アップロード画面より、適用するコンテンツ（イメージ・ファイル）グ
ループ、コンテンツ（イメージ・ファイル）タイプを選択する。
(3) 圧縮ファイルを選択し、Zip アップロードを行う。
2.5
Zip アップロード機能の制限事項
(1) HeartCore ZIP アップロード機能は、ZIP ファイルにある HTML ファイルの内容をその
まま HeartCore へ取り込む。
(2) 元 HTML ファイルに対して変更処理（URL 書換え、JavaScript/HTML 分離、文字コード
変更など）を行わない
(3) HeartCore ZIP アップロードは、一つの ZIP ファイルを一つのコンテンツグループに対し
てのみ処理する。
(4) コンテンツグループを分けて HTML ファイルを ZIP する必要がある。（一つの ZIP ファ
イルを、複数のコンテンツグループへアップロードすることはできない）
(5) ZIP アップロード時、コンテンツグループの指定が必須であるコンテンツグループを指定
せずにアップロードすることができない
(6) ZIP ファイルにある HTML ファイルのエンコーディングが統一する必要がある。エンコー
ディングが混在することはできません
(7) ZIP ファイルの中にあるファイル名は、英数字及び’_’ 、’-‘、’.’ のみとする。全角ファイ
ル名、スペースなどが入っているファイル名が処理できない
(8) アップロードする ZIP ファイルのファイル名は、英数字及び’_’ 、’-‘、’.’ のみとする。全
角ファイル名、スペースなどが入っているファイル名が処理できない
-5Copyright© 2009-2013 Xyxon, Inc. All Rights Reserved
(9) ZIP アップロード時には、HeartCore の設定にてコンテンツグループ、イメージグループ、
ファイルグループを有効にする必要がある。
(10) ZIP アップロード時には、アップロードするユーザが、コンテンツグループ、イメージグ
ループ、ファイルグループに対してアクセス可能な権限を設定する必要がある。
(11) Zip ファイルにイメージ及び、その他ファイル（PDF など）が混在していて、アップロー
ド時に格納するイメージ（ファイル）グループ、イメージ（ファイル）タイプを選択しな
かった場合、デフォルトの『-なし-』のグループ及び、タイプに設定される。
(12) ZIP ファイルにパスワードをかけることができない
(13) アップロードする ZIP ファイルサイズの上限は、設定ファイルで設定可能です。ただし、
WEB ベースアップロード処理なので、ネットワークなどの環境に依存するが、ファイルサ
イズが大きい場合、クライアントブラウザはタイムアウトが発生する場合もある
(14) HTML ファイルをアップロードする場合は、その HTML のメタ情報も取り込む。メタ情報
が空の場合は空で登録される。
-6Copyright© 2009-2013 Xyxon, Inc. All Rights Reserved
3
Zip アップロード機能導入手順
【表記説明】
本文書の手順説明に、下記の表記を使います。
$TOMCAT_HOME ： TOMCAT のインストールパス
3.1
Zip アップロードモジュールの実装手順
(1) WEB サーバのサービスを停止します。
(2) Tomcat のサービスを停止します。
(3) Tomcat のJSP キャッシュを削除します。
(4) Tomcat の$TOMCAT_HOME/webapps/ROOT フォルダをバックアップします。
(5) Tomcat の$TOMCAT_HOME/webapps/ROOT ディレクトリ内に、ZipUpload モジュー
ルを展開します。（上書き. 確認が出た場合は上書きを許可してください。）
(6) Zip アップロード機能設定ファイル(zipupload.properties)を開き、動作環境に合わせて設
定します。
(7) モジュールを適用するHeartCore の『webadmin/module/config.jsp』ファイルに
ZipUpload モジュールのメニューを追加します。
【追記する内容：ＪＳＰ版の記述例】
<%@ include file="zipupload/config.jsp" %>
(8) Zipアップロードモジュールでコンテンツを公開処理する場合は、環境の『ROOT』ディレク
トリ直下に配置されている『config.static.jsp』ファイルに下記の記述内容を追加します。
【追記する内容】
myconfig.setTemp("use_zipupload_publish","yes");
(9) Tomcat のサービスを開始します。
(10) WEB サーバのサービスを開始します。
-7Copyright© 2009-2013 Xyxon, Inc. All Rights Reserved
3.2
Zip アップロードモジュールの実装手順
下記のZipUpload 設定ファイルで、ZipUpload の機能設定を行います。
【Zip アップロード機能設定ファイル】
$TOMCAT_HOME/WEB-INF/classes/ zipupload.properties
【設定ファイル項目説明】
(1) UPLOAD_TEMP_PATH・・・アップロードファイルの一時保存ディレクトリをROOTからの相
対パスで指定します。（例えば、$TOMCAT_HOME/webapps/ROOT/tmp/ に指定します。
事前に$TOMCAT_HOME/webapps/ROOT/tmp/フォルダを作成する必要があります)
(2) HTML_TYPE・・・HTML ファイルの拡張子を指定します。（ここに登録した拡張子のファイ
ルは、コンテンツとしてアップロードされます）通常デフォルトのままで、変更する必要があり
ません。
(3) IMAGE_TYPE・・・イメージファイルの拡張子を指定します。（ここに登録した拡張子のファ
イルは、イメージとしてアップロードされます）
A) 通常デフォルトのままで、変更する必要がありません、また、IMAGE_TYPEに設定されて
いない拡張子のイメージファイルは、ファイルコンテンツとしてアップロードされます。
(4) CSS_TYPE・・・保留パラメータ。このパラメータを変更しないでください
(5) SIZETHRESHOLD・・・保留パラメータ。このパラメータを変更しないでください
(6) FILESIZEMAX・・・アップロードファイルの最大ファイルサイズ（バイト数）を指定します。
このパラメータを、SIZEMAX パラメータと同じ値に設定してください
(7) SIZEMAX・・・アップロードファイルの最大ファイルサイズ（バイト数）を指定します。この
パラメータをFILESIZEMAX パラメータと同じ値に設定してください
(8) LOGGING_FLAG・・・Zip アップロード機能の実行ログをTomcat のログファイルに書き込む
かどうかを設定します。（1=書き込む、0=書き込まない）
(9) TITLE_SUMMARY_SAME_FLAG・・・ZIP アップロード時、HTMLの<TITLE>タグの内容を、
コンテンツタイトルに設定する以外に、コンテンツのサマリにも設定する
(10) HTML_PARSER_FLAG・・・内部用保留パラメータです。変更しないでください
-8Copyright© 2009-2013 Xyxon, Inc. All Rights Reserved
【設定例】
UPLOAD_TEMP_PATH=tmp
HTML_TYPE=html,htm,shtml
IMAGE_TYPE=jpg,jpeg,swf,bmp,gif,png
CSS_TYPE=css
SIZETHRESHOLD=4096
FILESIZEMAX=20000000
SIZEMAX=200000000
LOGGING_FLAG=1
TITLE_SUMMARY_SAME_FLAG = 1
HTML_PARSER_FLAG = 1
4
Zip アップロード機能利用手順
4.1
Zip アップロード画面の説明
(1)
(3)
(5)（３）
(7)
（7）
（8）
(10)
(11)
(2)
（１）
（２）
（5） (6)
（4）
(8)
（6）
(4)
(9)
（9）
(12)
(13)
(1) コンテンツグループ
Zip アップロードするコンテンツに設定するコンテンツグループを選択します。
(2) コンテンツタイプ
Zip アップロードするコンテンツに設定するコンテンツタイプを選択します。
(3) イメージグループ
Zip アップロードするイメージに設定するイメージグループを選択します。
(4) イメージタイプ
Zip アップロードするイメージに設定するイメージタイプを選択します。
-9Copyright© 2009-2013 Xyxon, Inc. All Rights Reserved
(5) ファイルグループ
Zip アップロードするファイルに設定するファイルグループを選択します。
(6) ファイルタイプ
Zip アップロードするファイルに設定するファイルタイプを選択します。
(7) コンテンツの公開設定フィールド
Zip アップロードするコンテンツに公開を設定します。
(8) コンテンツの開始時間設定フィールド
Zip アップロードするコンテンツに公開開始時間を設定します。
（公開開始時間を有効にするには、コンテンツを公開処理する必要があります。）
(9) コンテンツの終了時間設定フィールド
Zip アップロードするコンテンツに公開終了時間を設定します。
（公開終了時間を有効にするには、コンテンツを公開処理する必要があります。）
(10)
コンテンツ選択フィールド
Zip アップロードする圧縮ファイルを選択します。
(11)
同じServer-Filename のコンテンツがサーバにある場合、上書きする。（チェック）
アップロードする圧縮ファイルと同じディレクトリ構成で、アプリケーションサーバ上に同じフ
ァイル名のコンテンツがあった場合、このチェックをつけることで、上書きすることができます。
チェックをつけない場合、アップロード処理を行いません。
(12)
文字コードの選択
アップロードするHTML コンテンツの文字エンコードを指定します。この項目で設定した文字エ
ンコード以外で、エンコーディングされたHTML コンテンツは、正常にZip アップロードされま
せん。
(13)
OK ボタン
設定した内容で Zip アップロードを実行します。
4.2
Zip 圧縮ファイルの作成
Zipアップロード機能で、複数のHTML コンテンツをHeartCoretコンテンツとして登録するには、
Zip形式の圧縮ファイルを作成する必要があります。
なお、ZIPファイルに格納されているフォルダ構成は、そのままアプリケーションサーバに展開さ
れます。
そのため、アプリケーションサーバに展開するHTMLコンテンツに対して、ディレクトリ構成を
定義したい場合は、ZIPファイルに定義するディレクトリ構成で格納する必要があります。
- 10 Copyright© 2009-2013 Xyxon, Inc. All Rights Reserved
4.3
Zip アップロードを行う。
(1) HeartCore 管理コンテンツへシステム管理者権限ユーザでログインします。
(2) 管理メニューより「設定」メニューをクリックします。
(3) 設定メニューツリーより「Zip Upload」メニューをクリックします。
(4) Zip アップロードする HTML コンテンツに、コンテンツ（イメージ・ファイル）グループ、
コンテンツ（イメージ・ファイル）タイプを設定します。
- 11 Copyright© 2009-2013 Xyxon, Inc. All Rights Reserved
(5) Zip アップロードする HTML コンテンツに、公開チェックボックスを選択した状態で、公開
開始時間、公開終了時間を設定します。
(6) 「参照」ボタンを押し、Zip アップロードする圧縮ファイルを選択します。
(7) 同一ファイル名であるファイルが存在した場合、上書きを行うには「同じServer-filename のコ
ンテンツがサーバにある場合、上書きする」にチェックをつけます。
- 12 Copyright© 2009-2013 Xyxon, Inc. All Rights Reserved
(8) 既にコンテンツが登録されている場合、既存の設定情報を初期化して登録する場合は、
「既存情
報を初期化する」ラジオボタンを選択します。
既存の設定情報を維持したまま登録する場合は『既存情報を維持する』ラジオボタンを選択しま
す。
(9) 「OK」ボタンを押すことで、Zip アップロード処理が行われます。
(10)
Zip アップロード処理が終了すると、各ファイルの完了ステータスが表示されます。アッ
プロードに失敗したファイルや、記述形式に注意点があった場合においても、エラー内容を表示
します。
- 13 Copyright© 2009-2013 Xyxon, Inc. All Rights Reserved
(11)
ウェブサイトコンテンツメニューを開き、Zip アップロードしたコンテンツグループから、
コンテンツを確認します。
このように、Zip アップロードしたHTML コンテンツを、HeartCore のコンテンツとして登録する
ことができます。
5
付録１ HeartCore の公開方式設定について
ZIP 圧縮ファイルにあるHTML ファイルが、HeartCore の公開設定によって、下記のように違う方
法でアップロードされます。
- 14 Copyright© 2009-2013 Xyxon, Inc. All Rights Reserved
(1) 公開方式が、“ページを公開するのに動的Web アドレスを使用します。”と設定されている場合、
HTML ファイルはHeartCore DB に登録されます。
(2) （静的ファイルが生成されない）公開方式が、“ページを公開するのに静的Web アドレスを有
効にします。
(3) ”→ “*.html ファイルと*.css ファイルを動的に出力します。”と設定されている場合、HTML
ファイルはHeartCore DBに登録され、HTML ファイルのパスと同じパスの動的ファイルも生成
される。
(4) 例えば、/abc/xyz.html がロードされた場合、
$TOMCAT_HOME/wbapps/ROOT/abc/xyz.html/index.jspファイルが生成されます。
(5) 公開方式が、“ページを公開するのに静的Web アドレスを有効にします。
(6) ”→ “*.html ファイルと*.css ファイルをWEB サーバーに対し、静的なファイルとして配信し
ます。”と設定されている場合、HTML ファイルはHeartCore DB に登録され、HTML ファイ
ルパスと同じパスの静的ファイルも生成されます。
(7) 例えば、/abc/xyz.html がロードされた場合、
$TOMCAT_HOME/webapps/ROOT/abc/xyz.htmlファイルが生成されます。
- 15 Copyright© 2009-2013 Xyxon, Inc. All Rights Reserved
ZIP 圧縮ファイルにあるHTML ファイルにメタ情報が記述されている場合は、コンテンツの『メタ
情報』へ登録されます。
【Zipアップロードを行なったHTMLソースメタ情報の例】
<meta name="author" content="作成者" />
<meta name="description" content="メタディスクリプション" />
<meta name="keywords" content="Keywords1,Keywords2,Keywords3 キーワード" />
<meta name="robots" content="all" />
(1) HTML ファイルに記述されている『author』メタ情報は、作成者として登録されます。
(2) HTML ファイルに記述されている『description』メタ情報は、メタディスクリプションとして
登録されます。
(3) HTML ファイルに記述されている『keywords』メタ情報は、キーワードとして登録されます。
(4) HTML ファイルに記述されている『author』『description』『keywords』以外のメタ情報は、
追加のメタ情報として追加登録されます。
- 16 Copyright© 2009-2013 Xyxon, Inc. All Rights Reserved
(1) ZIP 圧縮ファイルにあるHTML ファイルのHEAD情報は、コンテンツの『HTML HEADコード』
へ登録されます。
(2) ZIP 圧縮ファイルにあるHTML ファイルのBODYタグ属性情報は、コンテンツの『HTML
BODY属性』へ登録されます。
以上
- 17 Copyright© 2009-2013 Xyxon, Inc. All Rights Reserved

Download Report