5.2.20 MSMQ message sending job definition

This paragraph explains how to specify an MSMQ message sending job definition.

The following gives the format of, and the parameters for MSMQ message sending job definition information.

Format

[msqpt="queue-path-name";]
[msqlb="queue-label-name";]
[msrer=correlation-ID;]
[mslmt={-2|-1|n};]
[mshld={-1|n};]
[msmod={h|r};]
[mspri=priority;]
[msjnl={y|n};]
[msunr={y|n};]
[mstfn="text-file-name";]
[msttp=text-type;]
[mslbl="message-label";]
[msapl=application-information;]
[etm=n;]
[fd=time-required-for-execution;]
[ex="execution-agent-name";]
[ha={y|n};]
[eu={ent|def};]
[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

msqpt="queue-path-name";

Define the path name of a destination queue to be sent the message.

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

If you define both msqpt="queue-path-name"; and msqlb="queue-label-name"; , the latter is invalid.

You can specify a macro variable.

msqlb="queue-label-name";

Define the label name of a destination queue to be sent the message.

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

If you define both msqpt="queue-path-name"; and msqlb="queue-label-name"; , the latter is invalid.

You can specify a macro variable.

msrer=correlation-ID;

Define the correlation ID of a send message.

You can set a character string of 1 to 20 bytes. You can, however, specify only uppercase alphanumeric characters.

mslmt={-2|-1|n};

Define the delivery limit time for a send message. The default is -2.

-2: LONG_LIVED
-1: INFINITE
n: Specify the delivery limit time in seconds. You can set 0 to 2,147,483,647.

mshld={-1|n};

Define the period in which message sending is suspended. The default is -1.

-1: INFINITE
n: Specify the time period in seconds. You can set 0 to 2,147,483,647.

msmod={h|r};

Define delivery mode for a send message. The default is h.

h: High-speed mode
r: Recoverable mode

mspri=priority;

Define the priority of a send message.

You can set 0 to 7. The default is 3.

msjnl={y|n};

Define whether to store a delivered message into the journal queue. The default is n.

y: Stores a delivered message into the journal queue.
n: Does not store a delivered message into the journal queue.

msunr={y|n};

Define whether to store a delivered message into the dead message queue. The default is n.

y: Stores a delivered message into the dead message queue.
n: Does not store a delivered message into the dead message queue.

mstfn="text-file-name";

Define the name of the file which stores data to be used as the send message text.

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

You can specify a macro variable.

msttp=text-type;

Define the content type of send message text.

You can set hexadecimal values of 0 to FFFFFFFF.

mslbl="message-label";

Define the label of a send message.

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

You can specify a macro variable.

msapl=application-information;

Define application information on a send message.

You can set hexadecimal values of 0 to FFFFFFFF.

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

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.

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.

To Page Top