Tuning Manager ユーザーズガイド

13.1.2 パラメーターファイルの作成

コマンドの引数には，XML形式のパラメーターファイルを指定します。コマンドに指定するパラメーターファイルの作成について，次に説明します。

この項の構成

(1) 作成する前の確認事項

(2) パラメーターファイルの記述方式

パラメーターファイルを作成する前に，対象となるレポートの定義名やその定義の格納先ディレクトリのパスなどを事前に確認しておいてください。

これらの内容は，Performance Reporterの画面を使って確認できます。確認するレポートの画面の表示方法については，次の記述を参照してください。

登録レポートおよび複合レポートの場合：「6.3.1 複合レポートの表示手順」

登録レポートおよび複合レポート以外のレポートの場合：「6.2.1 Performance Reporterのレポートを表示する」

画面で確認した内容とパラメーターファイルに設定する内容の対応例を，次に示します。

図13-1 レポートの表示画面内容とパラメーターファイルの設定内容との対応例（画面）

図13-2 レポートの表示画面内容とパラメーターファイルの設定内容との対応例（jpcrptコマンド用パラメーターファイル）

なお，「パラメーターファイル記述例」が各コマンドの説明にありますので，そちらの記載も参照してください。

(2) パラメーターファイルの記述方式

コマンドの引数に指定するパラメーターファイルの記述方式を次に示します。
パラメーターは，XMLバージョンとエンコーディングを指定した直後に，<pr-cli-parameters>タグで囲んで指定します。<pr-cli-parameters>タグの説明を次の表に示します。
<pr-cli-parameters>タグ以外の指定するパラメーターについては，各コマンドの「パラメーターファイルの形式」を参照してください。
表13-1 pr-cli-parametersの説明

種別説明

意味 Performance Reporterコマンド入力のルートタグ

指定可能値なし

省略不可

属性 ver DTDファイルのバージョン。コマンドのサポート範囲外の値ならば，パラメーターファイルエラーとなります。また，省略するとエラーになります。サポート範囲については，「表13-2 コマンドがサポートするDTDファイル」を参照してください。

親要素なし

子要素 report-definitions レポート定義情報のルートタグ

launch-report レポート出力定義情報のルートタグ

launch-registration-report 登録レポート出力定義情報のルートタグ

launch-combination-bookmark 複合レポート出力定義情報のルートタグ

「<」などXML形式の書式制御文字を値に含める場合，XML仕様が定める記法に従って記述する必要があります。
例えば，「<」の場合は「<」，「>」の場合は「>」と記述します。

フィールドID，レコードID，date-range，report-intervalなど，コマンドのパラメーターファイル仕様で規定する固定のトークンから選択して指定する値は，仕様として明示的に制限されないかぎり，大文字だけ，または小文字だけであれば使用できます。パラメーターに指定する値の定義は，各コマンドの「パラメーターファイルの形式」またはDTDファイルを参照してください。

「TRUE」を指定できるパラメーターについては，「true」も指定できます。また，「FALSE」を指定できるパラメーターについては，「false」も指定できます。

空白だけの要素値または属性値については，省略と見なします。また，要素値，属性値の前後に指定した半角空白は，無視します。

制御文字を要素または属性に指定するとエラーとなります。
パラメーターファイルのDOCTYPE宣言は固定です。パラメーターファイルのDOCTYPE宣言には，パラメーターの記述を定義するDTDファイル名を必ず指定してください。なお，DTDファイルの格納先ディレクトリのパスを指定する必要はありません。
DOCTYPE宣言の例を次に示します。
<!DOCTYPE pr-cli-parameters SYSTEM "<DTDファイル名>">
また，コマンドがサポートするDTDファイルの一覧を次の表に示します。
表13-2 コマンドがサポートするDTDファイル

コマンド名 DTDファイル名 DTDファイルのサポートバージョン

jpcrdef create rdef_create_params.dtd 0100，0110

rdef_params.dtd 0100，0110

jpcrdef delete rdef_delete_params.dtd 0100

jpcrdef output rdef_output_params.dtd 0100

jpcrpt rpt_params.dtd 0100，0110，0200
parent-folder属性に「/」を指定すると，ルートディレクトリを指定できます。ルート以下のディレクトリ「Directory1」を指定する場合は，「/Directory1」と指定します。同様に，「Directory1」以下のディレクトリを指定する場合は，「/Directory1/Directory2...」のようにディレクトリ名を「/」で連結したディレクトリパスを指定します。ルートディレクトリ「/」に「User Reports」または「System Reports」を指定するとエラーになります。
なお，ルートディレクトリ「/」は，登録レポートおよび複合レポートの場合「Bookmarks」を，それ以外のレポートの場合「User Reports」および「System Reports」を指しています。

「パラメーターファイルの形式」で指定する範囲外の値を指定した場合は，パラメーターファイルエラーとなります。

作成したパラメーターファイルは，XML宣言で指定したエンコーディングで保存してください。

種別	説明
意味	Performance Reporterコマンド入力のルートタグ
指定可能値	なし
省略	不可
属性	ver	DTDファイルのバージョン。コマンドのサポート範囲外の値ならば，パラメーターファイルエラーとなります。また，省略するとエラーになります。サポート範囲については，「表13-2 コマンドがサポートするDTDファイル」を参照してください。
親要素	なし
子要素	report-definitions	レポート定義情報のルートタグ
launch-report	レポート出力定義情報のルートタグ
launch-registration-report	登録レポート出力定義情報のルートタグ
launch-combination-bookmark	複合レポート出力定義情報のルートタグ

コマンド名	DTDファイル名	DTDファイルのサポートバージョン
jpcrdef create	rdef_create_params.dtd	0100，0110
rdef_params.dtd	0100，0110
jpcrdef delete	rdef_delete_params.dtd	0100
jpcrdef output	rdef_output_params.dtd	0100
jpcrpt	rpt_params.dtd	0100，0110，0200

[目次] [前へ] [次へ]

[マニュアル発行元]