12.4.13 Define Details - [HTTP Connection Job] dialog box

(1) Items displayed in common

The following figure shows the items displayed in common.

Figure 12‒126: Items displayed in common in the Define Details - [HTTP Connection Job] dialog box

The following explains the displayed items.

Unit name

Specify a unit name. Use a character string of up to 30 bytes. The default is HTTP-Connection-Job.

Comment

Specify a comment for the unit. Use a character string of up to 80 bytes. The default is a blank.

Exec-agent

Specify the execution agent name or execution agent group name to be assigned the task of HTTP connection job execution. Use a character string of up to 255 bytes. You can also specify a macro variable in this field. The default is a blank.

If you define the unit under a remote jobnet, this item is displayed with a text box.

If you define the unit not under a remote jobnet, this item is displayed with a combo box in which you can select an execution agent. You can also directly enter an execution agent name into the combo box. The content of the list component of the combo box differs depending on whether execution agent profiles are enabled, and the contents of those profiles.

When execution agent profiles are disabled

The list is empty.

When execution agent profiles are enabled

• If the specified job is associated with an execution agent profile

  The list displays the execution agents permitted for the specified job.

• If the specified job is not associated with an execution agent profile

  If the upper-level unit is associated with an execution agent profile, the list displays the execution agents permitted for the upper-level unit.

  If the upper-level unit is not associated with an execution agent profile, the list will be empty.

For details about execution agents, see 5.1.1 Execution agents in the manual JP1/Automatic Job Management System 3 Overview.

To Page Top

(2) Definition page

The following figure shows the Definition page in the Define Details - [HTTP Connection Job] dialog box.

Figure 12‒127: Definition page in the Define Details - [HTTP Connection Job] dialog box

Conn. configuration file name

Specify a name of the connection configuration file on the agent host, in which the connection information for HTTP connection is defined, by using a character string of no more than 511 bytes.

You can specify an absolute path name.

You can also specify a macro variable in this field. The default is a blank.

You cannot omit this item.

If the connection configuration file name contains double quotation marks (") or #, use a cast character (#) to specify them. For example, specify #" for ", and specify ## for #.

Request type

Select the request type (HTTP method) for using HTTP communication. The default is GET. You can select the following request types:

• GET

• POST

• PUT

• DELETE

Transmission information file

Select whether to use extended mode. To use extended mode, select Extended mode.

If extended mode is not used, the contents of the transmission information file name are sent as an HTTP request.

If extended mode is used, the contents of both the URL parameter and message body are sent as an HTTP request.

This item is displayed if the version of JP1/AJS3 - View is 12-50 or later.

Trans. info. file name

Specify this item if the versions of JP1/AJS3 - Manager and JP1/AJS3 - Agent are 12-10 or earlier, or if extended mode is not used. Specify a name of the transmission information file, on the agent host, in which the information to be sent as an HTTP request is defined, by using a character string of no more than 511 bytes.

You can specify an absolute path name.

You can also specify a macro variable in this field. The default is a blank.

If you leave this field blank, empty request information will be sent.

If the transmission information file name contains double quotation marks (") or #, use a cast character (#) to specify them. For example, specify #" for ", and specify ## for #.

URL parameter

Specify this item if extended mode is used when the versions of JP1/AJS3 - Manager and JP1/AJS3 - Agent are 12-50 or later. Specify the name of the transmission information file (URL parameter) on the agent host by using a character string of no more than 511 bytes. In this file, the information to be sent as the URL parameter for an HTTP request is defined.

You can specify an absolute path name.

You can also specify a macro variable in this field. The default is a blank.

If you leave this field blank, empty request information will be sent.

If the transmission information file name contains double quotation marks (") or #, use a cast character (#) to specify them. For example, specify #" for ", and specify ## for #.

This item is displayed if the version of JP1/AJS3 - View is 12-50 or later.

Message body

Specify this item if extended mode is used when the versions of JP1/AJS3 - Manager and JP1/AJS3 - Agent are 12-50 or later. Specify the name of the transmission information file (Message body) on the agent host by using a character string of no more than 511 bytes. In this file, the information to be sent as the Message body for an HTTP request is defined.

You can specify an absolute path name.

You can also specify a macro variable in this field. The default is a blank.

If you leave this field blank, empty request information will be sent.

If the transmission information file name contains double quotation marks (") or #, use a cast character (#) to specify them. For example, specify #" for ", and specify ## for #.

This item is displayed if the version of JP1/AJS3 - View is 12-50 or later.

Status file name

Specify a name of the status file, which is created on the agent host for storing the HTTP status information included in an HTTP response, by using a character string of no more than 511 bytes.

You can specify an absolute path name.

You can also specify a macro variable in this field. The default is a blank.

You cannot omit this item.

How to store received data

Specify whether to output an HTTP header and an HTTP body, both of which are received as an HTTP response, to separate files or the same file. The default is Output header/body to another file. You can select one of the following methods for storing received data:

• Output header/body to another file

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

• Output header/body to the same file

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

Received header file name

Specify a name of the received header file, which is created on the agent host to store the HTTP header information that is received as an HTTP response, by using a character string of no more than 511 bytes.

You can specify an absolute path name.

You can also specify a macro variable in this field. The default is a blank.

You cannot omit this item.

If the received header file name contains double quotation marks (") or #, use a cast character (#) to specify them. For example, specify #" for ", and specify ## for #.

Received body file name

Specify a name of the received body file, which is created on the agent host to store the HTTP body information that is received as an HTTP response, by using a character string of no more than 511 bytes.

You can specify an absolute path name.

You can also specify a macro variable in this field. The default is a blank.

If the received body file name contains double quotation marks (") or #, use a cast character (#) to specify them. For example, specify #" for ", and specify ## for #.

You cannot omit Received body file name if Output header/body to another file is selected for How to store received data. If Output header/body to the same file is selected, the value specified for Received body file name is ignored.

Priority

Select the priority of job execution. You can set None or 1 to 5. The highest priority is 5. The default is None.

When None is selected, the priority depends on the definition of the upper-level jobnet. If None is selected here when None is specified for all upper-level jobnets up to the highest-level jobnet, the priority value specified for the DEFAULTPRIORITY environment setting parameter is assumed. If the DEFAULTPRIORITY environment setting parameter is not set, 1 is assumed. For details about how to specify the environment setting parameter DEFAULTPRIORITY, see 20.4.2(108) DEFAULTPRIORITY in the JP1/Automatic Job Management System 3 Configuration Guide.

Note that, when the target host is a Linux machine, if a user who is not logged in as a superuser attempts to execute the jobs resulting from mapping and 4 or 5 is set, a runtime privilege error occurs.

The following gives the values you can specify, and their meanings.

Table 12‒44: Specifiable values and execution priority

Specifiable values	In Linux	In Windows
1	nice value +20	Lower than interactive processing
2	nice value +10	Lower than interactive processing
3	nice value	Equal to interactive processing
4	nice value -10	Higher than interactive processing
5	nice value -20	Higher than interactive processing

Supplementary note

Windows provides three priority stages. Specify the following three priority classes to start a job process.

• If the specified value is 1 or 2, the job process runs when the system is idle. (Specify IDLE_PRIORITY_CLASS which Windows stipulates.)

• If the specified value is 3, the job process runs as a general one. (Specify NORMAL_PRIORITY_CLASS which Windows stipulates.)

• If the specified value is 4 or 5, the job process runs before the thread of the process to which you assigned the above priority classes. (Specify HIGH_PRIORITY_CLASS which Windows stipulates.)

In Linux, JP1/AJS3 service's nice value used when jajs_spmd is executed is used as the default (base) nice value. When the JP1/AJS3 service's nice value has not been set, 20 is assumed as the nice value.

For example, when the priority setting is 1 and the nice value is 20, the priority value is calculated as shown below.

39 20 (initial value) + 20 (increment)

If the resulting value is not within the possible nice value range (0-39), the maximum value is 39 and the minimum value is 0.

Standard output

Specify the name of the standard output file on the agent host used for job execution. Use a character string of up to 511 bytes. We recommend specifying a file name by using an absolute path. If you specify a file name by using a relative path and Windows is used as the OS for executing an HTTP connection job, the path is relative to the work directory name when the agent process, which is set for the agent environment settings, is executed. If Linux is used as the OS for executing an HTTP connection job, the path is relative to the home directory of the execution user. If the home directory is not defined, the path is relative to "/ (root)".

You can also specify a macro variable in this field. The default is a blank.

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

For notes on defining the standard output file name, see 7.10.1 Notes on the standard output file and standard error output file in the JP1/Automatic Job Management System 3 System Design (Work Tasks) Guide.

Standard error

Specify the name of the standard error output file on the agent host used for job execution. Use a character string of up to 511 bytes. We recommend specifying a file name by using an absolute path. If you specify a file name by using a relative path and Windows is used as the OS for executing an HTTP connection job, the path is relative to the work directory name when the agent process, which is set for the agent environment settings, is executed. If Linux is used as the OS for executing an HTTP connection job, the path is relative to the home directory of the execution user. If the home directory is not defined, the path is relative to "/ (root)".

You can also specify a macro variable in this field. The default is a blank.

For notes on defining the standard error output file name, see 7.10.1 Notes on the standard output file and standard error output file in the JP1/Automatic Job Management System 3 System Design (Work Tasks) Guide.

Return code specification

Specify a job return code for each HTTP status code. For HTTP status codes for which no return codes are specified, the default return codes are specified.

This item is displayed if the version of JP1/AJS3 - View is 12-50 or later.

Add button

When you click the Add button, the Return Code Specification dialog box opens. Specify a return code for each HTTP status code by using a character string of no more than 511 bytes. The return code specified in the Return Code Specification dialog box is added to the list in the Return code specification area.

For details, see 12.4.14 Define Details - [HTTP Connection Job] - [Return Code Specification] dialog box.

Edit button

When you select a return code in the list and click the Edit button, the Return Code Specification dialog box opens. In this dialog box, you can edit the specification of the return code associated with an HTTP status code. The return code edited by using the Return Code Specification dialog box is added to the list.

For details, see 12.4.14 Define Details - [HTTP Connection Job] - [Return Code Specification] dialog box.

Delete button

When you select a return code in the list and click the Delete button, the specification of the selected return code is deleted.

End judgment

Select conditions for end judgment.

Rule

The displayed items vary depending on the rule selected in the Rule drop-down list. In the initial status, Judgment by threshold is selected and the thresholds for the Warning and Abnormal levels are displayed. You can select one of the following rules for end judgment.

• Always normal

  Always terminates the HTTP connection job normally. You can specify neither Warning nor Abnormal.

• Always abnormal

  Always terminates the HTTP connection job abnormally. You can specify neither Warning nor Abnormal.

• Normal if specified file exists

  Ends normally the HTTP connection job if the agent host contains the file specified in the File name text box that appears below the Rule drop-down list. You can use a character string of up to 511 bytes to specify a file. You can specify an absolute path name. You can also specify a macro variable in this field. The default is a blank.

• Normal if file was updated

  Ends normally the HTTP connection job if the agent host's file specified in the File name text box that appears below the Rule drop-down list is updated within the period from the job start to the job end. You can use a character string of up to 511 bytes to specify a file. You can specify an absolute path name. You can also specify a macro variable in this field. The default is a blank.

• Judgment by threshold

  Define reference values for the normal end and the warning end, or for the normal end and the abnormal end. In the Warning and Abnormal text boxes, you can set 0 to 2,147,483,647. The default is a blank for Warning, and 0 for Abnormal.

  By default, the system assumes an abnormal end if the return code is other than zero. If you set Warning, the system assumes a normal end if the return code is from zero to the value of Warning. It assumes warning end if the return code is larger than the value of Warning. If you set Abnormal, the system assumes a normal end if the return code is from zero to the value of Abnormal. It assumes an abnormal end if the return code is not larger than -1 or larger than the value of Abnormal. If you specify both Warning and Abnormal, the system assumes as follows:

  Normal end: The return code is from zero to the Warning value.

  Warning end: The return code is larger than the Warning value but not larger than the Abnormal value.

  Abnormal end: The return code is not larger than -1 or larger than the Abnormal value.

  In Linux, the return codes only have positive values from 0 to 255.

  If the program exits with a negative value, the return code is assumed to be 256 + (exit code). For example, if the program exists with -1, the system assumes 256 - 1 = 255.

Retry on abnormal end

Select whether to retry execution when the executable file ends in an error.

You can select this item if Judgment by threshold is selected for Rule.

You can specify No or Yes. The default is No.

Return code

If Yes is selected for Retry on abnormal end, specify the range of return codes for which to retry jobs.

• Greater than or equal to

  Specify the lowest return code for jobs that are to be retried. A job is retried when its return code is greater than or equal to this value.

  You can specify a value in the range from 1 to 4,294,967,295. The default is a blank. If you omit this setting, a value one greater than the value specified in Abnormal is used.

• Less than or equal to

  Specify the highest return code for jobs that are to be retried. A job is retried when its return code is less than or equal to this value.

  You can specify a value in the range from 1 to 4,294,967,295. The default is a blank. If you omit this setting, 4,294,967,295 is used.

Maximum retry times

When Yes is selected for Retry on abnormal end, specify the maximum number of times a job can be retried. You can specify a value in the range from 1 to 12. The default is 1.

Retry interval

When Yes is selected for Retry on abnormal end, specify how long the system waits between the error occurring and retrying the job. You can specify a value in the range from 1 to 10 (minutes). The default is 1.

User name

Specify the OS user name of JP1/AJS3 - Agent that executes the job. Use a character string of up to 63 bytes. You can specify a macro variable in this field. The default is a blank.

You must map this user name to User who registered or User who owns in Executed by. However, if the execution-user fixing function is configured for the upper-level unit, you must map this user name to a fixed user regardless of the contents of the Executed by field.

By default, the job is executed under the primary user name in the user mapping. For details about the user mapping, see the JP1/Base User's Guide.

For a job executed on a Windows host, information regarding the OS user is limited by the authority of the OS user. The specified OS user is used to access the files from the HTTP connection job.

If you restrict access permission for the execution user to the local server user, specify the OS user name using the host-name\user-name format.

Important

• Do not specify, as the file name, a path beginning with a network drive name. Specify a path beginning with a computer name such as \\computer-name\shared-folder\execution-file-name. Do not use a path beginning with a network drive name.

• You can specify only text files in the Detailed Definition - [HTTP Connection Job] dialog box.

• For details about characters that can be used for data contained in the connection configuration file or transmission information file, see the C. Files Used for HTTP Connection Jobs in the JP1/Automatic Job Management System 3 System Design (Work Tasks) Guide.

To Page Top

(3) Attributes page

The following figure shows the Attributes page in the Detailed Definition - [HTTP Connection Job] dialog box.

Figure 12‒128: Attributes page in the Detailed Definition - [HTTP Connection Job] dialog box

The following explains the displayed items.

Hold

Specify whether to place the unit in the hold status in advance. You can specify No or Yes. The default is No.

Type

Set the unit type to Normal or Recovery. The default is Normal.

Set timeout period

Select whether to set a time-out period for job execution. You can specify No or Yes. The default is No.

Timeout period

If you select Yes in Set timeout period, specify a time-out period in minutes. You can set 1 to 1,440 minutes. The default is a blank.

Delayed end

Specify whether to monitor delayed end of jobs based on time required for execution. Select the Time-required-for-execution check box to monitor delayed end of jobs. The check box is not selected by default.

If you select the Time-required-for-execution check box, specify the time (in minutes) required for job execution. You can specify a value in the range from 1 to 1,440.

For details about cautionary notes on monitoring of delayed end of jobs based on time required for execution, see 5.1.3 End delay monitoring based on time-required-for-execution in the JP1/Automatic Job Management System 3 System Design (Work Tasks) Guide.

Owner

Specify the owner of the unit. Use a character string of up to 31 bytes. The default is the login JP1 user name. Note that if the upper-level unit-attribute inheritance function has been set for the upper-level jobnet, the default is the owner of the upper-level unit.

JP1 resource group

Specify a JP1 resource group name. Use a character string of up to 63 bytes. You can specify alphanumeric characters and underscores (_). The default is the JP1 resource group name of the upper-level unit. If you specify a blank, you are not authorized to access this group.

Executed by

Select the user who executes the job. The default is User who registered. You can select the following items.

• User who registered

  Performs user mapping for the JP1 user who registered the job. The system executes the job under the converted OS user account.

• User who owns

  Performs user mapping for the JP1 user who owns the job. The system executes the job under the converted user account.

You must perform user mapping on the host where you want to execute the job so that the specified user is converted to a OS user.

If the execution-user fixing function is configured for the upper-level unit, the execution user conforms to the unit-attribute profile regardless of the contents of this field.

To Page Top