5.2.13 MSMQ message reception monitoring job definition
This paragraph explains how to specify a job definition for monitoring MSMQ message reception.
The following gives the format of, and the parameters for an MSMQ message reception monitoring job definition.
- Format
[msqpt="path-name";] [msrer=correlation-ID;] [mslbl="message-label";] [msapl=application-information;] [mssvf="message-storage-file-name";] [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};]
- Parameters
-
- msqpt="path-name";
-
Define the queue path name of a queue to monitor messages.
You can set a character string of 1 to 259 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 #.
- msrer=correlation-ID;
-
Define the correlation ID of a message to be monitored.
You can set a character string of 1 to 20 bytes. Note that you can specify only uppercase alphabetic and numeric characters.
- mslbl="message-label";
-
Define the message label of a message to be monitored.
You can set a character string of 1 to 249 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 #.
- msapl=application-information;
-
Define application information about a message to be monitored.
You can specify any hexadecimal value ranging from 0 to FFFFFFFF.
- mssvf="message-storage-file-name";
-
Define the name of a file that stores messages matching monitoring conditions.
You can set a character string of 1 to 256 bytes. Specify a full-path file name.
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 #.
- 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;".
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 #.
- 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.
-
- 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.
-