...
ASB Consumer is a Read-type Snap that reads messages from Azure Service Bus (ASB).
...
Prerequisites
A valid Azure Service Bus accountAccount.
Valid Namespace and SharedAccessKey in ASB.
...
Field Name | Field Type | Field Dependency | Description | ||
---|---|---|---|---|---|
Label* Default Value: ASB Consumer | String | N/A | Specify the name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your Pipelinepipeline. | ||
Destination Type Default Value: QUEUE | Dropdown list | Enables Queue, Topic,and Subscription fields. | Choose an option the destination type to which the message needs to must be sent. Available options are:
| ||
Queue Default Value: N/A | String/Expression/Suggestion | Appears when you select QUEUE for Destination Type. | 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. | ||
Topic Default Value: N/A | String/Expression/Suggestion | Appears when you select TOPIC for Destination Type. | 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. | ||
Subscription Default Value: N/A | String/Expression/Suggestion | Appears when you select TOPIC for Destination Type. | 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. | ||
Processing Mode Default Value: ASYNCHRONOUS | Dropdown list | Appears when you select QUEUE for Destination Type. | Select the processing mode to make calls to the Azure Service Bus service. The available options are:
When you use the ASB Acknowledge Snap in the pipeline, you need to use SYNCHRONOUS Processing mode. Otherwise, we recommend that you use ASYNCHRONOUS mode for better performance. | ||
Prefetch Count Default Value: 0 | Integer/Expression | Appears when you select ASYNCHRONOUS for Processing Mode. | 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 a value from 0 (disabled) to 5. If you enter a value which that exceeds the recommended limit of 5, a Lint warning is displayed in the pipeline statistics. | ||
Count Down Latch Timeout (in seconds) Default Value: 1 | Integer/Expression | Appears when you select ASYNCHRONOUS for Processing Mode. | Specify the time interval in seconds to receive the messages.
| ||
Acknowledgment Type Default Value: Acknowledge Message | Dropdown list | Appears when you select ASYNCHRONOUS for Processing Mode. | Select an option for the Acknowledgement type to to determine the action on the receive received messages. Select the action to take on the received message The available options are:
| ||
Max Message Count Default Value: -1 | Integer/Expression | Appears when you select SYNCHRONOUS for Processing Mode. | Specify the maximum number of messages to read before the Consumer stops. If you provide a negative value, the Snap continuously reads messages. | ||
Max Idle Time (in seconds) Default Value: 120 | Integer/Expression | Appears when you select SYNCHRONOUS for Processing Mode. | Specify the maximum idle time (in seconds) before the Snap stops to wait for messages. | ||
Batch Pooling Default Value: Deselected | Checkbox | Appears when you select SYNCHRONOUS for Processing Mode. | Select this checkbox to pool multiple messages in a batch. | ||
Max Messages (per poll) Default Value: 1 | Integer/Expression | Appears when you select Batch Pooling. | Specify the maximum number of messages to read for each poll. | ||
Polling Interval (in milli seconds) Default Value: N/A | Integer/Expression | Appears when you select Batch Pooling. | Specify the time (in milliseconds) to wait between polls for messages. | ||
Message Acknowledge Mode Default Value: AUTO_ACKNOWLEDGE | Dropdown list | Appears when you select SYNCHRONOUS for Processing Mode. | Choose the mode for acknowledging messages in non-transaction sessions.
| ||
Acknowledgement wait time (in milliseconds)
Default Value: 10 | Integer | Appears when you select PIPELINE_CONTROL for Message Acknowledge Mode. | Specify the duration for which the Snap should wait to receive acknowledgments from the ASB Acknowledgement Snap. We recommend you to leave this field empty to ensure accurate acknowledgment of every message. | ||
Max Auto-lock Renew Duration (in seconds) Default Value: 60 | Integer/Expression | Appears when you select QUEUE for Destination Type. | Specify the maximum time (in seconds) to renew the message lock’s expiration.
| ||
Snap Execution Default Value: Validate & Execute | Dropdown list | N/A | Select one of the three modes in which the Snap executes. Available options are:
|
...
Step 3: Configure the ASB Acknowledge Snap to acknowledge the messages that are received.
...
Consume Messages and
...
Write to Topic
This example pipeline demonstrates how to use the ASB Consumer Snap to read and write messages to a topic.
...