Hitachi

JP1 Version 12 JP1/Automatic Job Management System 3 Command Reference


5.2.6 UNIX/PC job definition

This paragraph explains how to specify a definition for a UNIX/PC job.

The following gives the format of, and the parameters for a UNIX/PC job definition.

Format
[te="command-text";]
[sc="script-file-name";]
[prm="parameter";]
[wkp="work-path-name";]
[ev="environmental-variable-file-name";]
[env="environment-variable";]...
[si="standard-input-file-name";]
[so="standard-output-file-name";]
[se="standard-error-output-file-name";]
[soa={new|add};]
[sea={new|add};]
[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;]
[ts1="transfer-source-file-name-1";]
[td1="transfer-destination-file-name-1";]
[top1={sav|del};]
[ts2="transfer-source-file-name-2";]
[td2="transfer-destination-file-name-2";]
[top2={sav|del};]
[ts3="transfer-source-file-name-3";]
[td3="transfer-destination-file-name-3";]
[top3={sav|del};]
[ts4="transfer-source-file-name-4";]
[td4="transfer-destination-file-name-4";]
[top4={sav|del};]
[ha={y|n};]
[eu={ent|def};]
[jty={q|n};]
[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
te="command-text";

Define command text. You can set a character string of 1 to 1,023 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 #.

The command text can contain macro variables. In that case, you can set a character string of 1 to 1,023 bytes using the "macro-variable-name:passing-information-name" format. 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 (.).

sc="script-file-name";

For the Unix job, define a script file name on the agent host where the job is executed. For the PC job, define an execution file name on the agent host.

You can set a character string of 1 to 511 bytes. You can use either an absolute or relative path to specify the file name. If you specify a relative path, the system assumes it to be a relative path from the work path 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 file name can contain macro variables. In that case, you can set a character string of 1 to 511 bytes using the "macro-variable-name:passing-information-name" format. 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 (.).

prm="parameter";

Define a parameter for the target file.

You can set a character string of 1 to 1,023 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 #.

The parameter can contain macro variables. In that case, you can set a character string of 1 to 1,023 bytes using the "macro-variable-name:passing-information-name" format. 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 (.).

wkp="work-path-name";

Define the work path name using a full path name.

You can set a character string of 1 to 511 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 #.

If the job has the queuing attribute (jty=q), you can specify a macro variable.

ev="environment-variable-file-name";

Define the environmental variable file name for the agent host.

You can set a character string of 1 to 511 bytes. You can use either an absolute or relative path to specify the file name. If you specify a relative path, the system assumes it to be a relative path from the work path 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 #.

If the job has the queuing attribute (jty=q), you can specify a macro variable.

env="environment-variable";

Define an environment variable using the "environment-variable-name=value" format.

You can set a character string of 1 to 20,479 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 #.

The environment variable can contain macro variables. In that case, you can set a character string of 1 to 20,479 bytes using the "macro-variable-name:passing-information-name" format. 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 environment variable can contain macro variables. In that case, you can set a character string of 1 to 20,479 bytes using the "?AJS2xxxxxxxxx?:passing-information-name" format. Note that you can set a character string of 1 to 64 bytes in the ?AJS2xxxxxxxxx? part; only uppercase alphabetic characters and periods (.) can be used in the xxxxxxxxx part.

si="standard-input-file-name";

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

You can set a character string of 1 to 511 bytes. You can use either an absolute or relative path to specify the file name. If you specify a relative path, the system assumes it to be a relative path from the work path 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 #.

If the job has the queuing attribute (jty=q), you can specify a macro variable.

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. You can use either an absolute or relative path to specify the file name. If you specify a relative path, the system assumes it to be a relative path from the work path 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 #.

If the job has the queuing attribute (jty=q), by specifying $JP1AJS2_JPQSTDOUTTEMP$ you can output the standard output file as a temporary file.

You can also specify a macro variable if the job has the queuing attribute (jty=q).

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

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

You can set a character string of 1 to 511 bytes. You can use either an absolute or relative path to specify the file name. If you specify a relative path, the system assumes it to be a relative path from the work path 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 #.

If the job has the queuing attribute (jty=q), you can specify a macro variable.

soa={new|add};

Define an append option for a standard output file name. The default is new. This parameter is valid only when the standard output file name is specified in the so parameter.

  • new: Creates a new file.

  • add: Adds information to an existing file.

sea={new|add};

Define an append option for a standard error output file name. The default is new. This parameter is valid only when the name of the standard error output file is specified in the se parameter.

  • new: Creates a new file.

  • add: Adds information to an existing file.

etm=n;

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

You can set 1 to 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 with #. That is, use #" instead of ", and use ## instead of #.

If the job has the queuing attribute (jty=q), you can specify a macro variable.

un="execution-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 #.

If the job has the queuing attribute (jty=q), you can specify a macro variable.

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.

You can set a character string of 1 to 511 bytes. You can use either an absolute or relative path to specify the file name. If you specify a relative path, the system assumes it to be a relative path from the work path 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 #.

If the job has the queuing attribute (jty=q), you can specify a macro variable.

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.

ts1="transfer-source-file-name-1";

Define a full-path transfer source file name.

You can set a character string of 1 to 511 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 #.

If the job has the queuing attribute (jty=q), you can specify a macro variable.

td1="transfer-destination-file-name-1";

Define the name of a transfer destination file to be transferred to the agent host.

You can set a character string of 1 to 511 bytes. The default is the $JP1AJS2_JPQTEMPxx$ variable, where the xx part refers to the number of the transfer file ranging from 01 to 04. If this variable is assigned to the sc and prm parameters, you can execute the job without having to be aware of the transfer destination file name. If this variable is assigned to the sc and prm parameters, you can execute the job without having to be aware of the transfer destination file 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 #.

If the job has the queuing attribute (jty=q), you can specify a macro variable.

top1={sav|del};

Define the option to automatically delete the transfer destination file.

  • sav: Saves the file.

  • del: Deletes the file.

If you specify transfer source and destination file names with this parameter omitted, the system defaults to sav.

If you specify a transfer source file name without specifying a transfer destination file name and this parameter, this parameter defaults to del.

ts2="transfer-source-file-name-2";

Define a full-path transfer source file name.

You can set a character string of 1 to 511 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 #.

If the job has the queuing attribute (jty=q), you can specify a macro variable.

td2="transfer-destination-file-name-2";

Define the name of a transfer destination file to be transferred to the agent host.

You can set a character string of 1 to 511 bytes. The default is the $JP1AJS2_JPQTEMPxx$ variable, where the xx part refers to the number of the transfer file ranging from 01 to 04. If this variable is assigned to the sc and prm parameters, you can execute the job without having to be aware of the transfer destination file 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 #.

If the job has the queuing attribute (jty=q), you can specify a macro variable.

top2={sav|del};

Define the option to automatically delete the transfer destination file.

  • sav: Saves the file.

  • del: Deletes the file.

If you specify transfer source and destination file names with this parameter omitted, the system defaults to sav.

If you specify a transfer source file name without specifying a transfer destination file name and this parameter, this parameter defaults to del.

ts3="transfer-source-file-name-3";

Define a full-path transfer source file name.

You can set a character string of 1 to 511 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 #.

If the job has the queuing attribute (jty=q), you can specify a macro variable.

td3="transfer-destination-file-name-3";

Define the name of a transfer destination file to be transferred to the agent host.

You can set a character string of 1 to 511 bytes. The default is the $JP1AJS2_JPQTEMPxx$ variable, where the xx part refers to the number of the transfer file ranging from 01 to 04. If this variable is assigned to the sc and prm parameters, you can execute the job without having to be aware of the transfer destination file 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 #.

If the job has the queuing attribute (jty=q), you can specify a macro variable.

top3={sav|del};

Define the option to automatically delete the transfer destination file.

  • sav: Saves the file.

  • del: Deletes the file.

If you specify transfer source and destination file names with this parameter omitted, the system defaults to sav.

If you specify a transfer source file name without specifying a transfer destination file name and this parameter, this parameter defaults to del.

ts4="transfer-source-file-name-4";

Define a full-path transfer source file name.

You can set a character string of 1 to 511 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 #.

If the job has the queuing attribute (jty=q), you can specify a macro variable.

td4="transfer-destination-file-name-4";

Define the name of a transfer destination file to be transferred to the agent host.

You can set a character string of 1 to 511 bytes. The default is the $JP1AJS2_JPQTEMPxx$ variable, where the xx part refers to the number of the transfer file ranging from 01 to 04. If this variable is assigned to the sc and prm parameters, you can execute the job without having to be aware of the transfer destination file 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 #.

If the job has the queuing attribute (jty=q), you can specify a macro variable.

top4={sav|del};

Define the option to automatically delete the transfer destination file.

  • sav: Saves the file.

  • del: Deletes the file.

If you specify transfer source and destination file names with this parameter omitted, the system defaults to sav.

If you specify a transfer source file name without specifying a transfer destination file name and this parameter, this parameter defaults to del.

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.

jty={q|n};

Define whether the job has the queuing attribute. The default is q.

  • q: Has the queuing attribute.

  • n: Does not have the queuing attribute.

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.