Azure Service Bus
Azure Service Bus is a messaging service used to connect any applications, devices, and services with any other applications or services and exchange information. It establishes communication between applications and services.
You can consume, publish, and process the Azure Service Bus messages by using Templates/Transactions, and Process Flows. To connect with Azure Service Bus, you need to create an Azure Service Bus account and define Azure Service Bus listener or Azure Service Bus target.
Creating Azure Service Bus Account
Azure Service Bus account connects you with Azure Service Bus server. Follow the steps below to create an Azure Service Bus account:
Click Configure > ACCOUNTS > Azure Service Bus.
Click Create Azure Service Bus.
On Create Azure Service Bus Account window, enter the following details:
Click Save to save the Azure Service Bus account.
Azure Service Bus Listener
The Azure Service Bus Listener reads/consumes the messages from a Queue or Topic. You can create Azure Service Bus Listener, and use it in a Template/Transaction or with a Process Flow to consume and process the messages by following the instructions given in the sections below.
Creating and using Azure Service Bus Listener with a Process Flow
Creating Azure Service Bus Listener and using it in a Template
Creating and using Azure Service Bus Listener with a Process Flow
Follow the steps given below to create and use Azure Service Bus Listener with a Process Flow.
The Azure Service Bus Listener created from the manage page is available to be used only in a process flow.
Click Configure > EVENTS > Azure Service Bus Listener.
Click Create Azure Service Bus Listener.
On the Create Azure Service Bus Listener window, enter the following details:
Expand the Advanced Properties and enter the email id(s) separated by a comma in the Notification Receiver Email-ID(s) field to receive notifications on message failure.
Select the required project in the Select Project field.
Click Save to save Azure Service Bus Listener.
Creating Azure Service Bus Listener and using it in a Template
To use Azure Service Bus Listener in a Template, you need to create it from within the Template itself. Follow the steps given below to create Azure Service Bus Listener from within a Template.
You can also allow the Partner to create Azure Service Bus Listener by clicking Partner will define this step check box. The Partner will be able to create Azure Service Bus Listener while creating a Transaction using this Template.
While creating the Template, select Azure Service Bus as a source application.
In the Which event should trigger the data transfer? field, select New Message and click Next.
In the Provide Azure Service Bus account information field, select the Azure Service Bus account and click Next.
On the Azure Service Bus Settings page, provide the information required for each field. For more details refer to this table.
Click Next.
Complete rest of the steps in the wizard.
This creates the Azure Service Bus Listener which is used with the Template to consume and process the messages.
Activating or deactivating the Azure Service Bus Listener
You can activate (turn on) or deactivate (turn off) an Azure Service Bus Listener by toggling on the Azure Service Bus Listener manage page.
The option to turn the Azure Service Bus Listener ON or OFF is available only for the listener that have been created from the manage page.
Once turned on, the listener starts consuming the messages from Azure Service Bus Server and triggers the process flow for processing the received messages.
Once turned off, the listener stops receiving Azure Service Bus messages from server.
Azure Service Bus Target
Azure Service Bus Target sends the messages to Azure Service Bus. You can create Azure Service Bus Target by following the steps given in the following sections and use it in a Template/Transaction or Process Flow.
Creating Azure Service Bus Target and using it in a Process Flow
Creating Azure Service Bus Target and using it in a Template
Creating Azure Service Bus Target and using it in a Process Flow
Steps to create Azure Service Bus Target.
The Azure Service Bus Target created from the manage page or from within the process flow is available to be used only in a process flow.
Click Configure > TARGETS > Azure Service Bus Target.
Click Create Azure Service Bus Target.
In Create Azure Service Bus Target window, enter the following details:
This creates the Azure Service Bus Target. Once created, you can use it in a Process Flow as a destination. To achieve this, go to the Process Flow Repository View > Activities > Destination (Target) > AzureServiceBusTarget, and then expand and select the required Azure Service Bus target.
Creating Azure Service Bus Target and using it in a Template
To use Azure Service Bus Target in a Template, you need to create it from within the Template itself. Follow the steps given below to create Azure Service Bus Target from within a Template.
You can also allow the Partner to create Azure Service Bus Target by clicking Partner will define this step check box. The Partner will be able to create Azure Service Bus Target while creating a Transaction using this Template.
While creating the Template, select Azure Service Bus as a destination application.
In the Provide Azure Service Bus account information field, select the Azure Service Bus account and click Next.
In the How the data should be delivered to destination? field, select Send Message and click Next.
On the Azure Service Bus Settings page, provide the information required for each field. For more details refer to this table.
Click Next.
Complete rest of the steps in the wizard.
This creates the Azure Service Bus Target which is used with the Template/Transaction to send the messages to Azure Service Bus.
Setting the Event Context Enabled property
Perform the following steps to enable the Event Context Enabled property in the process flow.
Select the Source service and then click View Properties on the context pad menu.
In the Activity Properties panel, under the GENERAL tab, click the toggle switch to turn on the Event Context Enabled property.
Save the process flow.
Related Topics