5.2.24 UNIX/PC custom job definition

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

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

Format

[cty="custom-job-class-name";]
[te="command-text";]
[sc="script-file-name";]
[prm="parameter";]
[env="environment-variable";]
[so="standard-output-file-name";]
[se="standard-error-output-file-name";]
[etm=n;]
[fd=time-required-for-execution;]
[pr=n;]
[ex="job-execution-agent-host-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};]
[wkp="work-path-name";]
[ev="environmental-variable-file-name";]
[si="standard-input-file-name";]
[soa={new|add};]
[sea={new|add};]
[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};]
[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

cty="custom-job-class-name";

Define a custom job class name for each linked program.

You can define the types of custom job class names given below.

For standard custom jobs

The following gives the class names to be defined to use the custom jobs supported in the standard JP1/AJS3 configuration.

Linked program name	Class name
JP1/FTP	`JP1FTP`
JP1/AJS3 for Enterprise Applications	`JP1AMR3`
JP1/AJS3 for Enterprise Applications	`JP1AMR3BW`
JP1/AJS3 for Enterprise Applications	`JP1AMR3CP`
JP1/DH - AJE	`DHAJEW`
JP1/CPA	`CPALINK`

For custom PC jobs and custom Unix jobs

Set custom-job-class-name as a character string of no more than 16 bytes, by using the format USER_any-name (USER_ cannot be omitted).

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 you specify any of the following, the icon of the custom job does not appear in the icon list of the Jobnet Editor window:

- " (double quotation mark)

- *

- /

- : (colon)

- <

- >

- ?

- \

- |

- MS-DOS device names (NUL, CON, AUX, CLOCK$, COM1 to COM9, LPT1 to LPT9, PRN)

- Character strings beginning with MS-DOS-device-name. (period)

Also, the following characters cannot be specified:

- Single-byte space

- Control characters such as a line-feed character or tab character

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 #.

You can specify a macro variable.

sc="script-file-name";

For the Unix job, define a full-path script file name. For the PC job, define a full-path executable 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 #.

You can specify a macro variable.

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 #.

You can specify a macro variable.

env="environment-variable";

Define an environment variable.

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 #.

For notes on defining environment variables, see A. Notes on Defining Environment Variables and an Environment Variable File.

You can specify a macro variable.

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

Define a full-path standard output 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 #.

By specifying $JP1AJS2_JPQSTDOUTTEMP$ , you can output the standard output file as a temporary file.

You can specify a macro variable.

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

Define a full-path standard error output 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 #.

You can specify a macro variable.

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 depends on the definition of upper-level jobnet. 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="job-execution-agent-host-name";

Define the name of the JP1/AJS3 - Agent host to execute a job.

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.

un="execution-user-name";

To use the JP1/AJS3 - Agent host to execute a job, define the user name of the user responsible for job execution.

You can set a character string of 1 to 63 bytes. The user name cannot contain any space characters.

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.

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 y for the abr parameter. If you specify y, the KAVS0674-E message is output, and the unit cannot be created.

nm: Always assumes a normal end.
ab: Always assumes an abnormal end.
cod: Normal end if the return code is below a specified value.
mdf: Normal end if the file is refreshed.
exf: Normal end if a file is created.

wth=n;

Define the threshold for the end with warning.

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

tho=n;

Define the threshold for the abnormal end.

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

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

Define a full-path end judgment 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 #.

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 when automatic retrying is performed for an abnormal end.

You can define the lower limit only when you specify y 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 and a value greater than the upper limit of the return codes to be retried automatically, the KAVS0668-E message is output, and the unit cannot be created.

If you omit this option, the system assumes abnormal-threshold + 1 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 automatic retrying is performed for an abnormal end.

You can define the upper limit only when you specify y 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 and a value smaller than the lower limit of the return codes to be retried automatically, the KAVS0668-E message is output, and unit creation fails.

If you omit this option, the system assumes the maximum value (4,294,967,295) when the job is executed.

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

Define the maximum number of retry executions when automatic retrying is performed for an abnormal end.

You can specify this parameter only when you specify y 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 when automatic retrying is performed for an abnormal end.

You can specify this parameter only when you specify y 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.

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.

For a work path name including a double quotation mark (") or a hash mark (#), prefix the character by #. That is, use #" instead of " and use ## instead of #.

This cannot be specified in custom PC jobs.

You can specify a macro variable.

ev="environmental-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 path or a 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.

For a file name including a double quotation mark (") or a hash mark (#), prefix the character by #. That is, use #" instead of " and use ## instead of #.

This cannot be specified in custom PC jobs.

You can specify a macro variable.

For notes on defining environment variables, see A. Notes on Defining Environment Variables and an Environment Variable File.

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

Define the name of a standard input file on the agent host executing the job.

For a file name including a double quotation mark (") or a hash mark (#), prefix the character by #. That is, use #" instead of " and use ## instead of #.

This cannot be specified in custom PC jobs.

You can specify a macro variable.

soa={new|add};

Define the append option for a standard output file name. The default is new. This parameter is invalid if the so parameter does not specify the standard output file name.

This cannot be specified in custom PC jobs.

new: Creates a new file.
add: Adds information to an existing file.

sea={new|add};

Define the append option for a standard error output file name. The default is new. This parameter is invalid if the se parameter does not specify the standard error output file name.

This cannot be specified in custom PC jobs.

new: Creates a new file.
add: Adds information to an existing file.

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

Define the name of a transfer source file using a full path name.

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

For a file name including a double quotation mark (") or a hash mark (#), prefix the character by #. That is, use #" instead of " and use ## instead of #.

This cannot be specified in custom PC jobs.

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 means the transfer file's number ranging from 01 to 04.

With this variable specified in the sc or prm parameter, you can execute the job without having to be aware of the transfer destination file name.

For a file name including a double quotation mark (") or a hash mark (#), prefix the character by #. That is, use #" instead of " and use ## instead of #.

This cannot be specified in custom PC jobs.

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 the transfer source file name and the transfer destination file name without specifying this parameter, the system assumes sav.

If you specify the transfer source file name without specifying this parameter, the system assumes del.

This cannot be specified in custom PC jobs.

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

Define the name of a transfer source file using a full path name.

1 to 511 bytes of characters can be specified.

For a file name including a double quotation mark (") or a cast character (#), prefix the character by #. That is, use #" instead of " and use ## instead of #.

This cannot be specified in custom PC jobs.

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.

1 to 511 bytes of characters can be specified.

The default is the $JP1AJS2_JPQTEMPxx$ variable, where the xx part means the transfer file's number ranging from 01 to 04.

With this variable specified in the sc or prm parameter, you can execute the job without having to be aware of the transfer destination file name.

For a file name including a double quotation mark (") or a hash mark (#), prefix the character by #. That is, use #" instead of " and use ## instead of #.

This cannot be specified in custom PC jobs.

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 the transfer source file name and the transfer destination file name without specifying this parameter, the system assumes sav.

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

This cannot be specified in custom PC jobs.

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

Define the name of a transfer source file using a full path name.

1 to 511 bytes of characters can be specified.

For a file name including a double quotation mark (") or a hash mark (#), prefix the character by #. That is, use #" instead of " and use ## instead of #.

This cannot be specified in custom PC jobs.

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.

1 to 511 bytes of characters can be specified.

The default is the $JP1AJS2_JPQTEMPxx$ variable, where the xx part means the transfer file's number ranging from 01 to 04.

With this variable specified in the sc or prm parameter, you can execute the job without having to be aware of the transfer destination file name.

For a file name including a double quotation mark (") or a cast character (#), prefix the character by #. That is, use #" instead of " and use ## instead of #.

This cannot be specified in custom PC jobs.

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 the transfer source file name and the transfer destination file name without specifying this parameter, the system assumes sav.

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

This cannot be specified in custom PC jobs.

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

Define the name of a transfer source file using a full path name.

1 to 511 bytes of characters can be specified.

For a file name including a double quotation mark (") or a cast character (#), prefix the character by #. That is, use #" instead of " and use ## instead of #.

This cannot be specified in custom PC jobs.

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.

1 to 511 bytes of characters can be specified.

The default is the $JP1AJS2_JPQTEMPxx$ variable, where the xx part means the transfer file's number ranging from 01 to 04.

With this variable specified in the sc or prm parameter, you can execute the job without having to be aware of the transfer destination file name.

For a file name including a double quotation mark (") or a cast character (#), prefix the character by #. That is, use #" instead of " and use ## instead of #.

This cannot be specified in custom PC jobs.

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 the transfer source file name and the transfer destination file name without specifying this parameter, the system assumes sav.

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

This cannot be specified in custom PC jobs.

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