2.3.31　getJobnetSummaryメソッド

(1)　説明

指定されたジョブネットのサマリー情報（指定した取得対象期間の実行予定のユニット数，実行が終了したユニット数，終了予定日時などのジョブネットの進捗状況に関係する情報）を取得します。

ジョブネットリリース機能を使用している場合は，リリース登録時に指定したリリースIDに対応したユニット定義の情報も取得します。

ログインしたJP1ユーザーに参照権限がないユニットが存在する場合は，例外を送出し，すべての情報を取得できません。ただし，指定したユニットの状態が未登録のときは，指定したユニットの配下に参照権限がないユニットが存在する場合でも例外を送出しません（世代数が0のサマリー情報全体インターフェース（AjsCdTotalSummary）を取得します）。

取得対象期間と取得対象世代

取得対象となる世代は，取得対象期間が次の条件のどれかを満たしている必要があります。

• 取得対象期間に開始時刻または開始予定時刻が含まれている。

• 取得対象期間に終了時刻または終了予定時刻が含まれている。

• 取得対象期間の間，常に実行中である

取得対象期間に当日以降を指定した場合は，擬似予定も取得対象となります。

取得対象期間をまたがった世代の場合は，その配下のユニットのうち取得対象期間に含まれないユニットは取得対象になりません。

なお，再実行したジョブネットの場合は，再実行開始日時ではなく開始日時を使用して判定されます。

起動条件付きジョブネットを指定する場合

起動条件付きジョブネットを指定した場合は，監視世代と実行世代の両方が取得対象となります。

取得対象となるユニットは，実行世代の場合は通常のルートジョブネットと同様にその世代の開始日時または終了日時が取得対象の範囲に含まれるかどうかで判定されますが，監視世代の場合は監視世代の状態によって次のように判定されます。

監視世代の状態	取得対象ユニット
開始時刻待ち 保留中	ルートジョブネットおよび配下のすべてのユニット
監視中 監視正常終了 監視打ち切り終了 監視中断 監視未起動終了 繰り返し未実行	ルートジョブネットだけ
未計画	すべてのユニットが対象外

また，監視世代が擬似予定の場合も，ルートジョブネットおよび配下のすべてのユニットが取得対象となります。

取得対象となるユニットの総数（予定ユニット数）

次に示すユニットはカウント対象外となります。

• 監視世代が次の状態にある起動条件付きジョブネットの配下のユニット

  ・監視中

  ・監視正常終了

  ・監視未起動終了

  ・監視打ち切り終了

  ・監視中断

  ・繰り返し未実行

• ジョブネットコネクタの接続先ジョブネット，およびその配下のユニット

• ルートリモートジョブネットおよびネストリモートジョブネットの配下のユニット

• 次の状態のユニット

  ・未登録

  ・未計画

  ・計画未実行

  ・閉塞

  ・未実行終了

  ・繰り越し未実行（実行予定なし）

終了ユニット数と予定ユニット数

終了ユニット数と予定ユニット数の例を次に説明します。

（例1）取得対象期間に3回実行するジョブネットの場合

この例の場合，取得対象期間に実行される予定のユニットの数は，ジョブが9個とジョブネットが3個（世代1〜世代3）の合計12個になります。現在時刻では世代2のジョブAまでが正常終了していて，後続のジョブBが実行中のため，終了状態のユニットの数はジョブが4個にジョブネットが1個（世代1）の合計5個になります。

（例2）関連線で接続されているジョブが異常終了した場合

この例の場合，ジョブネット実行前の待ち状態のジョブネットでは（上図），終了ユニット数/実行予定ユニット数は「0/5」となります。

ジョブネットの実行が開始し，ジョブ2が異常終了すると（下図），後続のジョブ（ジョブ3およびジョブ4）が未実行終了になるため，終了ユニット数/実行予定ユニット数は「1/3」となります。

また，異常終了ユニット数は「2」となるため，異常終了したことを確認できます。

（例3）リカバリーユニットを含むジョブネットの場合

この例の場合，ジョブネット実行前の待ち状態のジョブネットでは（上図），終了ユニット数/実行予定ユニット数は「0/5」となります。

ジョブネットの実行が開始し，ジョブ2が正常終了すると（下図），ジョブ2の後続のリカバリージョブ（ジョブ4）が「未実行終了」状態でジョブネットの実行が終了しますが，終了ユニット数/実行予定ユニット数は「4/4」となります。

このように，正常終了したときは，実行されないリカバリーユニットを取得対象外にして，終了ユニット数と実行予定ユニット数を取得します。

ジョブネットのサマリー情報の詳細については，マニュアル「JP1/Automatic Job Management System 3 導入ガイド」のJP1/AJS3 - Viewでの監視について記載している個所を参照してください。

ページの先頭へ

(2)　形式

public AjsCdTotalSummary getJobnetSummary(
　　java.lang.String manager,
　　java.lang.String serviceName,
　　java.lang.Stirng unitName,
　　long begin,
　　long end,
　　AjsCdGetSummaryOption option) throws AjsCdException

ページの先頭へ

(3)　実行権限

ログインしたJP1ユーザーが，ユニットに対して次に示すJP1権限レベルのどれかを与えられている必要があります。

• JP1_AJS_Admin権限

• JP1_AJS_Manager権限

• JP1_AJS_Editor権限

• JP1_AJS_Operator権限

• JP1_AJS_Guest権限

ページの先頭へ

(4)　引数

引数名	省略	説明
manager	不可	要求を依頼するJP1/AJS3 - Managerのホスト名を，1〜255バイトの文字列で指定します。loginメソッドの第1引数に指定した値と合わせてください。
serviceName	不可	要求対象のスケジューラーサービス名を，1〜30バイトの文字列で指定します。
unitName	不可	情報を取得するユニットの完全名を，1〜930バイトの文字列で指定します。 指定できるユニットの種別を次に示します。それ以外の種別のユニットを指定した場合は，例外を送出します。 ルートジョブネット ルートリモートジョブネット プランニンググループ
begin※	不可	サマリーを取得する期間の開始時間を1970年1月1日0時0分0秒（UTC形式）からの経過時間（64ビット）のミリ秒単位で指定します。ただし，ミリ秒の指定は切り捨てて無視します（秒の値までが有効となります）。 指定できる範囲は1994/1/1〜2036/12/31です。それ以外の値を指定した場合の動作は保証しません。 なお，本引数には引数endで指定した時間以前の値を指定してください。それ以外の値を指定した場合は，例外を送出します。
end※	不可	サマリーを取得する期間の終了時間を1970年1月1日0時0分0秒（UTC形式）からの経過時間（64ビット）のミリ秒単位で指定します。ただし，ミリ秒の指定は切り捨てて無視します（秒の値までが有効となります）。 指定できる範囲は1994/1/1〜2036/12/31です。それ以外の値を指定した場合の動作は保証しません。 なお，本引数には引数beginで指定した時間以降の値を指定してください。それ以外の値を指定した場合は，例外を送出します。
option	可	取得オプションを設定したサマリー情報取得オプションクラスを指定します。 サマリー情報取得オプションクラスの詳細については，「3.22 サマリー情報取得オプションクラス（AjsCdGetSummaryOption）」を参照してください。 本引数を省略する場合は，nullを指定してください。本引数を省略した場合は，クラスのデフォルト値が適用されます。

注※

例えば，引数beginと引数endで指定する範囲を1日とする場合は次のように指定します。なお，基準時間はgetCalendarメソッドで取得してください。

引数beginに指定する値

取得対象日のミリ秒値 + 基準時間のミリ秒値

引数endに指定する値

引数beginに指定した値 + 1日のミリ秒値（1日を23時間59分59秒とする場合は((24×60×60)−1×1000)ミリ秒）

ページの先頭へ

(5)　戻り値

取得したユニットの情報を，サマリー情報全体インターフェース（AjsCdTotalSummary）を実装したクラスのインスタンスとして返却します。

ページの先頭へ

(6)　例外

例外が発生した場合，このメソッドは例外クラス（AjsCdException）を送出します。

ページの先頭へ

(7)　注意事項

• 接続先JP1/AJS3 - Managerが標準構成以外の場合，このメソッドは例外クラス（AjsCdException）を送出します。

• サマリー情報の取得は，取得対象の世代数や対象ジョブネットの総ユニット数によって，JP1/AJS3 - Managerに負荷がかかることがあります。JP1/AJS3 - Managerへの負荷を考慮して，取得する期間を検討してください。

• 本メソッドは，取得対象の世代数や対象ジョブネットの総ユニット数によって，JP1/AJS3 - Manager やネットワークに負荷がかかることがあります。また，世代数や対象ジョブネットの総ユニット数が増えるに従い，所要メモリ量と応答時間が増加します。

  世代数や対象ジョブネットの総ユニット数が多い場合は，１回あたりの取得期間を複数回に短く分割して取得するなどを検討してください。

ページの先頭へ