1.1 このマニュアルで使用している記述形式
このマニュアルで使用している記述形式および記号について説明します。
メッセージID
メッセージIDの形式には、次のものがあります。
-
AAnnnnn
-
AAAAnnnnn-Y
メッセージIDの形式ごとに構成する要素について、次に説明します。
- AAnnnnnの場合
-
- AA
-
メッセージのプリフィックスを示します。Apache が出力するメッセージをAH、Apache 以外が出力するメッセージをKHで表します。
- nnnnn
-
メッセージ番号を表します。それぞれのメッセージには、5桁の固有の番号が付いています。
- AAAAnnnnn-Yの場合
-
- AAAA
-
メッセージのプリフィックスを示します。JavaEE サーバが出力するメッセージをKDKD、Application Development Toolsが出力するメッセージをKEDT、パフォーマンストレーサーが出力するメッセージをKFCTで表します。
- nnnnn
-
メッセージ番号を表します。それぞれのメッセージには、5桁の固有の番号が付いています。
- Y
-
メッセージのレベルを表します。メッセージのレベルは英字1文字で示します。
エラーレベル
説明
E(Error)
エラーレベルのトラブルが発生したことを通知するメッセージです。このメッセージが出力されたときは、処理を中断します。
W(Warning)
警告レベルのトラブルが発生したことを通知するメッセージです。メッセージが出力されたあとも処理を続行します。
I(Information)
システムの動作を通知するメッセージです。メッセージが出力されたあとも処理を続行します。
メッセージテキスト
出力されるメッセージテキストを示します。
メッセージテキスト中の可変値(メッセージが出力される状況によって変わる値)は、「xx....xx」(xxは英小文字)の形式で示します。それぞれの可変値の説明は、メッセージテキストのあとに「xx....xx(改行)表示される情報」(xxは英小文字)の形式で示します。可変値に関する説明の記述例を次に示します。
- (例)
-
- aa....aa
-
ファイル名
- bb....bb
-
アプリケーション名
なお、可変値はメッセージによって記述しないものもあります。
説明
メッセージが通知された要因やメッセージを出力した構成ソフトウェアの動作など、メッセージに対する補足説明を示します。
メッセージによって記述しないものもあります。
また、メッセージIDがAAnnnnnの場合はエラーレベルも示します。エラーレベルは次のとおりです。
-
emerg
-
alert
-
crit
-
error
-
warn
-
notice
-
info
-
なし
レベル設定のないメッセージで、メッセージテキストだけ出力されます。
対処
ユーザが実施する対処を表します。なお、対処方法の「システム管理者に連絡してください 」、または「弊社問い合わせ窓口へ連絡してください」とは、購入時の契約に基づいて、システム管理者が弊社問い合わせ窓口へ連絡することを示します。
メッセージによって記述しないものもあります。
使用している記号
メッセージの説明では、次の記号を使用して記述しています。
記号 |
意味 |
---|---|
[ ] |
この記号で囲まれている項目は画面の要素を示します。 |
プロパティー |
斜体で表記されている項目は、該当する要素やファイルなどを指定したり、該当する要素が表示されたりすることを示します。 (例1) プロパティー プロパティーを記述します。またはプロパティーが表示されます。 (例2) ファイル名 ファイル名を指定します。 |