レポート・バッチの構成は、カスタム・レポートを作成するための手順の1つです。通常はレポート・コンフィギュレーション・ファイルを作成した後に構成します。このコンフィギュレーション・ファイルは、Reporterで実行するレポートの種類、実行間隔および保存場所を指定します。1つのレポートを異なるパラメータで使用する場合は、それらのパラメータもレポート・バッチに構成します。レポート・コンフィギュレーション・ファイルの詳細は、第23章「カスタム・レポートの作成方法」を参照してください。
レポート・バッチのデプロイメント・ディスクリプタを使用して、カスタム・レポートの作成に使用する各種オプションを指定します。
ディスクリプタのデフォルトの名前および場所はreport-group.xml
になります。このデフォルトのディスクリプタはcoherence.jar
にパッケージ化されており、カスタム・ファイルがアプリケーションのクラスパスに検出されないかぎり使用されます。
表24-1は、コマンドラインからレポート・バッチを制御する際に使用できるシステム・プロパティを示しています。
表24-1 レポート・バッチを制御するためのシステム・プロパティ
プロパティ | デフォルト | 説明 |
---|---|---|
|
|
レポートのリストや実行間隔など、Reporterのコンフィギュレーション設定を含むXMLファイル。 |
|
|
ノードの起動時にReporterを自動的に起動するフラグ。 |
|
|
Reporterを中央モデルで実行する( |
レポート・バッチのディスクリプタは、次のDOCTYPE
宣言から開始します。
<!DOCTYPE report-group SYSTEM "report-group.dtd">
レポート・バッチ・ドキュメントの要素のネストを例24-1に示します。
表24-2は、レポート・バッチの各要素の関係を示しています。
使用場所: report-group
説明
必須。レポート・バッチの実行間隔を示す、分数または秒数を指定する文字列です。10sと指定すると、レポートは10秒ごとに実行されます。5mと指定すると、レポートは5分ごとに実行されます。実行間隔には適切な値を選択することが重要です。実行間隔が短かすぎると、Reporterで膨大な量のデータが生成され、ディスク領域が著しく消費される可能性があります。実行間隔が長すぎると、情報の有益性が薄れます。Reporterを構成する前に、履歴情報のパージおよびアーカイブ処理について計画を立てることをお薦めします。
使用場所: report-list
説明
必須。レポート・コンフィギュレーション・ファイルのパスです。このファイルの詳細は、第23章「カスタム・レポートの作成方法」を参照してください。
使用場所: init-params
説明
init-param
要素には、レポートの初期化パラメータを記述します。このパラメータは、パラメータ名(またはパラメータ・タイプ)とその値で構成されます。
使用場所: report-config
説明
オプション。init-params
要素には、初期化パラメータのリストを記述します。
使用場所: report-group
説明
オプション。レポート・コンフィギュレーション・ファイルの出力ファイル名の先頭に付加するディレクトリ・パスです。ノードを実行するユーザー名には、このパスに対する読取り/書込みアクセスを付与する必要があります。
使用場所: init-param
説明
param-name
要素は、初期化パラメータの名前を指定します。
使用場所: init-param
説明
param-type
要素は、初期化パラメータのJavaタイプを指定します。サポートされているタイプは次のとおりです。
string
: 値がjava.lang.String
であることを示します。
long
: 値がjava.lang.Long
であることを示します。
double
: 値がjava.lang.Double
であることを示します。
使用場所: init-param
説明
param-value
要素は、初期化パラメータの値を指定します。この値は、パラメータの型に固有の形式にします。
使用場所: report-group
説明
report-config
には、レポートのコンフィギュレーション・ファイル名および初期化パラメータを記述します。
使用場所: ルート要素
説明
レポート・リスト、実行間隔、レポート・パラメータおよびバッチの出力ディレクトリを記述します。
使用場所: report-group
説明
必須。バッチに含めるレポートのリストです。この要素には、<report-config>
サブ要素を記述します。