5.2.17 JP1 event sending job definition

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

The following gives the format of, and the parameters for a JP1 event sending job definition.

Format

[evsid=event-ID;]
[evhst="event-destination-host-name";]
[evsms="message";]
[evssv={em|al|cr|er|wr|no|in|db};]
[evsfr=extended-attribute-name:"value";]
[pfm={u|p};]
[etm=n;]
[fd=time-required-for-execution;]
[ex="execution-agent-name";]
[ha={y|n};]
[eu={ent|def};]
[evsrt={y|n};]
[evspl=check-interval;]
[evsrc=check-count;]
[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

evsid=event-ID;

Define the event ID of an event to be sent.

You can set hexadecimal values of 00000000 to 00001FFF and 7FFF8000 to 7FFFFFFF.

evhst="event-destination-host-name";

Define an event destination host name. This parameter is required if you specify y for the evsrt parameter.

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

You can specify a macro variable.

evsms="message";

Define a message to be added to an event. You can set a character string of 1 to 1,023 bytes.

You can specify a macro variable.

evssv={em|al|cr|er|wr|no|in|db};

Define the event level to be added to an event. The default is no.

• em: Sets Emergency.

• al: Sets Alert.

• cr: Sets Critical.

• er: Sets Error.

• wr: Sets Warning.

• no: Sets Notice.

• in: Sets Information.

• db: Sets Debug.

evsfr=extended-attribute-name:"value";

Define an extended attribute to be added to an event.

You can set a character string of 5 to 128 bytes in the format of evsfr=extended-attribute-name:"value";.

You can specify a macro variable.

pfm={u|p};

Define a platform type for job execution. The default is p.

• p: Windows environment

• u: UNIX environment

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

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.

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.

evsrt={y|n};

Define whether to check the arrival of the event. The default is n.

When you specify y, the system checks for the arrival of an event three seconds after the JP1 event is sent.

• y: Checks the arrival of the event.

• n: Does not check the arrival of the event.

evspl=check-interval;

Define the interval to check for arrival of a JP1 event. You can specify a decimal value between 3 and 600 (seconds).

If you omit this option, the system assumes 10.

evsrc=check-count;

Define how many times to check for arrival of a JP1 event. You can specify a decimal value between 0 and 999 (times).

If you omit this option, the system assumes 10.

jty={q|n};

Define the queuing attribute type. If you do not specify this option, q is assumed.

• q: The queuing attribute exists.

• n: The queuing attribute does not exist.

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.

Cautionary notes

The following describes the notes on defining the event destination host name, the message, and the value of the extended attribute.

• You can use space characters and symbols. However, if you use a special character (`, $, or \) as an ordinary character in UNIX, it must be preceded by the \ mark.

  Examples

  <`> will be specified as <\`>.

  <$> will be specified as <\$>.

• If you want to use a double quotation mark (") or a hash mark (#) as a character, prefix the character by #.

  Examples

  <"> will be specified as <#">.

  <#> will be specified as <##>.

• If you want to use a double quotation mark (") as an ordinary character, prefix the quotation mark by the cast character string \#.

  Example

  <"> should be specified as <\#">.

The values of the event destination host name, message, and extended attribute are enclosed in double quotation marks (") for JP1 event sending, because these specifications might contain space characters and symbols. If you want to specify a \ mark as an ordinary character at the end of a character string in Windows, prefix another \ mark to it.

If passing information contains such a special character, the system may fail to pass on the information correctly or the job may terminate abnormally. If, however, you use the option that validates a double-quotation mark in passing information, any passing information containing a double-quotation mark will be taken over correctly.

Example

The following examples show how to use a special character, a double quotation mark ("), and a hash mark (#) as an ordinary character for the values of the event destination host name, message, and extended attribute.

• <`AAA`> will be specified as <\`AAA\`>. (For UNIX only)

• <$AAA$> will be specified as <\$AAA\$>. (For UNIX only)

• <#AAA#> will be specified as <##AAA##>.

• <"AAA"> will be specified as <\#"AAA\#">.

• <\AAA\> will be specified as <\AAA\\>> (for Windows) or <\\AAA\\> (for UNIX).

To Page Top