Overview

ASB Acknowledge is a Read-type Snap that acknowledges messages from Azure Service Bus (ASB).

You can use the ASB Acknowledge Snap only if the Consumer is set to SYNCHRONOUS mode and if you select PIPELINE CONTROL for Message acknowledge mode. For more information on the Processing and Acknowledge mode, see ASB Consumer Snap.

Prerequisites

None.

Support for Ultra Pipelines

Works in Ultra Pipelines.

Limitations and Known Issues

None.

Snap Views

Type	Format	Number of Views	Examples of Upstream and Downstream Snaps	Description

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input

Document

Min: 1
Max: 1

Mapper
Copy
ASB Consumer

Metadata from an upstream ASB Consumer Snap.

Output

Document

Min: 0
Max: 1

Mapper
JSON Formatter
ASB Producer

Messages that have been processed and acknowledged.

Error

Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter while running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab. The available options are:

Stop Pipeline Execution: Stops the current pipeline execution when the Snap encounters an error.
Discard Error Data and Continue: Ignores the error, discards that record, and continues with the rest of the records.
Route Error Data to Error View: Routes the error data to an error view without stopping the Snap execution.

Learn more about Error handling in Pipelines.

Snap Settings

Asterisk (*): Indicates a mandatory field.
Suggestion icon ( ): Indicates a list that is dynamically populated based on the configuration.
Expression icon (): Indicates whether the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.
Add icon ( ): Indicates that you can add fields in the field set.
Remove icon (): Indicates that you can remove fields from the field set.

Field Name	Field Type	Description

Field Name	Field Type	Description
Label*	String	Specify a unique 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 Pipeline. Default Value: ASB Acknowledge Example: ASB Acknowledge
Acknowledgement Type*	Dropdown list	Select an option for the Acknowledgement type to determine the action on the receive messages. Select the action to take on the received message 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. Default Value: Acknowledge Message Example: Defer Message
Message ID*	String/Expression	Specify the ID of the message to be acknowledged. Default Value: N/A Example: 345
Sequence Number*	String/Expression	Specify the order, relative to other messages, in which the message will be acknowledged. Default Value: N/A Example: 2
Lock Token*	String/Expression	Specify the lock token of the message to be acknowledged. Lock token is the lock on the message to access a particular message that is unique for each message. The lock token is bound with a specific time duration called as message lock duration in the Azure portal. This token is available for specific time duration only for each message. After the duration lapses, the token is exhausted or the message cannot be acknowledged and is abandoned automatically. Default Value: N/A Example: 852
Snap Execution	Dropdown list	Select one of the three modes in which the Snap executes. Available options are: Validate & Execute: Performs limited execution of the Snap, and generates a data preview during Pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during Pipeline runtime. Execute only: Performs full execution of the Snap during Pipeline execution without generating preview data. Disabled: Disables the Snap and all Snaps that are downstream from it. Default Value: Validate & Execute Example: Execute only