C レポート・グループ構成要素

この付録では、レポート・グループ・デプロイメント・ディスクリプタの要素のリファレンスと、ディスクリプタの簡単な概要を示します。個々のレポート・ファイルを作成するレポート・ファイル・デプロイメント・ディスクリプタの要素の詳細は、付録B「レポート・ファイル構成要素」を参照してください。

この付録では次の項について説明します。

• 「レポート・グループ構成デプロイメント・ディスクリプタ」

• 「要素リファレンス」

C.1 レポート・グループ構成デプロイメント・ディスクリプタ

レポート・グループ・デプロイメント・ディスクリプタでは、レポートが有効な場合に任意の数の個別レポートの作成を指定します。coherence.jar/reportsディレクトリには、2つの事前定義済ディスクリプタが含まれます。report-group.xmlディスクリプタはデフォルトのディスクリプタで、事前定義済レポートのサブセットが含まれています。report-all.xmlディスクリプタには、すべての事前定義済レポートが含まれます。これらの事前定義済レポート・グループ・デプロイメント・ディスクリプタを変更するか、必要に応じて新しいレポート・グループ・デプロイメント・ディスクリプタを作成します。実行時に使用するレポート・グループ・デプロイメント・ディスクリプタの名前と場所はオペレーション・デプロイメント・ディスクリプタで構成されており、オペレーション・オーバーライド・ファイルでオーバーライドされます。詳細は、第4章「Oracle Coherenceのレポート機能の使用」を参照してください。

レポート・グループ・デプロイメント・ディスクリプタ・スキーマは、coherence-report-group-config.xsdファイルで定義されます。このファイルは、coherence.jarライブラリのルートおよび次のWeb URLにあります。

http://xmlns.oracle.com/coherence/coherence-report-group-config/1.0/coherence-report-group-config.xsd

<report-group>要素はディスクリプタのルート要素であり、通常はXSDリファレンス、ネームスペース・リファレンス、およびcoherence-report-group-config.xsdファイルの場所が含まれます。次に例を示します。

<?xml version='1.0'?>
<report-group xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xmlns="http://xmlns.oracle.com/coherence/coherence-report-group-config"
   xsi:schemaLocation="http://xmlns.oracle.com/coherence/
   coherence-report-group-config coherence-report-group-config.xsd">

注意: coherence.jarライブラリにあるスキーマは、xsi:schemaLocation属性がWeb URLを参照する場合であっても、常に実行時に使用されます。 スキーマ検証を無効にするには、xsi:schemaLocation属性を省略します。 デフォルトの文字セットがASCIIではなくEBCDICである環境にOracle Coherenceをデプロイする場合、デプロイメント・ディスクリプタ・ファイルがASCII形式であり、ランタイム環境にバイナリ形式でデプロイされることを確認してください。

要素リファレンス

表C-1は、レポート・グループ・デプロイメント・ディスクリプタのすべての非終端要素を示しています。

表C-1 レポート・グループ・デプロイメント・ディスクリプタの非終端要素

要素	使用場所
init-param	init-params
init-params	report-config
report-config	report-group
report-group	ルート要素
report-list	report-group

init-param

使用場所: init-params

説明

init-param要素には、レポートの初期化パラメータを記述します。このパラメータは、パラメータ名(またはパラメータ・タイプ)とその値で構成されます。

要素

表C-2は、init-param要素のサブ要素を示しています。

表C-2 init-paramのサブ要素

要素	必須/ オプション	説明
param-name	オプション	初期化パラメータの名前を指定します。 この要素は、param-type要素と一緒には使用できません。
param-type	オプション	初期化パラメータのJavaタイプを指定します。サポートされているタイプは次のとおりです。 string: 値がjava.lang.Stringであることを示します long: 値がjava.lang.Longであることを示します double: 値がjava.lang.Doubleであることを示します この要素は、para-name要素と一緒には使用できません。
param-value	必須	初期化パラメータの値を指定します。この値は、パラメータの型に固有の形式にします。

init-params

使用場所: report-config

説明

init-params要素には、初期化パラメータのリストを記述します。

要素

表C-3は、init-params要素のサブ要素を示しています。

表C-3 init-paramsのサブ要素

要素	必須/ オプション	説明
init-param	オプション	レポートの初期化パラメータを指定します

report-config

使用場所: report-group

説明

report-configには、レポートの構成ファイル名および初期化パラメータを記述します。

要素

表C-4は、report-config要素のサブ要素を示しています。

表C-4 report-configのサブ要素

要素	必須/ オプション	説明
location	必須	coherence-report-config.xsdファイルに準拠するレポート構成ディスクリプタへのパスを指定します。パスには、ファイルまたはURLを含められます。
init-params	オプション	初期化パラメータのリストを指定します

report-group

使用場所: ルート要素

説明

report-group要素には、レポート・リスト、実行間隔、レポート・パラメータおよびバッチの出力ディレクトリを記述します。

要素

表C-5は、report-group要素のサブ要素を示しています。

表C-5 report-groupのサブ要素

要素	必須/ オプション	説明
frequency	必須	レポート・バッチのリフレッシュ頻度を指定します。値は秒(s)または分(m)単位で入力します。たとえば、値10sは10秒ごとに、値5mは5分ごとにレポートをリフレッシュします。適切なリフレッシュ頻度を選択することが重要です。このリフレッシュ頻度が短すぎると、レポートのデータが過多になるためかなりのディスク領域を消費します。リフレッシュ頻度が長すぎると、レポートに十分な情報が記述されません。また、レポート機能を有効化する前に、履歴情報をパージおよびアーカイブするプロセスを決定してください。
output-directory	オプション	レポート構成ファイルの出力ファイル名の先頭に付加するディレクトリ・パスです。クラスタ・メンバーには、このパスに対する読取り/書込みアクセスを付与する必要があります。 <output-directory>要素は、オプションのsystem-property属性をサポートします。属性値は、構成された出力場所をオーバーライドするために実行時に使用できる、ユーザー定義名です。 事前定義済レポート・グループ構成ファイルで使用されている事前構成済システム・プロパティ・オーバーライドは、tangosol.coherence.reporter.output.directoryです。
report-list	必須	レポート構成のリストを指定します

report-list

使用場所: report-group

説明

report-list要素には、バッチに含めるレポートのリストを記述します。

要素

表C-6は、report-list要素のサブ要素を示しています。

表C-6 report-listのサブ要素

要素	必須/ オプション	説明
report-config	必須	レポート構成ファイルと対応する初期化パラメータの場所を指定します