Hitachi

JP1 Version 12 JP1/Automatic Job Management System 3 - Print Option


jprwebcollect(Windows)

〈このページの構成〉

形式

jprwebcollect
     ユニット名
     ジョブ運用情報ファイル名
     [  -b  年/月/日  -e  年/月/日
     |  [-L]  [-N]  [-T]
     |  {-l   | -n   | -t}  [-p  ]
     |  [-C]  [-G]  [-D] ] [-w]
     [-F  JP1/AJSのスケジューラーサービス名]
     [-A]  [-U]  [-y]
     [-z]
     --user ログインユーザー名
     --mhost JP1/AJS3 - Managerのホスト名
     --whost JP1/AJS3 - Web Consoleのホスト名
     [--protocol {http | https}]
     [--port ポート番号]

説明

接続先のJP1/AJS3 - Web Consoleから収集対象のJP1/AJS3 - Managerにログインし,ジョブ運用情報を収集します。収集する情報は,ジョブネットワーク要素の定義情報および実行予定・結果情報です。収集した情報は,ジョブ運用情報ファイルに格納します。ジョブ運用情報ファイルは,ジョブ運用ドキュメント出力の入力情報となります。

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

コマンド名

用途

ajsprint

定義情報の収集

ajsshow

実行予定・結果情報の収集

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

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

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

実行予定・結果情報を収集するには,収集期間を指定してください。期間は,実行予定・結果情報の収集開始日と終了日の指定で指定します。指定方法は,年月日指定,月次指定,相対月指定,日次指定の4つから選ぶことができます。収集期間の詳細は,「jprcollect(Windows,UNIX)」を参照してください。

<指定例>
  • 収集対象のJP1/AJS3 - Managerのホスト名がhost001で,ログインユーザーにjp1adminを指定し,接続先のJP1/AJS3 - Web Consoleのホスト名がhostweb01の場合

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

jprwebcollect /Group1/Net1 c:\work\test.aoi -T -F AJSROOT1 --user jp1admin --mhost host001 --whost hostweb01

実行履歴はc:\work¥test.logに出力されます。

格納先ディレクトリ

(Install Path)

引数

ユニット名

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

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

複数個のユニット名は指定できません。

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

ジョブ運用情報ファイル名

出力するジョブ運用情報のファイル名を指定します。

ファイル名は完全パス(ファイル拡張子.aoiを含む)を指定してください。

指定できるファイル名長はパス全体で258バイト以下です。フォルダパス名長は194バイト以内です。ファイル名長は63バイト以内です。

次に示す文字を含むファイル名は指定できません。

\ / : * ? " < > |

-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

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

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

暦日および実行日での収集の違いについては,「jprcollect(Windows,UNIX)」を参照してください。

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

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

この引数を省略した場合は,JP1/AJSのスケジューラーサービスのサービス名に「AJSROOT1」が指定されたものとして動作します。

-A

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

-U

指定したユニットの下位を含めた最終更新日時を収集したい場合に指定します。

-y

指定したユニットにジョブネットリリース機能を使用した登録情報が含まれている場合で,リリースIDごとにジョブネットの情報を収集したいときに指定します。

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

-z

ジョブ運用情報ファイル名に指定したファイルがすでに存在するファイルだった場合の動作を指定します。

この引数を指定すると,ファイルがすでに存在する場合,ファイルを上書きします。この引数を省略すると,ファイルがすでに存在する場合,エラーになります。

--user ログインユーザー名

収集対象のJP1/AJS3 - ManagerにログインするJP1ユーザー名を指定します。

あらかじめjprajsmkkeyコマンドを実行して,JP1/AJS3 - Managerのホスト名,ログインユーザー名,およびパスワードを認証情報ファイルに登録してください。指定したログインユーザー名が認証情報ファイルに登録されていないとエラーになります。

--mhost JP1/AJS3 - Managerのホスト名

収集対象のJP1/AJS3 - Managerのホスト名またはIPアドレスを1〜255バイトで指定します。

あらかじめjprajsmkkeyコマンドを実行して,JP1/AJS3 - Managerのホスト名,ログインユーザー名,およびパスワードを認証情報ファイルに登録してください。指定したJP1/AJS3 - Managerのホスト名が認証情報ファイルに登録されていないとエラーになります。

--whost JP1/AJS3 - Web Consoleのホスト名

収集対象のJP1/AJS3 - Web Consoleのホスト名またはIPアドレスを1〜255バイトで指定します。

--protocol { http | https }

接続先のJP1/AJS3 - Web Consoleへの通信方式を,HTTP通信またはHTTPS通信のどちらかを指定します。--protocol引数を省略した場合,デフォルトはhttpとなります。

--port ポート番号

接続先のJP1/AJS3 - Web Consoleへの通信で使用するポート番号を指定します。--port引数を省略した場合,--protocol引数でhttpを指定するとデフォルトは22252となります。--protocol引数でhttpsを指定するとデフォルトは22253となります。

戻り値

0

正常終了

4

警告終了(定義情報は収集できたが,実行予定・結果情報は収集できなかった)

10

異常終了(引数指定エラー)

20

異常終了(実行時エラー)

補足

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

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

実行履歴情報については,「jprcollect(Windows,UNIX)」を参照してください。

注意事項
  • このコマンドは,JP1/AJS3 - Print Option,収集対象のJP1/AJS3 - Managerおよび同じマシンにインストールされたJP1/AJS3 - Print Option Manager,接続先のJP1/AJS3 - Web Consoleのバージョンがそれぞれ12-50以降の場合に使用できます。

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

    ユニットにジョブグループを指定し,そのジョブグループに実行登録のあるジョブネットと実行登録のないジョブネットが混在している場合は,実行登録のあるジョブネットだけ実行予定・結果情報を収集できます。

  • 収集対象のJP1/AJS3 - Managerのスケジューラーサービス名を正しく指定してください。正しく指定されていない場合,出力されたジョブ運用情報ファイルで帳票出力すると文字化けが発生します。

  • -A引数を指定してルート直下からジョブ運用情報を収集した場合,ユニット定義数やスケジュール情報量が多くなるため,ジョブ運用情報ファイル(aoiファイル)のサイズが非常に大きくなる場合があります。サイズの大きいジョブ運用情報ファイルを[ジョブ運用ドキュメント出力]画面で表示・印刷などしたり,jprprintコマンドで印刷・CSVファイルに出力したりすると多大なリソースを消費し,非常に多くの処理時間が必要となるので注意してください。

  • 指定した収集期間の範囲内に実行予定および実行結果のあるジョブが出力対象となります。収集期間の範囲内に実行を開始し,範囲を超えて終了したジョブは,ジョブ実行が終了した後にジョブ運用情報を収集した場合,収集期間の範囲内にある実行結果を取得できます。収集期間の範囲を超えた実行結果は取得できません。

  • JP1/AJS3 - Managerがクラスタ構成の場合は,アクティブな系からジョブ運用情報を収集してください。その際,論理ホスト用のスケジューラーサービス名を指定してください。

  • --b引数および-e引数を指定した場合,ユーザーの指定した年月日をajsshowコマンドの引数として使用します。

    -L引数,-N引数,-T引数,-l引数,-n引数,-t引数,-p引数,-C引数,-G引数,および-D引数を指定した場合,物理ホストのシステム時刻を基に収集期間を決定します。

  • -w引数を指定しない場合,ajsshowコマンドの-bおよび-e引数を使用します。

    -w引数を指定した場合,ajsshowコマンドの-vおよび-w引数を使用します。

  • -y引数を指定しない場合は,適用中のジョブネットの定義情報,実行予定,および結果情報を収集します。登録されているリリース情報は収集できません。

  • JP1/AJS3 - Managerのログイン認証に指定したJP1ユーザーに,ajsprintコマンドおよびajsshowコマンドの対象ユニットのJP1資源グループに対して,JP1権限レベルを設定してください。

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

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

  • jprwebcollectコマンドを実行中にJP1/AJSでユニットの追加やユニット名の変更が実行されると,出力されたジョブ運用情報ファイルの内容が不整合になり,帳票出力時にエラーになります。

  • UAC(ユーザーアカウント制御)が有効な環境で管理者権限を持たないユーザーがジョブ運用情報ファイル名に,OSによって保護された「C:\Program Files」などのフォルダを指定すると,ファイルがユーザーごとのVirtualStoreフォルダにリダイレクトして出力されることがあります。

    リダイレクトされるのは,ファイルの保存先として次のフォルダ配下を指定した場合です。

    ・「システムドライブ\Windows」配下

    ・「システムドライブ\Program Files」配下

    ・「システムドライブ\Program Files (x86)」配下(64ビット版のWindowsの場合)

    リダイレクトされたファイルの保存先は,それぞれ次のフォルダ配下になります。

    ・「%LocalAppData%\VirtualStore\Windows」配下

    ・「%LocalAppData%\VirtualStore\Program Files」配下

    ・「%LocalAppData%\VirtualStore\Program Files (x86)」配下

    「%LocalAppData%」のデフォルトは「システムドライブ\Users\OSユーザー名\AppData\Local」です。

  • --user引数および--mhost引数に指定した値が認証情報ファイルに登録されていない場合はエラーになります。jprajsmkkeyコマンドで認証情報ファイルに登録してからjprwebcollectコマンドを実行してください。

  • 認証情報ファイルに誤りがあると,認証に失敗しエラーになります。jprajsmkkeyコマンドで認証情報ファイルの一覧表示でJP1/AJS3 - Managerのホスト名とログインユーザーを確認してください。

  • --mhost引数,--whost引数,--protocol引数,および--port引数の指定に誤りがあると,通信ができずエラーになります。JP1/AJS3 - Web ConsoleおよびJP1/AJS3 - Manager の環境設定については,JP1/AJSのマニュアルを参照してください。

  • --protocol引数に指定する通信方式と--port引数に指定するポート番号はJP1/AJS3 - Web ConsoleのWebサーバ定義ファイルに合わせてください。一致していない場合は,通信ができずエラーになります。JP1/AJS3 - Web ConsoleのWebサーバ定義ファイルについては,JP1/AJSのマニュアルを参照してください。

  • JP1/AJS3 - Web ConsoleおよびJP1/AJS3 - Managerでエラーが発生した場合は,JP1/AJS3 - Web ConsoleおよびJP1/AJS3 - Managerの資料採取ツールでログを採取してください。

    JP1/AJS3 - Print OptionおよびJP1/AJS3 - Print Option Managerでエラーが発生した場合は,出力したジョブ運用情報ファイルと実行履歴ファイルを採取し,JP1/AJS3 - Print OptionおよびJP1/AJS3 - Print Option Managerの資料採取ツールでログを採取してください。

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

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

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

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

計算式

(指定したユニット以下の)定義ユニット数×4.5キロバイト

               +

(指定した期間に存在する)世代数×3.5キロバイト

jpwebrcollectコマンドで消費するメモリ量は,JP1/AJS3 - Print OptionおよびJP1/AJS3 - Print Option Managerでそれぞれ上記サイズと同値となります。