Control data
This section describes the keywords that you can include in a control-data
entry in a DLQ handler rules table.
- All keywords are optional.
- If a control-data entry is included in the rules table, it must be the first entry in the table.
- The default value for a keyword, if any, is underlined.
- The vertical line (|) separates alternatives. You can specify only
one of these.
- INPUTQ (QueueName|' ')
- Specifies the name of the DLQ that you want to process:
- If you specify a queue name in the PARM parameter of the EXEC statement,
this overrides any INPUTQ value in the rules table.
- If you do not specify a queue name in the PARM parameter of the EXEC statement,
the INPUTQ value in the rules table is used.
- If you do not specify a queue name in the PARM parameter of the EXEC statement
or the rules table, the dead-letter queue named qmgr-name.DEAD.QUEUE
is used if it has been defined. If this queue does not exist, the program
fails and returns error message CSQU224E, giving the reason code for the error.
- INPUTQM (QueueManagerName|' ')
- Specifies the name of the queue manager that owns the DLQ named on the
INPUTQ keyword.
- If you specify a queue manager name in the PARM parameter of the EXEC
statement, this overrides any INPUTQM value in the rules table.
- If you do not specify a queue manager name in the PARM parameter of the
EXEC statement, the INPUTQM value in the rules table is used.
- If you do not specify a queue manager name in the PARM parameter of the
EXEC statement or the rules table, the default queue manager is used (if one
has been defined using CSQBDEFV). If not, the program fails and returns error
message CSQU220E, giving the reason code for the error.
- RETRYINT (Interval|60)
- Specifies the interval, in seconds, at which the DLQ handler should
attempt to reprocess messages on the DLQ that could not be processed at the
first attempt, and for which repeated attempts have been requested.
The
default is 60 seconds.
- WAIT (YES|NO|nnn)
- Specifies whether the DLQ handler should wait for further messages to
arrive on the DLQ when it detects that there are no further messages that
it can process.
- YES
- The DLQ handler waits indefinitely.
- NO
- The DLQ handler terminates when it detects that the DLQ is either empty
or contains no messages that it can process.
- nnn
- The DLQ handler waits for nnn seconds for new work to arrive
after it detects that the queue is either empty or contains no messages that
it can process, before terminating.
Specify a value in the range 1 through
999 999.
Specify WAIT (YES) for busy DLQs, and WAIT (NO) or WAIT (nnn)
for DLQs that have a low level of activity. If the DLQ handler is allowed
to terminate, you can use triggering to invoke it when needed.