Hitachi

JP1 Version 12　JP1/Performance Management リファレンス

jpcrpt

〈このページの構成〉

形式

jpcrpt    -o 出力ファイル名
          [-mx 最大ヒープサイズ]
          [-ms 初期ヒープサイズ]
          [-y]
          [-rc 更新回数]
          [-ri 更新間隔]
          [-dateformat 日付フォーマットのパターン名]
          [-dateseparator 日付フォーマットのセパレーター名]
          [-exportseparator レポート出力時の日付フォーマットの
                           セパレーター名]
          [-agent サービスID[,サービスID]...]
          入力ファイル名

ページの先頭へ

機能

jpcrptコマンドは，レポートをCSV形式またはHTML形式でファイル出力するコマンドです。出力定義は，コマンドライン引数として指定されたXML形式のパラメーターファイルから取得します。パラメーターファイルには，レポートの出力形式，出力対象のレポート，および［レポート］または［複合レポート］画面の［レポートの表示設定］タブ相当の項目が指定できます。HTML形式で出力する場合は，入力ファイルでhtml-outputタグの設定が必要です。

なお，jpcrptコマンドで出力できるレポートの種類はPFM - Web Consoleのバージョンによって異なります。バージョンごとのレポート出力可否を次の表に示します。

表2‒37　バージョンごとのレポート出力可否

出力対象

08-00

08-10

08-11以降

レポート

CSV出力

○

○

○

HTML出力

×

○

○

登録レポート

CSV出力

×

×

○

HTML出力

×

×

○

複合レポート

HTML出力

×

×

○

（凡例）○：出力できる　×：出力できない

1パラメーターファイルに1レポートを指定できます。出力するレポートがリアルタイムレポートの場合，CSV形式によるレポート出力のときは，-rcオプションで指定した更新回数分のデータを，-riオプションで指定した更新間隔に従って，出力ファイルの末尾に追記します。HTML形式によるレポート出力のときは，コマンド実行時の最新のデータでHTMLファイルを出力します。HTMLファイルを出力したあと，データは更新されません。また，HTML形式によるレポート出力では，-rcオプションと-riオプションを指定しても無効になります。

シングルエージェントレポートに対して，複数エージェントを指定した場合は，エラーになります。

ページの先頭へ

コマンドを実行できるホスト

PFM - Web Console

ページの先頭へ

実行権限

Windowsの場合

Administrators権限を持つユーザー

UNIXの場合

rootユーザー権限を持つユーザー

また，コマンドを実行するためには，事前にPerformance Managementに対する管理ユーザー権限または一般ユーザー権限※のユーザーアカウントで認証用のキーファイルを作成する必要があります。詳細については，「jpcmkkey」コマンドを参照してください。

注※

Performance ManagementユーザーまたはJP1ユーザーが必要とする，Performance Managementに対する実行権限です。

ページの先頭へ

格納先ディレクトリ

Windowsの場合

インストール先フォルダ\tools\

UNIXの場合

/opt/jp1pcwebcon/tools/

ページの先頭へ

引数

-o 出力ファイル名

レポートを出力するファイル名称を指定します。出力ファイル名を指定しないと，エラーになります。また，出力ファイル名を指定するとき，次に示す文字は含めないでください。

# % < > & ¥

出力ファイル名は，絶対ファイルパス名，相対ファイルパス名，またはファイル名で指定できます。絶対ファイルパス名以外の場合は，カレントディレクトリを基点とします。指定されたディレクトリがない場合は，エラーになります。指定されたファイルが重複した場合は，-yオプションの指定に従います。

レポートの出力形式（CSV出力またはHTML出力）は，コマンドライン引数に指定したXML形式のパラメーターファイルで指定します。CSV出力を指定した場合，CSV形式のファイルが1つ出力されます。このCSV形式ファイルに拡張子は付けられません。一方，HTML出力を指定した場合，HTML形式のファイルおよびPNG形式のグラフ画像ファイルの2つが出力される場合があります。これらのファイルには拡張子が付けられます。したがってHTML出力を指定した場合，引数に指定した出力ファイル名に対して，実際に生成されるファイル名は異なるため注意してください。ファイル名のパターン例を次の表に示します。

出力形式

指定するファイル名

出力ファイル名

CSV

Output

output

output.csv

output.csv

HTML

output

output.htm

output.png

output.htm

output.htm.htm

output.htm.png

なお，HTML形式のレポートを出力する場合は，出力ファイルパスに次の文字を含むパスを指定すると，KAVJK0210-Eメッセージが表示され，コマンドの実行を中断します。

# % < > & ¥ "

-mx 最大ヒープサイズ

java.exeの最大ヒープサイズをメガバイト単位で指定します。デフォルトは，128メガバイトです。実際に取得できる最大サイズは，システムに依存します。指定する値が次の条件を満たさない場合は，コマンドライン形式不正となります。指定値の条件を次に示します。

  • 1〜2,048の整数

  • 「-mxの指定値 >= -msの指定値」

-ms 初期ヒープサイズ

java.exeの初期ヒープサイズをメガバイト単位で指定します。デフォルトは，32メガバイトです。指定する値が次の条件を満たさない場合は，コマンドライン形式不正となります。指定値の条件を次に示します。

  • 1〜2,048の整数

  • 「-mxの指定値 >= -msの指定値」

-y

-oオプションで指定した出力先のファイルが重複した場合，確認メッセージを出力するかどうかを指定します。

このオプションを指定した場合は，上書き確認メッセージを出力しないで，既存のファイルに上書きします。このオプションを省略した場合は，上書き確認メッセージを出力します。上書き確認メッセージに対して，「y」または「Y」で応答すると，既存のファイルに上書きします。それ以外の値で応答すると，処理を中断します。

-rc 更新回数

リアルタイムレポートに適用されるオプションです。レポートの更新回数を指定します。指定できる更新回数は，1〜2,147,483,647です。省略した場合，1となります。範囲外を指定するとエラーになります。履歴レポートに対して指定した場合およびHTML出力の場合は，無視されます。

-ri 更新間隔

リアルタイムレポートに適用されるオプションです。レポートの更新間隔を指定します。指定できる更新間隔は，レポート定義時の更新間隔の最小値〜3,600秒です。省略した場合，レポート定義時の更新間隔の初期値となります。範囲外を指定すると，エラーになります。リアルタイムレポートを［再スケジュールモード］で表示する設定の場合，履歴レポートに対して指定した場合，およびHTML出力の場合は，無視されます。

-dateformat 日付フォーマットのパターン名

指定したパターン名に対応する日付フォーマットで，入力ファイルの<expression-value>，<start-time>，<end-time>，<baseline-start-time>タグに記述した日付の形式を判定します。また，出力ファイル内の日付の形式を決定します。指定できる日付フォーマットのパターン名を次に示します。

  • pattern-ddMMyyyy

  • pattern-MMddyyyy

  • pattern-yyyyMMdd

-dateseparator 日付フォーマットのセパレーター名

指定したセパレーター名に対応するセパレーター文字列で，入力ファイルの<expression-value>，<start-time>，<end-time>，<baseline-start-time>タグに記述したセパレーターの形式を判定します。指定できる日付フォーマットのセパレーター名を次に示します。

  • space

  • slash

  • hyphen

  • period

-exportseparator レポート出力時の日付フォーマットのセパレーター名

出力ファイル内の日付フォーマットセパレーター名に対応するセパレーター文字列を指定します。指定できる日付フォーマットのセパレーター名を次に示します。

  • space

  • slash

  • hyphen

  • period

-agent サービスID

レポート出力対象のエージェントを，Agent Collectorサービス，リモートエージェントまたはグループエージェントのサービスIDで指定します。Remote Monitor CollectorサービスのサービスIDを指定するとエラーになります。レポート定義のレポート種別が「履歴（複数のエージェント）」で，複数のサービスIDを指定する場合はコンマ区切りで指定します。この場合，左側のサービスIDから順番に処理します。サービスIDを重複して指定した場合，先に指定したサービスIDを有効とします。

このオプションが指定された場合，パラメーターファイル内に<agent>タグが指定されていても無視されます。

存在しないサービスIDやレポート定義とプロダクトの異なるサービスIDを指定するとエラーになります。レポート定義のレポート種別が「履歴（複数のエージェント）」以外で，サービスIDを複数指定するとエラーになります。また，登録レポートまたは複合レポートに対して指定された場合は無視されます。

入力ファイル名

レポートを出力するための定義を記述した入力ファイル名を指定します。入力ファイルは，XML形式のパラメーターファイルです。このパラメーターファイルは，後述の「パラメーターファイルの形式」に基づいて作成します。入力ファイル名は，絶対パスでも相対パスでも指定できます。絶対パス以外で指定する場合は，カレントディレクトリを基点とします。

ページの先頭へ

パラメーターファイルの形式

XMLタグ仕様

パラメーターファイルの記述例を次に示します。なお，パラメーターファイルのサンプルを下記ディレクトリに格納しています。パラメーターファイルを記述するときのひな形として利用してください。

Windowsの場合：

インストール先のディレクトリ\sample\conf\

UNIXの場合：

/opt/jp1pcwebcon/sample/conf/

パラメーターファイル記述例（登録レポート，複合レポート以外のレポートを出力する場合）

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE pr-cli-parameters SYSTEM "rpt_params.dtd">
<pr-cli-parameters ver="0220">
  <launch-report>
    <agent>TA1htmprsvr</agent>
    <agent>TA1admin</agent>
    <report-definition name="CPU Trend" parent-folder="/Windows/Operating System/Monthly Trend">
      <launch-options>
        <indication-settings maximum-number-of-records="1440">
          <report-interval>HOUR</report-interval>
          <start-time>2007 08 10 12:00</start-time>
          <end-time>2007 08 11 12:00</end-time>
        </indication-settings>
      </launch-options>
      <html-output>
        <show-graph>
          <graph-options zoom-scale = "100">
            <show-3d/>
            <show-grid/>
            <vertical-axis minvalue="0" maxvalue="100"/>
          </graph-options>
        </show-graph>
        <show-table/>
      </html-output>
    </report-definition>
  </launch-report>
</pr-cli-parameters>

パラメーターファイル記述例（登録レポートを出力する場合）

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE pr-cli-parameters SYSTEM "rpt_params.dtd">
<pr-cli-parameters ver="0220">
  <launch-registration-report>
    <registration-report-definition report-name="CPU Usage@TA1host01"
      bookmark-name="CPU Usage"
      bookmark-parent-folder="/">
      <launch-options>
        <indication-settings maximum-number-of-records="1440">
          <date-range>WITHIN_THE_PAST_24_HOURS</date-range>
          <report-interval>HOUR</report-interval>
        </indication-settings>
      </launch-options>
      <html-output>
        <show-graph>
          <graph-options zoom-scale = "100">
            <show-grid/>
            <vertical-axis minvalue="0" maxvalue="100"/>
          </graph-options>
        </show-graph>
      <show-table/>
      </html-output>
    </registration-report-definition>
  </launch-registration-report>
</pr-cli-parameters>

パラメーターファイル記述例（複合レポートを出力する場合）

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE pr-cli-parameters SYSTEM "rpt_params.dtd">
<pr-cli-parameters ver="0220">
  <launch-combination-bookmark>
    <combination-definition bookmark-name="CPU Usage with Baseline" bookmark-parent-folder="/">
      <combination-options><combination-indication-settings>
        <date-range>WITHIN_THE_PAST_24_HOURS</date-range>
        <report-interval>HOUR</report-interval>
      </combination-indication-settings>
     </combination-options>
     <combination-graph-options zoom-scale="100" />
   </combination-definition>
  </launch-combination-bookmark>
</pr-cli-parameters>

日時を指定するタグの日付フォーマットの記述例

例1

引数-dateformatに「pattern-yyyyMMdd」を，引数-dateseparatorに「space」を指定し，report-intervalに「MINUTE」を指定した場合，日時を指定するタグは「YYYY△MM△DD△hh:mm」のフォーマットで指定する。

例2

引数-dateformatに「pattern-yyyyMMdd」を，引数-dateseparatorに「slash」を指定し，report-intervalに「MINUTE」を指定した場合，日時を指定するタグは「YYYY/MM/DD△hh:mm」のフォーマットで指定する。

例3

引数-dateformatに「pattern-yyyyMMdd」を，引数-dateseparatorに「hyphen」を指定し，report-intervalに「MINUTE」を指定した場合，日時を指定するタグは「YYYY-MM-DD△hh:mm」のフォーマットで指定する。

例4

引数-dateformatに「pattern-yyyyMMdd」を，引数-dateseparatorに「period」を指定し，report-intervalに「MINUTE」を指定した場合，日時を指定するタグは「YYYY.MM.DD△hh:mm」のフォーマットで指定する。

例5

引数に-dateformatを指定しない場合，日時を指定するタグはOSのロケールの設定値と同じフォーマットを指定する。

  • 日本語：YYYY△MM△DD△hh:mm

  • 英語（米国）：MM△DD△YYYY△hh:mm

  • 上記以外：DD△MM△YYYY△hh:mm

（凡例）

△：半角スペース

YYYY：西暦年

MM：月

DD：日

hh：時

mm：分

  • launch-report

    種別

    説明

    意味

    レポートを出力する場合に，レポート定義とエージェントの組み合わせを指定する。

    指定可能値

    なし

    省略

    可（launch-report，launch-registration-reportまたはlaunch-combination-bookmarkのどれか1つだけを指定する必要がある）

    属性

    なし

    親要素

    pr-cli-parameters

    子要素

    agent（複数指定できる）

    report-definition

  • agent

    種別

    説明

    意味

    レポート出力対象となるエージェントを1つ指定する。

    指定可能値

    エージェントの，Agent Collector，リモートエージェント，またはグループエージェントのサービスIDを指定する。ただし，次のサービスIDを指定するとエラーになる。

    • Remote Monitor CollectorサービスのサービスID

    • 存在しないサービスID

    • プロダクトが混在したサービスID

    • コマンド実行時のユーザーに参照権限がないエージェントのサービスID

    サービスIDを重複して指定した場合，先に指定したサービスIDが有効になる。「report-definition」に指定したレポートのレポート種別がマルチエージェント以外で，サービスIDを複数指定するとエラーになる。

    PFM - Web Console 08-50以降で，コマンドの実行時に-agentオプションが指定された場合，このタグの指定値は無視される。逆に，このタグを省略した場合は，コマンド実行時に-agentオプションを指定する必要がある。

    省略

    不可

    属性

    なし

    親要素

    launch-report

    子要素

    なし

  • report-definition

    種別

    説明

    意味

    レポート出力対象となるレポート定義を1つ指定する。

    ただし，次の場合はエラーになる。

    • 指定したレポート定義のプロダクトと同じプロダクトのエージェントを指定していない場合

    • レポート定義のデータモデルバージョンか，またはそれより新しいエージェントのデータモデルバージョンとなるエージェントを指定していない場合

    指定可能値

    なし

    省略

    不可

    属性

    name

    1〜64文字（バイトではない）の全角文字または半角文字でファイル出力するレポート定義名を指定する。レポート定義名に「\」または「/」を含む場合，それぞれ「\\」「\/」と記述する。

    存在しないレポート名を指定すると，エラーになる。省略するとエラーになる。

    parent-folder

    name属性で指定したレポート定義の親ディレクトリをディレクトリパスで指定する。ディレクトリパスは「/」で始まり，上位レベルのディレクトリ名から順に半角「/」で区切って指定する。ルートディレクトリを指定する場合は，「/」だけを指定する。ディレクトリ名に「\」または「/」を含む場合，それぞれ「\\」「\/」と記述する。存在しないディレクトリを指定すると，エラーになる。また，省略するとエラーになる。ディレクトリパス名の最後に「\」または「/」を記述してもエラーにならない。

    親要素

    launch-report

    子要素

    launch-options（1report-definitionに1回だけ指定できる。省略できる）

    html-output（1report-definitionに1回だけ指定できる。省略できる）

  • launch-options

    種別

    説明

    意味

    レポートの取得条件を指定する。

    指定可能値

    なし

    省略

    可（省略時は設定しない）

    属性

    なし

    親要素

    report-definition，registration-report-definition

    子要素

    indication-settings（1launch-optionsに1回だけ指定できる。省略できる）

    realtime-indication-settings（1launch-optionsに1回だけ指定できる。省略できる）

    expression-values（1launch-optionsに1回だけ指定できる。省略できる）

  • indication-settings

    種別

    説明

    意味

    次の値を指定する。

    • レポート取得間隔

    • レポート間隔

    • 開始日時

    • 終了日時

    • ピーク時間

    • 最大レコード数

    レコード定義のレポート種別が「リアルタイム（1つのエージェント）」の場合に指定すると，エラーになる。

    指定可能値

    なし

    省略

    可（子要素を含め，レポート定義の値を適用する）

    属性

    maximum-number-of-records

    1〜2,147,483,647の整数でレポートを取得する最大レコード数の上限値を指定する。指定できる上限は，config.xmlの<command>タグのmaxFetchCountで指定される値となる。それよりも大きい値を指定すると，maxFetchCountの値を適用する。また，config.xmlの<command>タグのmaxFetchCountの値がレポート定義で指定される値よりも小さい場合は，maxFetchCountの値を適用する。

    省略時は，レポート定義の値となる。

    親要素

    launch-options

    子要素

    date-range（1indication-settingsに1回だけ指定できる。省略できる）

    start-time（1indication-settingsに1回だけ指定できる。省略できる）

    end-time（1indication-settingsに1回だけ指定できる。省略できる）

    report-interval（1indication-settingsに1回だけ指定できる。省略できる）

    peak-time（1indication-settingsに1回だけ指定できる。省略できる）

    exclude-terminal-data（1indication-settingsに1回だけ指定できる。省略できる）

  • date-range

    種別

    説明

    意味

    レポートの取得期間を指定する。

    指定可能値

    次の値を指定できます。大文字と小文字は区別しない。

    • 過去1時間以内の場合「WITHIN_THE_PAST_HOUR」

    • 過去1日（24時間）以内の場合「WITHIN_THE_PAST_24_HOURS」

    • 過去7日以内の場合「WITHIN_THE_PAST_7_DAYS」

    • 過去1か月以内の場合「WITHIN_THE_PAST_MONTH」

    • 過去1年以内の場合「WITHIN_THE_PAST_YEAR」

    • レポート表示時に指定する場合「SPECIFY_WHEN_DISPLAYED」

    省略

    可（レポート定義の値を適用する）

    属性

    なし

    親要素

    indication-settings，combination-indication-settings

    子要素

    なし

  • report-interval

    種別

    説明

    意味

    レポート間隔を指定する。

    指定可能値

    次の値を指定できます。大文字と小文字は区別しない。

    • 分単位の場合「MINUTE」

    • 時間単位の場合「HOUR」

    • 日単位（24時間）の場合「DAY」

    • 週単位の場合「WEEK」

    • 月単位の場合「MONTH」

    • 年単位の場合「YEAR」

    レポートまたは登録レポートを出力する場合，レポート定義のレコードがPIレコード以外の場合に指定すると，エラーになる。複合レポートを出力する場合はエラーにならず，出力対象のうちPIレコードの系列だけがこの値を参照する。レポート定義にpeak timeが設定されている場合，「HOUR」以外を指定するとpeak timeは無効となる。

    省略

    可（レポート定義の値を適用する）

    属性

    なし

    親要素

    indication-settings，combination-indication-settings

    子要素

    なし

  • start-time

    種別

    説明

    意味

    開始日時を指定する。

    絶対時刻で直接指定する方法と，子要素の<relative-time>タグで相対指定する方法がある。

    指定可能値

    report-intervalで指定したフォーマットで指定する。report-intervalが指定できないレポートは，「MINUTE」が指定された場合のフォーマットで指定する。

    次の場合，エラーになる。

    • 指定値不正

    • フォーマット不正

    • end-timeより大きい値を指定

    • 指定した年が1970以下，または2036以上

    省略

    date-rangeおよびend-time指定値との組み合わせに依存する。詳細については，「注意事項」を参照。

    属性

    なし

    親要素

    indication-settings，combination-indication-settings

    子要素

    relative-time（1start-timeに1回だけ指定できる。省略できる）

  • end-time

    種別

    説明

    意味

    終了日時を指定する。

    絶対時刻で直接指定する方法と，子要素の<relative-time>タグで相対指定する方法がある。

    指定可能値

    report-intervalで指定したフォーマットで指定する。report-intervalが指定できないレポートは，「MINUTE」が指定された場合のフォーマットで指定する。

    次の場合，エラーになる。

    • 指定値不正

    • フォーマット不正

    • end-timeより大きい値を指定

    • 指定した年が1970以下，または2036以上

    省略

    date-rangeおよびstart-time指定値との組み合わせに依存する。詳細については，「注意事項」を参照。

    属性

    なし

    親要素

    indication-settings，combination-indication-settings

    子要素

    relative-time（1end-timeに1回だけ指定できる。省略できる）

  • peak-time

    種別

    説明

    意味

    ピーク時間を指定する。

    指定可能値

    ピーク時間を指定したいフィールドIDを指定する。「NONE」を指定すると，レポート定義で指定したフィールドIDは無効になる。

    レポート定義が次の条件のどれかに該当するときに指定した場合，エラーになる。

    • レコードがPIレコード以外

    • レコードが複数インスタンス

    • report-intervalがHOUR以外

    省略

    可（レポート定義の値を適用する）

    属性

    なし

    親要素

    indication-settings

    子要素

    なし

  • exclude-terminal-data

    種別

    説明

    意味

    レポートの開始，終了日時のデータを出力レポートに出力するかを指定する。

    指定可能値

    次の値を指定できる。大文字と小文字は区別しない。

    • 開始日時のデータをレポート出力しない場合「STARTTIME」

    • 終了日時のデータをレポート出力しない場合「ENDTIME」

    • 開始日時，終了日時のデータをレポート出力しない場合「BOTHTIME」

    • 開始日時，終了日時のデータをレポート出力する場合「NONE」

    省略

    可（初期設定ファイル（config.xml）のexcludeTerminalData（<command>タグ配下）の値を適用する。初期設定ファイル（config.xml）については，「初期設定ファイル（config.xml）」を参照）

    属性

    なし

    親要素

    indication-settings，combination-indication-settings

    子要素

    なし

  • realtime-indication-settings

    種別

    説明

    意味

    リアルタイムレポートのランキング表示を指定する。

    レポート定義のレポート種別が「リアルタイム（1つのエージェント）」の場合に指定できる。それ以外の場合はエラーになる。

    指定可能値

    なし

    省略

    可（子要素を含め，レポート定義の値を適用する）

    属性

    indicate-delta-value

    デルタ値で取得する場合は「TRUE」，それ以外は「FALSE」と指定する。省略時は，レポート定義の値を適用する。

    親要素

    launch-options

    子要素

    display-by-ranking（1realtime-indication-settingsに1回だけ指定できる。省略できる）

  • display-by-ranking

    種別

    説明

    意味

    ランキング取得フィールド，取得数，降順かどうかを指定できる。

    レポート定義のレコードが単数インスタンスの場合，エラーになる。

    指定可能値

    なし

    省略

    レポート定義の値

    属性

    field

    ランキング取得するフィールドIDを指定する

    ランキング取得をしない場合は，「NONE」を指定する。「NONE」の指定は，大文字と小文字は区別しない。省略するとエラーになる。

    display-number

    ランキング取得する件数を1〜100の整数で指定する。範囲外を指定するとエラーになる。field属性が「NONE」の場合にdisplay-numberを指定すると，エラーになる。

    field属性指定時に省略した場合，レポート定義でfield属性が指定されていれば，レポート定義の値，それ以外の場合は10となる。

    in-descending-order

    ランキング取得の判定基準となるフィールドIDを降順または昇順でソートし，先頭からdisplay-number属性で指定した件数分を取得する。

    昇順でソートする場合は「TRUE」，降順でソートする場合は「FALSE」を指定する。

    field属性が「NONE」の場合にin-descending-orderを指定すると，エラーになる。

    field属性指定時に省略した場合，レポート定義でfield属性が指定されていれば，レポート定義の値，それ以外の場合は「NONE」となる。field属性が指定されていなければ，「FALSE」となる。

    親要素

    realtime-indication-settings

    子要素

    なし

  • expression-values

    種別

    説明

    意味

    条件式を1つ以上指定する。

    「Specify when displayed」で設定された条件式を含まないレポートに指定すると，エラーになる。

    指定可能値

    なし

    省略

    可（省略時は設定しない）

    属性

    なし

    親要素

    launch-options

    子要素

    expression-value（複数指定できる）

  • expression-value

    種別

    説明

    意味

    条件式の値を1つ指定する。

    指定可能値

    pos属性で指定された行の式の値を指定する。

    指定可能値は，整数，小数値，または2,048バイト以内の半角文字列。

    省略

    可（expression-valuesを指定した場合は省略できない）

    属性

    pos

    条件式に「Specify when displayed」が設定されている単純式の出現順を0から始まる整数で指定する。出現順は，［レポートの表示設定］画面で表示される条件式の表示順と一致する。［レポートの表示設定］画面で1番目に表示される条件式のposの値は0となり，3番目に表示される条件式のposの値は2となる。

    指定できる範囲は，0〜「Specify when displayed」が設定されている単純式の個数-1となる。

    最初のexpression-valueタグでposを省略すると，0となる。2番目以降のexpression-valueタグでposを省略すると，1つ前のposの値+1となる。

    posに同じ値を複数指定できる。この場合，最後に指定された値が有効になる。

    範囲外の値を指定すると，エラーになる。

    親要素

    expression-values

    子要素

    relative-time（1expression-valueに1回だけ指定できる。省略できる）

  • html-output

    種別

    説明

    意味

    HTML形式でレポートを出力する。出力するレポートのフォーマットについては，「出力ファイル」を参照。

    HTML形式のレポートは，次の形式でデータを表示できる。表示形式は，子要素で指定する。

    • グラフ表示

    • テーブル表示

    子要素を指定しない場合は，ヘッダー部分のレポート定義名だけが出力される。

    指定可能値

    なし

    省略

    CSV形式でレポート出力する。

    属性

    なし

    親要素

    report-definition，registration-report-definition

    子要素 ※

    show-graph（1html-outputに1回だけ指定できる。省略できる）

    show-table（1html-outputに1回だけ指定できる。省略できる）

    注※　子要素を指定する場合は，記載順に指定します。

  • show-graph

    種別

    説明

    意味

    出力するレポートにグラフを表示する。グラフを表示する場合は，レポート定義でグラフ表示する設定をし，かつこのタグを指定する。レポート定義またはこのタグのどちらかの指定が無効の場合エラーにはならないが，レポートにグラフは表示されない。レポートに表示するグラフオプションは，子要素で指定する。子要素を指定しない場合は，デフォルト設定のグラフが表示される。

    指定可能値

    なし

    省略

    レポートにはグラフを表示しない。

    属性

    なし

    親要素

    html-output

    子要素

    graph-options（1show-graphに1回だけ指定できる。省略できる）

  • graph-options

    種別

    説明

    意味

    グラフオプションの設定を変更する。子要素の指定によって，次の項目の設定を変更できる。

    • 3Dで表示する

    • グリッドを表示する

    • 縦軸の最大値と最小値を手動で設定する

    指定可能値

    なし

    省略

    3D表示オフ，グリッド表示オフ，縦軸は自動設定となる。

    属性

    zoom-scale

    グラフの拡大率を指定する。選択できる値は，100，200，400，600，800のどれか。省略時のデフォルトは100。不正な値を指定した場合は，エラーになる。

    親要素

    show-graph

    子要素 ※

    show-3d（1graph-optionsに1回だけ指定できる。省略できる）

    show-grid（1graph-optionsに1回だけ指定できる。省略できる）

    vertical-axis（1graph-optionsに1回だけ指定できる。省略できる）

    注※　子要素を指定する場合は，記載順に指定します。

  • show-3d

    種別

    説明

    意味

    グラフを3Dで表示する。ただし，グラフ種別が線または面グラフの場合はエラーになる。なお，グラフ種別が積み上げ面の場合はエラーにはならないが，グラフは2Dで表示される。

    指定可能値

    なし

    省略

    グラフを2Dで表示する。

    属性

    なし

    親要素

    graph-options

    子要素

    なし

  • show-grid

    種別

    説明

    意味

    グラフ上にグリッドを表示する。ただし，グラフ種別が円グラフの場合はエラーになる。

    指定可能値

    なし

    省略

    グリッドを表示しない。

    属性

    なし

    親要素

    graph-options

    子要素

    なし

  • vertical-axis

    種別

    説明

    意味

    レポートで表示するグラフの縦軸の範囲を指定する。ただし，グラフ種別が円グラフの場合はエラーになる。

    指定可能値

    なし

    省略

    縦軸がグラフのデータに応じて自動で設定される。

    属性

    minvalue

    縦軸の最小値を実数値で指定する。指定できる範囲は，-1.797E308〜1.797E308。省略時およびminvalue>maxvalueの場合は，エラーになる。

    maxvalue

    縦軸の最大値を実数値で指定する。指定できる範囲は，-1.797E308〜1.797E308。省略時およびminvalue>maxvalueの場合は，エラーになる。

    親要素

    graph-options

    子要素

    なし

  • show-table

    種別

    説明

    意味

    出力するレポートでテーブル（表）を表示する。テーブルを表示する場合は，レポート定義でテーブル表示を設定し，かつこのタグを指定する。レポート定義およびこのタグのどちらかの指定が無効の場合エラーにはならないが，レポートにテーブルは表示されない。

    指定可能値

    なし

    省略

    レポートにはテーブルを表示しない。

    属性

    なし

    親要素

    html-output

    子要素

    なし

  • launch-registration-report

    種別

    説明

    意味

    ブックマーク階層のブックマーク（複合ブックマークを含む）の配下にある登録レポートを指定する。

    指定可能値

    なし

    省略

    可（launch-report，launch-registration-reportまたはlaunch-combination-bookmarkのどれか1つだけを指定する必要がある）

    属性

    なし

    親要素

    pr-cli-parameters

    子要素

    registration-report-definition

  • registration-report-definition

    種別

    説明

    意味

    レポート出力対象となる登録レポートを1つ指定する。

    指定可能値

    なし

    省略

    可（launch-registration-reportを指定した場合は省略できない）

    属性

    bookmark-name

    ファイル出力する登録レポートが格納されているブックマーク（複合ブックマークを含む）の名前を指定する。ブックマーク名に「\」または「/」を含む場合は，それぞれ「\\」または「\/」と記述する。存在しないブックマークを指定した場合はエラーになる。省略した場合はエラーになる。

    report-name

    ファイル出力する登録レポートの名前を指定する。「\」または「/」を含める場合は，それぞれ「\\」または「\/」と記述する。bookmark-name属性で指定したブックマーク配下にない登録レポートを指定するとエラーになる。省略した場合はエラーになる。

    注意：同一ブックマーク配下に同じ名称の登録レポートが複数定義されている場合，コマンドによって1つ目に情報取得された登録レポートが出力される。

    bookmark-parent-folder

    bookmark-name属性で指定したブックマークの親ディレクトリをディレクトリパスで指定する。ディレクトリパスは「/」で始まり，上位レベルのディレクトリ名から順に半角「/」で区切って指定する。ルートディレクトリを指定する場合は，「/」だけを指定する。ディレクトリ名に「\」または「/」を含む場合，それぞれ「\\」「\/」と記述する。存在しないディレクトリを指定すると，エラーになる。また，省略するとエラーになる。ディレクトリパス名の最後に「\」または「/」を記述するとエラーになる。

    親要素

    launch-registration-report

    子要素 ※

    launch-options（1registration-report-definitionに1回だけ指定できる。省略できる）

    html-output（1registration-report-definitionに1回だけ指定できる。省略できる）

    注※　子要素を指定する場合は，記載順に指定します。

  • launch-combination-bookmark

    種別

    説明

    意味

    ブックマーク階層の複合ブックマークを指定する。

    指定可能値

    なし

    省略

    可（launch-report，launch-registration-reportまたはlaunch-combination-bookmarkのどれか1つだけを指定する必要がある）

    属性

    なし

    親要素

    pr-cli-parameters

    子要素

    combination-definition

  • combination-definition

    種別

    説明

    意味

    レポート出力対象となる複合ブックマークを1つ指定する。

    指定可能値

    なし

    省略

    可（launch-combination-bookmarkを指定した場合は省略できない）

    属性

    bookmark-name

    ファイル出力する複合ブックマークの名前を指定する。ブックマーク名に「\」または「/」を含む場合は，それぞれ「\\」または「\/」と記述する。存在しないブックマーク，複合ブックマークではないブックマークを指定した場合はエラーになる。省略した場合はエラーになる。

    bookmark-parent-folder

    bookmark-name属性で指定したブックマークの親ディレクトリをディレクトリパスで指定する。ディレクトリパスは「/」で始まり，上位レベルのディレクトリ名から順に半角「/」で区切って指定する。ルートディレクトリを指定する場合は，「/」だけを指定する。ディレクトリ名に「\」または「/」を含む場合，それぞれ「\\」「\/」と記述する。存在しないディレクトリを指定すると，エラーになる。また，省略するとエラーになる。ディレクトリパス名の最後に「\」または「/」を記述するとエラーになる。

    親要素

    launch-combination-bookmark

    子要素 ※

    combination-options（1combination-definitionに1回だけ指定できる。省略できる）

    combination-graph-options（1combination-definitionに1回だけ指定できる。省略できる）

    注※　子要素を指定する場合は，記載順に指定します。

  • combination-graph-options

    種別

    説明

    意味

    レポート出力対象となる複合ブックマークを1つ指定する。

    指定可能値

    なし

    省略

    グラフの拡大率を100％にする。

    属性

    zoom-scale

    グラフの拡大率を指定する。選択できる値は，100，200，400，600，800のどれか。省略時のデフォルトは100。不正な値を指定した場合は，エラーになる。

    親要素

    combination-definition

    子要素

    なし

  • combination-options

    種別

    説明

    意味

    複合レポートを出力する場合のオプションを指定する。なお，ベースラインの表示設定は，子要素で指定する。

    指定可能値

    なし

    省略

    複合レポートの表示オプションは設定されない。

    属性

    なし

    親要素

    combination-definition

    子要素 ※

    combination-indication-settings（1combination-optionsに1回だけ指定できる。省略できる）

    baseline-indication-settings（1combination-optionsに1回だけ指定できる。省略できる）

    注※　子要素を指定する場合は，記載順に指定します。

  • combination-indication-settings

    種別

    説明

    意味

    複合レポートに対して，レポート取得期間，レポート間隔，開始日時，終了日時を指定する。

    指定可能値

    なし

    省略

    子要素で指定する値を含め，レポート定義の値が適用される。

    属性

    なし

    親要素

    combination-options

    子要素

    date-range（1combination-indication-settingsに1回だけ指定できる。省略できる）

    start-time（1combination-indication-settingsに1回だけ指定できる。省略できる）

    end-time（1combination-indication-settingsに1回だけ指定できる。省略できる）

    report-interval（1combination-indication-settingsに1回だけ指定できる。省略できる）

    exclude-terminal-data（1combination-indication-settingsに1回だけ指定できる。省略できる）

  • baseline-indication-settings

    種別

    説明

    意味

    複合レポートのベースラインの表示開始位置を指定する。なお，ベースラインの表示開始位置は，子要素で指定する。

    指定可能値

    なし

    省略

    ベースラインの開始位置として，デフォルト（レポートの開始日時）が使用される。

    属性

    なし

    親要素

    combination-options

    子要素

    baseline-start-time

  • baseline-start-time

    種別

    説明

    意味

    複合レポートのベースラインの表示開始位置を指定する。

    絶対時刻で直接指定する方法と，子要素の<relative-time>タグで相対指定する方法がある。

    指定可能値

    report-intervalで指定したフォーマットで指定する。report-intervalが指定できないレポートは，「MINUTE」が指定された場合のフォーマットで指定する。

    次の場合，エラーになる。

    • 指定値不正

    • フォーマット不正

    • end-timeより大きい値を指定

    指定した年が1970以下，または2036以上

    省略

    可（baseline-start-timeを指定した場合は省略できない）

    属性

    なし

    親要素

    baseline-indication-settings

    子要素

    relative-time（1baseline-start-timeに1回だけ指定できる。省略できる）

  • relative-time

    種別

    説明

    意味

    基点日時または基点日時からの相対時間で時刻を指定する。

    基点日時は，PFM - Web Consoleホストのローカル時刻で，コマンドを実行した時間，またはコマンドを実行した時，日，週，月，年どれかの開始時刻から選択してorigin属性で指定する。さらに，オプション属性であるyear, month, week, day, hour, minuteを組み合わせて指定することで，基点日時から相対時間で時刻を指定できる。

    最終的に算出された時刻の年が1970以下または2036以上の場合はエラーになる。

    指定可能値

    なし

    省略

    省略時は，親要素のフォーマットに従って絶対時刻を指定する必要があります。

    属性

    origin

    基点時刻を，コマンドを実行した時刻，または時，日，週，月，年どれかの開始時刻から指定する。

    • 「NOW」または「now」

      コマンドを実行した時刻

    • 「THIS-HOUR」または「this-hour」

      コマンドを実行した時の0分

    • 「THIS-DAY」または「this-day」

      コマンドを実行した日の0時0分

    • 「THIS-WEEK」または「this-week」

      コマンドを実行した週の開始曜日の0時0分

    • 「THIS-MONTH」または「this-month」

      コマンドを実行した月の1日の0時0分

    • 「THIS-YEAR」または「this-year」

      コマンドを実行した年の1月1日0時0分

    上記以外の値を指定した場合や，省略時はエラーになる。

    開始曜日は，デフォルトでは，コマンドを実行した環境のロケールに依存し，日本やアメリカでは日曜日になる。開始曜日はconfig.xmlのfirstDayOfWeekパラメーターで任意の曜日に変更できる。

    year

    基点時刻からの相対年数を指定する。省略した場合は0になる。相対値を示す属性の中で，最初に評価される。最終的に算出された時刻の年が1970以下または2036以上の場合はエラーになる。

    month

    基点時刻からの相対的な月の数を指定する。範囲は-12〜12。省略した場合は0。year属性の次に評価される。

    week

    基点時刻からの相対的な週の数を指定する。範囲は-53〜53。省略した場合は0になる。month属性の次に評価される。

    day

    基点時刻からの相対日数を指定する。範囲は-366〜366。省略した場合は0になる。week属性の次に評価される。

    hour

    基点時刻からの相対的な時間数を指定する。範囲は-24〜24。省略した場合は0になる。day属性の次に評価される。

    minute

    基点時刻からの相対的な分の数を指定する。範囲は-60〜60。省略した場合は0。hour属性の次に評価される。

    親要素

    start-time，end-time，expression-value，baseline-start-time

    子要素

    なし

ページの先頭へ

注意事項

ページの先頭へ

戻り値

0

正常終了した。

1

コマンドラインの形式が不正である。

2

コマンドの実行権限がない。

4

-rcオプション，または-riオプションに指定した範囲が不正である。

5

DTDファイルと不整合のためパラメーターを解析できない。

6

誤ったDTDファイルが指定された。

10

入力ファイルに指定した値が不正である。

11

PFM - Managerへの認証処理に失敗した。

21

出力ファイルにアクセスできない。

70

レポートの取得処理でタイムアウトが発生した。

80

ユーザーによって上書きを拒否された。

100

Performance Managementの環境不正によって初期化できない。

200

メモリーが不足している。

202

入力ファイルにアクセスできない。

220

PFM - Managerにアクセスできない。

222

PFM - Managerに接続できない。

223

通信処理でエラーが発生した。

224

PFM - AgentまたはPFM - RMに接続できない。

229

接続先のPFM - Managerでエラーが発生した。

255

予期しないエラーが発生した。

ページの先頭へ

使用例

レポート出力の定義内容を記述したパラメーターファイル（param.xml）をファイル（output.csv）に出力する場合のコマンド実行例を次に示します。 

jpcrpt -o output.csv -y param.xml

ページの先頭へ

出力例

コマンド処理の詳細情報を標準出力，標準エラー出力，トレースログファイルに出力します。ログ仕様については「4.　Performance Managementで出力するログ情報」を参照してください。

標準出力形式を次に示します。引数で指定したレポート出力の実行結果を表示します。

標準出力の出力例（成功時）

jpcrpt connected to hostname at dd MM yyyy HH:MM:SS.mmm
result  OK  : レポート定義ディレクトリパス/レポート定義名＠エージェントID
jpcrpt disconnected at dd MM yyyy HH:MM:SS.mmm

ページの先頭へ

出力ファイル

出力ファイルは，データヘッダー部分およびその他の部分で構成されます。データヘッダー部分は，初期設定ファイル（config.xml）の<command><export>タグ配下にあるoutputCsvHeaderで，出力有無を変更できます。

レポート結果をCSV形式で出力する場合

CSV形式のレポートは，データヘッダー部分およびデータ部分で構成されます。

このコマンドの出力ファイルのデータヘッダーに出力する情報を次の表に示します。

表2‒41　データヘッダーに出力する情報

データヘッダー情報

出力する情報

Report:

レポート名の絶対パスを出力する。

Agents:

エージェント名を出力する。プロダクト名表示機能の設定に関わらず，常にプロダクト名表示機能が無効の形式で出力する。

Date Format:

日付フォーマットおよびセパレーターを出力する。

Command:

オプションで指定した順に出力する。

空行

なし

列見出し

フィールドの列見出しを出力する。

フィールドの列見出しに出力されるのは，フィールドのスキーマ名。ただし，定義時にフィールドに対して，［表示名］が設定されている場合は，設定された［表示名］が出力される。

詳細は，マニュアル「JP1/Performance Management 運用ガイド」の，稼働分析のためのレポートの作成について説明している章を参照。

このコマンドの出力ファイル例を次に示します。なお，結果が0件の場合またはエージェントが停止していた場合，データ部は出力されません。データヘッダー部だけが出力されます。ただし，初期設定ファイル（config.xml）の<command><export>タグ配下にあるoutputCsvHeaderで，データヘッダーを出力しない設定にしている場合は，何も出力されません。

レポート結果をCSV形式で出力したときの出力ファイル例 

Report: /Windows/Troubleshooting/RecentPast/System Overview
Agents: TA1htmprsvr
Date Format: pattern-yyyyMMdd,slash
Command:jpcrpt -input C:\ProgramFiles\Hitachi\jp1pcWebCon\
        param.xml,-o C:\ProgramFiles\Hitachi\jp1pcWebCon\
        output.csv,-y
 
Agent Host,Agent Instance,Date and Time,CPU %,User CPU %,
Privileged CPU %,Processor Queue Length,Context Switches/sec,
               % Total Interrupt Time,System Calls/sec
htmprsvr,htmprsvr,2006/07/03 09:00:00,10.910626,8.917643,
                1.9929985,4,825.3214,0.040342055,3351.263
htmprsvr,htmprsvr,2006/07/03 10:00:00,10.646775,9.116808,
                1.5356027,5,778.178,0.009959743,3238.7776
htmprsvr,htmprsvr,2006/07/03 11:00:00,11.603203,9.505386,
                2.0978165,3,809.5369,0.036344547,3257.031
htmprsvr,htmprsvr,2006/07/03 12:00:00,2.2210534,0.8610586,
                1.3599948,2,744.3879,0.0121342335,3597.5398
htmprsvr,htmprsvr,2006/07/03 13:00:00,2.2657635,1.1398388,
                1.1259354,3,675.37067,0.024730453,2883.5593
htmprsvr,htmprsvr,2006/07/03 14:00:00,10.394524,8.527414,
                1.8726714,4,817.1143,0.009072154,3453.1233

レポート結果をHTML形式で出力する場合

HTML形式のレポートは，レポートヘッダー部分，グラフ表示部分，およびテーブル表示部分で構成されます。

各部分に出力される内容および出力条件については，マニュアル「JP1/Performance Management 運用ガイド」の，稼働分析のためのレポートの作成について説明している章を参照してください。

結果が0件の場合またはエージェントが停止していた場合は，レポートヘッダー部だけが出力されます。ただし，初期設定ファイル（config.xml）の<command><export>タグ配下にあるoutputCsvHeaderで，データヘッダーを出力しない設定にしている場合は，何も出力されません。

HTMLはUTF-8コードで出力されます。config.xmlのExport形式での文字コードや改行の設定には従いません。

なお，レポートヘッダー部分に出力されるエージェント名は，プロダクト名表示機能の設定に関わらず，常にプロダクト名表示機能が無効の形式になります。

ページの先頭へ

時刻の相対指定によるレポート実行の運用例

時刻の相対指定方法を利用すると，定期的にレポートを実行する運用で，取得期間を効率良く指定できます。時刻の相対指定方法によるパラメーターファイルの記述例について説明します。なお，時刻の相対指定ができるのはPFM - Web Console 08-50以降です。

運用例1

毎日24時間分（00:00〜24:00）に対するレポートを実行します。なお，jpcrptコマンドは翌日の00:00〜24:00の間に実行します。

  • エージェント：TA1host1

  • レポート定義：/Folder1/ReportA

  • 取得期間：jpcrptコマンド実行時刻の前日1日

  • サンプルのパラメーターファイル名：jpcrpt-parameters-for-scheduled-operation1.xml

サンプルパラメーターファイルの太字の部分を編集してください。

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE pr-cli-parameters SYSTEM "rpt_params.dtd">
<pr-cli-parameters ver="0220">
  <launch-report>
    <agent>TA1host1</agent>
    <report-definition name="ReportA" parent-folder="/Folder1">
      <launch-options>
        <indication-settings>
          <report-interval>HOUR</report-interval>
           <start-time>
             <relative-time origin="THIS-DAY" day="-1"/>
           </start-time>
           <end-time>
             <relative-time origin="THIS-DAY"/>
           </end-time>
        </indication-settings>
      </launch-options>
    </report-definition>
  </launch-report>
</pr-cli-parameters>

上記の記述例では，<start-time>タグ，<end-time>タグ，共にorigin属性にTHIS-DAYを指定して，基点時刻をjpcrptコマンドを実行した当日の0時0分としています。<start-time>タグはday属性に-1を指定して，そこから1日さかのぼっています。これによって，取得期間の開始時刻を前日の0時0分，取得期間の終了時刻を当日の0時0分(=前日の24時0分)と指定しています。なお，出力するレコードがPIレコードの場合は，出力するレポートの間隔を<report-interval>タグで指定します。

運用例2

毎日8:30から翌日の5:00に対するレポートを実行します。なお，jpcrptコマンドは翌日の5:00〜8:30の間に実行します。

  • エージェント：TA1host1

  • レポート定義：/Folder1/ReportA

  • 取得期間：jpcrptコマンド実行時刻の前日の8:30から当日の5:00

  • サンプルのパラメーターファイル名：jpcrpt-parameters-for-scheduled-operation2.xml

サンプルパラメーターファイルの太字の部分を編集してください。

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE pr-cli-parameters SYSTEM "rpt_params.dtd">
<pr-cli-parameters ver="0220">
  <launch-report>
    <agent>TA1host1</agent>
    <report-definition name="ReportA" parent-folder="/Folder1">
      <launch-options>
        <indication-settings>
          <report-interval>MINUTE</report-interval>
           <start-time>
             <relative-time origin="THIS-DAY" day="-1" hour="8" minute="30"/>
           </start-time>
           <end-time>
             <relative-time origin="THIS-DAY" hour="5"/>
           </end-time>
        </indication-settings>
      </launch-options>
    </report-definition>
  </launch-report>
</pr-cli-parameters>

運用例1の応用で，時や分の単位まで細かく設定している記述例です。<start-time>で前日の8:30を指定するとき，day属性を使用しないで，hour属性に-15，minute属性に-30を指定しても同じ結果が得られますが，この例で示すように，いったんday属性で1日さかのぼり，そこからhour属性とminute属性で時間を進めると読みやすい定義になります。なお，出力するレコードがPIレコードの場合は，出力するレポートの間隔を<report-interval>タグで指定します。

運用例3

毎週月曜日から金曜日（終日）に対するレポートを実行します。なお，jpcrptコマンドは翌日の土曜日にバッチ実行します。

  • エージェント：TA1host1

  • レポート定義：/Folder1/ReportA

  • 取得期間：jpcrptコマンド実行時刻の週の月曜日から金曜日（金曜日の24時0分（土曜日の0時0分）を含む）

  • サンプルのパラメーターファイル名：jpcrpt-parameters-for-scheduled-operation3.xml

サンプルパラメーターファイルの太字の部分を編集してください。

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE pr-cli-parameters SYSTEM "rpt_params.dtd">
<pr-cli-parameters ver="0220">
  <launch-report>
    <agent>TA1host1</agent>
    <report-definition name="ReportA" parent-folder="/Folder1">
      <launch-options>
        <indication-settings>
          <report-interval>DAY</report-interval>
           <start-time>
             <relative-time origin="THIS-WEEK" day="1"/>
           </start-time>
           <end-time>
             <relative-time origin="THIS-WEEK" day="6"/>
           </end-time>
        </indication-settings>
      </launch-options>
    </report-definition>
  </launch-report>
</pr-cli-parameters>

origin属性にTHIS-WEEKを指定する場合，基点時刻は週の開始曜日の0時0分になります。週の開始曜日は，日本ではデフォルトで日曜日となるため，ここでは<start-time>のday属性に+1することで開始時刻に月曜日の0時0分，<end-time>のday属性に+6することで終了時刻に土曜日の0時0分(=金曜日の24時0分)を指定できます。<end-time>はday属性+5とhour属性+24の組み合わせで表記しても同じ結果が得られます。

なお，jpcrptコマンドの実行が日曜日にずれ込んでしまう場合は，基点時刻も翌週にずれてしまうため，week属性に-1を加えるなどの考慮が必要になります。

また，出力するレコードがPIレコードの場合は，出力するレポートの間隔を<report-interval>タグで指定します。

運用例4

毎月25日の22:00に開始する月次処理の時間帯に対するレポートを実行します。ただし，月次処理に掛かる時間にばらつきがあるため，終了時刻は26日をまたいでしまう場合があります。jpcrptコマンドは月次処理完了の直後に実行します。

  • エージェント：TA1host1

  • レポート定義：/Folder1/ReportA

  • 取得期間：jpcrptコマンド実行時刻の当月の25日の22:00からコマンド実行時刻直前まで

  • サンプルのパラメーターファイル名：jpcrpt-parameters-for-scheduled-operation4.xml

サンプルパラメーターファイルの太字の部分を編集してください。

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE pr-cli-parameters SYSTEM "rpt_params.dtd">
<pr-cli-parameters ver="0220">
  <launch-report>
    <agent>TA1host1</agent>
    <report-definition name="ReportA" parent-folder="/Folder1">
      <launch-options>
        <indication-settings>
          <report-interval>MINUTE</report-interval>
           <start-time>
             <relative-time origin="THIS-MONTH" day="24" hour="22"/>
           </start-time>
           <end-time>
             <relative-time origin="NOW"/>
           </end-time>
        </indication-settings>
      </launch-options>
    </report-definition>
  </launch-report>
</pr-cli-parameters>

月次で実行するレポートの記述例です。終了時刻はコマンド実行時刻であるNOWを指定します。開始時刻は日付がずれないようにするため，基点時刻にTHIS-DAYではなくTHIS-MONTHなどを指定します。THIS-MONTHとday属性を組み合わせて指定する際の注意点として，THIS-MONTHは当月の1日を示すため，当月の25日を相対指定する場合はday属性を+24する必要があります。同様の理由から，THIS-YEARと組み合わせて指定するmonth属性やday属性の値にも注意が必要です。なお，出力するレコードがPIレコードの場合は，出力するレポートの間隔を<report-interval>タグで指定します。

運用例5

四半期（3か月）ごとのレポートを実行します。jpcrptコマンドは，各四半期の翌月である4月，7月，10月，1月に実行します。

  • エージェント：TA1host1

  • レポート定義：/Folder1/ReportA

  • 取得期間：jpcrptコマンド実行時刻の3か月前から前月（前月最終日の24時0分（当月の1日0時0分）を含む）

  • サンプルのパラメーターファイル名：jpcrpt-parameters-for-scheduled-operation5.xml

サンプルパラメーターファイルの太字の部分を編集してください。

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE pr-cli-parameters SYSTEM "rpt_params.dtd">
<pr-cli-parameters ver="0220">
  <launch-report>
    <agent>TA1host1</agent>
    <report-definition name="ReportA" parent-folder="/Folder1">
      <launch-options>
        <indication-settings>
          <report-interval>MONTH</report-interval>
          <start-time>
            <relative-time origin="THIS-MONTH" month="-3"/>
          </start-time>
          <end-time>
            <relative-time origin="THIS-MONTH"/>
          </end-time>
        </indication-settings>
      </launch-options>
    </report-definition>
  </launch-report>
</pr-cli-parameters>

四半期のレポートの記述例です。取得期間は3か月であるため，<start-time>タグのmonth属性に-3を指定しています。なお，出力するレコードがPIレコードの場合は，出力するレポートの間隔を<report-interval>タグで指定します。

運用例6

毎日24時間分（00:00〜23:59）に対するレポートを実行します。なお，jpcrptコマンドは翌日の00:00〜24:00の間に実行します。

  • エージェント：TA1host1

  • レポート定義：/Folder1/ReportA

  • 取得期間：jpcrptコマンド実行時刻の前日1日

  • サンプルのパラメーターファイル名：jpcrpt-parameters-for-scheduled-operation6.xml

サンプルパラメーターファイルの太字の部分を編集してください。

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE pr-cli-parameters SYSTEM "rpt_params.dtd">
<pr-cli-parameters ver="0220">
 <launch-report>
  <agent>TA1host1</agent>
  <report-definition name="ReportA" parent-folder="/Folder1">
   <launch-options>
    <indication-settings>
     <start-time>
      <relative-time origin="THIS-DAY" day="-1"/>
     </start-time>
     <end-time>
      <relative-time origin="THIS-DAY"/>
     </end-time>
     <exclude-terminal-data>ENDTIME</exclude-terminal-data>
    </indication-settings>
   </launch-options>
  </report-definition>
 </launch-report>
</pr-cli-parameters>

上記の記述例では，<start-time>タグ，<end-time>タグ，共にorigin属性にTHIS-DAYを指定して，基点時刻をjpcrptコマンドを実行した当日の0時0分としています。<start-time>タグはday属性に-1を指定して，そこから1日さかのぼっています。また，<exclude-terminal-data>タグにENDTIMEを指定して当日の0時0分（=前日の24時0分）のデータを出力しないようにしています。これによって，取得期間の開始時刻を前日の0時0分，取得期間の終了時刻を当日の0時0分（=前日の23時59分59秒）と指定しています。

ページの先頭へ

Copyright (C) 2019, Hitachi, Ltd.

Copyright (C) 2019, Hitachi Solutions, Ltd.

(C)opyright 2000-2009, by Object Refinery Limited and Contributors.