This Snap has at most one document input view.

Expected input: A document containing a message or topic.

• Mapper
• CSV Formatter
• JSON Formatter
• XML Formatter

This Snap has exactly one document output view.

Expected output: The message data with key or value parameters and metadata.

• Mapper
• Copy
• JSON Formatter
• File Writer

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: ASB Consumer

Example: ASB Consumer

Choose the destination type to which the message must be sent. Available options are:

• QUEUE: Messages are sent to the queue.
• TOPIC: Messages are sent to the topic.

Default value: QUEUE

Example: TOPIC

Specify the queue from which the message should be consumed in ASB. Alternatively, click the Suggestion icon to fetch the list of queues corresponding to the Azure Service Bus account and select a queue.

To retrieve messages from a dead-letter queue (DLQ), you must concatenate /$deadletterqueue to the Queue name. For example, xyz_test_q1/$deadletterqueue

Appears when you select QUEUE for Destination Type.

Default value: N/A

Example: customers_queue

Specify the topic from which the message should be consumed in ASB. Alternatively, click the Suggestion icon to fetch the list of topics corresponding to the Azure Service Bus account and select a topic.

To retrieve messages from a dead-letter queue (DLQ), you must concatenate /$deadletterqueue to the Subscription name. For example, xyz_topic1_sub2/$deadletterqueue

Appears when you select TOPIC for Destination Type.

Default value: N/A

Example: XYZ

Specify the subscription for the topic. Alternatively, click the Suggestion icon to fetch the list of Subscriptions for the topic corresponding to the Azure Service Bus account and select a Subscription.

Appears when you select TOPIC for Destination Type.

Default value: N/A

Example: XYZ

Select the processing mode to make calls to the Azure Service Bus service. The available options are:

• ASYNCHRONOUS: This mode enables the consumer to read the message from the destination when it arrives until a 'STOP' is read or the Message Count is reached.
• SYNCHRONOUS: This mode enables the consumer to read messages from the destination every 5 seconds until a 'STOP' is read or the Message Count is reached. If the consumer reads the message within 5 seconds, it will process it and not wait every 5 seconds for the next message.

Appears when you select QUEUE for Destination Type.

Default value: ASYNCHRONOUS

Example: SYNCHRONOUS

Specify the number of messages to be read into the buffer before the Snap begins processing. If the field is left empty, the Snap sets it to 0.

Incrementing the prefetch count improves the overall performance of the ASB Consumer Snap. The prefetch count can be from 0 (disabled) to 5. If you enter a value that exceeds the recommended limit of 5, a Lint warning is displayed in the pipeline statistics.

Appears when you select ASYNCHRONOUS for Processing Mode.

Default value: 0

Example: 10

Specify the time interval in seconds to receive the messages.

To read messages constantly from ASB in Asynchronous mode, you must set the Count Down Latch Timeout (in seconds) to 0 or -1.

Appears when you select ASYNCHRONOUS for Processing Mode.

Default value: 1

Example: 5

Select an option for the Acknowledgement type to determine the action on the received messages. The available options are:

• Defer Message: Indicates that the message is a lower priority and can be processed after higher priority messages.
• Abandon Message: Discards the message.
• Acknowledge Message: Ensures that the receiver has read the message.
• Deadletter Message: Holds the messages that cannot be delivered to the receiver.

Appears when you select ASYNCHRONOUS for Processing Mode.

Default value: Acknowledge Message

Example: Defer Message

Specify the maximum number of messages to read before the Consumer stops. If you provide a negative value, the Snap continuously reads messages.

Appears when you select SYNCHRONOUS for Processing Mode.

Default value: -1

Example: 5

Specify the maximum idle time (in seconds) before the Snap stops to wait for messages.

Appears when you select SYNCHRONOUS for Processing Mode.

Default value: 120

Example: 100

Select this checkbox to pool multiple messages in a batch.

Appears when you select SYNCHRONOUS for Processing Mode.

Default value: Deselected

Specify the maximum number of messages to read for each poll.

Appears when you select Batch Pooling.

Default value: 1

Example: 12

Specify the time (in milliseconds) to wait between polls for messages. We recommend you to leave this field empty.

Appears when you select Batch Pooling.

Default value: N/A

Example: 250

Choose the mode for acknowledging messages in non-transaction sessions.

• AUTO_ACKNOWLEDGE
• PIPELINE_CONTROL

Appears when you select SYNCHRONOUS for Processing Mode.

Default value: AUTO_ACKNOWLEDGE

Specify the duration for which the Snap should wait to receive acknowledgments from the ASB Acknowledge Snap. We recommend you to leave this field empty to ensure accurate acknowledgment of every message.

Appears when you select PIPELINE_CONTROL for Message Acknowledge Mode.

Default value: 10

Example: 5000

Specify the maximum time (in seconds) to renew the message lock's expiration.

The maximum time should be in sync with the message lock duration in the queue/topic. By default, this is set to 60 seconds. We recommend that you set the maximum time to a value slightly greater than the message lock duration for the queue/topic because even after the message lock duration is exhausted, you can still renew the lock to process the message.

Appears when you select QUEUE for Destination Type.

Default value: 60

Example: 70