HeartCore HeartCore Zip アップロード機能マニュアル

HeartCore
Zip アップロード機能マニュアル
アップロード機能マニュアル
Aug 2010 Ver6
Ver6.0
-1Copyright© 2009-2010 Xyxon, Inc. All Rights Reserved
目
次
1
本文書の目的と対象 ................................................................
................................................................................................
...................................................................................
................................................... - 3 -
2
機能概要 ................................................................
................................................................................................
................................................................................................
...................................................................
................................... - 3 -
3
4
2.1
ZIP アップロード機能とは？ ........................................................................................................- 3 -
2.2
ZIP アップロード機能の利用目的 ................................................................................................- 3 -
2.3
ZIP アップロード機能を利用可能なユーザ権限............................................................................アップロード機能を利用可能なユーザ権限
3-
2.4
ZIP アップロードの流れ...............................................................................................................3アップロードの流れ
2.5
ZIP アップロード機能の制限事項 ................................................................................................- 4 -
ZIP アップロード機能導入手順 ................................................................
................................................................................................
....................................................................
.................................... - 5 3.1
ZIP アップロードモジュールの実装手順.......................................................................................5アップロードモジュールの実装手順
3.2
ZIP アップロードモジュールの実装手順.......................................................................................5アップロードモジュールの実装手順
ZIP アップロード機能利用手順
アップロード機能利用手順 ................................................................
................................................................................................
....................................................................
.................................... - 7 4.1
5.
ZIP アップロード画面の説明 .......................................................................................................- 7 -
付録１ HEARTCORE の公開方式設定と ZIP アップロード機能について .....................................
..........................................- 12 -
-2Copyright© 2009-2010 Xyxon, Inc. All Rights Reserved
1
本文書の目的と対象
本文書の目的と対象
本文書は、弊社がお客様に納品する CMS パッケージ製品「HeartCore」における Zip アップロード機能の
実装手順及び操作手順を説明する文書です。
お客様が実際に 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（システム管理
者）権限を持ったユーザとなります。
2.4
Zip アップロードの流れ
Zip アップロード機能を利用するための大まかな手順は以下の通りです。
・ HTML 形式WEB コンテンツ（イメージファイル含む）をZip 形式で圧縮する。
・ HeartCore のZip アップロード画面より、適用するコンテンツグループ、コンテンツタイプを選択する。
・ 圧縮ファイルを選択し、Zip アップロードを行う。
-3Copyright© 2009-2010 Xyxon, Inc. All Rights Reserved
2.5
・
Zip アップロード機能の制限事項
HeartCore ZIP アップロード機能は、ZIP ファイルにある HTML ファイルの内容をそのまま
HeartCore へ取り込む。
・
元 HTML ファイルに対して変更処理（URL 書換え、JavaScript/HTML 分離、文字コード変更な
ど）を行わない
・
HeartCore ZIP アップロードは、一つの ZIP ファイルを一つのコンテンツグループに対してのみ処
・
理する。
コンテンツグループを分けて HTML ファイルを ZIP する必要がある。（一つの ZIP ファイルを、複
・
数のコンテンツグループへアップロードすることはできない）
ZIP アップロード時、コンテンツグループの指定が必須であるコンテンツグループを指定せずにア
ップロードすることができない
・
ZIP ファイルにある HTML ファイルのエンコーディングが統一する必要がある。エンコーディング
・
が混在することはできません
ZIP ファイルの中にあるファイル名は、英数字及び’_’ 、’-‘、’.’ のみとする。全角ファイル名、
・
スペースなどが入っているファイル名が処理できない
アップロードする ZIP ファイルのファイル名は、英数字及び’_’ 、’-‘、’.’ のみとする。全角ファイ
・
ル名、スペースなどが入っているファイル名が処理できない
ZIP ファイルに HTML ファイル、イメージ及び、その他ファイル（PDF など）を混在してアップロード
した場合、 イメージファイルのイメージグループ及び、その他ファイルのファイルグループも、選択
したコンテンツグループと同じグループ名に設定される。（但し、事前にイメージグループ（タイプ）、
・
ファイルグループ（タイプ）の作成が必要となります。）
ZIP ファイルに HTML ファイル、イメージ及び、その他ファイル（PDF など）を混在してアップロード
した場合、イメージファイルのイメージタイプ及び、その他ファイルのファイルタイプも、 選択したコ
ンテンツタイプと同じタイプ名に設定される
・
同じ ZIP ファイルにあるコンテンツ、イメージ、ファイルは、全て同じコンテンツグループ、コンテン
ツタイプに設定される。（コンテンツグループ、コンテンツタイプを分けて ZIP ファイルを作成する必
要がある）
・
ZIP ファイルにパスワードをかけることができない
・
アップロードする ZIP ファイルサイズの上限は、設定ファイルで設定可能です。ただし、WEB ベー
スアップロード処理なので、ネットワークなどの環境に依存するが、ファイルサイズが大きい場合、
クライアントブラウザはタイムアウトが発生する場合もある
-4Copyright© 2009-2010 Xyxon, Inc. All Rights Reserved
3
Zip アップロード機能導入手順
【表記説明】
本文書の手順説明に、下記の表記を使います。
$TOMCAT_HOME ： TOMCAT のインストールパス
Zip アップロードモジュールの実装手順
アップロードモジュールの実装手順
3.1
1.
WEB サーバのサービスを停止します。
2.
3.
Tomcat のサービスを停止します。
Tomcat のJSP キャッシュを削除します。
4.
5.
Tomcat の$TOMCAT_HOME/webapps/ROOT フォルダをバックアップします。
Tomcat の$TOMCAT_HOME/webapps/ROOT ディレクトリ内に、ZipUpload モジュールを展開します。
（上書き. 確認が出た場合は上書きを許可してください。）
6.
Zip アップロード機能設定ファイル(zipupload.properties)を開き、動作環境に合わせて設定します。
7.
8.
Tomcat のサービスを開始します。
WEB サーバのサービスを開始します。
Zip アップロードモジュールの実装手順
3.2
下記のZipUpload 設定ファイルで、ZipUpload の機能設定を行います。
【Zip アップロード機能設定ファイル】
$TOMCAT_HOME/WEB-INF/classes/ zipupload.properties
【設定ファイル項目説明】
・
UPLOAD_TEMP_PATH・・・アップロードファイルの一時保存ディレクトリをROOTからの相対パスで指
定します。（ 例えば、tmp に指定します。事前に$TOMCAT_HOME/webapps/ROOT/tmp/フォルダ
を作成する必要があります)
・
HTML_TYPE・・・HTML ファイルの拡張子を指定します。（ここに登録した拡張子のファイルは、コン
・
テンツとしてアップロードされます）通常デフォルトのままで、変更する必要がありません。
IMAGE_TYPE・・・イメージファイルの拡張子を指定します。（ここに登録した拡張子のファイルは、イ
メージとしてアップロードされます）
通常デフォルトのままで、変更する必要がありません、また、IMAGE_TYPEに設定されていない拡張
子のイメージファイルは、ファイルコンテンツとしてアップロードされます。
・
CSS_TYPE・・・保留パラメータ。このパラメータを変更しないでください
・
・
SIZETHRESHOLD・・・保留パラメータ。このパラメータを変更しないでください
FILESIZEMAX・・・アップロードファイルの最大ファイルサイズ（バイト数）を指定します。このパラメー
・
タを、SIZEMAX パラメータと同じ値に設定してください
SIZEMAX・・・アップロードファイルの最大ファイルサイズ（バイト数）を指定します。このパラメータを
FILESIZEMAX パラメータと同じ値に設定してください
-5Copyright© 2009-2010 Xyxon, Inc. All Rights Reserved
・
LOGGING_FLAG・・・Zip アップロード機能の実行ログをTomcat のログファイルに書き込むかどうか
を設定します。（1=書き込む、0=書き込まない）
・
TITLE_SUMMARY_SAME_FLAG・・・ZIP アップロード時、HTMLの<TITLE>タグの内容を、コンテンツ
タイトルに設定する以外に、コンテンツのサマリにも設定する
・
HTML_PARSER_FLAG・・・内部用保留パラメータです。変更しないでください
【設定例】
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
-6Copyright© 2009-2010 Xyxon, Inc. All Rights Reserved
4
4.1
Zip アップロード機能利用手順
Zip アップロード画面の説明
（１）
（２）
（３）
（４）
（５）
（６）
（７）
（８）
(1) コンテンツグループ
Zip アップロードするコンテンツに設定するコンテンツグループを選択します。
(2) コンテンツタイプ
Zip アップロードするコンテンツに設定するコンテンツタイプを選択します。
(3) コンテンツの開始時間設定フィールド
Zip アップロードするコンテンツに公開開始時間を設定します。
（公開開始時間を有効にするには、コンテンツを公開処理する必要があります。）
(4) コンテンツの終了時間設定フィールド
Zip アップロードするコンテンツに公開終了時間を設定します。
（公開終了時間を有効にするには、コンテンツを公開処理する必要があります。）
(5) コンテンツ選択フィールド
Zip アップロードする圧縮ファイルを選択します。
(6) 同じServer-Filename のコンテンツがサーバにある場合、上書きする。（チェック）
アップロードする圧縮ファイルと同じディレクトリ構成で、アプリケーションサーバ上に同じフ
ァイル名のコンテンツがあった場合、このチェックをつけることで、上書きすることができます。
チェックをつけない場合、アップロード処理を行いません。
(7) 文字コードの選択
アップロードするHTML コンテンツの文字エンコードを指定します。この項目で設定した文字エン
コード以外で、エンコーディングされたHTML コンテンツは、正常にZip アップロードされません。
(8) OK ボタン
設定した内容で Zip アップロードを実行します。
-7Copyright© 2009-2010 Xyxon, Inc. All Rights Reserved
4.2 Zip 圧縮ファイルの作成
Zipアップロード機能で、複数のHTML コンテンツをHeartCoretコンテンツとして登録するには、Zip
形式の圧縮ファイルを作成する必要があります。
なお、ZIPファイルに格納されているフォルダ構成は、そのままアプリケーションサーバに展開され
ます。
そのため、アプリケーションサーバに展開するHTMLコンテンツに対して、ディレクトリ構成を定義し
たい場合は、ZIPファイルに定義するディレクトリ構成で格納する必要があります。
4.3 Zip アップロードを行う。
1. HeartCore 管理コンテンツへシステム管理者権限ユーザでログインします。
2. 管理メニューより「設定」メニューをクリックします。
3. 設定メニューツリーより「Zip Upload」メニューをクリックします。
-8Copyright© 2009-2010 Xyxon, Inc. All Rights Reserved
4. Zip アップロードする HTML コンテンツに、コンテンツグループ、コンテンツタイプを設定し
ます。
5. Zip アップロードする HTML コンテンツに、公開開始時間、公開終了時間を設定します。
-9Copyright© 2009-2010 Xyxon, Inc. All Rights Reserved
6. 「参照」ボタンを押し、Zip アップロードする圧縮ファイルを選択します。
7. 同一ファイル名であるファイルが存在した場合、上書きを行うには「同じServer-filename のコ
ンテンツがサーバにある場合、上書きする」にチェックをつけます。
8. 「OK」ボタンを押すことで、Zip アップロード処理が行われます。
- 10 Copyright© 2009-2010 Xyxon, Inc. All Rights Reserved
9. Zip アップロード処理が終了すると、各ファイルの完了ステータスが表示されます。アップロ
ードに失敗したファイルや、記述形式に注意点があった場合においても、エラー内容を表示し
ます。
10. ウェブサイトコンテンツメニューを開き、Zip アップロードしたコンテンツグループから、コ
ンテンツを確認します。
このように、Zip アップロードしたHTML コンテンツを、HeartCore のコンテンツとして登録するこ
とができます。
11. Zip アップロードする HTML コンテンツに設定された、公開開始時間、公開終了時間は、コン
テンツの詳細表示、更新画面から確認できます。
設定されたコンテンツの開始時間、終了時間を有効にするには、コンテンツの公開処理を行う必要
があります。
- 11 Copyright© 2009-2010 Xyxon, Inc. All Rights Reserved
12. Zip アップロードしたコンテンツを詳細表示、更新画面の『公開』チェックボックスにチェッ
クを入れて『保存』ボタンを押下し、公開処理を行うと、Zip アップロードしたコンテンツに
設定された開始時間、終了時間を有効が有効になります。
5
付録１ HeartCore の公開方式設定と ZIP アップロード機能について
ZIP 圧縮ファイルにあるHTML ファイルが、HeartCore の公開設定によって、下記のように違う方法
でアップロードされます。
・
公開方式が、
“ページを公開するのに動的Web アドレスを使用します。”と設定されている場合、
HTML ファイルはHeartCore DB に登録されます。
（静的ファイルが生成されない）公開方式が、“ページを公開するのに静的Web アドレスを有効
にします。
”→ “*.html ファイルと*.css ファイルを動的に出力します。”と設定されている場合、HTML
ファイルはHeartCore DBに登録され、HTML ファイルのパスと同じパスの動的ファイルも生成さ
れる。
例えば、/abc/xyz.html がロードされた場合、
$TOMCAT_HOME/wbapps/ROOT/abc/xyz.html/index.jspファイルが生成されます。
- 12 Copyright© 2009-2010 Xyxon, Inc. All Rights Reserved
・
公開方式が、“ページを公開するのに静的Web アドレスを有効にします。
”→ “*.html ファイルと*.css ファイルをWEB サーバーに対し、静的なファイルとして配信し
ます。”と設定されている場合、HTML ファイルはHeartCore DB に登録され、HTML ファイルパ
スと同じパスの静的ファイルも生成されます。
例えば、/abc/xyz.html がロードされた場合、$TOMCAT_HOME/webapps/ROOT/abc/xyz.htmlファイ
ルが生成されます。
ZIP 圧縮ファイルにあるHTML ファイルにメタ情報が記述されている場合は、コンテンツの『メタ情
報』へ登録されます。
【Zipアップロードを行なったHTMLソースメタ情報の例】
<meta name="author" content="作成者" />
<meta name="description" content="メタディスクリプション" />
<meta name="keywords" content="Keywords1,Keywords2,Keywords3 キーワード" />
<meta name="robots" content="all" />
・
HTML ファイルに記述されている『author』メタ情報は、作成者として登録されます。
・
HTML ファイルに記述されている『description』メタ情報は、メタディスクリプションとして登
録されます。
・
HTML ファイルに記述されている『keywords』メタ情報は、キーワードとして登録されます。
・
HTML ファイルに記述されている『author』『description』『keywords』以外のメタ情報は、追
加のメタ情報として追加登録されます。
- 13 Copyright© 2009-2010 Xyxon, Inc. All Rights Reserved
・
ZIP 圧縮ファイルにあるHTML ファイルのHEAD情報は、コンテンツの『HTML HEADコード』へ
登録されます。
・
ZIP 圧縮ファイルにあるHTML ファイルのBODYタグ属性情報は、コンテンツの『HTML BODY属
性』へ登録されます。
以上
- 14 Copyright© 2009-2010 Xyxon, Inc. All Rights Reserved