jprcollect（Windows，UNIX）

〈このページの構成〉

形式
説明
格納先ディレクトリ
引数

形式

jprcollect
     ユニット名
     出力ファイル名
     [  -b  年/月/日  -e  年/月/日
     |  [-L]  [-N]  [-T]
     |  {-l  月 | -n  月 | -t}  [-p  月]
     |  [-C]  [-G]  [-D] ] [-w]
     [-F  JP1/AJSのスケジューラーサービス名]
     [-A]  [-U]  [-y]

ページの先頭へ

説明

JP1/AJSからジョブ運用情報を収集します。収集する情報は，ジョブネットワーク要素の定義情報と実行予定・結果情報です。収集した情報は，ジョブ運用情報ファイルに格納します。ジョブ運用情報ファイルは，ジョブ運用ドキュメント出力の入力情報となります。

ジョブ運用情報の収集は，JP1/AJSが提供する次のコマンドを内部で実行することで実現しています。

コマンド名	用途
ajsprint	定義情報の収集
ajsshow	実行予定・結果情報の収集

当該コマンドを実行するには，上記のコマンドを実行できる環境（環境変数など）の設定が必要です。詳細については，マニュアル「JP1/Automatic Job Management System 3 コマンドリファレンス」を参照してください。

ジョブ運用情報の収集対象をユニット名で指定します。ユニット名は，JP1/AJSのジョブ名，ジョブネット名，またはジョブグループ名を完全名で指定します。完全名は先頭が「/」で，ルートジョブグループからそのジョブネットワークまでの名称を「/」で区切って指定したものです。

ルートジョブグループ以下をまとめて収集する場合は，-A引数を指定してください。-A引数を指定することで，ユニット名に「/」（ルートジョブグループ）を指定できます。

収集したジョブ運用情報は出力ファイル名で指定したファイル（ジョブ運用情報ファイル）に格納されます。出力ファイル名は，ファイル拡張子を除いた名称で指定します。当該コマンドでファイル拡張子（.aoi）を付加したファイルを作成します。

実行予定・結果情報を収集するには，収集期間を指定してください。期間は，実行予定・結果情報の収集開始日と終了日の指定で指定します。指定方法は，年月日指定，月次指定，相対月指定，日次指定の4つから選ぶことができます。

収集期間内に実行を開始する予定のユニット，または収集期間内に実行していたユニットの情報が収集されます。実行中のユニットの情報は収集されません。

開始日または終了日が2037/1/1以降となる場合は，実行予定・結果情報を収集できません。

月次指定および，相対月指定は，月単位で収集期間を指定します。月の範囲は，1日の基準時刻〜末日の基準時刻に23時間59分59秒を加えた時刻までです。

＜指定例＞

収集期間を暦日の年月日で指定する場合

ジョブ運用情報を収集する対象が「Group1」ジョブグループ下の「Net1」ジョブネットで，実行予定・結果情報の収集期間が暦日の「2016年1月1日」から「2016年1月31日」で，収集した結果を「/tmp/file1.aoi」ファイルに格納するには，次のコマンドを実行します。

jprcollect  /Group1/Net1  /tmp/file1  -b 2016/01/01  -e 2016/01/31

収集期間を実行日の年月日で指定する場合

ジョブ運用情報を収集する対象が「Group1」ジョブグループ下の「Net1」ジョブネットで，実行予定・結果情報の収集期間が実行日の「2016年1月1日」から「2016年1月31日」で，収集した結果を「/tmp/file1.aoi」ファイルに格納するには，次のコマンドを実行します。

jprcollect  /Group1/Net1  /tmp/file1  -b 2016/01/01  -e 2016/01/31 -w

収集期間を月次で指定する場合

ジョブ運用情報を収集する対象が「Group1」ジョブグループ下の「Net1」ジョブネットで，実行予定・結果情報の収集期間を「先月」にして，収集した結果を「/tmp/file1.aoi」ファイルに格納するには，次のコマンドを実行します。

jprcollect  /Group1/Net1  /tmp/file1  -L

このコマンドを「2016年4月」に実行した場合，収集期間は「2016年3月1日」から「2016年3月31日」になります。

収集期間を暦日の相対月で指定する場合

ジョブ運用情報を収集する対象が「Group1」ジョブグループ下の「Net1」ジョブネットで，実行予定・結果情報の収集期間が「当月より3ヶ月前」から「2ヶ月分」で，暦日で収集し，収集した結果を「/tmp/file1.aoi」ファイルに格納するには，次のコマンドを実行します。

jprcollect  /Group1/Net1  /tmp/file1  -l 3  -p 2

このコマンドを「2016年4月」に実行した場合，収集期間は「2016年1月1日」から「2016年2月28日」になります。

収集期間を実行日の相対月で指定する場合

ジョブ運用情報を収集する対象が「Group1」ジョブグループ下の「Net1」ジョブネットで，実行予定・結果情報の収集期間が「当月より5ヶ月後」から「1ヶ月分」で，実行日で収集し，収集した結果を「/tmp/file1.aoi」ファイルに格納するには，次のコマンドを実行します。

jprcollect  /Group1/Net1  /tmp/file1  -n 5  -p 1 -w

このコマンドを「2016年1月」に実行した場合，収集期間は「2016年6月1日」から「2016年6月30日」になります。

収集期間を実行日の相対月で指定する場合

ジョブ運用情報を収集する対象が「Group1」ジョブグループ下の「Net1」ジョブネットで，実行予定・結果情報の収集期間が「当月より12ヶ月前」から「12ヶ月」で，実行日で収集し，収集した結果を「/tmp/file1.aoi」ファイルに格納するには，次のコマンドを実行します。

jprcollect  /Group1/Net1  /tmp/file1  -l 12  -p 12 -w

このコマンドを「2017年12月」に実行した場合，収集期間は「2016年12月1日」から「2017年11月30日」になります。

収集期間を暦日の日次で指定する場合

ジョブ運用情報を収集する対象が「Group1」ジョブグループ下の「Net1」ジョブネットで，実行予定・結果情報の収集期間を「前日」で，暦日で収集し，収集した結果を「/tmp/file1.aoi」ファイルに格納するには，次のコマンドを実行します。

jprcollect /Group1/Net1 /tmp/file1 -C

このコマンドを「2017年12月8日」に実行した場合，収集期間は「2017年12月7日」から「2017年12月7日」になります。

収集期間を実行日の日次で指定する場合

ジョブ運用情報を収集する対象が「Group1」ジョブグループ下の「Net1」ジョブネットで，実行予定・結果情報の収集期間を「本日」と「翌日」で，実行日で収集し，収集した結果を「/tmp/file1.aoi」ファイルに格納するには，次のコマンドを実行します。

jprcollect /Group1/Net1 /tmp/file1 -D -G -w

このコマンドを「2017年12月8日」に実行した場合，収集期間は「2017年12月8日」から「2017年12月9日」になります。

ページの先頭へ

格納先ディレクトリ

Windowsの場合

（Install Path）

UNIXの場合

/opt/jp1ajs2pom/bin

ページの先頭へ

引数

ユニット名

収集するジョブ運用情報のユニット名を指定します。ここで指定したユニット以下のすべてのユニット情報が収集対象となります。

ユニット名に総称名（「*」，または「?」）は指定できません。

ユニット名に複数個の名称を指定しないでください。ジョブ運用ドキュメントの出力でエラーとなります。

ユニット名は，大文字・小文字が区別されます。

出力ファイル名

収集したジョブ運用情報を格納するジョブ運用情報ファイルの名称を指定します。ファイル拡張子（.aoi）は指定しないでください。

ファイル名は，絶対パス名または相対パス名で指定できます。

ファイル名として機種依存文字および次の記号は使用しないでください。

　\　/　:　*　?　"　<　>　|　$　`　-

ただし「-」については，ファイルパス名の先頭以外は使用できます。

また，JP1/AJS3 - Print Optionでジョブ運用情報ファイルを開くときは，ファイル名は63バイト以下，フォルダパス名長を194バイト以下にしてください。

UNIXの場合，実行ユーザーに出力先のディレクトリの書き込み権限が与えられているか確認してください。

-b　年/月/日

実行予定・結果情報を収集する期間の開始日を指定します。なお，開始時刻は基準時刻です。

年

指定できる値は，1994〜2036（単位：西暦年）です。
月

指定できる値は，1（または01）〜12（単位：月）です。
日

指定できる値は，1（または01）〜31（単位：日）です。

この引数は-e引数と同時に指定してください。この引数を指定しないと，実行予定・結果情報を収集しません。

-e　年/月/日

実行予定・結果情報を収集する期間の終了日を指定します。終了日には開始日と同じ日，または開始日以降の日を指定します。なお，終了時刻は基準時刻に23時間59分59秒を加えた時刻です。

年

指定できる値は，1994〜2036（単位：西暦年）です。
月

指定できる値は，1（または01）〜12（単位：月）です。
日

指定できる値は，1（または01）〜31（単位：日）です。

この引数は，-b引数と同時に指定してください。

-L

先月分の実行予定・結果情報を収集したい場合に指定します。

-T引数を指定せずに-N引数と同時に指定することはできません。

-N

来月分の実行予定・結果情報を収集したい場合に指定します。

-T引数を指定せずに-L引数と同時に指定することはできません。

-T

今月分の実行予定・結果情報を収集したい場合に指定します。

-l　月

当月以前を月単位で実行予定・結果情報を収集したい場合に，当月から何か月前の月を開始月とするのかを相対月で指定します。

指定値は次の範囲になります。

月：1〜12

-n　月

当月以後を月単位で実行予定・結果情報を収集したい場合に，当月から何か月後の月を開始月とするのかを相対月で指定します。

指定値は次の範囲になります。

月：1〜12

-t

当月を開始月として，月単位で実行予定・結果情報を収集したい場合に指定します。

-p　月

月単位で実行予定・結果情報を収集したい場合に，開始月より何か月分収集したいのかを開始月からの相対月で指定します。

指定値は次の範囲になります。

月：1〜12

この引数は-l引数，-n引数，または-t引数と同時に指定してください。

-p引数を省略した場合は-p 1を仮定し，1か月分だけ収集します。

-C

前日分の実行予定・結果情報を収集したい場合に指定します。

-D引数を指定せずに-G引数と同時に指定することはできません。

-G

翌日分の実行予定・結果情報を収集したい場合に指定します。

-D引数を指定せずに-C引数と同時に指定することはできません。

-D

本日分の実行予定・結果情報を収集したい場合に指定します。

-w

実行予定・結果情報を収集する期間の開始日および終了日を実行日で指定します。

この引数を省略した場合は，実行予定・結果情報を収集する期間の開始日および終了日を暦日で指定します。

-F　JP1/AJSのスケジューラーサービス名

処理対象とする，JP1/AJSのスケジューラーサービスのサービス名を指定します。

-A

ユニット名に「/」（ルートジョブグループ）を指定できるようにします。

-U

指定したユニットの下位を含めた最終更新日時を収集したい場合に指定します。ただし，JP1/AJS3 - Manager 09-00以降の場合だけ収集できます。

-y

指定したユニットにジョブネットリリース機能を使用した登録情報が含まれている場合で，リリースIDごとにジョブネットの情報を収集したいときに指定します。ただし，JP1/AJS3 - Managerのバージョンが09-00-04以降の場合だけ収集できます。

ジョブネットリリース機能については，マニュアル「JP1/Automatic Job Management System 3 導入ガイド」のジョブネットリリース機能の説明を参照してください。

戻り値

0	正常終了
4	警告終了（定義情報は収集できたが，実行予定・結果情報は収集できなかった）
10	異常終了（引数指定エラー）
20	異常終了（実行時エラー）

補足

コマンド実行ごとに，ジョブ運用情報の収集に関する実行履歴情報を格納したファイルをジョブ運用情報ファイルと同じディレクトリまたはフォルダに作成します。ファイルの名称は，出力ファイル名に指定したファイル名に，ファイル拡張子（.log）を付加したものです。

このコマンドでは，特に引数の妥当性をチェックしません。このコマンドが異常終了した場合は，実行履歴情報を参照して，要因を取り除いてください。

実行履歴情報の出力例を示します。

[図データ]

<<実行履歴情報ファイルの構成および内容について>>

1行目：製品ヘッダ部

2行目：情報収集の実行日時

3行目：情報収集の実行コマンドの引数情報

4行目以降： JP1/AJSのコマンド(ajsshow, ajsprint)実行履歴および各コマンドの結果

注意事項

収集期間を指定しても，指定したユニットを実行登録していない場合は，定義情報は収集できますが，実行予定・結果情報は収集できません。また，指定した収集期間内に実行登録がないときも，実行予定・結果情報は収集できません。これらの場合，コマンドは警告終了しますが，ジョブ運用情報ファイルのドキュメント出力は可能です。ただし，実行予定・結果情報が収集できていないので，実行予定・結果情報に関する帳票の出力はできません。

ユニットにジョブグループを指定し，そのジョブグループに実行登録のあるジョブネットと実行登録のないジョブネットが混在している場合は，実行登録のあるジョブネットだけ実行予定・結果情報を収集できます。
UNIXの場合，コマンド投入元の文字コードとJP1/AJSのマネージャー環境設定の文字コードを合わせて実行してください。

コマンド投入元の文字コードとは，コマンド投入時のLANG環境変数などのOS上の設定のことです。

コマンド投入元の文字コードがEUCの場合は，ジョブ運用情報ファイルの出力内容をShift-JISコードに変換します。ただし，ユニット名や項目値に機種依存文字が含まれている場合は，変換エラーとなります。

コマンド投入元の文字コードがShift-JISやUTF-8の場合は，ジョブ運用情報ファイルの出力内容をコマンド投入元の文字コードで出力します。
-Aオプションを指定してルート直下からジョブ運用情報を収集した場合，ユニット定義数やスケジュール情報量が多くなるため，ジョブ運用情報ファイル（aoiファイル）のサイズが非常に大きくなります。サイズの大きいジョブ運用情報ファイルを［ジョブ運用ドキュメント出力］画面で表示・印刷などしたり，jprprintコマンドで印刷・CSVファイルに出力したりすると多大なリソースを消費し，非常に多くの処理時間が必要となりますので注意してください。
指定した収集期間の範囲内に実行予定および実行結果のあるジョブが出力対象となります。収集期間の範囲内に実行を開始し，範囲を超えて終了したジョブは，ジョブ実行が終了した後にジョブ運用情報を収集した場合，収集期間の範囲内にある実行結果を取得できます。収集期間の範囲を超えた実行結果は取得できません。
jprcollectコマンドでは内部的に次のようなシステムの標準提供コマンドを利用していますので，下記コマンドが利用可能である必要があります。

UNIXの場合： sh, iconv, cp, rm, echo, hostname

Windowsの場合： echo
JP1/AJS3 - Managerがクラスタ構成の場合は，アクティブな系からジョブ運用情報を収集してください。その際，論理ホスト用のスケジューラーサービス名を指定してください。
-Lオプション，-Nオプション，-Tオプション，-lオプション，-nオプション，-tオプション，-pオプション，-Cオプション，-Gオプション，および-Dオプションを指定した場合，物理ホストのシステム時刻を基に収集期間を決定します。スケジューラーサービスのローカル日時には対応していません。スケジューラーサービスのローカル日時を変更している場合は，-bオプションと-eオプションに，ローカル日時を基にした期間を指定してください。
Windows Server 2019，Windows Server 2016およびWindows Server 2012で，ユーザーアカウント制御（UAC）が有効な環境で管理者（Administrator）以外のユーザーを使用している場合，出力ファイル名に，OSによって保護された「C:\Program Files」などのフォルダを指定するとエラーになります。このときは，管理者（Administrator）でコマンドプロンプトを起動してからコマンドを実行してください。
-yオプションを指定しない場合は，適用中のジョブネットの定義情報，実行予定，および結果情報を収集します。登録されているリリース情報は収集できません。
JP1/AJS3の環境設定パラメーターADMACLIMITを「yes」にしてジョブ運用情報を収集すると，KAVR1000-Eのエラーになる場合があります。この場合，次のどちらかを実施してください。

（Windowsの場合）

OSにログオンして，jprcollectコマンドを実行するユーザーアカウント名と同じ名前のJP1ユーザーを作成し，ajsprintコマンドおよびajsshowコマンドの対象ユニットのJP1資源グループに対して，JP1権限レベルを設定してください。

ajsprintコマンドおよびajsshowコマンドを実行するために必要なJP1権限レベルの詳細については，JP1/AJS3のマニュアルを参照してください。

（UNIXの場合）

OSにログインして，jprcollectコマンドを実行するユーザーアカウント名と同じ名前のJP1ユーザーを作成し，ajsprintコマンドおよびajsshowコマンドの対象ユニットのJP1資源グループに対して，JP1権限レベルを設定してください。

ajsprintコマンドおよびajsshowコマンドを実行するために必要なJP1権限レベルの詳細については，JP1/AJS3のマニュアルを参照してください。

JP1/AJS3の環境設定パラメーターAJSPRINTSORTUNITINFが「yes」の場合，関連線情報は先行ユニットおよび後続ユニットの文字コード昇順にジョブ運用情報ファイルに出力されます。環境設定パラメーターAJSPRINTSORTUNITINFが「no」，または値を設定していない場合，関連線情報は先行ユニットおよび後続ユニットの作成順に出力されます。詳細については，JP1/AJS3のマニュアルを参照してください。

収集期間に含まれるジョブの予定日時には，JP1/AJSが提供するajsshowコマンドで取得する次の情報が使用されます。

・「処理サイクルの計算から求めた実行開始予定日時」

・「処理サイクルの計算から求めた実行終了予定日時」

実行済みジョブの場合は，次の例のように，実際に実行を開始または終了した日時がそれぞれ出力されます。

図8‒1　2/16 12:00に2/1〜2/28の運用情報を取得後，月次予定情報（時刻付き）を出力した場合の出力例

予定情報に実績を含めない帳票を作成する場合は，-bオプションの収集する期間の開始日に現在の日時以降を指定して取得してください。

JP1/AJS3 - View連携からjprcollectコマンドが実行されたとき，接続先のJP1/AJS3 - Print Option Managerが11-00以前の場合は，-wオプションを指定すると，暦日による収集となるか，あるいは，KAVR5024-Eのエラーとなります。
JP1/AJS3 - View連携からjprcollectコマンドが実行されたとき，接続先のJP1/AJS3 - Print Option Managerが11-10以前の場合は，-l/-n/-pオプションに指定した月数が6を超えると，KAVR5024-Eのエラーとなります。
JP1/AJS3 - View連携からjprcollectコマンドが実行されたとき，接続先のJP1/AJS3 - Print Option Managerが11-10以前の場合は，-C/-D/-Gオプションを指定すると，スケジュール情報を収集できないか，あるいは，KAVR5024-Eのエラーとなります。
-wオプションを指定しない場合，ajsshowコマンドの-bおよび-eオプションを使用します。

-wオプションを指定した場合，ajsshowコマンドの-vおよび-wオプションを使用します。
jprcollectコマンドを実行中にJP1/AJSでユニットの追加やユニット名の変更が実行されると，出力されたジョブ運用情報ファイルの内容が不整合になり，帳票出力時にエラーになります。

ジョブ運用情報ファイルのサイズ

出力するジョブ運用情報ファイル（aoiファイル）のサイズは，次の計算式によって求めることができます。

ただし，この計算式は余裕をもたせた目安として考えてください。

ユニット名の長さ，ユニットの階層の深さ，指定したユニットの位置，関連線の数，スケジュールルールの数など，ユーザー指定に依存する部分が多いため，実際のサイズとは異なる場合があります。

計算式

（指定したユニット以下の）定義ユニット数×４．５キロバイト

　　　　　　　　　　　　　　　＋

（指定した期間に存在する）世代数×３．５キロバイト

jprcollectコマンドで消費するメモリ量は，上記サイズと同値となります。

暦日および実行日での収集の違い

暦日および実行日での収集の違いを次に示します。

（例1）暦日指定で，2016年5月25日のスケジュールを収集した場合

jprcollect /grp1/net1 /tmp/file1 -b 2016/05/25 -e 2016/05/25

このコマンドを実行すると，日またがりで5月26日00:30の実行予定となるジョブは収集されません。

[図データ]

（例2）実行日指定で，2016年5月25日のスケジュールを収集した場合

jprcollect /grp1/net1 /tmp/file1 -b 2016/05/25 -e 2016/05/25 -w

このコマンドを実行すると，日またがりで5月26日00:30の実行予定となるジョブは，上位のジョブネットの実行予定日が5月25日であるため，収集されます。

[図データ]

（例3）暦日指定で，本日のスケジュールを収集した場合

jprcollect /grp1/net1 /tmp/file1 -D

このコマンドを「2017年12月8日」に実行すると，日またがりで12月9日00:05の実行予定となるジョブは収集されません。

[図データ]

（例4）実行日指定で，本日のスケジュールを収集した場合

jprcollect /grp1/net1 /tmp/file1 -D -w

このコマンドを「2017年12月8日」に実行すると，日またがりで12月9日00:05の実行予定となるジョブは上位のジョブネットの実行予定日が12月8日であるため，収集されます。

[図データ]

ページの先頭へ