WebSphere MQ Inquire

The WebSphere 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.

Description

A short description for the Inquire activity.

Input

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 WebSphere MQ API call if applicable.
mqReasonCode String The reason code for the failing WebSphere 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.