This Snap does not accept input documents.

N/A

Each consumed message is output as a separate document containing the message payload, properties, and metadata.

• Mapper

Label

String

Required. Specify a unique name for the Snap. Modify this to be more appropriate, especially if more than one of the same Snaps is in the pipeline.

Default value: IBM MQ Consumer

Required. Specify the destination name to retrieve the message.

Example: DEV.1

Specify the type of destination from which to retrieve messages:

• Queue - Point-to-point messaging where each message is consumed by one consumer
• Topic - Publish-subscribe messaging where messages can be consumed by multiple subscribers

Default value: Queue

Choose the queue access mode:

• Shared - Multiple consumers can retrieve messages from the queue simultaneously
• Exclusive - Only one consumer can access the queue at a time (MQOO_INPUT_EXCLUSIVE)
• As Queue Definition - Uses the access mode defined in the queue's configuration (MQOO_INPUT_AS_Q_DEF)

Default value: As Queue Definition

A message acknowledgment mode for non-transacted sessions. Valid options are:

• Auto acknowledge - The session acknowledges the receipt of a message when a call to the receive method or when the message listener returns successfully
• Client acknowledge - The client has the power to acknowledge the message

When enabled, it automatically converts the message character set and encoding to the specified target values. Use this option when consuming messages that require character set or encoding transformation.

Default value: Not selected

Specify the target encoding value for message conversion. This field is used when Convert message is enabled.

Example: 273 (for EBCDIC encoding)

Specify the target character set identifier (CCSID) for message conversion. This field is used when the Convert message is enabled.

Example: 1208 (for UTF-8)

Specify the maximum number of messages to retrieve per execution:

• -1 - retrieves all the messages and Snap runs indefinitely
• 0 - retrieves all the messages in the queue
• Positive integer - Retrieves the specified number of messages

Default value: -1

Example: 100 (retrieves up to 100 messages)

The maximum time, in seconds, the Snap waits for execution to complete. If the time exceeds, the Snap stops processing and completes execution. The default value 0 indicates no timeout.

If the Execution timeout is greater than 0, the Snap stops consuming after the specified timeout is reached, even if the Message count threshold is not met.

Default value: 0

Example: 30

Specify the number of retry attempts for connection or network errors. When set to 0, the Snap does not retry on failure.

Default value: 0

Specify the wait time in milliseconds between retry attempts.

Default value: 1000

Example: 5000 (waits 5 seconds between retries)

Specify the time in milliseconds to wait between polling attempts when no messages are available in the queue or topic.

Default value: 0

Example: 5000 (polls every 5 seconds)