3.20.2 メッセージ定義ファイル
- 〈この項の構成〉
(1) 形式
リソースKey-ログの出力レベル=出力するメッセージ :
(2) 機能
(a) ログ出力アクティビティでの任意のメッセージの出力方法
ログ出力アクティビティで任意のメッセージを出力する場合,次のどちらかの方法で指定します。
-
[ログ出力アクティビティ]ダイアログの[任意の文字列]に,メッセージを直接指定する
-
メッセージ定義ファイルにメッセージを記述しておき,該当するプロパティのキーを[ログ出力アクティビティ]ダイアログの[リソースKey]に指定する
この項では,メッセージ定義ファイルの作成について説明します。
[ログ出力アクティビティ]ダイアログと各定義ファイルの関係,およびログファイルの出力結果については,マニュアル「サービスプラットフォーム 解説」の「3.9 ログ出力アクティビティでのログ出力」を参照してください。
また,[ログ出力アクティビティ]ダイアログの指定方法については,「1.4.19 ログ出力アクティビティダイアログ」を参照してください。
(b) 作成手順
メッセージ定義ファイルの作成から,ログ出力アクティビティに割り当てるまでの流れを次に示します。
-
次のテンプレートファイルを基に,メッセージ定義ファイルをプロパティ形式で記述します。
<サービスプラットフォームのインストールディレクトリ>\CSC\config\bp\templates\message_definition.properties
メッセージ定義ファイルには次の項目を記述します。各項目の指定規則は「(3) 設定できるプロパティ」を参照してください。
-
キー名には,リソースKeyと,ログの出力レベルを「-(半角ハイフン)」で連結して記述します。
-
指定値には,出力するメッセージを記述します。
1つのメッセージ定義ファイルには複数行記述できます。
ファイルは,ログ出力識別子ごと(ログの出力先ごと)に分けて作成してください。
-
-
メッセージ定義ファイルを格納します。
格納場所とファイル名は任意です。
-
メッセージ定義ファイルのパスをログ出力アクティビティ定義ファイルのlog-activity.<ログ出力識別子>.message-definition-filepathプロパティに設定します。
これによってログ出力識別子に割り当てられます。パスの設定方法については,「3.20.1 ログ出力アクティビティ定義ファイル」を参照してください。
-
ログ出力アクティビティの定義時に,[ログ出力アクティビティ]ダイアログの[リソースKey]を指定します。
[リソースKey]には,メッセージ定義ファイルに記述したプロパティのキー「リソースKey-ログの出力レベル」を指定してください。
複数のログ出力アクティビティから,1つのメッセージ定義ファイルを指定することもできます。
なお,メッセージ定義ファイルの定義内容は,HCSCサーバの次回起動時から有効になります。
(3) 設定できるプロパティ
リソースKeyを指定します。
ログの出力レベル 〜<TRACE|DEBUG|INFO|WARN|ERROR|FATAL>
出力するメッセージのログの出力レベルを次の中から指定します。
-
TRACE
-
DEBUG
-
INFO
-
WARN
-
ERROR
-
FATAL
ログ出力アクティビティ定義ファイルとメッセージ定義ファイルの間で異なる出力レベルが設定された場合,次のように出力されます。
ログ出力アクティビティ定義ファイルの出力レベルの指定 |
メッセージ定義ファイルの出力レベルの指定 |
|||||
---|---|---|---|---|---|---|
TRACE |
DEBUG |
INFO |
WARN |
ERROR |
FATAL |
|
TRACE |
○ |
○ |
○ |
○ |
○ |
○ |
DEBUG |
× |
○ |
○ |
○ |
○ |
○ |
INFO |
× |
× |
○ |
○ |
○ |
○ |
WARN |
× |
× |
× |
○ |
○ |
○ |
ERROR |
× |
× |
× |
× |
○ |
○ |
FATAL |
× |
× |
× |
× |
× |
○ |
- (凡例)
-
○:出力されます。
×:出力されません。
出力するメッセージ 〜<java.text.MessageFormatで解釈できる値>
出力するメッセージをjava.text.MessageFormatで解釈できる値で指定します。なお,FormatElementにFormatTypeとFormatStyleは指定できません。これらの条件を満たさない値を指定した場合の動作は保証しません。
出力するメッセージには,改行を含む文字列は設定できません。
メッセージには埋め込み文字として,ビジネスプロセス定義画面に指定した変数や,変数内の情報を埋め込むことができます。それぞれ指定できる内容を次に示します。
-
変数
変数の値を埋め込むことができます。ビジネスプロセスで定義できるすべての変数を使用できます。「non-XML」「any」の変数の場合,16進数に変換した値を埋め込みます。
-
変数内の情報
変数の部分またはXPathで取得した変数内の情報を埋め込むことができます。
埋め込み文字を使用する場合,メッセージに添字を{ }で囲んで指定します。
添字に割り当てる変数や式は,[ログ出力アクティビティ]ダイアログの[埋め込み要素値]で指定します。[ログ出力アクティビティ]ダイアログについては,「1.4.19 ログ出力アクティビティダイアログ」を参照してください。
(4) 記述例
メッセージ定義ファイルの記述例を次に示します。
msg_id_001-ERROR= The specified element is not defined. (element name = {0}) msg_id_002-WARN = The fault message has initialized.