5.2.28 Custom event job definition

This paragraph explains how to specify a definition for a custom event job.

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

Format

cety="identifier";
[jpoif=macro-variable-name:passing-information-name;]...
[etm=n;]
[fd=time-required-for-execution;]
[ex="execution-agent-name";]
[ha={y|n};]
[eu={ent|def};]
[ets={kl|nr|wr|an};]
[mm={and|or};]
[nmg={y|n};]
[eun=name-of-the-unit-whose-end-is-being-waited-for;]...
[ega={exec|execdeffer|none};]
[uem={y|n};]
[cprm="parameter-name=value";]...

Parameters

cety="identifier";

Defines the information that identifies the program to be linked with a custom event job. Specify a character string that begins with CE and is not longer than 16 bytes.

The value that can be defined differs depending on the program to be linked. For details, see the applicable documentation for the program to be linked.

If you specify a value that is not provided by the linked program, the job ends abnormally.

jpoif=macro-variable-name:passing-information-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 (.).

This parameter can contain up to 2,048 bytes in the "jpoif=macro-variable-name:passing-information-name;" format.

To specify multiple macro variables, repeat the parameter. (You can set up to 2,048 bytes of multiple values in the format of jpoif=macro-variable-name:passing-information-name;)

This parameter makes it possible to take over event information of subsequent Unix jobs, PC jobs, flexible jobs, HTTP connection jobs, and action jobs.

The values that can be specified as the passing information names are CMTMOUT and OBJECT01 to OBJECT10.

etm=n;

Define the time-out period using the relative minutes from the start time. You can set 1 to 1,440 minutes. This parameter is invalid for a job within the start condition.

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

If you define this parameter as a start condition, it is disabled when a job is executed.

ex="execution-agent-name";

Define the name of the execution agent 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 #.

You can specify a macro variable.

ha={y|n};

Define whether to suspend job execution. The default is n. This parameter is invalid for a job within the start condition.

y: Suspends job execution.
n: Does not suspend job 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.

ets={kl|nr|wr|an};

Define the state of the custom event job after the execution time-out period elapses. The default is kl. This parameter is invalid for a job within the start condition.

kl: Killed
nr: Ended normally
wr: Ended with warning
an: Ended abnormally

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.

cprm="parameter-name=value";

Specifies a unit definition parameter for a custom event job in the parameter-name=value format.

You can set a character string of 2 to 20,479 bytes. If you specify multiple cprm options at the same time, the total number of characters in all specified values must not exceed 20,479 minus the number of specified cprm options plus 1 (unit: bytes). For example, if you specify five cprm options at the same time for one unit, the total number of characters that can be specified for the five values is a maximum of 20,475 (= 20479 - 5 + 1) bytes.

To specify a value that includes a double quotation mark (") or hash mark (#), prefix the cast character (#) to cast the mark. For a double quotation mark ("), specify #", and for a hash mark (#), specify ##.

For the value portion, you can also specify a macro variable. In that case, you can set a character string of 9 to 20,479 bytes using the "parameter-name=macro-variable-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 (.).

To Page Top