20.1.1 メッセージの記述形式
以降の「20.2 メッセージの詳細」では,メッセージを次の形式で記述します。
-
KDLRnnnnn-Y
メッセージテキスト
可変値に関する説明
- 説明
-
メッセージテキストに対する補足説明
- 対処
-
ユーザが実施する対処
- java.util.loggingのレベル
-
java.util.loggingのレベル
なお,「可変値に関する説明」,「説明」および「java.util.loggingのレベル」はメッセージによって記述しないものもあります。
次に,各項目について説明します。
- KDLRnnnnn
-
メッセージIDを表します。
メッセージIDを構成する要素について,次に説明します。
- KDLR
-
本製品で出力されるメッセージのプリフィックスを示します。
- nnnnn
-
本製品で管理するメッセージ番号を表します。それぞれのメッセージには,5桁の固有の番号が付いています。
- Y
-
メッセージのレベルを表します。メッセージのレベルは英字1文字で示します。
メッセージのレベルを示す文字とその意味を次に示します。
- E(Error)
-
エラーレベルのトラブルが発生したことを通知するメッセージです。
このメッセージが出力されたときは,処理を中断します。
- W(Warning)
-
警告レベルのトラブルが発生したことを通知するメッセージです。
メッセージが出力されたあとも処理を続行します。
- I(Information)
-
システムの動作を通知するメッセージです。
メッセージが出力されたあとも処理を続行します。
- メッセージテキスト
-
本製品で出力されるメッセージテキストを示します。
なお,メッセージテキスト中の可変値(メッセージが出力される状況によって変わる値)は,「xx....xx」(xxは英小文字)の形式で示します。
- 可変値に関する説明
-
メッセージテキスト中の可変値に表示される情報を「xx....xx:表示される情報」(xxは英小文字)の形式で示します。可変値に関する説明の記述例を次に示します。
- (例)
-
aa....aa:ファイル名
bb....bb:アプリケーション名
- 説明
-
メッセージが通知された要因やメッセージを出力した構成ソフトウェアの動作など,メッセージに対する補足説明を示します。
- 対処
-
ユーザが実施する対処を表します。なお,対処方法の「保守員に連絡してください」とは,購入時の契約に基づいて,システム管理者が弊社問い合わせ窓口へ連絡することを示します。
- java.util.loggingのレベル
-
java.util.loggingのレベルを表します。詳細については「20.1.2 java.util.loggingのレベル」を参照してください。