14.2.2 変換定義ファイルの各レコード

ここでは,変換定義ファイルの各レコードについて説明します。

<この項の構成>
(1) ヘッダー行
(2) イベントソース名指定行
(3) メッセージ定義行
(4) 基本メッセージ
(5) 変換メッセージ

(1) ヘッダー行

ヘッダー行は各カラムのタイトルを示します。

(a) 記述形式

jmoexportコマンドで変換定義ファイルを出力すると,ファイルの先頭に出力されます。また,jmoimportコマンドでインポートする場合,ヘッダー行は省略できます。

ヘッダー行を記述する場合,行頭には必ず#を記述してください。

(b) カラムの記述ルール

ヘッダー行のカラムの記述ルールを次の表に示します。

表14-2 ヘッダー行のカラムの記述ルール

カラムカラムの内容使用できない文字・
文字列
備考
第1カラム第1カラムのタイトル
"Category"
省略できます。
第2カラム第2カラムのタイトル
"Identifier"
省略できます。
第3カラム第3カラムのタイトル
"JP1eventID"
省略できます。
第4カラム第4カラムのタイトル
"Severity"
省略できます。
第5カラム第5カラムのタイトル
"MessageText"
省略できます。
第6カラム第6カラムのタイトル
"ReplaceFlag"
省略できます。
第7カラム第7カラムのタイトル
"RestraintFlag"
省略できます。
第8カラム第8カラムのタイトル
"AdditionalIdentifier"
省略できます。
(凡例)
-:なし
ヘッダー行の各カラムは省略できます。
注※
jmoexportコマンドで変換定義ファイルを出力した場合の内容です。

(2) イベントソース名指定行

イベントソース名指定行は,イベントソース名を記述する行です。

ヘッダー行を除いた最初の行はイベントソース名指定行とする必要があります。

(a) 記述形式

イベントソース名指定行の記述形式を次の表に示します。

表14-3 イベントソース名指定行の記述形式

カラム指定内容
第1カラム<eventsource>
第2カラムイベントソース名を記述します。
イベントソース名は,JP1/IM - MOですでに定義されたイベントソース定義情報のイベントソース名を指定します。イベントソース定義情報がない場合は,この行,およびこの行から次のイベントソース名指定行の間にある行の定義はインポートできません。
第3カラム以降使用しません。

(b) カラムの記述ルール

イベントソース名指定行のカラムの記述ルールを次の表に示します。

表14-4 イベントソース名指定行のカラムの記述ルール

カラムカラムの内容使用できない文字・
文字列
備考
第1カラム<eventsource><eventsource>以外の文字列省略できません。
第2カラムイベントソース名
  • 0x00~0x1F,および0x7Fの制御コード
  • 先頭の「-」
  • ¥
  • ,
  • ;
  • :
  • *
  • ?
  • "
  • <
  • >
  • |
  • (
  • )
  • =
32バイト以内で記述します。
省略できません。
第3カラム空欄すべての文字使用しません。
第4カラム空欄すべての文字使用しません。
第5カラム空欄すべての文字使用しません。
第6カラム以降空欄すべての文字省略できます。
使用しません。

(3) メッセージ定義行

メッセージ定義行は,基本メッセージと変換メッセージの形式を定義します。

メッセージ定義行は,イベントソース名指定行とイベントソース名指定行の間,またはイベントソース名指定行とファイルの終端の間に指定します。メッセージ定義行は直前で指定されたイベントソース名指定行のイベントソース定義に属します。メッセージ定義行は,基本メッセージ,変換メッセージの順に定義します。

(4) 基本メッセージ

(a) 記述形式

メッセージ定義行(基本メッセージ)の記述形式を次の表に示します。

表14-5 メッセージ定義行(基本メッセージ)の記述形式

カラム指定内容
第1カラム<basic>固定
第2カラムメッセージ識別子を記述します。
第3カラムJP1イベントIDを記述します。
第4カラム基本メッセージの重大度を記述します。
第5カラム埋め字定義済みメッセージテキストを記述します。
第6カラム使用しません。
第7カラム使用しません。
第8カラム追加メッセージ識別子を記述します。記述を省略できます。
第9カラム以降使用しません。

jmoimportコマンドでインポートするとき,書式エラーが発生した場合は,該当するレコードをインポートしないで,次の行の処理に移ります。

(b) カラムの記述ルール

メッセージ定義行(基本メッセージ)のカラムの記述ルールを次の表に示します。

表14-6 メッセージ定義行(基本メッセージ)のカラムの記述ルール

カラムカラムの内容使用できない文字・
文字列
備考
第1カラム<basic><basic>以外の文字列省略できません。
第2カラムメッセージ識別子改行コード,水平タブ以外の制御コードこのカラムはデータを""で囲む必要があります。また,メッセージ識別子中の「"」は「""」とエスケープする必要があります。
メッセージ識別子としてJP1イベントIDを指定する場合,上位4バイト(基本コード),下位4バイト(拡張コード)を8桁の前0あり16進数で表現する形式で指定してください。
(例)
00000111:00000000
1023バイト以内で記述します。
省略できません。
第3カラムJP1イベントID次に示す形式以外の文字列
  • 1けた以上8けた以下の前0なし16進数
  • 8けたの前0あり16進数
  • nnn:mmm
    ただし,nnnmmmはそれぞれ8けた以下の前0なし16進数
  • xxxxxxxx:yyyyyyyy
    ただし,xxxxxxxxyyyyyyyyはそれぞれ8けたの前0あり16進数
17バイト以内で記述します。
省略できません。
第4カラム重大度なし変換前の重大度を記述します。
このカラムはデータを""で囲んでください。重大度なしの場合は""で囲まないで<None>を指定します。
255バイト以内で記述します。
省略できません。
第5カラム埋め字定義済みメッセージテキスト改行コード,水平タブ以外の制御コードこのカラムはデータを""で囲む必要があります。また,埋め字定義済みメッセージテキスト中の「"」は「""」とエスケープする必要があります。
メッセージテキストとは,JP1イベントのメッセージ属性を基本フォーマットで分割した場合の「メッセージテキスト」の要素に該当する部分の文字列です。埋め字の定義は,メッセージ中に{%数字}を挿入して定義します。数字は1~5の整数だけ使用できます。
1023バイト以内で記述します。
省略できません。
第6カラム空欄すべての文字使用しません。
第7カラム空欄すべての文字使用しません。
第8カラム追加メッセージ識別子制御コード(0x00~0x1F,および0x7F)このカラムはデータを""で囲む必要があります。また,追加メッセージ識別子中の「"」は「""」とエスケープする必要があります。追加メッセージ識別子とは,第2カラムで指定したメッセージ識別子に追加して指定するメッセージ識別子です。
255バイト以内で指定してください。メッセージ識別子を追加しない場合,このカラムの記述は省略できます。
メッセージ識別子としてJP1イベントIDを指定する場合,上位4バイト(基本コード),下位4バイト(拡張コード)を8桁の前0あり16進数で表現する形式で指定してください。
(例)
00000111:00000000
追加メッセージ識別子として「重大度」を指定する場合,JP1/IM - MO Assistantの画面で表示される日本語ではなく,次のように英語で指定します。大文字と小文字は区別されます。
  • Emergency
  • Emergence
  • Alert
  • Critical
  • Error
  • Warning
  • Notice
  • Information
  • Debug
ただし,上記以外の重大度の場合は,重大度の値をそのまま指定してください。
第9カラム以降空欄すべての文字使用しません。
注※
誤った形式で指定すると,メッセージテキストの変換はしないでフォーマットの変換だけ行ったJP1イベントを登録します。誤って定義をしたファイルをインポートした場合,誤って定義した基本メッセージをJP1/IM - MO Assistantで削除したあとに,変換定義ファイルを正しく修正してインポートをやり直す必要があります。

(c) 注意事項

(5) 変換メッセージ

(a) 記述形式

メッセージ定義行(変換メッセージ)の記述形式を次の表に示します。

表14-7 メッセージ定義行(変換メッセージ)の記述形式

カラム指定内容
第1カラム変換メッセージ群名を記述します。
変換メッセージ群名が定義済みの場合は,その変換メッセージ群の下に変換メッセージ定義を追加します。変換メッセージ群名が定義されていない場合は,直前に指定されたイベントソース名指定行のイベントソース定義に,このカラムで指定した変換メッセージ群名の変換メッセージ群を追加して,その下に変換メッセージ定義を追加します。
第2カラムメッセージ識別子を記述します。
第3カラム使用しません。
第4カラム変換後の重大度を記述します。
第5カラム変換後の「メッセージテキスト」要素の文字列を記述します。
第6カラムメッセージテキストを変換するかどうかを記述します。
Y,またはy
メッセージを変換します。
N,またはn
メッセージを変換しません。
第7カラムJP1イベントの出力を抑止するかどうかを記述します。
Y,またはy
JP1イベントの出力を抑止します。
N,またはn
JP1イベントの出力を抑止しません。
第8カラム追加メッセージ識別子を記述します。記述を省略できます。
第9カラム以降使用しません。

jmoimportコマンドでインポートする場合,書式エラーが発生したときは,該当するレコードをインポートしないで,次の行の処理に移ります。

(b) カラムの記述ルール

メッセージ定義行(変換メッセージ)のカラムの記述ルールを次の表に示します。

表14-8 メッセージ定義行(変換メッセージ)のカラムの記述ルール

カラムカラムの内容使用できない文字・
文字列
備考
第1カラム変換メッセージ群名
  • 0x00~0x1F,および0x7Fの制御コード
  • 先頭の「-」
  • ¥
  • ,
  • ;
  • :
  • *
  • ?
  • "
  • <
  • >
  • |
  • (
  • )
  • =
32バイト以内で記述します。
省略できません。
第2カラムメッセージ識別子改行コード,水平タブ以外の制御コードこのカラムはデータを""で囲む必要があります。また,メッセージ識別子中の「"」は「""」とエスケープする必要があります。
メッセージ識別子としてJP1イベントIDを指定する場合,上位4バイト(基本コード),下位4バイト(拡張コード)を8桁の前0あり16進数で表現する形式で指定してください。
(例)
00000111:00000000
1,023バイト以内で記述します。
省略できません。
第3カラム空欄すべての文字使用しません。
第4カラム重大度次に示す文字列以外
  • Emergency
  • Emergence
  • Alert
  • Critical
  • Error
  • Warning
  • Notice
  • Information
  • Debug
  • <None>
変換後の重大度を記述します。
このカラムはデータを""で囲む必要があります。重大度を変換しない場合は,カラムを空欄または空文字列("")にします。重大度中の「"」は「""」とエスケープする必要があります。
255バイト以内で記述します。
第5カラム変換後メッセージテキスト改行コード,水平タブ以外の制御コードこのカラムはデータを""で囲む必要があります。また,変換メッセージテキスト中の「"」は「""」とエスケープする必要があります。
メッセージテキストとは,JP1イベントのメッセージ属性を基本フォーマットで分割した場合の「メッセージテキスト」要素に該当する部分の文字列です。
埋め字の定義は,メッセージ中に{%数字}を挿入して定義します。数字は1~5の整数だけ使用できます。
1023バイト以内で記述します。
省略できます。
第6カラムメッセージテキスト変換フラグ「Y」「y」「N」「n」以外の値省略できます。
第7カラムJP1イベント出力抑止フラグ「Y」「y」「N」「n」以外の値省略できます。
第8カラム追加メッセージ識別子制御コード(0x00~0x1Fおよ0x7F)このカラムはデータを""で囲む必要があります。また,追加メッセージ識別子中の「"」は「""」とエスケープする必要があります。追加メッセージ識別子とは,第2カラムで指定したメッセージ識別子に追加して指定するメッセージ識別子です。
255バイト以内で指定してください。メッセージ識別子を追加しない場合,このカラムの記述は省略できます。
メッセージ識別子としてJP1イベントIDを指定する場合,上位4バイト(基本コード),下位4バイト(拡張コード)を8桁の前0あり16進数で表現する形式で指定してください。
(例)
00000111:00000000
追加メッセージ識別子として「重大度」を指定する場合,JP1/IM - MO Assistantの画面で表示される日本語ではなく,次のように英語で指定します。大文字と小文字は区別されます。
  • Emergency
  • Emergence
  • Alert
  • Critical
  • Error
  • Warning
  • Notice
  • Information
  • Debug
ただし,上記以外の重大度の場合は,重大度の値をそのまま指定してください。
第9カラム以降空欄すべての文字使用しません。
注※
誤った形式で指定すると,メッセージテキストの変換はしないでフォーマットの変換だけ行ったJP1イベントを登録します。誤って定義をしたファイルをインポートした場合,誤って定義した基本メッセージをJP1/IM - MO Assistantで削除したあとに,変換定義ファイルを正しく修正してインポートをやり直す必要があります。