5.2.28 カスタムイベントジョブ定義情報の記述方法
カスタムイベントジョブ定義情報の記述方法を説明します。
カスタムイベントジョブ定義情報の形式,およびパラメーターを次に示します。
- 形式
cety="識別子"; [jpoif=マクロ変数名:引き継ぎ情報名;] [etm=n;] [fd=実行所要時間;] [ex="実行エージェント名";] [ha={y|n};] [eu={ent|def};] [ets={kl|nr|wr|an};] [mm={and|or};] [nmg={y|n};] [eun=待ち合わせ対象ユニット名;] [ega={exec|execdeffer|none};] [uem={y|n};] [cprm="任意の指定項目名=値";]
- パラメーター
-
- cety="識別子";
-
カスタムイベントジョブで連携するプログラムを識別する情報を定義します。総バイト数が16バイト以内の先頭が「CE」で始まる文字列で指定します。
定義できる値は,連携するプログラムに応じて異なります。カスタムイベントジョブと連携する製品のマニュアルを参照してください。
連携するプログラムが提供する情報以外の値を指定した場合,ジョブは異常検出終了となります。
- jpoif=マクロ変数名:引き継ぎ情報名;
-
マクロ変数名は,「?AJS2xxxxx?」という形式の64バイト以内の文字列で指定します。xxxxxの部分に指定できる文字列は,A〜Z(大文字の英字),0〜9(アラビア数字),「.(ピリオド)」です。
このパラメーターは,「jpoif=マクロ変数名:引き継ぎ情報名;」の形式で,バイト数の合計が2,048バイトまで指定できます。
このパラメーターでは,後続のUNIXジョブ,PCジョブ,フレキシブルジョブ,HTTP接続ジョブ,およびアクションジョブに対してイベント情報を引き継げます。
引き継ぎ情報名に指定できる値は,「CMTMOUT」および「OBJECT01〜OBJECT10」です。
- etm=n;
-
実行打ち切り時間を,実行開始時刻からの相対分で定義します。指定できる値は,1〜1,440(単位:分)です。起動条件内のジョブの場合,このパラメーターは無効になります。
- fd=実行所要時間;
-
終了遅延監視するジョブの実行所要時間を定義します。
指定できる値は,10進数の値で1〜1,440(単位:分)です。
起動条件として定義する場合,このパラメーターはジョブ実行時に無効になります。
- ex="実行エージェント名";
-
ジョブを実行する実行エージェント名を定義します。
指定できる文字数は,1〜255(単位:バイト)です。
実行エージェント名中に「"(ダブルクォーテーションマーク)」や「#」が含まれる場合は,キャスト文字(#)でキャストします。「"」は「#"」,「#」は「##」と記述します。
マクロ変数を指定できます。
- ha={y|n};
-
ジョブの実行を保留するかを定義します。省略した場合,nが仮定されます。起動条件内のジョブの場合,このパラメーターは無効になります。
-
y:保留します。
-
n:保留しません。
-
- eu={ent|def};
-
ジョブ実行時のJP1ユーザーを定義します。省略した場合,entが仮定されます。
-
ent:ジョブネットを登録したJP1ユーザーをジョブ実行時のJP1ユーザーとします。
-
def:ジョブを所有するJP1ユーザーをジョブ実行時のJP1ユーザーとします。
-
- ets={kl|nr|wr|an};
-
実行打ち切り時間が経過したあとのカスタムイベントジョブの状態を定義します。省略した場合,klが仮定されます。起動条件内のジョブの場合,このパラメーターは無効になります。
-
kl:強制終了
-
nr:正常終了
-
wr:警告検出終了
-
an:異常検出終了
-
- mm={and|or};
-
指定した待ち合わせ対象ユニットとの待ち合わせ方法を指定します。
省略した場合はandが仮定されます。
-
and:すべての待ち合わせ対象ユニットが終了したら実行を開始する。
-
or:待ち合わせ対象ユニットが一つでも終了したら実行を開始する。
-
- nmg={y|n};
-
指定した待ち合わせ対象ユニットのルートジョブネットに待ち合わせる世代がないときの動作を指定します。
省略した場合はnが仮定されます。
-
y:実行を開始する。
-
n:実行を開始しない。
-
- eun=待ち合わせ対象ユニット名;
-
待ち合わせ対象ユニットとするユニットを,完全名で指定します。
待ち合わせ対象ユニットを複数指定する場合,このパラメーターを複数回指定します。最大で32個指定できます。
待ち合わせ対象ユニット名に指定できる文字数は1〜930(単位:バイト)です。
- ega={exec|execdeffer|none};
-
起動条件付きジョブネットを待ち合わせ対象に指定していて,実行世代に異常終了がある場合の動作を指定します。
省略した場合はnoneが仮定されます。
-
exec:実行を開始する。
-
execdeffer:実行を開始しない。ただし,実行世代が「繰り越し未実行」状態の場合は,実行を開始する。
-
none:実行を開始しない。
-
- uem={y|n};
-
起動条件付きジョブネットを待ち合わせ対象に指定していて,監視世代が監視未起動終了の場合の動作を指定します。
省略した場合はnが仮定されます。
-
y:実行を開始する。
-
n:実行を開始しない。
-
- cprm="任意の指定項目名=値";
-
カスタムイベントジョブのユニット定義パラメーターを「任意の指定項目名=値」形式で指定します。
指定できる文字数は,2〜20,479(単位:バイト)です。このパラメーターを複数同時に指定した場合,指定した入力値すべての文字数の合計が,最大「20,479からcprmパラメーターの指定数を引き,1を足した値(単位:バイト)」です。例えば,cprmパラメーターを一つのユニットに同時に5個指定した場合,値として指定できる文字数の合計は最大「20479-5+1=20475」(単位:バイト)です。
指定値に「"(ダブルクォーテーションマーク)」や「#」が含まれる場合は,キャスト文字(#)でキャストします。「"」は「#"」,「#」は「##」と記述します。
「任意の指定項目名=値」の値部分には,マクロ変数を指定できます。マクロ変数で指定する場合,指定できる文字数は,「任意の指定項目名=マクロ変数名」の形式で,9〜20,479(単位:バイト)です。マクロ変数名は,「?AJS2xxxxx?」という形式の64バイト以内の文字列で指定します。xxxxxの部分に指定できる文字列は,A〜Z(大文字の英字),0〜9(アラビア数字),「.(ピリオド)」です。