Interstage Business Application Server アプリケーション開発ガイド

19.3.1 ログメッセージファイルの記述

ログメッセージファイルは、アプリケーションで使用する文字列データをログ出力用にカスタマイズして、メッセージの一部に動的な情報を埋め込んで定義するXMLファイルです。

以下にログメッセージファイルの記述例を示します。

《logresource.xml》

<?xml version="1.0" encoding="UTF-8"?>
<ujiResource>
  <config>
    <version>5.1</version>
  </config>

  <map id="12345">
    <elem key="label.code">sys</elem>
    <elem key="label.name">mainsystem</elem>
    <elem key="label.subname">compo1</elem>
    <elem key="errorType">ERROR</elem>
    <elem key="level">1</elem>
    <elem key="message">エラー:{0}-{1}</elem>
  </map>
  <map id="12346">
    <elem key="label.code">sys</elem>
    <elem key="label.name">mainsystem</elem>
    <elem key="label.subname">compo1</elem>
    <elem key="errorType">INFO</elem>
    <elem key="level">5</elem>
    <elem key="message">情報:{0}</elem>
  </map>
</ujiResource>

ログメッセージファイルには、以下に示すApcoordinatorのリソースファイルのタグを指定します。

■ujiResource

ログメッセージファイルのルートの要素です。

• アトリビュート

  ujiResourceタグのアトリビュートは指定できません。

• コンテント

  コンテントには以下をこの順番で記述します。

  • configタグ(必ず1個記述します。省略または複数記述することはできません。)

  • mapタグ(0個以上記述します。)

■config

ログメッセージファイル全体に共通の設定を記述します。

• アトリビュート

  configタグのアトリビュートは指定できません。

• コンテント

  コンテントには以下を記述します。

  • versionタグ(必ず1個記述します。省略または複数記述することはできません。)

■version

ログメッセージファイルの文法バージョンを記述します。

• アトリビュート

  versionタグのアトリビュートは指定できません。

• コンテント

  コンテントには文法バージョンを記述します。指定可能なバージョンは 5.1 です。

■map

ログメッセージの定義を記述します。

• アトリビュート

  mapタグでは以下のアトリビュートを指定します。

  アトリビュート名	省略	意味	省略時の動作
  id	不可	メッセージIDを指定します。	省略できません。

• コンテント

  コンテントには以下を記述します。

  • elemタグ(0個以上記述します。)

■elem

ログメッセージの情報を記述します。

• アトリビュート

  mapタグでは以下のアトリビュートを指定します。

  アトリビュート名	省略	意味	省略時の動作
  key	不可	各情報を表わすキーを指定します。各メッセージに対して、以下のキーをもつelemタグを指定してください。 label.code label.name label.subname errorType level message	省略できません。

• コンテント

  コンテントにはキーの値により以下の内容を記述します。

  キー	省略	コンテントへ指定する値	省略時の動作
  label.code	不可	英数字最大3桁の管理コード	省略できません。
  label.name	不可	英数字最大12桁の識別名（業務名など）	省略できません。
  label.subname	不可	英数字最大9桁の識別名（モジュール名など）	省略できません。
  errorType	不可	以下のログの種別 HALT：停止 ERROR：エラー WARNING：警告 INFO：情報	省略できません。
  level	不可	出力するログのレベル	省略できません。
  message	不可	メッセージ本体 java.text.MessageFormatで使用するフォーマットで記述 記述メッセージ本文内の{0}、{1}などを、パラメタとして渡される補足情報に置き換えて出力。{0}から{9}まで利用可能（注1）（注2）	省略できません。

  注1）C言語 APIで使用する場合は、テキスト形式で記述します。
  注2）C言語 APIで使用する場合は、日本語文字列は使用できません。