IBM MQ Inquire

The IBM MQ Inquire activity inquires about the current state of a queue and is primarily intended to obtain the depth of the queue.

General

The General tab of the Inquire activity contains the following fields:

Name Global Variable Description
Name N Name of the activity.
Connection Y The connection resource which connects this activity with the queue manager that has access to the desired queue.
Destination Y The name of the queue from which the state is retrieved.
Logger Name Y Enter the name of any pre-configured logger available to the run time. Loggers are configured in an XML document referenced by the Dlogback.configurationFile runtime parameter.

Input

Activity Pooling

The Activity Pooling tab allows the activity to pool all the MQ resources associated with the inquire activity at the process level.

The Activity Pooling tab contains the following fields:

Field Global Variable Description
Pool Activity N Select the Pool Activity checkbox to activate pooling for the client objects used by this activity. Selecting this option causes pooling to be done at a higher level than merely pooling the connection. All destinations used by the activity are kept open and the connection resource specified are not pooled in the usual way even if that resource has pooling enabled. This option is used when the server to which you are connected experiences very high latency such that opening, closing, and pooling of connections cause unacceptable performance degradation.

The primary consideration for choosing pooling parameters is the number of available connections to the queue manager. Choose values that do not create unnecessary resource consumption in the queue manager, and leave available connections for other applications (including other pooled connections and activities, remember that the application might be deployed on multiple engine instances).

Pool Max Y Determines the maximum number of connections in the pool. When this limit is reached, subsequent activities fail with the following message:

"Activity Pool is exhausted: [Timeout waiting for idle object] Either enlarge the pool, allow it to grow, or increase the blocking time."

Pool Max Idle Y Determines the maximum number of idle connections in the pool. When the number of unused connections reaches this number, the idle connections are disconnected and closed, freeing resources on the server. Amounts over the Max Connections value are ignored.
Exhausted Action N Select one of the following options:

● FAIL - The activity fails immediately after the pool is exhausted.

● BLOCK - The activity waits for the "Pool Wait" interval before failing. If an MQ client is available before the timeout, the activity acquires it.

● GROW - The pool grows past its maximum parameters.

Pool Wait Y If exhausted action is set to "BLOCK", the pool waits for the "Pool Wait" interval for an activity to become available before failing.

The following table lists the input items for the Inquire activity:

Input Item Global Variable Description
InteractionInput N The root node for all the input provided to the activity
mqproperties N destination: the destination can be overridden at run time.
destqmgr N Destination queue manager, for future use only.

Output

The following table lists the output items for the Inquire activity:

Output Item Global Variable Description
InteractionOutput N The root node for all the output provided by the activity.
  • depth: documents the current depth of the queue (that is, how many messages are in the queue).
  • maxDepth: documents the configured maximum depth of the queue.
  • maxMsgLength: documents the configured maximum size of any individual message in the queue.
  • type: documents the configured queue type.
  • shareability: documents the configured shareability for the queue.
  • triggerDepth: documents the configured trigger depth for the queue.
  • openInput: the number of handles open for input on this queue.
  • openOutput: the number of handles open for output on this queue.
mqproperties N The node containing all the message header fields (plus the destination override) which are relevant on input.
  • destination: documents the actual destination used for the inquiry.
  • destqmgr: destination queue manager, for future use only.
responsetimemillisec N The number of milliseconds the inquiry takes.

Fault

The following table lists the error schema elements for the Inquire activity:

Error Schema Element Data Type Description
msg String The textual message as it relates to the direct or underlying cause of the exception that caused the activity to fail.
msgCode String The error message identifier for this message.
mqCompCode String The completion code for the failing IBM MQ API call if applicable.
mqReasonCode String The reason code for the failing IBM MQ API call if applicable.
mqErrorCode String If extra information is available to augment that provided in the msg field it is provided here, otherwise this is a copy of msg.