ASB Producer

Overview

The ASB Producer Snap allows you to send messages to a queue in Azure Service Bus (ASB).



Supported Accounts

Prerequisites

  • A valid Azure Service Bus account.
  • Valid Namespace and SharedAccessKey in Azure Service Bus.

Snap views

Type Description Examples of upstream and downstream Snaps
Input

This Snap has at most one document input view.

Expected input: A key-value pair for the message.
Output

This Snap has at most one document output view.

Expected output: Message records.

Note: The Consumer Snap is decoupled from the Producer Snap.
  • None
Learn more about Error handling.

Snap settings

Legend:
  • Expression icon (): Allows using pipeline parameters to set field values dynamically (if enabled). SnapLogic Expressions are not supported. If disabled, you can provide a static value.
  • SnapGPT (): Generates SnapLogic Expressions based on natural language using SnapGPT. Learn more.
  • Suggestion icon (): Populates a list of values dynamically based on your Snap configuration. You can select only one attribute at a time using the icon. Type into the field if it supports a comma-separated list of values.
  • Upload : Uploads files. Learn more.
Learn more about the icons in the Snap settings dialog.
Field/Field set Description
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: ASB Producer
Destination Type

Dropdown list

Choose an option where the messages should be sent. Enables Queue and Topic fields. Available options are:

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

String/Expression

Specify the name of the queue to which the message should be added. Alternatively, click the Suggestion icon to get the list of Queues corresponding to the Azure Service Bus account and select a Queue.

Enabled on selecting QUEUE for Destination Type.

Default value: N/A

Example: 25queue
Topic

String/Expression

Specify the topic to which the message should be published or subscribed. Alternatively, click the Suggestion icon to fetch the list of Topics corresponding to the Azure Service Bus account and select a Topic.

Enabled on selecting TOPIC for Destination Type.

Default value: N/A

Example: XYZ
Message value

String/Expression

Specify the message value (content of the message) to send.

Default value: N/A

Example: $msg
Content Type

Dropdown list

Choose the content type for the message:

  • PLAIN_TEXT
  • APPLICATION_JSON
  • APPLICATION_XML
Note: You can overwrite the content type chosen here by providing advanced properties.

Default value: APPLICATION_JSON

Example: PLAIN_TEXT
Message Properties

Use this field set to define message properties. This field set contains the following fields:

  • Properties
  • Values
Properties

Dropdown list

Choose the type of the message property to route messages to particular destinations. Available options are:

  • Message ID: The ID of the message that you want the Snap to write in ASB.
  • Subject: The subject of the message.
  • Correlation ID: A context for the message for the purpose of correlation, for example reflecting the Message ID of a message that is being replied to.
  • Content Type: Gets or sets the content type. The content type can be of three types: XML, JSON, and Plain Text.
  • Schedule Enqueue Time: The scheduled enqueue time in UTC, which is similar to Schedule Message Date. It also accepts the OffsetDateTime, (2022-01-11T12:30:00+05:30) yyyy-MM-ddTHH:mm:ss[+/-]xx:xx
  • Time to Live: The time to live in seconds for a message, for example PT20S - stands for 20 seconds, after 20 seconds the message is deleted from the queue.
  • Partition Key: Partition Key is used when the queue is partition enabled. You can enable partitioning while creating the queue. Partitioning allows you to store similar kind of data in partitions using partition keys in the ASB. You need to create a queue with partitioning enabled and provide a Partition Key.
  • Reply To: The address of an entity to send replies to. Specify a reply path to the receiver of the message. When a sender expects a reply, it sets the value to the absolute or relative path of the queue or topic it expects the reply to be sent to, for example testQueue4.
  • To: Specify the next entity path for the message, for example testqueue4.

Default value: Message ID

Example: Subject
Values

String/Expression

Specify the value of the message property.

Default value: N/A

Example: 630
Custom Properties

Use this field set to provide custom properties in key-value pairs. Click the Add icon to add key-value pairs. Enter each pair in a separate row.

  • Key
  • Values
Key

String/Expression

Specify the key for the custom property.

Default value: N/A

Example: keyProp
Values

String/Expression

Specify a value for the key.

Default value: N/A

Example: valueProp
Max Batch Size (in bytes)

Integer

Specify the maximum size (in bytes) of a batch of messages to process. Maximum: 256kb for standard tier and 1MB for premium tier.

Default value: -1

Example: 5
Schedule Message Date (yyyy-MM-ddTHH:mm:ss[+/-]xx:xx)

String/Expression

Specify the time and date at which the message should be sent to ASB. The time and date format must be in OFFSET_DATE_TIME format (2021-12-22T20:00:00-08:00), as Azure Service Bus supports the OffsetDateTime format only.

Default value: N/A

Example: 2021-12-22T20:00:00-08:00
Snap execution

Dropdown list
Choose 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.