1.2.1 記述形式
システムの構築・運用・保守で使用するメッセージは,次に示す形式を基本として説明しています。
KDIWnnnnn-X
メッセージテキスト
可変値に関する説明
- 要因
-
メッセージの要因を説明します。
- 対処
-
ユーザが実施する対処を説明します。
- 特記事項
-
メッセージに対する特記事項を説明します。
なお,「可変値に関する説明」,「要因」,「対処」および「特記事項」は,メッセージによっては記述がない場合もあります。
次に,メッセージの記述形式にあるそれぞれの項目について説明します。
KDIW
CSCIWのメッセージであることを示します。
nnnnn
メッセージの番号を示します。
X
メッセージレベルを表します。メッセージのレベルは英字1文字で示します。
メッセージのレベルを示す文字とその意味を次に示します。
- E:エラーメッセージ(Error)
-
このメッセージレベルが表示された場合,プログラムの終了が必要です。重度の障害が発生したことを通知するメッセージです。
- I:付加情報メッセージ(Information)
-
プログラムの付加情報を通知するメッセージです。
- W:警告メッセージ(Warning)
-
このメッセージレベルが表示された場合,プログラムの終了は不要です。一部の機能が使用できないなどの障害が発生したことを通知する,または警告が必要な事象が発生したことを通知するメッセージです。
メッセージテキスト
出力されるメッセージを示します。
可変値に関する説明
メッセージテキスト中の可変値に表示される情報を示します。「xx....xx」(xxは英小文字)を可変値とした場合の,可変値に関する説明の記述例を次に示します。
- (例1)
-
aa....aa:オブジェクト種別
bb....bb:コード種別
- (例2)
-
-
aa....aa
オブジェクト種別
-
bb....bb
コード種別
-
要因
メッセージが出力された要因について説明します。
対処
ユーザが実施する対処方法について説明します。
特記事項
このメッセージに対する注意事項などの特記事項を説明します。