5.2.27 HTTP Connection job definition

This paragraph explains how to specify a definition for an HTTP Connection job.

The following gives the format and parameters for an HTTP Connection job definition.

Format

htcfl="connection-configuration-file-name";
[htknd={GET|POST|PUT|DELETE};]
[htexm={y|n};]
[htrqf="transmission-information-file-name";]
[htrqu="transmission-information-file-name-(URL-parameter)";]
[htrqm="transmission-information-file-name-(message-body)";]
htstf="statuses-store-file-name";
[htspt={diff|same};]
htrhf="received-header-store-file-name";
[htrbf="received-body-store-file-name";]
[htcdm=return-code-1:HTTP-status-code-1,[HTTP-status-code-2...];]
[so="standard-output-file-name";]
[se="standard-error-output-file-name";]
[etm=n;]
[fd=time-required-for-execution;]
[pr=n;]
[ex="execution-agent-name";]
[un="target-user-name";]
[jd={nm|ab|cod|mdf|exf};]
[wth=n;]
[tho=n;]
[jdf="end-judgment-file-name";]
[abr={y|n};]
[rjs=lower-limit-of-return-codes-to-be-retried-automatically;]
[rje=upper-limit-of-return-codes-to-be-retried-automatically;]
[rec=maximum-number-of-retry-executions;]
[rei=retry-interval;] 
[ha={y|n};]
[eu={ent|def};]
[mm={and|or};]
[nmg={y|n};]
[eun=name-of-the-unit-whose-end-is-being-waited-for;]
[ega={exec|execdeffer|none};]
[uem={y|n};]

Parameters

htcfl="connection-configuration-file-name";

Define the name of the connection configuration file on the agent host. In this file, connection information for HTTP connection is defined.

You can set a character string of 1 to 511 bytes.

Specify the connection configuration file name by using the absolute path.

If you want to use a double quotation mark (") or a hash mark (#) as a character, prefix the character by #. That is, use #" instead of " and use ## instead of #.

You can specify a macro variable for the connection configuration file name. Set macro-variable-name as a character string of no more than 64 bytes, using the format ?AJS2xxxxx?. In the xxxxx part, you can use uppercase alphabetic characters (A to Z), numerals (0 to 9), and periods (.).

htknd={GET|POST|PUT|DELETE};

Define the request type (HTTP method) used for HTTP communication. The default is GET.

GET
POST
PUT
DELETE

htexm={y|n};

Define whether to use extended mode. You can specify this parameter if the versions of JP1/AJS3 - Manager and JP1/AJS3 - Agent are 12-50 or later.

The default is n.

y

Extended mode is used. The contents of both the transmission information file (URL parameter) and the transmission information file (message body) are sent as an HTTP request.
n

Extended mode is not used. The contents of only the transmission information file are sent as an HTTP request.

htrqf="transmission-information-file-name";

Define the name of the transmission information file on the agent host. In this file, information to be sent as an HTTP request is defined.

You can set a character string of 1 to 511 bytes.

Specify the transmission information file name by using the absolute path.

If you want to use a double quotation mark (") or a hash mark (#) as a character, prefix the character by #. That is, use #" instead of " and use ## instead of #.

You can specify a macro variable for the transmission information file name. Set macro-variable-name as a character string of no more than 64 bytes, using the format ?AJS2xxxxx?. In the xxxxx part, you can use uppercase alphabetic characters (A to Z), numerals (0 to 9), and periods (.).

Whether the contents of the transmission information file are to be sent as a URL parameter or a message body depends on the request type of the HTTP request. If you want to specify the type of information to be sent independently of the request type, we recommend that you use the following specification: Specify y for the htexm parameter, in addition to using htrqu="transmission-information-file-(URL-parameter)"; and htrqm="transmission-information-file-(message-body)";.

The specification of this parameter is overridden if y is specified for the htexm parameter.

htrqu="transmission-information-file-name-(URL-parameter)";

Define the name of the transmission information file (URL parameter) that exists on the agent host and contains the information to be sent as the URL parameter of an HTTP request. You can specify this parameter if extended mode is used when the versions of JP1/AJS3 - Manager and JP1/AJS3 - Agent are 12-50 or later.

You can set a character string of 1 to 511 bytes.

Specify the absolute path of the transmission information file (URL parameter).

If the name of the transmission information file (URL parameter) includes a double quotation mark (") or hash mark (#), cast the character by prefixing it with a cast character (#). To cast a quotation mark ("), specify #". To cast a hash mark (#), specify ##.

You can specify a macro variable for the transmission information file name (URL parameter). Set macro-variable-name as a character string of no more than 64 bytes, using the format ?AJS2xxxxx?. In the xxxxx part, you can use uppercase alphabetic characters (A to Z), numerals (0 to 9), and periods (.).

The specification of this parameter is overridden if n is specified for the htexm parameter.

htrqm="transmission-information-file-name-(message-body)";

Define the name of the transmission information file (message body) that exists on the agent host and contains the information to be sent as the message body of an HTTP request. You can specify this parameter if extended mode is used when the versions of JP1/AJS3 - Manager and JP1/AJS3 - Agent are 12-50 or later.

You can set a character string of 1 to 511 bytes.

Specify the absolute path of the transmission information file (message body).

If the name of the transmission information file (message body) includes a double quotation mark (") or hash mark (#), cast the character by prefixing it with a cast character (#). To cast a quotation mark ("), specify #". To cast a hash mark (#), specify ##.

You can specify a macro variable for the transmission information file name (message body). Set macro-variable-name as a character string of no more than 64 bytes, using the format ?AJS2xxxxx?. In the xxxxx part, you can use uppercase alphabetic characters (A to Z), numerals (0 to 9), and periods (.).

The specification of this parameter is overridden if n is specified for the htexm parameter.

htstf="statuses-store-file-name";

Define the statuses store file name that is to be created on the agent host in order to store the HTTP status information contained in the HTTP response.

You can set a character string of 1 to 511 bytes.

Specify the statuses store file name by using the absolute path.

If you want to use a double quotation mark (") or a hash mark (#) as a character, prefix the character by #. That is, use #" instead of " and use ## instead of #.

You can specify a macro variable for the statuses store file name. Set macro-variable-name as a character string of no more than 64 bytes, using the format ?AJS2xxxxx?. In the xxxxx part, you can use uppercase alphabetic characters (A to Z), numerals (0 to 9), and periods (.).

htspt={diff|same};

Define whether the HTTP header and HTTP body that are received as an HTTP response are to be output to separate files, or to the same file. The default is diff.

diff

The header of the received data is written in the received header file. The body is written in the received body file.
same

The received data, including the header and body, is written to the received header file only.

htrhf="received-header-store-file-name";

Define the received header store file name that is to be created on the agent host in order to store the information of the HTTP header received as an HTTP response.

You can set a character string of 1 to 511 bytes.

Specify the received header store file name by using the absolute path.

If the received header store file name contains a space character, enclose the received header store file name by double quotation marks (").

If you want to use a double quotation mark (") or a hash mark (#) as a character, prefix the character by #. That is, use #" instead of " and use ## instead of #.

You can specify a macro variable for the received header store file name. Set macro-variable-name as a character string of no more than 64 bytes, using the format ?AJS2xxxxx?. In the xxxxx part, you can use uppercase alphabetic characters (A to Z), numerals (0 to 9), and periods (.).

htrbf="received-body-store-file-name";

Define the received body store file name that is to be created on the agent host in order to store the information of the HTTP body received as an HTTP response.

You can set a character string of 1 to 511 bytes.

Specify the received body store file name by using the absolute path.

If the received body store file name contains a space character, enclose the received body store file name by double quotation marks (").

If you want to use a double quotation mark (") or a hash mark (#) as a character, prefix the character by #. That is, use #" instead of " and use ## instead of #.

You can specify a macro variable for the received body store file name. Set macro-variable-name as a character string of no more than 64 bytes, using the format ?AJS2xxxxx?. In the xxxxx part, you can use uppercase alphabetic characters (A to Z), numerals (0 to 9), and periods (.).

If you define diff for htspt={diff|same};, you cannot omit htrbf="received-body-store-file-name";. If you select same, the value defined in htrbf="received-body-store-file-name"; is ignored.

htcdm=return-code-1:HTTP-status-code-1,[HTTP-status-code-2...];

Specify a job return code for each HTTP status code. You can specify multiple instances of this parameter. To specify multiple job return codes, use the following specification format: htcdm=return-code-1:HTTP-status-code-1 htcdm=return-code-2:HTTP-status-code-2 ...

You can set a character string of 1 to 511 bytes. For a job return code, you can specify a value in the range from 0 to 9. For an HTTP status code, you can specify a value in the range from 100 to 999. You can use only numeric characters (0 to 9) and colons (:).

so="standard-output-file-name";

Define a file name for standard output on the agent host where the job is executed.

You can set a character string of 1 to 511 bytes. We recommend that you specify the file name by using the absolute path. Assume that you specify the file name by using the relative path when the HTTP connection job is executed by Windows. In such a case, the path will be the relative path from the work directory used when the agent process (set in the environment settings of the agent) is executed. If the HTTP connection job is executed by Linux, the path will be the relative path from the home directory for the execution user. If the home directory has not been defined, the path will be the relative path from the root directory (/).

If you want to use a double quotation mark (") or a hash mark (#) as a character, prefix the character by #. That is, use #" instead of " and use ## instead of #.

You can specify a macro variable for the standard output file name. Set macro-variable-name as a character string of no more than 64 bytes, using the format ?AJS2xxxxx?. In the xxxxx part, you can use uppercase alphabetic characters (A to Z), numerals (0 to 9), and periods (.).

If you specify $JP1AJS2_JPQSTDOUTTEMP$ , the standard output file is output to a temporary file.

se="standard-error-output-file-name";

Define a file name for standard error output on the agent host where the job is executed.

If you want to use a double quotation mark (") or a hash mark (#) as a character, prefix the character by #. That is, use #" instead of " and use ## instead of #.

You can specify a macro variable for the standard error output file name. Set macro-variable-name as a character string of no more than 64 bytes, using the format ?AJS2xxxxx?. In the xxxxx part, you can use uppercase alphabetic characters (A to Z), numerals (0 to 9), and periods (.).

etm=n;

Define the time-out period using the relative minutes from the start time.

You can specify a decimal value between 1 and 1,440 (minutes).

fd=time-required-for-execution;

Define the time-required-for-execution within which the job is expected to be terminated.

You can specify a decimal value between 1 and 1,440 (minutes).

pr=n;

Define the priority of job execution.

You can set 1 to 5. The lowest priority of execution is 1, while the highest priority is 5. The default value depends on the definition of the upper-level jobnets. If this parameter is not specified, and if the pr parameter and the ni parameter of all upper-level jobnets of the job are not specified, the priority of the job is assumed to be the value specified for the DEFAULTPRIORITY environment setting parameter (If no value is specified for the DEFAULTPRIORITY environment setting parameter, then the priority is assumed to be 1). For details about the DEFAULTPRIORITY environment setting parameter, see 20.4.2(108) DEFAULTPRIORITY in the JP1/Automatic Job Management System 3 Configuration Guide.

ex="execution-agent-name";

Define the name of the execution agent or execution agent group that is used to execute jobs.

You can set a character string of 1 to 255 bytes.

If you want to use a double quotation mark (") or a hash mark (#) as a character, prefix the character by #. That is, use #" instead of " and use ## instead of #.

You can specify a macro variable for the execution agent name. Set macro-variable-name as a character string of no more than 64 bytes, using the format ?AJS2xxxxx?. In the xxxxx part, you can use uppercase alphabetic characters (A to Z), numerals (0 to 9), and periods (.).

un="target-user-name";

Define the name of the OS user responsible for executing a job in the agent host.

You can set a character string of 1 to 63 bytes. You cannot specify a space character in the user name.

If you want to use a double quotation mark (") or a hash mark (#) as a character, prefix the character by #. That is, use #" instead of " and use ## instead of #.

You can specify a macro variable for the target user name. Set macro-variable-name as a character string of no more than 64 bytes, using the format ?AJS2xxxxx?. In the xxxxx part, you can use uppercase alphabetic characters (A to Z), numerals (0 to 9), and periods (.).

jd={nm|ab|cod|mdf|exf};

Define the type of end judgment. The default is cod.

If you specify a value other than cod, you cannot specify the rjs, rje, rec, and rei parameters. In addition, you cannot specify y for the abr parameter. If you specify y, unit creation fails.

nm: Always assumes a normal end.
ab: Always assumes an abnormal end.
cod: Normal end if the return code is below a set value
mdf: Normal end if the file is refreshed during the period between the start and the end of job execution
exf: Normal end if a file is created at the end of job execution

wth=n;

Define the warning threshold.

You can set 0 to 2,147,483,647.

tho=n;

Define the abnormal threshold.

You can set 0 to 2,147,483,647. The default is 0.

jdf="end-judgment-file-name";

Define an end judgment file name on the agent host for job execution.

If you want to use a double quotation mark (") or a hash mark (#) as a character, prefix the character by #. That is, use #" instead of " and use ## instead of #.

The end judgment file name can contain macro variables. Set macro-variable-name as a character string of no more than 64 bytes, using the format ?AJS2xxxxx?. In the xxxxx part, you can use uppercase alphabetic characters (A to Z), numerals (0 to 9), and periods (.).

abr={y|n};

Define whether retrying on an abnormal end is enabled. If you omit this option, the system assumes n.

You can specify y only when you specify cod for the jd parameter.

y: Automatic retries are performed if an abnormal end occurs.
n: Automatic retries are not performed if an abnormal end occurs.

rjs= lower-limit-of-return-codes-to-be-retried-automatically;

Define the lower limit of the return codes to be retried automatically if an abnormal end occurs.

This option can be specified only if automatic retrying is performed when an abnormal end occurs (y is specified for the abr parameter).

You can specify a value from 1 to 4,294,967,295. If you specify a value equal to or smaller than the abnormal threshold (the tho parameter) and a value greater than the upper limit on return codes to be automatically retried (the rie parameter), unit creation fails.

If this option is omitted, a lower limit for the return codes to be retried automatically is not defined, and abnormal-threshold + 1 is assumed when the job is executed.

rje=upper-limit-of-return-codes-to-be-retried-automatically;

Define the upper limit of the return codes to be retried automatically if an abnormal end occurs.

This option can be specified only if automatic retrying is performed when an abnormal end occurs (y is specified for the abr parameter).

You can specify a value from 1 to 4,294,967,295. If you specify a value equal to or smaller than the abnormal threshold (the tho parameter) and a value smaller than the lower limit of the return codes to be retried automatically (the ris parameter), unit creation fails.

If this option is omitted, an upper limit of the return codes to be automatically retried is not defined, and the maximum value (4,294,967,295) is assumed when the job is executed.

rec=maximum-number-of-retry-executions;

Define the maximum number of retry executions only when automatic retry is performed for an abnormal end (y is specified for the abr parameter).

You can specify a value from 1 to 12 (times). If you omit this option, the system assumes 1.

rei=retry-interval;

Define the retry interval only when automatic retrying is performed for an abnormal end (y is specified for the abr parameter).

You can specify a value from 1 to 10 (minutes). If you omit this option, the system assumes 1.

ha={y|n};

Define whether to suspend job execution. The default is n.

y: Suspends jobnet execution.
n: Does not suspend jobnet execution.

eu={ent|def};

Define the JP1 user who executes the job. The default is ent.

ent: The JP1 user who registered the jobnet executes the job.
def: The JP1 user who owns the job executes the job.

mm={and|or};

Define the wait method with respect to the specified units whose ends are being waited for.

The default is and.

and: Start executing at completion of all units whose ends are being waited for.
or: Start executing at completion of one of the units whose ends are being waited for.

nmg={y|n};

Define the behavior when there are no generations of the root jobnet for the specified unit whose end is being waited for.

The default is n.

y: Start executing.
n: Do not start executing.

eun=name-of-the-unit-whose-end-is-being-waited-for;

Define the full-path name of a unit whose end is being waited for.

To specify multiple units, repeat the parameter. You can specify a maximum of 32 units.

You can use a character string of 1 to 930 bytes as the unit name.

ega={exec|execdeffer|none};

Specify the behavior when a jobnet with start conditions is specified as the jobnet whose end is being waited for and the execution generation ends abnormally.

If you omit this option, the system assumes none.

exec: Start executing.
execdeffer: Do not start executing. However, if the execution generation is in the Skipped so not exe. status, start executing.
none: Do not start executing.

uem={y|n};

Specify the behavior when a jobnet with start conditions is specified as the jobnet whose end is being waited for and the monitoring generation is in the Unmonitored + Ended status.

If you omit this option, the system assumes n.

y: Start executing.
n: Do not start executing.

To Page Top