(Microsoft Word - OpenCms\212O\225\224\230A\214g\201E\203f\201[\203^\210\332\215s\203}\203j\203\205\203A\203\213.doc)

Transcription

1 OpenCms 外 部 連 携 データ 移 行 マニュアル 株 式 会 社 ジークス (2010 年 10 月 25 日 更 新 )

2 目 次 1 はじめに 拡 張 HTML インポート 拡 張 HTML インポート 機 能 とは? 使 い 方 WebDAV の 利 用 OpenCms の WebDAV 機 能 とは? 使 い 方 ( 事 前 準 備 ) その 他 の WebDAV クライアント サーバー 側 の 設 定 サーバー 側 の 詳 細 な 設 定 ファイル 同 期 機 能 ファイル 同 期 機 能 とは? 使 い 方 リソース 自 動 生 成 機 能 リソース 自 動 生 成 機 能 とは? 使 い 方 リソース 定 義 ファイルの 入 力 項 目 < 基 本 項 目 > リソース 定 義 ファイルのリソース パスの 指 定 方 法 リソース 定 義 ファイルの 入 力 項 目 <メタ 情 報 > リソース 定 義 ファイルの 入 力 項 目 <アクセス 権 限 > リソース 定 義 ファイルの 入 力 項 目 <アクション> リソース 自 動 生 成 機 能 < 各 種 ジェネレータ> CSV データジェネレータ データベースジェネレータ シーケンスジェネレータ 期 間 ジェネレータ ユーザー 情 報 ジェネレータ

3 1 はじめに この 資 料 では 主 に 外 部 のデータを OpenCms に 取 り 込 む 上 で 役 に 立 つ 機 能 を 説 明 します 2 拡 張 HTML インポート 2-1 拡 張 HTML インポート 機 能 とは? OpenCms の 拡 張 HTML インポート 機 能 を 利 用 すると 他 のサイトの 静 的 ページを OpenCms に 取 り 込 む 事 が 出 来 ます 単 に 取 り 込 むだけではなく ヘッダーやフッター サイドメニューなどの 不 要 な 部 分 を 除 去 し 必 要 な 本 文 のみを 切 り 出 して 取 り 込 むことが 出 来 ます 取 り 込 んだページは OpenCms のテンプレートを 適 用 する 事 が 可 能 で 本 文 も HTML エディタで 編 集 することが 出 来 ます HTML ページの 他 にも 画 像 や CSS JavaScript また PDF や Word のようなバイナリファイル も そのサイトの 階 層 構 造 を 保 ったまま 一 括 で 取 り 込 むことが 出 来 ます 3

4 2-2 使 い 方 まず OpenCms に 取 り 込 みたいファイルを 一 式 ZIP 形 式 に 圧 縮 して 下 さい 4

5 次 に OpenCms のエクスプローラ 上 で 1 取 り 込 みたい 場 所 に 移 動 して 2 新 規 ボタンをクリ ックして 下 さい すると 新 規 ダイアログが 表 示 されるので 3 拡 張 HTML インポート を 選 択 して 4 次 へ >> ボタンをクリックして 下 さい すると アップロード 画 面 が 表 示 されるので 5 拡 張 ボタンをクリックして 下 さい 5

6 6 参 照 ボタンで インポートする 静 的 コンテンツを 圧 縮 した ZIP ファイルを 選 択 します 7イメージギャラリー 欄 に イメージギャラリーのフォルダを 指 定 すると インポートする 画 像 が 全 てそのフォルダにまとめられます 画 像 がバラバラに 配 置 されている 静 的 コンテンツを 取 り 込 む 場 合 画 像 ファイルを 一 箇 所 にまとめられるので 便 利 です HTML 内 で 記 述 している 画 像 へのリンクのパスも それにあわせて 自 動 的 に 修 正 されてインポートさ れます 但 し 同 じファイル 名 の 画 像 が 別 々のディレクトリに 存 在 する 場 合 は 上 書 きされてしまうの で 注 意 が 必 要 です 同 様 に ダウンロードギャラリーを 指 定 すると PDF や Word Excel swf などのバイナリファイ ルが そのフォルダにまとめられます 6

7 外 部 リンクギャラリーを 指 定 すると インポートする HTML 内 に 記 述 された 外 部 のサイトの URL が このフォルダ 内 に 外 部 リンクとして 登 録 されます インポートする HTML 内 のリンクも 外 部 リンクを 参 照 するように 修 正 されるので URL が 変 更 になった 場 合 この 外 部 リンクの URL を 一 箇 所 修 正 すれ ばよくなります これらのギャラリーを 指 定 する 場 合 は 事 前 にギャラリーのフォルダを 作 成 しておく 必 要 があります 8テンプレートプルダウンで テンプレートを 選 択 し 9エレメント 欄 に 登 録 先 のエレメント 名 を 指 定 します インポートする HTML ファイルには ここで 指 定 したテンプレートが 適 用 され 指 定 し たエレメントに HTML が 登 録 されます 9エレメント 欄 に 記 述 できるエレメント 名 は 8テンプレートプルダウンで 選 択 した JSP テンプレー トの template-elements プロパティに 指 定 されているエレメント 名 しか 指 定 できません また 指 定 で きるエレメントは 一 つだけです 一 度 のインポートで 指 定 できるテンプレートも 一 つだけですので テンプレートが 違 う HTML を インポートするには 複 数 回 に 分 けてインポートする 必 要 があります 10ロケールプルダウンにはインポート 先 のロケールを 指 定 します 11 入 力 エンコーディング 欄 には インポートする HTML の 文 字 コードを 指 定 します OpenCms に 取 り 込 んだ 後 は UTF-8 となりますが 基 本 的 に OpenCms に 取 り 込 んだ 後 の 文 字 コードは content-encoding プロパティで 制 御 します 12 開 始 正 規 表 現 パターンと 13 終 了 正 規 表 現 パターンは インポートする HTML 内 で 切 り 出 す HTML の 開 始 文 字 と 終 了 文 字 を 正 規 表 現 で 指 定 します 例 えば ヘッダーやフッターはテンプレートで 表 示 されるものなので 本 文 だけインポートすればいいケースがあります その 場 合 は 本 文 の 開 始 位 置 から 終 了 位 置 までを 指 定 すれば その 部 分 だけを 切 り 出 してインポートされます 切 り 出 せる 部 分 は HTML ファイル 一 つに 付 き 一 箇 所 だけです また 切 り 出 す 箇 所 を 特 定 できるように インポートする HTML の 該 当 部 分 には 事 前 にコメント タグなどを 入 れて 準 備 しておく 必 要 があります インポートするファイルが 既 に OpenCms に 存 在 している 場 合 上 書 きしてよいのであれば 14ファ イルの 上 書 きチェックボックスにチェックを 入 れます インポートする HTML にリンク 切 れがある 場 合 でも 強 制 的 に 取 り 込 む 場 合 は 15リンク 切 れを 無 視 チェックボックスにチェックを 入 れます 尚 取 り 込 む HTML ファイルのリンクは 相 対 パスで 記 述 されていなければなりません 7

8 インポート 中 はログが 表 示 されます エラーがあれば 赤 字 で 表 示 されます 取 り 込 み 結 果 は 以 下 のようになります 8

9 3 WebDAV の 利 用 3-1 OpenCms の WebDAV 機 能 とは? WebDAV の 機 能 を 利 用 すると 共 有 フォルダのような 感 覚 で OpenCms 上 のリソースを 操 作 できます 画 像 などの Drag&Drop によるアップロードやダウンロードが 可 能 になります 尚 FireFox 3.6 以 上 であれば HTML5 の 機 能 を 利 用 して ブラウザからファイルを 直 接 ドラッグ &ドロップでアップロードできます 他 のブラウザも HTML5 の 対 応 が 進 めば 可 能 になります 9

10 3-2 使 い 方 ( 事 前 準 備 ) 以 下 は クライアントが Windows XP 環 境 の 場 合 の WebDAV の 設 定 方 法 です Windows のエクスプローラを 開 いて 1マイ ネットワーク 2ネットワークプレースを 追 加 するを 選 択 して 下 さい 10

11 3 次 へ(N) > ボタンをクリックして 下 さい 4 別 のネットワークの 場 所 を 選 択 をクリックし 5 次 へ(N) > ボタンをクリックして 下 さい 11

12 6インターネットまたはネットワークのアドレス(A) 欄 に OpenCms の WebDAV アドレスを 入 力 します もし インストールした OpenCms のログイン 画 面 の URL が 以 下 であれば WebDAV のアドレスは 以 下 になります 最 後 に 7 次 へ(N) > ボタンをクリックします 注 意 以 下 の 様 に ポートが 80 の 為 にポート 指 定 を 省 略 している 場 合 接 続 できない 事 があります その 場 合 は 以 下 のようにアドレスにポートを 指 定 するか 以 下 のように 最 後 の 文 字 を"/"ではなく"?"にして 接 続 するようにして 下 さい 12

13 WebDAV へ 接 続 しようとすると 最 初 にユーザー 名 とパスワードを 聞 かれますので OpenCms のログインアカウントのユーザー 名 とパスワードを 入 力 して 下 さい そのアカウントの 権 限 で OpenCms へ WebDAV 経 由 でアクセスできるようになります 尚 初 回 は このショートカットに 名 前 を 入 力 するように 求 められますので 8ネットワークプレース の 名 前 欄 に 適 当 な 名 前 を 入 力 し 9 次 へ(N) > ボタンをクリックして 下 さい 13

14 これ 以 降 は マイネットワークを 開 けば このフォルダが 表 示 されるようになります 上 記 のように Windows のエクスプローラに OpenCms 上 のファイルが 表 示 され ドラッグ&ドロッ プによるアップロードなどが 行 えます properties フォルダには そのフォルダ 内 のリソースのプロパティなどのメタ 情 報 が 保 存 されてい ます よく 分 からない 場 合 は 触 らないように 注 意 して 下 さい また 画 像 や PDF CSS などのファイルはそのまま 利 用 できますが xmlpage や 構 造 化 コンテンツ のような OpenCms のテンプレートと 関 連 付 いていて HTML エディタや 入 力 フォームからデータを 登 録 する 類 のページは 静 的 なテキストファイルと 同 様 の 方 法 で 運 用 する 事 は 出 来 ません これらのファイルは データが 全 て XML で 保 存 されていますので 修 正 する 場 合 は 注 意 して 下 さい 静 的 な HTML テキストでファイルを 上 書 きしてしまうと OpenCms 上 で 表 示 されなくなってしまいま す 逆 に 言 えば その XML の 構 造 にあわせてファイルを 作 成 すると OpenCms でそのまま 利 用 する 事 が 出 来 ます 尚 WebDAV から 編 集 しても 発 行 などの 作 業 はブラウザから 行 う 必 要 があります 14

15 3-3 その 他 の WebDAV クライアント 前 項 では Windows 標 準 で 付 属 している WebDAV クライアントで 説 明 しましたが このクライアン トは 実 装 上 の 問 題 が 多 い 事 で 有 名 です できれば 別 途 WebDAV クライアントをインストールして 使 用 する 方 がよいでしょう フリーのもので 日 本 語 化 されているものとしては 以 下 のものが OpenCms と 相 性 が 良 いようです FFFTP と 似 たような GUI でアップロードやダウンロードが 可 能 です dddav その 他 有 償 のものでは Windows の 共 有 フォルダのように 操 作 できるものもあるようです 15

16 3-4 サーバー 側 の 設 定 WebDAV の 設 定 は./WEB-INF/web.xml の 以 下 の 箇 所 で 行 います <servlet> <description> Creates an access to OpenCms through WebDAV. </description> <servlet-name>opencmswebdavservlet</servlet-name> <servlet-class>org.opencms.webdav.cmswebdavservlet</servlet-class> <init-param> <param-name>listings</param-name> <param-value>true true</param-value> </init-param> <init-param> <param-name>readonly</param-name> <param-value>false false</param-value> </init-param> <init-param> <param-name>repository</param-name> <param-value>extended extended</param-value> </init-param> </servlet> WebDav の 機 能 を 無 効 にしたい 場 合 は listings パラメータを false にして 下 さい 読 み 込 み 専 用 で 書 き 込 みや 削 除 を 禁 止 したい 場 合 は readonly パラメータを true にして 下 さい repository パラメータに 関 しては 次 項 で 説 明 します 16

17 3-5 サーバー 側 の 詳 細 な 設 定 WebDAV からアクセスした 時 は ブラウザでログインした 時 と 同 じファイルやフォルダが 閲 覧 できま すが 例 えば WebDAV からのアクセスの 場 合 は 画 像 のフォルダ 以 外 は 見 せないようにしたい 等 見 え 方 を 代 えたい 場 合 があります OpenCms には WebDAV からのアクセス 権 限 を 設 定 する 機 能 があります この 設 定 は opencms-importexport.xml の 以 下 の 箇 所 で 行 います 設 定 ファイル:./WEB-INF/config/opencms-importexport.xml <repository name="extended" class="org.opencms.repository.cmsrepositoryignoreexpiration"> <params> <param name="wrapper">org.opencms.file.wrapper.cmsresourceextensionwrapperjsp</param> <param name="wrapper">org.opencms.file.wrapper.cmsresourceextensionwrapperxmlcontent</param> <param name="wrapper">org.opencms.file.wrapper.cmsresourceextensionwrapperxmlpage</param> <param name="wrapper">org.opencms.file.wrapper.cmsresourcewrappersystemfolder</param> <param name="wrapper">org.opencms.file.wrapper.cmsresourcewrapperpropertyfile</param> </params> <filter type="include"> <regex>/</regex> <regex>/sites/.*</regex> <regex>/system/</regex> <regex>/system/galleries/.*</regex> <regex>/system/modules/</regex> <regex>/system/modules/[^/]*/</regex> <regex>/system/modules/[^/]*/resources/.*</regex> </filter> </repository> WebDAV から 参 照 可 能 なフォルダを<regex/>で 列 挙 していきます これに 該 当 しないフォルダへのア クセスは WebDAV からは 出 来 なくなります <repository/>タグ 内 にこれらの 設 定 を 記 述 しますが この 設 定 は 複 数 記 述 する 事 が 可 能 で それぞれ に name="extended"のように 名 前 を 付 けておきます これを 3-4 サーバー 側 の 設 定 で 設 定 したサーブレットの repository パラメータに 指 定 すると その 設 定 が 有 効 になります 複 数 パターンの 設 定 を 有 効 にしたい 場 合 は 複 数 の 設 定 を 記 述 した 後 それに 対 応 する WebDAV サ ーブレットを パスを 変 えて 複 数 立 ち 上 げます 17

18 18

19 4 ファイル 同 期 機 能 4-1 ファイル 同 期 機 能 とは? ファイル 同 期 機 能 とは OpenCms が 管 理 しているリソースを 物 理 ディレクトリにコピーし 同 期 を 取 る 機 能 です OpenCms のエクスプローラーで 操 作 していると 実 際 のファイルを 操 作 しているように 錯 覚 します が OpenCms が 管 理 しているリソースの 実 態 は 全 てデータベースの 中 にあります よって サーバー 上 の 物 理 的 な 場 所 にファイルがあるわけでは 無 いので FTP などで 更 新 することはできません しかし ファイル 同 期 機 能 を 利 用 すると OpenCms で 管 理 しているリソースを サーバー 上 の 物 理 ディレクトリ 上 にコピーされ サーバー 上 のファイルを 直 接 変 更 すると OpenCms のデータベースに 反 映 されるようになります 逆 に OpenCms 上 でリソースに 変 更 を 加 えると 物 理 ファイルも 動 揺 の 更 新 が 行 われるようになります この 機 能 により FTP や 共 有 フォルダとして OpenCms のリソースを 操 作 したり バッチで 定 期 的 に 更 新 することも 通 常 のファイル 操 作 のシェルを 作 成 すれば 可 能 になります 19

20 4-2 使 い 方 1 表 示 プルダウンを 管 理 メニューにし 管 理 画 面 を 表 示 します 次 に 2ワークプレースツール 3 同 期 設 定 とクリックします 20

21 同 期 設 定 の 画 面 が 表 示 されるので 設 定 項 目 を 入 力 して 下 さい 1 有 効 チェックボックスにチェックを 入 れると ファイル 同 期 機 能 が 利 用 可 能 になります 2ターゲットフォルダー 欄 には サーバーの 物 理 パスを 指 定 して 下 さい ここで 指 定 したパスに OpenCms 上 のリソースがコピーされます 指 定 するディレクトリは 事 前 に 作 成 しておく 必 要 があります 3リソース 欄 には ファイル 同 期 対 象 となる OpenCms 上 のパスを 指 定 します 複 数 指 定 できます 4 検 索 ボタンをクリックすると 入 力 補 助 機 能 のフォルダツリーが 表 示 されます 5+ボタンや6 ボタンをクリックすると 3リソース 欄 を 増 やしたり 減 らしたり 出 来 ます 設 定 が 終 わったら 7OK ボタンをクリックして 下 さい 21

22 画 面 をリロードすると ツールバーに8 同 期 フォルダーボタンが 表 示 されていると 思 います このボタンをクリックすると 現 在 のリソースの 状 態 で ファイルの 同 期 が 行 われます サーバー 上 の 物 理 ディレクトリに 同 期 されたファイル 22

23 このように ファイルを 更 新 しただけで 即 座 に 同 期 が 行 われるわけではなく 同 期 処 理 が 実 行 される タイミングで 初 めて 更 新 がかかります よって この 処 理 を 行 わない 限 り 同 期 が 取 れず 差 異 が 生 じ たままとなります ツールバーのボタンは 手 動 で 即 時 に 同 期 を 行 う 場 合 ですが 定 期 的 に 同 期 処 理 を 実 行 する 場 合 は ジョブ スケジューラにファイル 同 期 用 のジョブを 登 録 します ジョブの 登 録 の 仕 方 は 以 下 です 9 表 示 プルダウンを 管 理 メニューに 変 更 し 管 理 画 面 を 表 示 します 次 に 10ジョブ 11 新 しいジョブ とクリックします 23

24 ジョブ 名 には このジョブの 名 前 を 入 力 します この 名 前 はジョブの 一 覧 画 面 で 表 示 されます Java のクラスには org.opencms.scheduler.jobs.cmssynchronizejob を 指 定 して 下 さい クーロン 表 現 形 式 には ファイル 同 期 ジョブの 実 行 時 間 ( 実 行 間 隔 )をクーロン 表 記 で 指 定 します ユーザー 名 にはこのジョブを 実 行 するユーザーを 指 定 して 下 さい 必 ず OpenCms へログインし 同 期 対 象 のディレクトリへの 書 き 込 み 権 限 を 持 ったユーザーでなければなりません プロジェクトは Online 以 外 を 指 定 して 下 さい Online プロジェクトだと 更 新 が 出 来 ません 続 けるボタンをクリックすると ジョブのパラメータを 入 力 する 画 面 が 表 示 されます 24

25 +ボタンや ボタンをクリックする 事 でパラメータ 入 力 欄 を 増 やしたり 減 らしたり 出 来 ます まず rfs_path=(サーバー 上 の 物 理 パス 名 )を 指 定 して 下 さい このパラメータで 指 定 したパスに OpenCms 上 のリソースがコピーされます 次 に vfs_path_( 連 番 )=(OpenCms 上 のパス 名 )を 指 定 して 下 さい このパラメータで 指 定 したパスが 同 期 対 象 となります rfs_path も vfs_path_( 連 番 )も 指 定 しなかった 場 合 は 管 理 ツールの 同 期 設 定 画 面 で 設 定 した 値 が 使 わ れます また enabled=false を 指 定 すると このジョブが 実 行 されても 同 期 処 理 はスキップされます OK ボタンをクリックすると ジョブが 登 録 され 定 期 的 にファイル 同 期 処 理 が 実 行 されるようになり ます 25

26 5 リソース 自 動 生 成 機 能 5-1 リソース 自 動 生 成 機 能 とは? リソース 自 動 生 成 機 能 を 利 用 すると CSV やデータベース その 他 さまざまな 条 件 をもとにして OpenCms 内 にリソースを 作 成 することが 出 来 ます また リソースの 生 成 処 理 はジョブに 登 録 する 事 が 出 来 るので 定 期 的 にリソースの 生 成 を 行 う 事 が 出 来 ます 5-2 使 い 方 リソースの 自 動 生 成 を 行 うには まず 自 動 生 成 ルールの 定 義 ファイルを 作 成 する 必 要 があります 定 義 ファイルを 置 く 適 当 な 場 所 に 移 動 し 1 新 規 ボタン 2その 他 設 定 ファイル 3 次 へ>>ボ タンとクリックして 下 さい 26

27 次 に 4リソース 生 成 ルール 定 義 ファイルを 選 択 し 5 次 へ >> ボタンをクリックして 下 さい 定 義 ファイルのファイル 名 を6 名 前 欄 に 入 力 して 7 次 へ >> ボタンをクリックして 下 さい ファイル 名 の 拡 張 子 は*.html にして 下 さい その 後 に 出 てくるプロパティ 設 定 画 面 では 特 に 何 も 入 力 せず 完 了 ボタンをクリックして 下 さい 上 記 のように 定 義 ファイルが 作 成 されます このファイルの8ファイル 名 をクリックし プレビューを 表 示 して 下 さい 27

28 プレビューでは 設 定 内 容 が 表 示 されます 9 直 接 編 集 ボタンをクリックすると 編 集 画 面 へ 遷 移 しますので そこで 生 成 ルールを 入 力 して 下 さい ( 生 成 ルールの 各 入 力 項 目 に 関 しては 後 で 詳 細 に 説 明 します ) 設 定 が 終 わったら この 設 定 ファイルをジョブとしてスケジューラに 登 録 します 28

29 プレビュー 画 面 からジョブ ジョブを 登 録 する 場 合 ジョブ スケジューラに 登 録 する 最 も 簡 単 な 方 法 は この 画 面 から 登 録 することです ジョブスケジューラの 登 録 権 限 のあるユーザーであれば プレビューの 左 上 に10 今 すぐジョブを 登 録 する リンクが 表 示 されているので それをクリックして 下 さい すると ジョブの 登 録 フォームが 表 示 されます 11ジョブ 名 欄 に このジョブの 名 前 を 入 力 してください 12 実 行 日 時 欄 には このジョブを 実 行 する 日 時 を 指 定 します 定 期 的 に 実 行 したい 場 合 は cron 表 記 で 入 力 して 下 さい 特 定 の 日 時 を 指 定 するとその 時 刻 に 一 度 だけ 実 行 されるようになります 日 付 の 入 力 は 13カレンダーから 入 力 する 事 も 可 能 です 即 時 に 一 度 だけ 実 行 したい 場 合 は 現 在 より 過 去 の 日 付 を 入 力 して 下 さい 最 後 に14 登 録 するボタンをクリックすると ジョブが 登 録 されます 29

30 管 理 画 面 からジョブ ジョブを 登 録 する 場 合 管 理 画 面 からジョブを 登 録 する 場 合 は 以 下 のようにします 9 表 示 プルダウンを 管 理 メニューに 変 更 し 管 理 画 面 を 表 示 します 次 に 10ジョブ 11 新 しいジョブ とクリックします 30

31 ジョブ 名 には このジョブの 名 前 を 入 力 します この 名 前 はジョブの 一 覧 画 面 で 表 示 されます Java のクラスには org.opencms.scheduler.jobs.cmsgenerateresourcesjob を 指 定 して 下 さい クーロン 表 現 形 式 には ファイル 同 期 ジョブの 実 行 時 間 ( 実 行 間 隔 )をクーロン 表 記 で 指 定 します クーロン 表 記 以 外 は 受 け 付 けません ユーザー 名 にはこのジョブを 実 行 するユーザーを 指 定 して 下 さい 必 ず OpenCms へログインし リ ソース 生 成 対 象 ディレクトリへの 書 き 込 み 権 限 を 持 ったユーザーでなければなりません 31

32 プロジェクトは Online 以 外 を 指 定 して 下 さい Online プロジェクトだと 生 成 出 来 ません サイトルートには リソースを 生 成 するサイトのルートパスを 指 定 して 下 さい この 師 弟 を 間 違 うと 全 く 違 うディレクトリにリソースが 生 成 されてしまいます 続 けるボタンをクリックすると ジョブのパラメータを 入 力 する 画 面 が 表 示 されます +ボタンや ボタンをクリックする 事 でパラメータ 入 力 欄 を 増 やしたり 減 らしたり 出 来 ます config =(リソース 生 成 ルール 定 義 ファイルのパス)を 指 定 して 下 さい ここには 読 み 込 むルール 定 義 ファイルを 指 定 します 前 の 画 面 のサイトルート 欄 で 指 定 したパスからの 相 対 位 置 で 指 定 します OK ボタンをクリックすると ジョブが 登 録 され 定 期 的 にリソース 生 成 処 理 が 実 行 されるようになり ます 32

33 5-3 リソース 定 義 ファイルの 入 力 項 目 < 基 本 項 目 > リソース 定 義 ファイルの 入 力 項 目 の 説 明 をします タイトル 欄 には このリソース 定 義 ファイルの 名 前 を 入 力 します ルール 欄 には ジェネレータ ベースパス パラメータ 上 書 き 方 法 生 成 リソース 定 義 などの 入 力 項 目 があり 自 動 生 成 のルールを 定 義 します ルール 欄 は 複 数 登 録 する 事 が 可 能 で ルール 欄 を 追 加 した い 場 合 は 右 側 の 二 重 丸 アイコンで 追 加 削 除 を 行 います 以 下 は ルール 欄 の 各 入 力 項 目 の 説 明 です ジェネレータ プルダウンには 使 用 するジェネレータを 指 定 します 選 択 できるジェネレータには 以 下 のものがあります ジェネレータ データベース ユーザー 情 報 CSV データ シーケンス 期 間 説 明 外 部 のデータベースに SQL を 発 行 し 取 得 したデータをもとにリソースを 生 成 するジェネレータです 登 録 されている OpenCms のアカウント 情 報 をもとにリソースを 生 成 するジ ェネレータです CSV ファイルを 読 み 込 み そのデータをもとにリソースを 生 成 するジェネレ ータです 連 番 を 指 定 し その 連 番 をもとにリソースを 生 成 するジェネレータです 期 間 を 指 定 し その 期 間 をもとにリソースを 生 成 するジェネレータです 33

34 ベース パス 欄 にはリソースの 生 成 先 を 指 定 します ここで 指 定 するディレクトリは 自 動 的 には 作 成 されませんので 事 前 に 作 成 されている 必 要 があります パラメータ 欄 には ジェネレータに 渡 すパラメータを 指 定 します ここで 指 定 するパラメータの 内 容 は ジェネレータ プルダウンに 指 定 したジェネレータに 依 存 します 例 えば ジェネレータに CSV データを 指 定 した 場 合 は ここには CSV ファイルのパスを 指 定 し ジェ ネレータにデータベースを 指 定 した 場 合 は ここには SQL を 記 述 する 事 になります 上 書 き 方 法 プルダウンには リソースを 自 動 生 成 する 時 既 に 同 名 のファイルが 存 在 していた 場 合 の 挙 動 を 選 択 します 選 択 できる 項 目 には 以 下 のものがあります 項 目 既 に 存 在 する 場 合 は 上 書 き 既 に 存 在 する 場 合 はスキップ 既 に 存 在 しない 場 合 はスキップ 既 に 存 在 する 場 合 は 警 告 して 継 続 既 に 存 在 する 場 合 はエラーで 終 了 説 明 既 存 のファイルに 対 して 上 書 きを 行 います 何 もせず 次 のファイルの 生 成 に 移 ります 既 に 存 在 する 場 合 のみ 上 書 きを 行 い 存 在 しなければ 何 も 行 いません つまり 新 規 作 成 は 行 われません ログにアラートを 出 力 し 処 理 を 継 続 します 上 書 きが 行 われます ログにエラーを 出 力 し 処 理 を 停 止 します 上 書 きは 行 われず 次 のファイルの 生 成 にも 移 りません 但 し 今 まで 生 成 したファイルのロールバックも 行 われま せん 生 成 リソース 定 義 欄 には 実 際 に 生 成 するリソースの 定 義 を 記 述 します 最 低 でも 生 成 するリソース のパスとリソースタイプを 指 定 しなければなりません 生 成 リソース 定 義 欄 は 複 数 登 録 する 事 が 可 能 で 生 成 リソース 定 義 欄 を 追 加 したい 場 合 は 右 側 の 二 重 丸 アイコンで 追 加 削 除 を 行 います 34

35 5-4 リソース 定 義 ファイルのリソース パスの 指 定 方 法 では これまで 説 明 した 入 力 パラメータを 用 いて 実 際 に 実 行 してみます タイトル ルール ジェネレータ ベース パス パラメータ 上 書 き 方 法 生 成 リソース 定 義 パス リソースタイプ リソース 生 成 ルールのサンプル CSV データ /news/ /news/data.csv 既 に 存 在 する 場 合 は 上 書 き news_%(col,id)_%(col,ファイル 名 ).html xmlpage まず 上 記 のように 入 力 しました ジェネレータには CSV データを 使 用 するようにしています よって パラメータには CSV ファイルのパスを 指 定 しています そして ベース パスに/news/を 指 定 しているので /news/ 以 下 にリソースが 生 成 されます また /news/data.csv を 事 前 に 作 成 します この CSV の 内 容 は 以 下 の 通 りです /news/data.csv(リソースタイプ:テキスト) CSV ファイルの 一 行 目 は 実 データではなく 必 ず ヘッダー( 項 目 名 )でなければなりません リソースタイプ 欄 には xmlpage を 指 定 しているので xmlpage のリソースが 生 成 されます パス 欄 には 生 成 するリソースのパス(ファイル 名 )を 指 定 します news_%(col,id)_%(col,ファイル 名 ).html が 指 定 しされていますが %( )は マクロと 呼 ばれ 様 々な 変 数 に 置 換 されます 利 用 できるマクロはジェネレータに 依 存 します 35

36 ジェネレータが CSV データやデータベースの 場 合 は %(col)のマクロを 使 用 することが 出 来 ます カンマ 区 切 りで 引 数 に 項 目 名 を 指 定 すると その 項 目 名 に 置 換 されます よって CSV データの ID 列 が 1 で ファイル 名 列 が samplea の 場 合 news_%(col,id)_%(col,ファイ ル 名 ).html は news_1_samplea.html となります また %(col, < 項 目 名 >) は %(col, < 列 番 号 >) で 指 定 することも 可 能 です よって news_%(col,id)_%(col,ファイル 名 ).html は news_%(col,1)_%(col,2).html でも 同 じ 意 味 にな ります このリソース 生 成 定 義 ファイルで 実 行 した 結 果 は 以 下 になります リソースタイプ xmlpage のページが 3 つ 作 成 されました CSV データの 場 合 CSV データの 行 数 分 ルール 欄 で 指 定 した 処 理 が 実 行 されるため 3 つのファイ ルが 作 成 されています 36

37 生 成 するリソースのパスを %(col,ファイル 名 )/index.html のようにしたい 場 合 の 方 法 を 説 明 します この 場 合 %(col,ファイル 名 )のフォルダの 中 に index.html という 名 前 で xmlpage を 生 成 する 事 になります しかし %(col,ファイル 名 )というフォルダはまだ 存 在 しない 為 このまま 実 行 するとエラーとなります こういったケースでは xmlpage の 生 成 ルールの 前 に フォルダの 生 成 ルールを 追 加 します タイトル リソース 生 成 ルールのサンプル ルール ジェネレータ CSV データ ベース パス /news/ パラメータ /news/data.csv 上 書 き 方 法 既 に 存 在 する 場 合 は 上 書 き 生 成 リソース 定 義 パス %(col,ファイル 名 ) リソースタイプ folder 生 成 リソース 定 義 パス %(col,ファイル 名 )/index.html リソースタイプ xmlpage パスは ベース パスで 指 定 したパスからの 相 対 位 置 で 記 述 します また 生 成 リソース 定 義 欄 の 順 序 は 重 要 です 上 から 順 に 実 行 されますので フォルダの 作 成 をページの 作 成 より 上 に 記 述 する 必 要 があります 37

38 実 行 結 果 は 以 下 です samplea sampleb samplec フォルダが 生 成 され そのフォルダの 下 に それぞれの index.html が 生 成 されています 38

39 生 成 するリソースのパスには *(ワイルドカード)を 指 定 することが 出 来 ます 例 えば /news/フォルダの 下 に カテゴリ 毎 にフォルダを 作 成 する 事 にします そして カテゴリフォルダの 下 に 自 動 生 成 で xmlpage のページと images フォルダ(イメージギャラ リー)を 作 成 する 事 にします 但 し カテゴリ 毎 のフォルダ 自 体 は 自 動 生 成 されるものではなく 手 動 で 作 成 します 手 動 でフォルダを 作 成 すると その 下 のリソースが 自 動 生 成 により 作 成 されるようにしてみます まず /news/の 下 に ir と product と topics というフォルダを 手 動 で 作 成 しました このフォルダの 下 には まだリソースは 何 もありません リソース 定 義 ファイルを 以 下 のようにします タイトル ルール ジェネレータ ベース パス パラメータ 上 書 き 方 法 生 成 リソース 定 義 パス リソースタイプ 生 成 リソース 定 義 パス リソースタイプ リソース 生 成 ルールのサンプル CSV データ /news/ /news/data.csv 既 に 存 在 する 場 合 は 上 書 き */news_%(col,id)_%(col,ファイル 名 ).html xmlpage */images imagegallery 生 成 リソース 定 義 のパスに*(ワイルドカード)を 使 用 しています 39

40 実 行 結 果 は 以 下 です ir product topics の 各 フォルダの 下 に images フォルダと CSV から 取 得 したデータで 生 成 された 3 ページが 生 成 されます フォルダを 新 規 作 成 した 後 必 要 なファイルやフォルダを 一 式 まとめて 生 成 する 場 合 などに 有 効 です 40

41 5-5 リソース 定 義 ファイルの 入 力 項 目 <メタ 情 報 > 生 成 リソース 定 義 には パスとリソースタイプの 他 に メタ 情 報 を 指 定 することが 出 来 ます メタ 情 報 欄 は 複 数 登 録 する 事 が 可 能 で メタ 情 報 欄 を 追 加 したい 場 合 は 右 側 の 二 重 丸 アイコンで 追 加 削 除 を 行 います メタ 情 報 には タイプ 名 前 値 を 入 力 する 欄 があります まず タイプ プルダウンで 登 録 するメタ 情 報 の 種 類 を 選 択 します 選 択 できるメタ 情 報 の 種 類 には 以 下 のものがあります 個 別 プロパティ 個 別 プロパティをセットする 場 合 に 選 択 します これを 指 定 した 場 合 名 前 欄 にプロパティ 名 を 値 欄 にプロパティ 値 を 入 力 します 値 には マクロを 使 用 する 事 が 可 能 です 入 力 例 上 の 例 の 場 合 /news/フォルダの Title プロパティが"ニュース"で 且 つ 自 動 生 成 した 時 の 日 時 が 2010 年 6 月 20 日 の 場 合 生 成 される html の Title プロパティには " のニュース"という 値 が 入 ります 41

42 共 有 プロパティ 共 有 プロパティをセットする 場 合 に 選 択 します リソースをショートカットとしてコピーした 場 合 個 別 プロパティは 別 々に 値 をセットできますが 共 有 プロパティは 値 を 共 有 します よって 共 有 プロパティのプロパティ 値 を 変 更 すると ショートカ ットとして 作 成 されたほかのリソースのプロパティ 値 も 変 更 される 事 になります 設 定 方 法 は 個 別 プロパティの 時 と 全 く 同 じです 入 力 例 上 の 例 の 場 合 /news/フォルダの Title プロパティが"ニュース"で 且 つ 自 動 生 成 した 時 の 日 時 が 2010 年 6 月 21 日 の 場 合 生 成 される html の NavText プロパティには " のニュース"とい う 値 が 入 ります 入 力 例 上 の 例 の 場 合 "/system/modules/jp.zyyx.opencms7_5_1.core/templates/blank.jsp"という 値 が 生 成 される html の template プロパティに 入 ります xmlpage の 場 合 テンプレートの 指 定 は 必 須 なので このようにしてテンプレートを 指 定 する 事 になります 42

43 公 開 日 リソースの 公 開 日 をセットする 場 合 に 選 択 します これを 指 定 した 場 合 名 前 欄 は 未 入 力 のままで 問 題 ありません 値 欄 には 公 開 日 をセットしますが セットするのは UNIX TIME でなければなりません よって "2010/6/21"といったような 文 字 列 は 指 定 できず " "のような 数 値 しか 受 け 付 け ません 尚 ミリ 秒 単 位 での UNIX TIME なので 元 のデータが 秒 単 位 の UNIX TIME の 場 合 それを 1000 倍 したデータを 登 録 する 必 要 があります 1970 年 といった 日 付 が 登 録 される 場 合 は 値 を 1000 倍 にし て 下 さい また 値 には マクロを 使 用 する 事 が 可 能 です 入 力 例 %(now)は 現 在 時 刻 を 表 すマクロです + 3days とすることで リソース 生 成 日 時 から 3 日 後 を 指 定 した 事 になります また %(now)は カンマ 区 切 りでフォーマットを 引 数 に 渡 す 事 が 出 来 ます 43

44 公 開 日 や 公 開 期 限 はデータが UNIX TIME なのでフォーマット 指 定 は 無 意 味 なのですが 年 月 日 時 分 秒 を 固 定 の 値 にしたい 場 合 に 利 用 できます 例 えば リソース 生 成 処 理 が どの 時 間 に 実 行 さ れたとしても リソース 生 成 日 時 から 3 日 後 の 10 時 ジャストに 公 開 日 をセットしたい 場 合 以 下 のよ うにフォーマットで 指 定 します フォーマットは"yyyy-MM-dd HH:mm:ss" 又 は "yyyy/mm/dd HH:mm:ss"で 指 定 して 下 さい 44

45 公 開 期 限 リソースの 公 開 期 限 をセットする 場 合 に 選 択 します 設 定 方 法 は 公 開 日 の 時 と 全 く 同 じです 入 力 例 エレメント これは メタ 情 報 というよりは データ 本 体 をあらわしています これは リソースタイプによって 動 作 や 設 定 方 法 が 変 わります 生 成 するリソースタイプが xmlpage の 場 合 名 前 欄 にエレメント 名 を 指 定 し その 内 容 を 値 欄 に 指 定 します 入 力 例 上 の 例 では body エレメントに CSV のデータを 間 に 改 行 タグを 挿 入 しながら 出 力 するように 指 示 しています 45

46 生 成 されたページのプレビューです 本 文 に 指 定 された 文 字 列 が 入 っています 本 文 は 直 接 編 集 ボタンから HTML エディタを 開 き 編 集 することが 可 能 です 46

47 生 成 するリソースタイプが 構 造 化 コンテンツの 場 合 名 前 欄 にエレメント 名 を 指 定 し その 内 容 を 値 欄 に 指 定 します エレメントが 階 層 構 造 を 持 っている 場 合 / 区 切 りで 階 層 を 指 定 します また エレメントが 可 変 長 の 配 列 構 造 の 場 合 [ ]で 添 え 字 を 指 定 することが 出 来 ます 入 力 例 上 の 例 では Title エレメントに CSV データのタイトル 列 のデータを 登 録 します 上 の 例 では FileInfo エレメント 内 の ReleaseDate エレメントに 現 在 日 時 をフォーマット 指 定 ありで 指 定 しています 47

48 上 の 例 では FileInfo エレメント 内 の FileName エレメントに CSV データのファイル 名 欄 の 値 を 指 定 しています FileName エレメントは 複 数 のフィールドを 持 てる 配 列 構 造 であり 添 え 字 を 指 定 して 1 番 目 の 入 力 欄 にセットされるように 指 定 しています 尚 このマニュアルの 例 では リソースタイプに"xmlcontent"と 指 定 していますが 本 来 は 自 分 で 作 成 したリソースタイプを 指 定 します 自 作 したリソースタイプ 追 加 した 時 opencms-modules.xml を 設 定 したと 思 いますが 自 作 したりソースタイプを 指 定 する 場 合 その<type/>タグの name 属 性 にセ ットした 名 前 を 指 定 して 下 さい ( 詳 しくは テンプレート 開 発 マニュアルの 5-4 リソースタイプの 追 加 を 参 照 して 下 さい ) <type class="org.opencms.file.types.cmsresourcetypexmlcontent" name="sample" id="80"> また データタイプに OpenCmsDateTime を 指 定 したエレメントに 日 付 のデータを 入 れるときは 注 意 が 必 要 です この 場 合 も 公 開 日 の 場 合 と 同 様 セットするのは UNIX TIME でなければなりません よって "2010/6/21"といったような 文 字 列 は 指 定 できず " "のような 数 値 しか 受 け 付 け ません 尚 ミリ 秒 単 位 での UNIX TIME なので 元 のデータが 秒 単 位 の UNIX TIME の 場 合 それを 1000 倍 したデータを 登 録 する 必 要 があります 1970 年 といった 日 付 が 登 録 される 場 合 は 値 を 1000 倍 にし て 下 さい 48

49 生 成 するリソースタイプが plain や JSP PHP Groovlet などのテキストファイルの 場 合 名 前 欄 には 何 も 指 定 する 必 要 はありません 値 欄 に 指 定 したテキストデータが そのままテキストファイルの 内 容 として 保 存 されます 入 力 例 49

50 生 成 するリソースタイプが image や binary などのバイナリ ファイルの 場 合 名 前 欄 には 何 も 指 定 する 必 要 はありません 値 欄 に 指 定 したバイナリ データが そのままファイルの 内 容 として 保 存 さ れます 但 し ジェネレータがデータバースの 場 合 Blob 系 のカラムのみサポートされます ジェネレータが CSV データなどであれば 入 力 はテキストデータになります この 場 合 そのテキス トデータは バイナリデータを BASE64 でエンコードしたものである 必 要 があります 入 力 例 生 成 するリソースタイプが folder や gallery 系 の 場 合 エレメントの 指 定 は 無 効 です 50

51 最 後 に 演 算 式 欄 ですが ここには 計 算 式 を 記 述 します 計 算 式 が 入 力 されると 値 欄 のデータをこの 式 に 当 てはめて 計 算 し その 計 算 結 果 の 数 値 を 登 録 するよ うになります 演 算 式 欄 に 式 を 記 述 する 場 合 値 欄 のデータは 数 値 である 事 が 前 提 となります また セットされる 値 は 式 の 中 では? であらわします 入 力 例 上 の 例 では CSV の 価 格 列 からデータを 取 得 し それを Price エレメントに 登 録 します ただし 登 録 する 前 に CSV の 価 格 値 を 80%にして 500 を 引 いた 値 に 変 換 してから 登 録 します 51

52 5-6 リソース 定 義 ファイルの 入 力 項 目 <アクセス 権 限 > アクセス 権 限 欄 では 生 成 するリソースのアクセス 権 限 を 指 定 します アクセス 権 限 欄 は 一 つのリソ ースに 対 し 複 数 登 録 する 事 が 可 能 で アクセス 権 限 欄 を 追 加 したい 場 合 は 右 側 の 二 重 丸 アイコンで 追 加 削 除 を 行 います 対 象 欄 には アクセス 権 限 を 付 与 する 対 象 を 記 述 します 直 接 記 述 する 事 も 可 能 ですが 右 側 の 検 索 ア イコンをクリックすると 一 覧 から 選 択 できます パーミッション 欄 には 権 限 を 指 定 します 設 定 できる 文 字 列 は 以 下 のものがあり これらをつなげた 文 字 列 を 入 力 します 設 定 値 説 明 +r 読 み 込 みを 許 可 する +w 書 き 込 みを 許 可 する +v エクスプローラー 上 での 表 示 を 許 可 する +c コピーや 移 動 などのリソース コントロールを 許 可 する +d 直 接 発 行 を 許 可 する +i サブフォルダーにも 同 じ 権 限 設 定 を 継 承 させる +o 親 フォルダから 継 承 された 権 限 を 破 棄 する +l このコンテンツの 責 任 者 にする -r 読 み 込 みを 拒 否 する -w 書 き 込 みを 拒 否 する -v エクスプローラー 上 での 表 示 を 拒 否 する -c コピーや 移 動 などのリソース コントロールを 拒 否 する -d 直 接 発 行 を 拒 否 する 52

53 実 行 結 果 53

54 5-7 リソース 定 義 ファイルの 入 力 項 目 <アクション> アクション 欄 では リソース 生 成 時 に 実 行 するアクションを 指 定 します アクション 欄 は 一 つのリ ソースに 対 し 複 数 登 録 する 事 が 可 能 で アクション 欄 を 追 加 したい 場 合 は 右 側 の 二 重 丸 アイコンで 追 加 削 除 を 行 います コマンド 欄 には 実 行 するアクションの 種 類 を 指 定 します コマンドには 以 下 のものがあります コマンド 同 時 に 発 行 する コピー 移 動 削 除 : 関 連 付 けファイルは 残 す 削 除 : 関 連 付 けファイルも 削 除 説 明 リソースを 生 成 した 後 発 行 も 行 います リソース 生 成 ジョブの 実 行 ユーザーが 発 行 権 限 を 持 って いる 必 要 があります 生 成 したリソース 又 は 生 成 しようとしていたリソース が 既 に 存 在 していた 場 合 に そのリソースを 別 のディレク トリにコピーします 生 成 したリソース 又 は 生 成 しようとしていたリソース が 既 に 存 在 していた 場 合 に そのリソースを 別 のディレク トリに 移 動 します 生 成 したリソース 又 は 生 成 しようとしていたリソース が 既 に 存 在 していた 場 合 そのリソースを 削 除 します 削 除 対 象 のリソースが 関 連 付 けファイルを 持 っている 場 合 その 関 連 付 けファイルは 削 除 しません 生 成 したリソース 又 は 生 成 しようとしていたリソース が 既 に 存 在 していた 場 合 そのリソースを 削 除 します 削 除 対 象 のリソースが 関 連 付 けファイルを 持 っている 場 合 その 関 連 付 けファイルも 同 時 に 削 除 します 54

55 コピー 移 動 時 のオプション 欄 には コマンド 欄 で コピー または 移 動 を 選 択 した 場 合 に その 移 動 先 などの 情 報 を 指 定 します この 欄 は コマンド 欄 で コピー または 移 動 を 選 択 した 時 のみ 指 定 します コピー 移 動 先 欄 は コピー 又 は 移 動 先 のディレクトリを 指 定 します ここで 指 定 したディレクトリの 直 下 に 同 じファイル 名 でリソースがコピー 又 は 移 動 されます 指 定 するディレクトリは 事 前 に 作 成 しておかなければなりません また リソース 自 動 生 成 ジョブを 実 行 するユーザーの 権 限 で 書 き 込 める 必 要 があります 上 書 き 方 法 プルダウンには コピー 又 は 移 動 先 に 既 に 同 名 のファイルが 存 在 していた 場 合 の 挙 動 を 指 定 します 指 定 できる 項 目 には 以 下 のものがあります 項 目 既 に 存 在 する 場 合 は 上 書 き 既 に 存 在 する 場 合 はスキップ 既 に 存 在 しない 場 合 はスキップ 既 に 存 在 する 場 合 は 警 告 して 継 続 既 に 存 在 する 場 合 はエラーで 終 了 説 明 既 存 のファイルに 対 して 上 書 きを 行 います 何 もせず 次 のファイルの 生 成 に 移 ります 既 に 存 在 する 場 合 のみ 上 書 きを 行 い 存 在 しなければ 何 も 行 いません つまり 新 規 作 成 は 行 われません ログにアラートを 出 力 し 処 理 を 継 続 します 上 書 きが 行 われます ログにエラーを 出 力 し 処 理 を 停 止 します 上 書 きは 行 われず 次 のファイルの 生 成 にも 移 りません 但 し 今 まで 生 成 したファイルのロールバックも 行 われま せん 関 連 付 けファイルの 扱 い プルダウンは コピー 時 の 関 連 付 けファイル(ショートカット)の 扱 い 方 法 を 指 定 します 指 定 できる 項 目 には 以 下 のものがあります 項 目 関 連 付 けファイルを 保 持 する 別 リソースとしてコピー 関 連 付 けファイルとしてコピー 説 明 関 連 付 けファイルであれば 関 連 付 けファイル そうでなけ れば 別 リソースとしてコピーします 常 に 別 リソースとしてコピーします 常 に 関 連 付 けファイルとしてコピーします コマンドがコピーの 場 合 のみ 有 効 です 移 動 の 場 合 は この 指 定 は 無 視 されます 55

56 タイミング 欄 には リソースをコピー 又 は 移 動 するタイミングを 指 定 します 指 定 できる 項 目 には 以 下 のものがあります 項 目 メタ 情 報 更 新 前 に 移 動 またはコピー メタ 情 報 更 新 後 に 移 動 またはコピー 説 明 メタ 情 報 などの 更 新 を 行 う 前 にリソースをコピーまた は 移 動 します よって 新 たに 生 成 されたりソースと コピー 又 は 移 動 させたリソースのメタ 情 報 は 一 致 しません これは 主 に 変 更 を 加 える 前 に 現 在 のファイルをバッ クアップするといった 目 的 で 使 用 します メタ 情 報 などの 更 新 を 行 った 後 に リソースをコピーは 移 動 します よって 新 たに 生 成 されたりソースと コ ピー 又 は 移 動 させたリソースのメタ 情 報 は 一 致 します これは 自 動 生 成 したファイルを 複 数 の 場 所 に 配 置 し たり 生 成 するフォルダと 配 置 するフォルダを 別 にする 必 要 がある 場 合 などに 使 用 します 56

57 6 リソース 自 動 生 成 機 能 < 各 種 ジェネレータ> 6-1 CSV データジェネレータ このジェネレータは CSV ファイルからデータを 読 み 込 み それをもとにリソースを 生 成 します 定 義 されたルールは CSV の 行 の 数 だけ 実 行 されます パラメータ パラメータ 欄 に 指 定 するのは CSV ファイルのパスです OpenCms に 登 録 されている CSV ファイル(VFS)を 指 定 する 場 合 は ジョブを 実 行 するサイトの ルートからの 相 対 パスを 指 定 します OpenCms がインストールされているサーバー 上 の 物 理 ファイル(RFS)を 指 定 する 場 合 は 絶 対 パ スで 指 定 します 文 字 コードを 指 定 する 場 合 は ( 文 字 コード) (CSV ファイルのパス) 形 式 で 指 定 します デフォルトの 文 字 コードは OpenCms 上 の CSV ファイルの 場 合 content-encoding プロパティ 値 の 値 が 適 用 され content-encoding プロパティが 未 入 力 なら UTF-8 が 適 用 されます サーバー 上 の 物 理 ファイルの 場 合 のデフォルト 文 字 コードは OS のデフォルトの 文 字 コードです 57

58 マクロ CSV データジェネレータで 使 用 できるマクロは 以 下 の 通 りです マクロ %(col) 説 明 CSV データの 該 当 するカラムの 値 を 表 します カンマで 区 切 って カラム 名 を 指 定 します カラム 名 は CSV データの 一 行 目 のデータが 使 用 されます 例 )%(col, タイトル) また カラム 名 ではなく 列 の 番 号 でも 指 定 することが 出 来 ます 列 の 番 号 は 1 以 上 の 整 数 です 1 が 一 番 左 の 列 を 表 します 例 )%(col, 3) %(now) 注 意 : 登 録 先 の デ ー タ 型 が OpenCmsDataTime の 場 合 登 録 す る の は "yyyy-mm-dd"のような 日 付 の 文 字 列 ではなく ミリ 秒 まで 含 んだ UNIX TIME になります よって CSV のデータも 事 前 に UNIX TIME にしておく 必 要 があ ります リソースの 自 動 生 成 が 実 行 された 日 時 を 表 します デフォルトでは 日 付 のフォーマットは"yyyy-MM-dd"ですが カンマで 区 切 っ て フォーマットを 指 定 することが 出 来 ます 例 )%(now, yyyy/mm/dd HH:mm) "2010/6/21"といったような 文 字 列 ではなく " "のような 数 値 (UNIX TIME)で 表 示 したい 場 合 は 以 下 のようにフォーマットを 空 文 字 で 指 定 します ( カンマだけ 指 定 します ) 例 )%(now, ) また 現 在 時 刻 に 対 して 時 間 を 加 算 減 算 することが 出 来 ます 例 )%(now + 3days) 現 在 時 刻 から 3 日 後 を 指 定 %(now - 2days) 現 在 時 刻 から 2 日 前 を 指 定 %(now + 8hours) 現 在 時 刻 から 8 時 間 後 を 指 定 %(now - 1year, M 月 d 日 ) 現 在 時 刻 から 1 年 前 を 指 定 ( 日 付 フォーマットの 指 定 あり) 但 し 演 算 子 は 一 つまでしか 指 定 できません 58

59 時 間 の 加 算 減 算 の 指 定 には 以 下 のものが 使 用 できます 秒 : second, sec, seconds 分 : minute, min, nimutes 時 : hour, hours 日 : day, days 月 : month 年 : year, years また 公 開 日 や 公 開 期 限 にこのマクロを 指 定 する 場 合 フォーマット 指 定 の 扱 いが 若 干 異 なります 公 開 日 や 公 開 期 限 の 場 合 入 力 されるデータは 必 ず UNIX TIME なのでフォー マット 指 定 は 無 意 味 なのですが 代 わりに 年 月 日 時 分 秒 を 固 定 の 値 にしたい 場 合 に 利 用 できます 例 えば リソース 生 成 処 理 が どの 時 間 に 実 行 されたとしても リソース 生 成 日 時 から 3 日 後 の 10 時 ジャストに 公 開 日 をセットしたい 場 合 以 下 のようにフ ォーマットで 指 定 します 例 )%(now + 3days, yyyy/mm/dd 10:00:00) この 場 合 フォーマットは"yyyy-MM-dd HH:mm:ss" 又 は "yyyy/mm/dd HH:mm:ss"で 指 定 して 下 さい %(parent) 個 別 プロパティ 又 は 共 有 プロパティの 値 の 設 定 でこのマクロを 使 用 した 場 合 設 定 しようとしているプロパティ 名 と 同 じプロパティ 名 で 親 フォルダを 再 帰 的 に 検 索 し 最 初 に 見 つけたプロパティ 値 をセットします 公 開 日 又 は 公 開 期 限 の 値 の 設 定 でこのマクロを 使 用 した 場 合 親 フォルダの 公 開 日 又 は 公 開 期 限 をそのままセットします 上 記 以 外 のところでこのマクロを 指 定 しても 効 果 はありません %(prop) 指 定 されたプロパティ 名 で 親 フォルダを 再 帰 的 に 検 索 し 最 初 に 見 つけたプロパ ティ 値 をセットします カンマで 区 切 って プロパティ 名 を 指 定 します 例 )%(prop, Description) プロパティ 名 は 大 文 字 小 文 字 の 区 別 があるので 注 意 してください 59

60 6-2 データベースジェネレータ このジェネレータは データベースへ SQL を 発 行 し 取 得 したデータをもとにリソースを 生 成 しま す 定 義 されたルールは 取 得 したレコードの 件 数 だけ 実 行 されます パラメータ パラメータ 欄 に 指 定 するのは 発 行 する SQL と 接 続 先 データベースを 表 すコネクション プールの 名 前 です SQL のみ 記 述 すると OpenCms が 使 用 しているデフォルトのデータベースへ 接 続 します 別 のデータベースへ 接 続 する 場 合 は./WEB-INF/config/opencms.properties に 接 続 情 報 を 記 述 し そ のプール 名 を "(プール 名 ) (SQL 文 )" の 形 式 で 指 定 します 別 のデータベースへ 接 続 する 方 法 は OpenCms タグリファレンス の 2-19 query を 参 照 して 下 さい 60

61 マクロ データベースジェネレータで 使 用 できるマクロは 以 下 の 通 りです マクロ %(col) 説 明 データベースから 取 得 したデータの 該 当 するカラムの 値 を 表 します カンマで 区 切 って カラム 名 を 指 定 します 例 )%(col, GROUP_NAME) また カラム 名 ではなく 列 の 番 号 でも 指 定 することが 出 来 ます 列 の 番 号 は 1 以 上 の 整 数 です 1 が 一 番 左 の 列 を 表 します 例 )%(col, 2) 注 意 : 登 録 先 の デ ー タ 型 が OpenCmsDataTime の 場 合 登 録 す る の は "yyyy-mm-dd"のような 日 付 の 文 字 列 ではなく ミリ 秒 まで 含 んだ UNIX TIME になります よって データベースのデータも 事 前 に UNIX TIME にしておく 必 要 があります %(now) リソースの 自 動 生 成 が 実 行 された 日 時 を 表 します 内 容 は CSV データジェネレータと 同 様 ですので そちらの 説 明 を 参 照 して 下 さ い %(parent) 個 別 プロパティ 又 は 共 有 プロパティの 値 の 設 定 でこのマクロを 使 用 した 場 合 設 定 しようとしているプロパティ 名 と 同 じプロパティ 名 で 親 フォルダを 再 帰 的 に 検 索 し 最 初 に 見 つけたプロパティ 値 をセットします 公 開 日 又 は 公 開 期 限 の 値 の 設 定 でこのマクロを 使 用 した 場 合 親 フォルダの 公 開 日 又 は 公 開 期 限 をそのままセットします 上 記 以 外 のところでこのマクロを 指 定 しても 効 果 はありません %(prop) 指 定 されたプロパティ 名 で 親 フォルダを 再 帰 的 に 検 索 し 最 初 に 見 つけたプロパ ティ 値 をセットします カンマで 区 切 って プロパティ 名 を 指 定 します 例 )%(prop, Description) プロパティ 名 は 大 文 字 小 文 字 の 区 別 があるので 注 意 してください 61

62 6-3 シーケンスジェネレータ このジェネレータは 指 定 されたループ 回 数 だけ 定 義 されたリソース 生 成 ルールを 実 行 します パラメータ パラメータ 欄 に 指 定 するのは ループの 開 始 番 号 と 終 了 番 号 です 上 記 の 場 合 1 から 10 までの 合 計 10 回 リソース 生 成 処 理 を 実 行 します この 1 から 10 までの 数 字 は マクロで 取 得 する 事 が 出 来 ます 数 字 の 増 加 数 を 指 定 する 場 合 は 3 つ 目 の 引 数 に 指 定 します 上 記 の 場 合 0, 50, 100, 150, 200 の 合 計 5 回 リソースの 生 成 処 理 が 実 行 されます 62

63 マクロ シーケンスジェネレータで 使 用 できるマクロは 以 下 の 通 りです マクロ 説 明 %(seq) 現 在 のシーケンスの 番 号 を 取 得 します %(now) リソースの 自 動 生 成 が 実 行 された 日 時 を 表 します 内 容 は CSV データジェネレータと 同 様 ですので そちらの 説 明 を 参 照 して 下 さ い %(parent) 個 別 プロパティ 又 は 共 有 プロパティの 値 の 設 定 でこのマクロを 使 用 した 場 合 設 定 しようとしているプロパティ 名 と 同 じプロパティ 名 で 親 フォルダを 再 帰 的 に 検 索 し 最 初 に 見 つけたプロパティ 値 をセットします 公 開 日 又 は 公 開 期 限 の 値 の 設 定 でこのマクロを 使 用 した 場 合 親 フォルダの 公 開 日 又 は 公 開 期 限 をそのままセットします 上 記 以 外 のところでこのマクロを 指 定 しても 効 果 はありません %(prop) 指 定 されたプロパティ 名 で 親 フォルダを 再 帰 的 に 検 索 し 最 初 に 見 つけたプロパ ティ 値 をセットします カンマで 区 切 って プロパティ 名 を 指 定 します 例 )%(prop, Description) プロパティ 名 は 大 文 字 小 文 字 の 区 別 があるので 注 意 してください 63

64 6-4 期 間 ジェネレータ す このジェネレータは 期 間 を 指 定 し その 期 間 の 日 数 分 定 義 されたリソース 生 成 ルールを 実 行 しま パラメータ パラメータ 欄 に 指 定 するのは 開 始 日 と 終 了 日 です カンマ 区 切 りで 指 定 します リソースが 生 成 された 時 間 から 相 対 的 に 時 間 を 指 定 する 場 合 は 以 下 のように +3days や-3days と 指 定 します 期 間 の 指 定 には 以 下 の 値 を 指 定 することが 出 来 ます 秒 : second, sec, seconds 分 : minute, min, nimutes 時 : hour, hours 日 : day, days 月 : month 年 : year, years また 日 時 を 日 付 で 直 接 指 定 することも 出 来 ます 直 接 日 付 を 指 定 する 場 合 は"yyyy/MM/dd HH:mm:ss" 又 は"yyyy/MM/dd"の 日 付 フォーマットで 指 定 し ます 64

65 マクロ 期 間 ジェネレータで 使 用 できるマクロは 以 下 の 通 りです マクロ 説 明 %(date) 現 在 処 理 している 日 付 を 取 得 します それ 以 外 の 使 い 方 は CSV データジェネレータの%(now)と 同 様 ですので そち らの 説 明 を 参 照 して 下 さい %(now) リソースの 自 動 生 成 が 実 行 された 日 時 を 表 します 内 容 は CSV データジェネレータと 同 様 ですので そちらの 説 明 を 参 照 して 下 さ い %(parent) 個 別 プロパティ 又 は 共 有 プロパティの 値 の 設 定 でこのマクロを 使 用 した 場 合 設 定 しようとしているプロパティ 名 と 同 じプロパティ 名 で 親 フォルダを 再 帰 的 に 検 索 し 最 初 に 見 つけたプロパティ 値 をセットします 公 開 日 又 は 公 開 期 限 の 値 の 設 定 でこのマクロを 使 用 した 場 合 親 フォルダの 公 開 日 又 は 公 開 期 限 をそのままセットします 上 記 以 外 のところでこのマクロを 指 定 しても 効 果 はありません %(prop) 指 定 されたプロパティ 名 で 親 フォルダを 再 帰 的 に 検 索 し 最 初 に 見 つけたプロパ ティ 値 をセットします カンマで 区 切 って プロパティ 名 を 指 定 します 例 )%(prop, Description) プロパティ 名 は 大 文 字 小 文 字 の 区 別 があるので 注 意 してください 65

66 使 用 例 期 間 ジェネレータを 用 いて 以 下 のように 設 定 した 場 合 の 実 行 結 果 を 示 します タイトル ルール リソース 生 成 ルールのサンプル ジェネレータ 期 間 ( 毎 日 ) ベース パス /news/ パラメータ 2010/06/01 10:00:00, 2010/06/03 10:00:00 上 書 き 方 法 既 に 存 在 する 場 合 は 上 書 き 生 成 リソース 定 義 パス %(date, yyyymmdd_hh).html リソース タイプ xmlpage 実 行 結 果 ジェネレータに 期 間 ( 毎 日 ) を 指 定 しているので 増 分 は 一 日 になります よって 2010/06/01 10:00:00 ~ 2010/06/03 10:00:00 の 間 で 3 日 分 の html が 生 成 されます 他 の 設 定 はそのままで ジェネレータだけ 期 間 ( 毎 時 )に 変 更 した 場 合 の 実 行 結 果 は 以 下 になります タイトル ルール リソース 生 成 ルールのサンプル ジェネレータ 期 間 ( 毎 時 ) ベース パス /news/ パラメータ 2010/06/01 10:00:00, 2010/06/03 10:00:00 上 書 き 方 法 既 に 存 在 する 場 合 は 上 書 き 生 成 リソース 定 義 パス %(date, yyyymmdd_hh).html リソース タイプ xmlpage 66

67 実 行 結 果 ジェネレータに 期 間 ( 毎 時 ) を 指 定 しているので 増 分 は 一 時 間 になります よって 2010/06/01 10:00:00 ~ 2010/06/03 10:00:00 の 間 で 時 間 毎 の html がたくさん 生 成 されます 67

68 6-5 ユーザー 情 報 ジェネレータ このジェネレータは OpenCms に 登 録 されているアカウントの 情 報 を 元 に 定 義 されたリソース 生 成 ルールを 実 行 します パラメータ パラメータ 欄 には 取 得 するユーザーの 条 件 をカンマ 区 切 りで 指 定 します 指 定 できる 条 件 には 以 下 のものがあります( 大 文 字 小 文 字 は 区 別 されません) 条 件 説 明 enable 有 効 なユーザーのみを 取 得 します!enable 無 効 なユーザーのみを 取 得 します disable 無 効 なユーザーのみを 取 得 します zip 郵 便 番 号 が 入 力 済 みのユーザーのみ 取 得 します!zip 郵 便 番 号 が 未 入 力 のユーザーのみ 取 得 します city 市 町 村 が 入 力 済 みのユーザーのみ 取 得 します!city 市 町 村 が 未 入 力 のユーザーのみ 取 得 します street アドレスが 入 力 済 みのユーザーのみ 取 得 します!street アドレスが 未 入 力 のユーザーのみ 取 得 します country 国 籍 が 入 力 済 みのユーザーのみ 取 得 します!country 国 籍 が 未 入 力 のユーザーのみ 取 得 します description 説 明 が 入 力 済 みのユーザーのみ 取 得 します!description 説 明 が 未 入 力 のユーザーのみ 取 得 します role.(ロール 名 ) 指 定 されたロールに 所 属 しているユーザーのみ 取 得 します!role.(ロール 名 ) 指 定 されたロールに 所 属 していないユーザーのみ 取 得 します group.(グループ 名 ) 指 定 されたグループに 所 属 しているユーザーのみ 取 得 します!group.(グループ 名 ) 指 定 されたグループに 所 属 していないユーザーのみ 取 得 します user.(ユーザー 名 ) 指 定 されたユーザーのみ 取 得 します!user.(ユーザー 名 ) 指 定 されたユーザーは 取 得 しません key.( 追 加 情 報 のキー) 指 定 された 追 加 情 報 が 入 力 済 みのユーザーのみ 取 得 します!key.( 追 加 情 報 のキー) 指 定 された 追 加 情 報 が 未 入 力 のユーザーのみ 取 得 します 68

69 マクロ ユーザー 情 報 ジェネレータで 使 用 できるマクロは 以 下 の 通 りです マクロ %(name) %(lastname) %(firstname) %( ) %(zip) %(city) %(street) %(country) %(description) %(key. 追 加 情 報 のキー) %(now) %(parent) %(prop) 説 明 ログイン 名 を 表 します 姓 を 表 します 名 を 表 します メールアドレスを 表 します 郵 便 番 号 を 表 します 市 町 村 を 表 します アドレスを 表 します 国 籍 を 表 します 説 明 文 を 表 します 追 加 情 報 を 表 します リソースの 自 動 生 成 が 実 行 された 日 時 を 表 します 内 容 は CSV データジェネレータと 同 様 ですので そちらの 説 明 を 参 照 して 下 さい 個 別 プロパティ 又 は 共 有 プロパティの 値 の 設 定 でこのマクロを 使 用 した 場 合 設 定 しようとしているプロパティ 名 と 同 じプロパティ 名 で 親 フォルダを 再 帰 的 に 検 索 し 最 初 に 見 つけたプロパティ 値 をセットします 公 開 日 又 は 公 開 期 限 の 値 の 設 定 でこのマクロを 使 用 した 場 合 親 フォルダの 公 開 日 又 は 公 開 期 限 をそのままセットします 上 記 以 外 のところでこのマクロを 指 定 しても 効 果 はありません 指 定 されたプロパティ 名 で 親 フォルダを 再 帰 的 に 検 索 し 最 初 に 見 つけたプロパティ 値 をセットします カンマで 区 切 って プロパテ ィ 名 を 指 定 します 例 )%(prop, Description) プロパティ 名 は 大 文 字 小 文 字 の 区 別 があるので 注 意 してくださ い 69