5.2.27 HTTP接続ジョブ定義情報の記述方法
HTTP接続ジョブ定義情報の記述方法を説明します。
HTTP接続ジョブ定義情報の形式,およびパラメーターを次に示します。
- 形式
htcfl="接続設定ファイル名"; [htknd={GET|POST|PUT|DELETE};] [htexm={y|n};] [htrqf="送信情報ファイル名";] [htrqu="送信情報ファイル(URLパラメーター)";] [htrqm="送信情報ファイル(メッセージボディ)";] htstf="ステータス格納ファイル名"; [htspt={diff|same};] htrhf="受信ヘッダー格納ファイル名"; [htrbf="受信ボディ格納ファイル名";] [htcdm=終了コード1:HTTPステータスコード1,[HTTPステータスコード2...];] [so="標準出力ファイル名";] [se="標準エラー出力ファイル名";] [etm=n;] [fd=実行所要時間;] [pr=n;] [ex="実行エージェント名";] [un="実行ユーザー名";] [jd={nm|ab|cod|mdf|exf};] [wth=n;] [tho=n;] [jdf="終了判定ファイル名";] [abr={y|n};] [rjs=自動リトライする終了コードの下限;] [rje=自動リトライする終了コードの上限;] [rec=最大リトライ回数;] [rei=リトライ間隔;] [ha={y|n};] [eu={ent|def};] [mm={and|or};] [nmg={y|n};] [eun=待ち合わせ対象ユニット名;] [ega={exec|execdeffer|none};] [uem={y|n};]
- パラメーター
-
- htcfl="接続設定ファイル名";
-
HTTP接続をするための接続情報を定義した,エージェントホスト上の接続設定ファイル名を定義します。
指定できる文字数は,1〜511(単位:バイト)です。
接続設定ファイル名は,絶対パスで指定します。
接続設定ファイル名に「"(ダブルクォーテーションマーク)」や「#」が含まれる場合は,キャスト文字(#)でキャストします。「"」は「#"」,「#」は「##」と記述します。
接続設定ファイル名には,マクロ変数を指定できます。マクロ変数名は,「?AJS2xxxxx?」という形式の64バイト以内の文字列で指定します。xxxxxの部分に指定できる文字列は,A〜Z(大文字の英字),0〜9(アラビア数字),「.(ピリオド)」です。
- htknd={GET|POST|PUT|DELETE};
-
HTTP通信をするときのリクエスト種別(HTTPメソッド)を定義します。省略した場合,GETが仮定されます。
-
GET
-
POST
-
PUT
-
DELETE
-
- htexm={y|n};
-
拡張モードを使用するかどうかを定義します。JP1/AJS3 - ManagerおよびJP1/AJS3 - Agentのバージョンが12-50以降の場合に指定できます。
省略した場合,nが仮定されます。
-
y
拡張モードを使用します。送信情報ファイル名(URLパラメーター)および送信情報ファイル名(メッセージボディ)の内容をHTTPリクエストとして送信します。
-
n
拡張モードを使用しません。送信情報ファイル名の内容をHTTPリクエストとして送信します。
-
- htrqf="送信情報ファイル名";
-
HTTPリクエストとして送信する情報を定義した,エージェントホスト上の送信情報ファイル名を定義します。
指定できる文字数は,1〜511(単位:バイト)です。
送信情報ファイル名は,絶対パスで指定します。
送信情報ファイル名に「"(ダブルクォーテーションマーク)」や「#」が含まれる場合は,キャスト文字(#)でキャストします。「"」は「#"」,「#」は「##」と記述します。
送信情報ファイル名には,マクロ変数を指定できます。マクロ変数名は,「?AJS2xxxxx?」という形式の64バイト以内の文字列で指定します。xxxxxの部分に指定できる文字列は,A〜Z(大文字の英字),0〜9(アラビア数字),「.(ピリオド)」です。
送信情報ファイルの内容をURLパラメーターとして送信するか,メッセージボディとして送信するかは,HTTPリクエストのリクエスト種別によって異なります。リクエスト種別にかかわらず送信する情報を指定したい場合は,「htexm={y|n};」に「y」を指定し,「htrqu="送信情報ファイル(URLパラメーター)";」および「htrqm="送信情報ファイル(メッセージボディ)";」を使用することを推奨します。
htexmパラメーターに「y」を指定した場合,このパラメーターの指定は無視されます。
- htrqu="送信情報ファイル(URLパラメーター)";
-
HTTPリクエストのURLパラメーターとして送信する情報を定義した,エージェントホスト上の送信情報ファイル名(URLパラメーター)を定義します。JP1/AJS3 - ManagerおよびJP1/AJS3 - Agentのバージョンが12-50以降で,拡張モードを使用する場合に指定できます。
指定できる文字数は,1〜511(単位:バイト)です。
送信情報ファイル名(URLパラメーター)は,絶対パスで指定します。
送信情報ファイル名(URLパラメーター)に「"(ダブルクォーテーションマーク)」や「#」が含まれる場合は,キャスト文字(#)でキャストします。「"」は「#"」,「#」は「##」と記述します。
送信情報ファイル名(URLパラメーター)には,マクロ変数を指定できます。マクロ変数名は,「?AJS2xxxxx?」という形式の64バイト以内の文字列で指定します。xxxxxの部分に指定できる文字列は,A〜Z(大文字の英字),0〜9(アラビア数字),「.(ピリオド)」です。
htexmパラメーターに「n」を指定した場合,このパラメーターの指定は無視されます。
- htrqm="送信情報ファイル(メッセージボディ)";
-
HTTPリクエストのメッセージボディとして送信する情報を定義した,エージェントホスト上の送信情報ファイル名(メッセージボディ)を定義します。JP1/AJS3 - ManagerおよびJP1/AJS3 - Agentのバージョンが12-50以降で,拡張モードを使用する場合に指定できます。
指定できる文字数は,1〜511(単位:バイト)です。
送信情報ファイル名(メッセージボディ)は,絶対パスで指定します。
送信情報ファイル名(メッセージボディ)に「"(ダブルクォーテーションマーク)」や「#」が含まれる場合は,キャスト文字(#)でキャストします。「"」は「#"」,「#」は「##」と記述します。
送信情報ファイル名(メッセージボディ)には,マクロ変数を指定できます。マクロ変数名は,「?AJS2xxxxx?」という形式の64バイト以内の文字列で指定します。xxxxxの部分に指定できる文字列は,A〜Z(大文字の英字),0〜9(アラビア数字),「.(ピリオド)」です。
htexmパラメーターに「n」を指定した場合,このパラメーターの指定は無視されます。
- htstf="ステータス格納ファイル名";
-
HTTPレスポンスに含まれるHTTPステータスの情報を格納するためにエージェントホスト上に作成されるステータス格納ファイル名を定義します。
指定できる文字数は,1〜511(単位:バイト)です。
ステータス格納ファイル名は,絶対パスで指定します。
ステータス格納ファイル名に「"(ダブルクォーテーションマーク)」や「#」が含まれる場合は,キャスト文字(#)でキャストします。「"」は「#"」,「#」は「##」と記述します。
ステータス格納ファイル名には,マクロ変数を指定できます。マクロ変数名は,「?AJS2xxxxx?」という形式の64バイト以内の文字列で指定します。xxxxxの部分に指定できる文字列は,A〜Z(大文字の英字),0〜9(アラビア数字),「.(ピリオド)」です。
- htspt={diff|same};
-
HTTPレスポンスとして受信したHTTPヘッダーとHTTPボディを,別のファイルに出力するか,同じファイルに出力するかを定義します。省略した場合,diffが仮定されます。
-
diff
受信データのヘッダー部分を受信ヘッダー格納ファイルに,ボディ部分を受信ボディ格納ファイルに記述します。
-
same
受信データのヘッダー部分とボディ部分を分けずに,受信ヘッダー格納ファイルだけに記述します。
-
- htrhf="受信ヘッダー格納ファイル名";
-
HTTPレスポンスとして受信したHTTPヘッダーの情報を格納するためにエージェントホスト上に作成される受信ヘッダー格納ファイル名を定義します。
指定できる文字数は,1〜511(単位:バイト)です。
受信ヘッダー格納ファイル名は,絶対パスで指定します。
受信ヘッダー格納ファイル名に空白文字が含まれる場合,「"(ダブルクォーテーションマーク)」で受信ヘッダー格納ファイル名を囲んでください。
受信ヘッダー格納ファイル名に「"(ダブルクォーテーションマーク)」や「#」が含まれる場合は,キャスト文字(#)でキャストします。「"」は「#"」,「#」は「##」と記述します。
受信ヘッダー格納ファイル名には,マクロ変数を指定できます。マクロ変数名は,「?AJS2xxxxx?」という形式の64バイト以内の文字列で指定します。xxxxxの部分に指定できる文字列は,A〜Z(大文字の英字),0〜9(アラビア数字),「.(ピリオド)」です。
- htrbf="受信ボディ格納ファイル名";
-
HTTPレスポンスとして受信したHTTPボディの情報を格納するためにエージェントホスト上に作成される受信ボディ格納ファイル名を定義します。
指定できる文字数は,1〜511(単位:バイト)です。
受信ボディ格納ファイル名は,絶対パスで指定します。
受信ボディ格納ファイル名に空白文字が含まれる場合,「"(ダブルクォーテーションマーク)」で受信ボディ格納ファイル名を囲んでください。
受信ボディ格納ファイル名に「"(ダブルクォーテーションマーク)」や「#」が含まれる場合は,キャスト文字(#)でキャストします。「"」は「#"」,「#」は「##」と記述します。
受信ボディ格納ファイル名には,マクロ変数を指定できます。マクロ変数名は,「?AJS2xxxxx?」という形式の64バイト以内の文字列で指定します。xxxxxの部分に指定できる文字列は,A〜Z(大文字の英字),0〜9(アラビア数字),「.(ピリオド)」です。
「htspt={diff|same};」で「diff」と定義した場合,「htrbf="受信ボディ格納ファイル名";」は省略できません。「same」を選択した場合は,「htrbf="受信ボディ格納ファイル名";」に定義されている値は無視されます。
- htcdm=終了コード1:HTTPステータスコード1,[HTTPステータスコード2...];
-
HTTPステータスコードごとのジョブの終了コードを指定します。このパラメーターは,複数指定できます。複数のジョブの終了コードを指定する場合は,「htcdm=終了コード1:HTTPステータスコード1 htcdm=終了コード2:HTTPステータスコード2」のように指定してください。
指定できる文字数は,1〜511(単位:バイト)です。指定できるジョブの終了コードの値は0〜9です。指定できるHTTPステータスコードの値は100〜999です。指定できる文字列は,0〜9(アラビア数字),「:(コロン)」です。
- so="標準出力ファイル名";
-
ジョブを実行するエージェントホスト上の標準出力ファイル名を定義します。
指定できる文字数は,1〜511(単位:バイト)です。ファイル名は絶対パスで指定することを推奨します。相対パスで指定した場合,HTTP接続ジョブを実行するOSがWindowsのときは,エージェントの環境設定で設定されているエージェントプロセス実行時のワークディレクトリ名からの相対パスになります。HTTP接続ジョブを実行するOSがLinuxのときは,実行ユーザーのホームディレクトリからの相対パス,ホームディレクトリが未定義のときは「/(ルート)」からの相対パスになります。
ファイル名中に「"(ダブルクォーテーションマーク)」や「#」が含まれる場合は,キャスト文字(#)でキャストします。「"」は「#"」,「#」は「##」と記述します。
標準出力ファイル名には,マクロ変数を指定できます。マクロ変数名は,「?AJS2xxxxx?」という形式の64バイト以内の文字列で指定します。xxxxxの部分に指定できる文字列は,A〜Z(大文字の英字),0〜9(アラビア数字),「.(ピリオド)」です。
「$JP1AJS2_JPQSTDOUTTEMP$」を指定した場合,標準出力ファイルは一時ファイルに出力されます。
- se="標準エラー出力ファイル名";
-
ジョブを実行するエージェントホスト上の標準エラー出力ファイル名を定義します。
指定できる文字数は,1〜511(単位:バイト)です。ファイル名は絶対パスで指定することを推奨します。相対パスで指定した場合,HTTP接続ジョブを実行するOSがWindowsのときは,エージェントの環境設定で設定されているエージェントプロセス実行時のワークディレクトリ名からの相対パスになります。HTTP接続ジョブを実行するOSがLinuxのときは,実行ユーザーのホームディレクトリからの相対パス,ホームディレクトリが未定義のときは「/(ルート)」からの相対パスになります。
ファイル名中に「"(ダブルクォーテーションマーク)」や「#」が含まれる場合は,キャスト文字(#)でキャストします。「"」は「#"」,「#」は「##」と記述します。
標準エラー出力ファイル名には,マクロ変数を指定できます。マクロ変数名は,「?AJS2xxxxx?」という形式の64バイト以内の文字列で指定します。xxxxxの部分に指定できる文字列は,A〜Z(大文字の英字),0〜9(アラビア数字),「.(ピリオド)」です。
- etm=n;
-
実行打ち切り時間を,実行開始時刻からの相対分で定義します。
指定できる値は,10進数の値で1〜1,440(単位:分)です。
- fd=実行所要時間;
-
終了遅延監視するジョブの実行所要時間を定義します。
指定できる値は,10進数の値で1〜1,440(単位:分)です。
- pr=n;
-
ジョブの実行優先順位を定義します。
指定できる値は,「1」〜「5」です。実行優先順位がいちばん低いのが「1」,いちばん高いのが「5」です。省略した場合,上位ジョブネットの定義に依存します。このパラメーターを省略し,かつ,最上位までのすべての上位ジョブネットに対してpr,またはniパラメーターを指定しなかった場合,ジョブの実行優先順位は環境設定パラメーターDEFAULTPRIORITYの設定値によって決まります。環境設定パラメーターDEFAULTPRIORITYの設定も省略した場合は,「1」が仮定されます。
環境設定パラメーターDEFAULTPRIORITYの詳細については,マニュアル「JP1/Automatic Job Management System 3 構築ガイド 20.4.2(108) DEFAULTPRIORITY」を参照してください。
- ex="実行エージェント名";
-
ジョブを実行する実行エージェント名または実行エージェントグループ名を定義します。
指定できる文字数は,1〜255(単位:バイト)です。
実行エージェント名中に「"(ダブルクォーテーションマーク)」や「#」が含まれる場合は,キャスト文字(#)でキャストします。「"」は「#"」,「#」は「##」と記述します。
実行エージェント名には,マクロ変数を指定できます。マクロ変数名は,「?AJS2xxxxx?」という形式の64バイト以内の文字列で指定します。xxxxxの部分に指定できる文字列は,A〜Z(大文字の英字),0〜9(アラビア数字),「.(ピリオド)」です。
- un="実行ユーザー名";
-
エージェントホストでジョブを実行する場合の,ジョブを実行するOSユーザー名を定義します。
指定できる文字数は,1〜63(単位:バイト)です。ユーザー名中に空白文字は指定できません。
ユーザー名中に「"(ダブルクォーテーションマーク)」や「#」が含まれる場合は,キャスト文字(#)でキャストします。「"」は「#"」,「#」は「##」と記述します。
実行ユーザー名には,マクロ変数を指定できます。マクロ変数名は,「?AJS2xxxxx?」という形式の64バイト以内の文字列で指定します。xxxxxの部分に指定できる文字列は,A〜Z(大文字の英字),0〜9(アラビア数字),「.(ピリオド)」です。
- jd={nm|ab|cod|mdf|exf};
-
終了判定種別を定義します。省略した場合,codが仮定されます。
cod以外を指定した場合,rjs,rje,rec,およびreiパラメーターを指定できません。また,abrパラメーターにyを指定できません。指定した場合はユニットの作成に失敗します。
-
nm:すべて正常終了とします。
-
ab:すべて異常終了とします。
-
cod:終了コードが指定値以下の場合は,正常終了とします。
-
mdf:ジョブの実行開始から実行終了までの間にファイルが更新されている場合は,正常終了とします。
-
exf:ジョブの実行終了時にファイルが作成されている場合は,正常終了とします。
-
- wth=n;
-
警告しきい値を定義します。
指定できる値は,0〜2,147,483,647です。
- tho=n;
-
異常しきい値を定義します。
指定できる値は,0〜2,147,483,647です。省略した場合,0が仮定されます。
- jdf="終了判定ファイル名";
-
ジョブを実行するエージェントホスト上の終了判定ファイル名を定義します。
指定できる文字数は,1〜511(単位:バイト)です。ファイル名は,絶対パスで指定することを推奨します。相対パスで指定した場合,HTTP接続ジョブを実行するOSがWindowsのときは,エージェントの環境設定で設定されているエージェントプロセス実行時のワークディレクトリ名からの相対パスになります。HTTP接続ジョブを実行するOSがLinuxのときは,実行ユーザーのホームディレクトリからの相対パス,ホームディレクトリが未定義のときは「/(ルート)」からの相対パスになります。
ファイル名中に「"(ダブルクォーテーションマーク)」や「#」が含まれる場合は,キャスト文字(#)でキャストします。「"」は「#"」,「#」は「##」と記述します。
終了判定ファイル名には,マクロ変数を指定できます。マクロ変数名は,「?AJS2xxxxx?」という形式の64バイト以内の文字列で指定します。xxxxxの部分に指定できる文字列は,A〜Z(大文字の英字),0〜9(アラビア数字),「.(ピリオド)」です。
- abr={y|n};
-
異常終了時リトライを定義します。省略した場合,nが仮定されます。
jdパラメーターにcodを指定した場合にだけ,yを指定できます。
-
y:異常終了時に自動リトライします。
-
n:異常終了時に自動リトライしません。
-
- rjs=自動リトライする終了コードの下限;
-
異常終了時に自動リトライする終了コードの下限を定義します。
異常終了時に自動リトライする場合(abrパラメーターにyを指定した場合)にだけ指定できます。
指定できる値は,1〜4,294,967,295です。異常しきい値(thoパラメーター)以下の値および自動リトライする終了コードの上限(rieパラメーター)より大きな値を指定した場合は,ユニットの作成に失敗します。
省略した場合,自動リトライする終了コードの下限は定義されないで,ジョブ実行時に「異常しきい値+1」が仮定されます。
- rje=自動リトライする終了コードの上限;
-
異常終了時に自動リトライする終了コードの上限を定義します。
異常終了時に自動リトライする場合(abrパラメーターにyを指定した場合)にだけ指定できます。
指定できる値は,1〜4,294,967,295です。異常しきい値(thoパラメーター)以下の値および自動リトライする終了コードの下限(risパラメーター)より小さな値を指定した場合は,ユニットの作成に失敗します。
省略した場合,自動リトライする終了コードの上限は定義されないで,ジョブ実行時に最大値(4,294,967,295)が仮定されます。
- rec=最大リトライ回数;
-
異常終了時に自動リトライする場合(abrパラメーターにyを指定した場合)にだけ,最大リトライ回数を定義します。
指定できる値は1〜12(単位:回)です。省略した場合,1が仮定されます。
- rei=リトライ間隔;
-
異常終了時に自動リトライする場合(abrパラメーターにyを指定した場合)にだけ,リトライ間隔を指定できます。
指定できる値は,1〜10(単位:分)です。省略した場合,1が仮定されます。
- ha={y|n};
-
ジョブの実行を保留するかを定義します。省略した場合,nが仮定されます。
-
y:保留します。
-
n:保留しません。
-
- eu={ent|def};
-
ジョブ実行時のJP1ユーザーを定義します。省略した場合,entが仮定されます。
-
ent:ジョブネットを登録したJP1ユーザーをジョブ実行時のJP1ユーザーとします。
-
def:ジョブを所有するJP1ユーザーをジョブ実行時のJP1ユーザーとします。
-
- 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:実行を開始しない。
-