ASB Consumer

In this article

Overview

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

Prerequisites

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: 0

  • Max: 1

  • Mapper

  • CSV Formatter

  • JSON Formatter

  • XML Formatter

A document containing a message or topic.

Output

Document

 

  • Min: 1

  • Max: 1

  • Mapper

  • Copy

  • JSON Formatter and File Writer

The message data with key or value parameters and metadata.

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

Field Dependency

Description

Field Name

Field Type

Field Dependency

Description

Label*

 

Default ValueASB Consumer
ExampleASB 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 pipeline.

 

Destination Type

 

Default Value: QUEUE
Example: TOPIC

Dropdown list

Enables Queue, Topic, and Subscription fields.

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.

 

Queue

 

Default Value: N/A
Example: customers_queue

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
Example: XYZ

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
Example: XYZ

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
Example: SYNCHRONOUS

Dropdown list

Appears when you select QUEUE for Destination Type.

Select