マップ・メッセージのフォーマット

WebSphere Business Integration Express では、メッセージの整合性を保証するため、メッセージ・フォーマットを作成しました。このセクションでは、このフォーマットの以下の内容について説明します。

注:
マップ固有のメッセージ・ファイルの変更は、Map Designer Express の「メッセージ」タブから行う必要があります。ファイルに直接変更を加えないでください。Map Designer Express は、マップ固有のメッセージ・ファイルに加えられたカスタム変更を、マップに保管されているメッセージで上書きします。ただし、メッセージ・ファイル UserMapMessages.txtCWMapMessages.txt に関しては、ファイルに直接変更を加えても問題ありません。

メッセージ・フォーマット

各メッセージのフォーマットは次のとおりです。

MessageNum
 Message
 

メッセージ番号 (MessageNum) およびメッセージ自体 (Message) は、別の行にある必要があります。この場合、各行の終わりには改行が必要です。

例: 図 136 に示すように、マップのメッセージには番号 23 と確認されたメッセージがあり、このメッセージのテキストに {1}{2} で示された 2 つのプレースホルダー変数が含まれています。

図 136. サンプル・メッセージ

23
 Customer ID {1} could not be changed: {2}
 

メッセージのパラメーター

マップが特定のメッセージを表示するメソッドを呼び出すとき、メッセージの識別番号と、考えられる追加パラメーターをメソッドに渡します。このメソッドはこの識別番号を使用して、メッセージ・ファイルから正しいメッセージを探し出し、追加パラメーターの値をメッセージ・テキストのプレースホルダー変数に挿入します。

考えられるすべての状況ごとに別のメッセージを作成する必要はありません。代わりに、パラメーターを使って実行時に変化する値を表します。パラメーターを使用することにより、1 つのメッセージで複数の状況に対処することが可能になり、メッセージ・ファイルの増大を防ぐことができます。

パラメーターは常に、{number} のように中括弧で囲まれた番号として表示されます。メッセージに追加したい各パラメーターには、以下のように中括弧で囲んだ番号をメッセージのテキストに挿入します。

message text {number} more message text.
 

例: 図 136 のメッセージ 23 の場合を再度考えてみます。マップがこのメッセージを表示または記録する必要がある場合、マップはこのメッセージの識別番号 (23) と 2 つの追加パラメーターを該当するメソッドに渡します。

このメソッドは、正しいメッセージを探し出し、メッセージのプレースホルダーのパラメーター値を置換し、以下のメッセージを表示または記録します。

Customer ID 6701 could not be changed: greater 
 than maximum length
 

メッセージ・テキストでは、欠落しているエントリーとその ID をパラメーターとして記述できるので、ハードコーディングされたストリングとして組み込む代わりに、顧客 ID と説明テキストの任意のペアに対して同じメッセージを使用できます。

コメント

メッセージ・ファイルの各コメントの先頭には、ポンド記号 (#) を付けます。

例: コメントは次のようになります。

# Message file for the Address business object map.
 

推奨: ファイルの先頭に、一連のコメント行を短縮ヘッダーとして挿入することをお勧めします。このヘッダー・データには、マップの名前や、ファイルの作成者およびファイルの作成日などの情報を組み込みます。

Copyright IBM Corp. 2004