set_template(コミュニティテンプレートの追加)
機能
コミュニティテンプレートの定義内容をデータベースのテンプレートテーブル(TBL_TEMPLATE)に設定します。2回目以降の実行時には,設定内容を上書きします。
形式
set_template [-o 出力ファイル名] [-q] [-e ログファイル名] [-f テンプレート定義ファイル名]
オプション
- -o 出力ファイル名
- 指定したファイルに,標準出力データを出力します。ただし,出力メッセージのうち,KDCM00071-E~KDCM00076-Eは出力しません。
- 出力ファイル名の指定方法の詳細は,「5.2(3)-oオプションに指定する出力ファイル」を参照してください。
- -q
- 標準出力および標準エラー出力への出力を抑制します。
- -e ログファイル名
- 指定したログファイルに,次の情報を出力します。
- SQLクエリ発行直前および発行直後のSQLクエリ文字列
- SQLクエリ発行時のエラーメッセージ
- ログファイル名の指定方法の詳細は,「5.2(4)-eオプションに指定するログファイル」を参照してください。
- -f テンプレート定義ファイル名
- テンプレート定義ファイル(set_template.cfg)に定義されている内容をデータベースのテンプレートテーブル(TBL_TEMPLATE)に設定します。
- ファイル名の指定方法
- テンプレート定義ファイルのファイル名は,絶対パス,またはコマンドを実行するディレクトリからの相対パスで指定します。ファイル名は,220バイト以内の文字列で指定します。ただし,絶対パスで表したときに220バイト以内の文字列になるように指定してください。
- ファイルの記述形式
- テンプレート定義ファイルの記述形式については,「7.2.3 テンプレート定義ファイル(set_template.cfg)」を参照してください。
- サンプルファイルの利用
- テンプレート定義ファイルに,サンプルファイル(set_template.cfg.sam)を使用する場合,サンプルファイルの内容を使用する環境に合わせて変更し,ファイル名「set_template.cfg」で保存してください。
- -fオプションを省略した場合
- デフォルトのテンプレートファイルに定義されている内容が設定されます。デフォルトのテンプレートファイル名は,コマンドプロパティファイル(hptl_clb_ccm_cmd.properties)のhptl_clb_ccm_cmd_set_template_configキーに指定された値となります。
- -fオプションを省略しhptl_clb_ccm_cmd_set_template_configキーを指定していない場合
- テンプレートファイル名は,プログラムのデフォルトである「set_template.cfg」となります。
戻り値
set_templateコマンドの戻り値を次に示します。
表5-4 set_templateコマンドの戻り値
戻り値 | 意味 |
---|
0 | 正常終了しました。 |
1 | ユーザによる強制終了が発生したか,またはコマンド用jarが見つかりません。 |
2 | 指定したテンプレート定義ファイル,またはhptl_clb_ccm_cmd.propertiesファイルが見つかりません。 出力ファイル,またはログファイルを生成できません。 |
12 | 出力ファイル名,ログファイル名,またはテンプレート定義ファイル名が長過ぎます。 |
13 | テンプレート定義ファイルの書式にエラーがあります。 |
14 | テンプレート定義ファイル,またはhptl_clb_ccm_cmd.propertiesの属性値が適切な範囲にありません。 |
21 | データベースからの応答がありません。 |
22 | データベースへの接続に失敗しました。 |
23 | SQLクエリの実行に失敗しました。 |
24 | JDBCドライバがインストールされていません。または,パスが通っていません。 |
31 | 入出力処理中にエラーが発生しました。 |
32 | トレース処理中にエラーが発生しました。 |
33 | コマンドの書式が違います。 |
34 | システム情報の取得に失敗しました。 |
35 | nullが指定されました。 |
36 | 内部矛盾が発生しました。 |
39 | 次の意味が考えられます。
- コマンドが実行できる状態ではありません。
- 環境変数が設定されていません。
- システムコールでエラーが発生しました。
|
実行結果
指定した値がデータベースのテンプレートテーブル(TBL_TEMPLATE)に設定されます。
使用例
set_templateコマンドの使用例を紹介します。ここでは,次のような環境を想定しています。
- ソフトウェア環境
set_templateコマンドを実行できる環境
- コマンドプロンプトのカレントディレクトリ
<Collaboration - Serverインストールディレクトリ>¥community¥command¥bin
- テンプレート定義ファイル
C:¥Program Files¥Hitachi¥Collaboration¥community¥command¥sys¥set_template.cfg
- テンプレート定義ファイルの内容をテンプレートテーブルに登録する場合
- テンプレート定義ファイルの内容をデータベースのテンプレートテーブル(TBL_TEMPLATE)に登録する場合,set_templateコマンドを次のように実行します。
set_template -e "C:¥Program Files¥Hitachi¥Collaboration¥community¥command¥log¥set_template.log" -f "C:¥Program Files¥Hitachi¥Collaboration¥community¥command¥sys¥set_template.cfg" |
- この実行例では,set_templateコマンドを実行すると,エラーログがある場合は-eオプションで指定したログファイル(set_template.log)に出力されます。
- 実行例は改行されているように表示されていますが,実際に実行するときは,1行で記述する必要があります。
- 標準出力に何も出力しない場合
- ログをデフォルトのログファイルに出力する場合,set_templateコマンドを次のように実行します。
- この実行例は,あらかじめコマンドプロパティファイル(hptl_clb_ccm_cmd.properties)のhptl_clb_ccm_cmd_logfileキーの設定値に,ログファイルとしてC:¥Program Files¥Hitachi¥Collaboration¥community¥log¥error_set_template.logを指定していることを想定しています。
注意事項
- set_templateコマンドの実行中にエラーが発生した場合,必ず,set_templateコマンドが正常終了するまで再実行して,データベースのテンプレートテーブル(TBL_TEMPLATE)に値を設定してください。
- set_templateコマンドは,テンプレート定義ファイルに不正な属性記述子が記述されている場合,メッセージ(KDCM00002-W)を出力して正常終了します。メッセージで提示された属性記述子を含むレコードはデータベースに登録されていないため,メッセージが出なくなるまで再実行してください。
- コミュニティテンプレート情報はワークプレーステンプレート情報とセットで登録しなければなりません。したがって,ワークプレーステンプレート情報の登録が完了していないと,正しく動作しないので注意してください。ワークプレーステンプレート情報の詳細は「2.7.4 ワークプレーステンプレート情報の登録」を参照してください。