5.2.17 JP1イベント送信ジョブ定義情報の記述方法
JP1イベント送信ジョブ定義情報の記述方法を説明します。
JP1イベント送信ジョブ定義情報の形式，およびパラメーターを次に示します。
- 形式
[evsid=イベントID;] [evhst="イベント送信先ホスト名";] [evsms="メッセージ";] [evssv={em|al|cr|er|wr|no|in|db};] [evsfr=拡張属性名:"値";] [pfm={u|p};] [etm=n;] [fd=実行所要時間;] [ex="実行エージェント名";] [ha={y|n};] [eu={ent|def};] [evsrt={y|n};] [evspl=確認間隔;] [evsrc=確認回数;] [jty={q|n};] [mm={and|or};] [nmg={y|n};] [eun=待ち合わせ対象ユニット名;] [ega={exec|execdeffer|none};] [uem={y|n};]- パラメーター
-
- evsid=イベントID;
-
送信するイベントIDを定義します。
指定できる値は，16進数の値で，00000000〜00001FFF，7FFF8000〜7FFFFFFFです。
- evhst="イベント送信先ホスト名";
-
イベント送信先ホスト名を定義します。evsrtパラメーターにyを指定した場合，このパラメーターの指定は必須です。
指定できる文字数は，1〜255（単位：バイト）です。
マクロ変数を指定できます。
- evsms="メッセージ";
-
イベントに付加するメッセージを定義します。指定できる文字数は，1〜1,023（単位：バイト）です。
マクロ変数を指定できます。
- evssv={em|al|cr|er|wr|no|in|db};
-
イベントに付加する重大度を定義します。省略した場合，noが仮定されます。
-
em：「Emergency」を設定します。
-
al：「Alert」を設定します。
-
cr：「Critical」を設定します。
-
er：「Error」を設定します。
-
wr：「Warning」を設定します。
-
no：「Notice」を設定します。
-
in：「Information」を設定します。
-
db：「Debug」を設定します。
-
- evsfr=拡張属性名:"値";
-
イベントに付加する拡張属性を定義します。
指定できる文字数は，「evsfr=拡張属性名:"値";」の形式で，5〜128（単位：バイト）です。
値には，マクロ変数を指定できます。
- pfm={u|p};
-
ジョブを実行するプラットフォーム種別を指定します。省略した場合，pが仮定されます。
-
p：Windows環境で実行します。
-
u：UNIX環境で実行します。
-
- etm=n;
-
実行打ち切り時間を，実行開始時刻からの相対分で定義します。指定できる値は，1〜1,440（単位：分）です。
- fd=実行所要時間;
-
終了遅延監視するジョブの実行所要時間を定義します。
指定できる値は，10進数の値で1〜1,440（単位：分）です。
- ex="実行エージェント名";
-
ジョブを実行する実行エージェント名または実行エージェントグループ名を定義します。
指定できる文字数は，1〜255（単位：バイト）です。
実行エージェント名中に「"（ダブルクォーテーションマーク）」や「#」が含まれる場合は，キャスト文字（#）でキャストします。「"」は「#"」，「#」は「##」と記述します。
キューイング属性あり（jty=q）の場合は，マクロ変数を指定できます。
- ha={y|n};
-
ジョブの実行を保留するかを定義します。省略した場合，nが仮定されます。
-
y：保留します。
-
n：保留しません。
-
- eu={ent|def};
-
ジョブ実行時のJP1ユーザーを定義します。省略した場合，entが仮定されます。
-
ent：ジョブネットを登録したJP1ユーザーをジョブ実行時のJP1ユーザーとします。
-
def：ジョブを所有するJP1ユーザーをジョブ実行時のJP1ユーザーとします。
-
- evsrt={y|n};
-
イベント到達確認を行うかどうかを定義します。省略した場合，nが仮定されます。
yを指定した場合，JP1イベントを送信してから3秒後に到達確認をします。
-
y：到達確認を行います。
-
n：到達確認を行いません。
-
- evspl=確認間隔;
-
JP1イベントが到達していなかった場合，到達確認を行う間隔を定義します。指定できる値は，10進数の値で，3〜600（単位：秒）です。
省略した場合，10が仮定されます。
- evsrc=確認回数;
-
JP1イベントが到達していなかった場合，到達確認を行う回数を定義します。指定できる値は，10進数の値で，0〜999（単位：回）です。
省略した場合，0が仮定されます。
- jty={q|n};
-
キューイング属性の種別を定義します。省略した場合，qが仮定されます。
-
q：キューイング属性あり。
-
n：キューイング属性なし。
-
- 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：実行を開始しない。
-
- 注意事項
-
イベント送信先ホスト名，メッセージ，拡張属性の値の定義に関する注意事項は次のとおりです。
-
空白文字や記号なども使用できます。ただし，UNIXの場合，特殊文字「`」，「$」，「\」を通常文字として扱うときは，これらの特殊文字の前に「\」を指定してください。
（指定例）
「`」は「\`」と指定します。
「$」は「\$」と指定します。
-
「"（ダブルクォーテーションマーク）」や「#」が含まれる場合は，キャスト文字（#）でキャストしてください。
（指定例）
「"」は「#"」と指定します。
「#」は「##」と指定します。
-
「"（ダブルクォーテーションマーク）」を通常文字として扱う場合は，キャストしたあと，キャスト文字（#）の前に「\」を指定してください。
（指定例）
「"」は「\#"」と指定します。
JP1イベント送信では，イベント送信先ホスト名，メッセージ，拡張属性の値に空白文字や記号などが使用されることを考慮して，イベント送信先ホスト名，メッセージ，拡張属性の値を「"（ダブルクォーテーションマーク）」で囲んでいます。このため，Windowsの場合で，文字列の最後の部分に「\」を通常文字として指定するときは，「\」の前にさらに「\」を指定してください。
引き継ぎ情報に上記の特殊文字が含まれる場合は，正しく引き継がれなかったり，ジョブが異常終了したりすることがあります。ただし，引き継ぎ情報での「"（ダブルクォーテーションマーク）」有効オプションを使用する場合には，「"（ダブルクォーテーションマーク）」を含む引き継ぎ情報は正しく引き継がれます。
-
- 指定例
-
イベント送信先ホスト名，メッセージ，拡張属性の値に，特殊文字および「"」や「#」を通常文字として定義する場合の例を次に示します。
-
「`AAA`」は，「\`AAA\`」と指定します（UNIXの場合だけ）。
-
「$AAA$」は，「\$AAA\$」と指定します（UNIXの場合だけ）。
-
「#AAA#」は，「##AAA##」と指定します。
-
「"AAA"」は，「\#"AAA\#"」と指定します。
-
「\AAA\」は，「\AAA\\」（Windowsの場合）または「\\AAA\\」（UNIXの場合）と指定します。
-