Hitachi

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

5.2.26 Flexible job definition

This paragraph explains how to specify a definition for a flexible job.

The following gives the format and parameters for a flexible job definition.

Format
[ex="relay-agent-name";]
da="destination-or-broadcast-agent";
[fxg={none|sync|async};]
sc="name-of-the-file-to-be-executed-on-the-agent-host";
[prm="parameter";]
[env="environment-variable";]...
[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
ex="relay-agent-name";

Define the name of the execution agent or execution agent group to be the relay agent. You do not have to specify this parameter if relay is not performed.

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

The Relay agent 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 (.).

da="destination-or-broadcast-agent";

Define the host name, IP address, or DNS name of the destination to which execution of the flexible job is to be requested. jp1hosts information or jp1hosts2 information is not referenced.

When broadcasting is used, the destination of the execution request is a broadcast agent.

When a load balancer is used without broadcasting, the destination of the execution request is the load balancer.

When neither broadcasting nor a load balancer is used, the destination of the execution request is the agent host on which the flexible job is to be executed.

You can set a character string of 1 to 128 bytes. Specifying this parameter is mandatory.

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 Destination 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 (.).

fxg={none|sync|async};

Specify the broadcast execution method for a flexible job. If you omit this option, the system assumes none.

  • none: Executes a normal flexible job without performing broadcast execution.

  • sync: Performs broadcast execution in synchronous mode.

  • async: Performs broadcast execution in asynchronous mode.

sc="name-of-the-file-to-be-executed-on-the-agent-host";

Define the name of the file, on the agent host, to be executed.

You can set a character string of 1 to 511 bytes. Specify the file name by using the absolute path. If the file to be executed is located directly under the path specified by the environment variable PATH, you can specify the file name only. Specifying this parameter is mandatory.

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 name of the file (to be executed on the agent host). 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 the parameter to be used for the file (to be executed on the agent host).

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. 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 (.).

env="environment-variable";

While a job is being executed, the environment variables set at job execution, the system environment variables, or the environment variables set in the local login script for the execution user (OS user) are enabled. You can add new variables and then execute the job. Define the environment variables to be added in the format of environment-variable-name=value.

You can set a character string of 1 to 10,240 bytes. If you have specified multiple env parameters, you can specify environment variables up to 10,240 bytes in total.

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. 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 (.).

For details about the environment variables to be set at job execution, see 1.4.2 Environment variables set when a job is executed from JP1/AJS3.

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

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 start and end of job process execution on the destination agent

  • exf: Normal end if the file is refreshed at the end of job process execution on the destination agent

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 flexible job execution.

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

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

Copyright (C) 2019, 2022, Hitachi, Ltd.

Copyright (C) 2019, 2022, Hitachi Solutions, Ltd.