Hitachi

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

5.2.9 Job definition for monitoring JP1 event reception

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

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

Format
[evwid=event-ID;]
[evusr="event-issue-source-user-name";]
[evgrp="event-issue-source-group-name";]
[evhst="event-issue-source-host-name";]
[evipa=event-issue-source-IP-address;]
[evwms="message";]
[evdet="detailed-event-information";]
[evwsv=em[:al[:cr[:er[:wr[:no[:in[:db]]]]]]];]
[evwfr=optional-extended-attribute-name:"value";]
[evtmc={n|a|n:"file-name"|a:"file-name"
     |d:"file-name"|b:"file-name"};]
[evuid=event-issue-source-user-ID;]
[evgid=event-issue-source-group-ID;]
[evpid=event-issue-source-process-ID;]
[jpoif=macro-variable-name:passing-information-name;]
[etm=n;]
[fd=time-required-for-execution;]
[ex="execution-agent-name";]
[ha={y|n};]
[eu={ent|def};]
[evesc={no|minutes};]
[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};]
Parameters
evwid=event-ID;

Define the event ID of an event to be received.

You can set hexadecimal values of 00000000:00000000 to FFFFFFFF: FFFFFFFF.

evusr="event-issue-source-user-name";

Define the user name of the event issue source in the basic information on an event to be received.

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

Note that you can use a regular expression to specify the user name.

evgrp="event-issue-source-group-name";

Define the group name of the event issue source in the basic information on an event to be received.

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

Note that you can use a regular expression to specify the group name.

evhst="event-issue-source-host-name";

Define the host name of the event issue source in the basic information about an event to be received.

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

Note that you can use a regular expression to specify the host name.

You can also specify a macro variable.

evipa=event-issue-source-IP-address;

Define the IP address of the event issue source in the basic information about an event to be received.

You can specify 0.0.0.0 to 255.255.255.255 using the XXX.YYY.xxx.yyy format. You can specify 0 to 255 in each of the XXX, YYY, xxx, and yyy parts.

evwms="message";

Define a character string that is to be compared with the message part of an event received.

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

Note that you can use a regular expression to specify the message.

evdet="detailed-event-information";

Define a character string that is to be compared with the detailed information part of an event received.

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

Note that you can use a regular expression to specify the detailed information.

evwsv=em[:al[:cr[:er[:wr[:no[:in[:db]]]]]]];

Define the event level of the extended attribute of an event to be received.

  • em: Sets Emergency as the condition to be met.

  • al: Sets Alert as the condition to be met.

  • cr: Sets Critical as the condition to be met.

  • er: Sets Error as the condition to be met.

  • wr: Sets Warning as the condition to be met.

  • no: Sets Notice as the condition to be met.

  • in: Sets Information as the condition to be met.

  • db: Sets Debug as the condition to be met.

evwfr=optional-extended-attribute-name:"value";

If you have set an optional attribute name or value for the extended attribute of an event to be received, define the optional extended attribute name in the format of evwfr=optional extended attribute name:"value".

You can set a character string of 1 to 2,048 bytes. You can set multiple values. (You can set up to 2,048 bytes of multiple values in the format of evwfr=optional-extended-attribute-name:"value";.)

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

Note that you can use regular expressions and macro variables in the optional extended attribute name.

evtmc={n|a|n:"file-name"|a:"file-name"|d:"file-name"|b:"file-name"};

Define conditions on end judgment. The default is n.

  • n: Always assumes a normal end.

  • a: Always assumes an abnormal end.

  • n:"file-name": Normal end if the message matches the contents of a specified file

  • a:"file-name": Abnormal end if the message matches the contents of a specified file

  • d:"file-name": Normal end if the detailed information matches the contents of a specified file

  • b:"file-name": Abnormal end if the detailed information matches the contents of a specified file

For the file name, You can set a character string of 1 to 256 bytes.

evuid=event-issue-source-user-ID;

Define the user ID of the event issue source in the basic information about an event to be received.

You can set a value of -1 to 9,999,999,999 bytes.

evgid=event-issue-source-group-ID;

Define the group ID of the event issue source in the basic information about an event to be received.

You can set a value of -1 to 9,999,999,999 bytes.

evpid=event-issue-source-process-ID;

Define the process ID of the event issue source in the basic information about an event to be received.

You can set a value of -1 to 9,999,999,999 bytes.

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.

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

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 jobnet execution.

  • n: Does not suspend jobnet execution.

eu={ent|def};

Define the JP1 user who executes the job. The default is ent. This parameter is ignored in an event job.

  • ent: The JP1 user who registered the jobnet executes the job.

  • def: The JP1 user who owns the job executes the job.

evesc={no|minutes};

Define whether, immediately after the JP1 event reception monitoring job is executed (before starting monitoring for a JP1 event) any previous JP1 events still need to be monitored for reception. The default is no.

  • no: Does not search for previous JP1 events.

  • minutes: Searches for JP1 events that occurred from the time point earlier by the specified minutes than the time when the JP1 event reception monitoring job was executed. You can specify a decimal value between 1 and 720 (minutes).

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

Define the state of the 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.

Cautionary note

Suppose that you want to pass on the information received in an event job to the parameters of a standard job or action job. If the passing information contains a double quotation mark ("), you must prefix the \ sign to the passing information. If you do not prefix the \ sign, when the received information is inherited, a problem occurs such as the double quotation mark being ignored. You can avoid this problem by setting the option that enables any data containing a double quotation mark to be considered as inheritance information.

For the specific settings, see the following appropriate sections, depending on your OS. On a Windows host, see 6.3.4 Passing event data containing double quotation marks in the JP1/Automatic Job Management System 3 Configuration Guide. On a UNIX host, see 15.3.4 Passing event data containing double quotation marks in the JP1/Automatic Job Management System 3 Configuration Guide.

To Page Top

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

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