Help Manual - Azure Service Bus Destination

Documentation on SSIS Azure Service Bus Destination component

Using the Azure Service Bus Destination Component

The Azure Service Bus Destination Component is an SSIS data flow pipeline component that can be used to send messages to an Azure Service Bus queue, topic, or event hub. There are three pages of configuration:

  • General
  • Columns
  • Error Handling

General Page

SSIS Azure Service Bus Destination

Connection Manager

The destination component requires an active connection to Azure Service Bus. The Connection Manager drop-down will show a list of all Azure Service Bus Connection Managers that have been created in the current SSIS package.

Action

The Action specifies how you want to write to the Azure Service Bus queue service. There are 2 Actions:

  • Create
  • Delete(since v21.2)
  • Move to Dead Letter (Since v23.1)
Entity Type:

If an active connection manager is selected it will be possible to select an entity to connect to. The options are Queue, Topic, and Event Hub.

Queue

If the Entity Type property is set to Queue a list of queues will be presented from those available in Azure Service Bus. Messages will be written to this queue.

Topic

If the Entity Type property is set to Topic a list of topics will be presented from those available in Azure Service Bus. Messages will be written on this topic.

Event Hub

If the Entity Type property is set to Event Hub a list of event hubs will be presented from those available in Azure Service Bus. Events will be sent to this event hub.

Message Time To Live

Messages written to Azure Service Bus can have a time to live property set which is a number of seconds after which they will expire and be removed from the queue. Setting this value to 0 will create messages that do not automatically expire.

Message Column Type

The Message Column Type allows you to specify whether you want to write the binary content of the message or the text content of the message to Azure Service Bus. There are two different modes available for Message column types: Binary and Text. The default setting is Text.

Encoding

The encoding that will be used to convert the message body to a byte array when sending the message. This option is only available when the Message Column Type is Text.

Refresh Component Button

Clicking the Refresh Component button causes the component to retrieve the latest metadata and update each field to its most recent metadata. It will remove any custom fields that have been added to the columns page.

Map Unmapped Fields Button

By clicking this button, the component will try to map any unmapped attributes by matching their names with the input columns from upstream components. This is useful when your source component has recently added more columns, in which case you can use this button to automatically establish the association between input columns and unmapped destination attributes.

Clear All Mappings Button

By clicking this button, the component will reset all your mappings in the destination component.

Expression fx Icon

Click the blue fx icon to launch SSIS Expression Editor to enable dynamic updates of the property at run time.

Generate Documentation Icon

Click the Generate Documentation icon to generate a Word document that describes the component's metadata including relevant mapping, and so on.

Columns page

The Columns page allows you to map the columns from upstream components to destination attributes.

On the Columns page, you will see a grid as shown below.

SSIS Azure Service Bus Destination Component - Columns Page

  • Input Column: You can select an input column from an upstream component here.
  • Azure Service Bus Field: The attribute/field that you want to write data to.
  • Data Type: This column indicates the type of value for the current attribute.
  • Unmap: This button provides a convenient way to unset the mapping for the selected attribute/field.

Add Button

Clicking the Add button will bring up a dialog that will allow custom fields to be added. Custom fields can be used for values of any custom properties on the written messages.

Error Handling page

The Error Handling page allows you to specify how errors should be handled when they happen.

Azure Service Bus Destination Component - Error Handling

There are three options available:

  1. Fail on error
  2. Redirect rows to error output
  3. Ignore error

When the Redirect rows to error output option is selected, rows that failed to write to Azure Service Bus will be redirected to the 'Error Output' of the Destination Component. As indicated in the screenshot below, the green output connection represents rows that were successfully written, and the red 'Error Output' connection represents erroneous rows. The 'AzureServiceBusErrorMessage' output column found in the 'Error Output' may contain the error message that was reported by Azure Service Bus or the component itself.

SSIS Azure Service Bus Destination Component - Error Output

Note: Use extra caution when selecting Ignore error option, since the component will remain silent for any errors that have occurred.