Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

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

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.

  1. Click Configure > TARGETS > Azure Service Bus Target.
  2. Click Create Azure Service Bus Target.

  3. In Create Azure Service Bus Target window, enter the following details:



    Field NameDescription
    Name

    A short, descriptive name to re-use this target in future.

    Description

    A short Description for the Azure Service Bus Target.

    Azure Service Bus Account

    The account with which you want to associate the target.

    Important tip

    If you have set the Authentication Type as Shared Access Signature while creating the Azure Service Bus account, but the Connection String does not have manage and read claim, the list of topics/queues will not be auto populated in the Topic/Queue field. In this case, you can enter the queue/topic name manually.

    Azure Service Bus Type

    The field that governs the type (Queue, or Topic) of service bus you want to select for processing the messages.

    You can select QUEUE or TOPIC as the Azure Service Bus Type. Based on your selection, the input fields that follow will differ.

    • If you select TOPIC as the Azure Service Bus Type, you need to select the Topic through which you want to send the messages.
    • If you select QUEUE as Azure Service Bus Type, you need to select the name of the queue through which you want to send the messages.
    Content Type The content type of the message. The available types are Text/Plain, Application/XML , or Application/JSON.  You can also enter a custom value in this field.
    Correlation ID (Optional)The field for specifying a context for the message for correlation, for example, reflecting the Message-Id of a message that is being replied to.
    The unique identifier for the message and its payload. The value for this field is a free-form string. It can be a GUID or an identifier derived from the application context. Specifying the Message ID of the message prevents the submission of duplicate messages.
    The field to set the subject/label of the message. It indicates the purpose of the message to the receiver in a standardized fashion, similar to an email subject line.
    Reply To (Optional)The field to set the "ReplyTo" address for the message.
    To (Optional)The email address of the message receiver.
    Session ID (Optional)

    Enables joint and ordered handling of unbounded sequences of related messages. You can create/join a session when submitting messages into a topic or queue by setting the Session ID field to some application-defined identifier that's unique to the session. 

    Custom Properties (Optional)

    The field to specify custom properties for the message. To add multiple custom properties, click .

    Enable Message SplitterThe field that enables splitting of the messages based on message type and sending them in batches. To enable this feature, select the checkbox Enable Message Splitter. If you enable message splitter, you need to provide the following information.
    1. Message Type: Select the data format – JSON, XML, or PLAINTEXT – of the messages based on which you want to split them.

    2. Message Splitter: Enter the value for this field based on the selected Message Type.

      • If the Message Type is JSON: Enter an element name. You can also leave this field blank.
      • If the Message Type is XML: Enter an an element name of the record.
      • If the Message Type is PLAINTEXT: Enter a delimiter.
    3. Batch Size: Enter the number of messages you want to be sent in a single batch.

    Select ProjectSelect the required project in the field.

    You can also create Azure Service Bus Target while creating or editing a Process Flow by going to Repository View > Activities > Destination (Target) > AzureServiceBusTarget, and then clicking the icon. 

    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.

  1. While creating the Template, select Azure Service Bus as a destination application.



  2. In the Provide Azure Service Bus account information field, select the Azure Service Bus account and click Next.


  3. In the How the data should be delivered to destination? field, select Send Message and click Next.



  4. On the Azure Service Bus Settings page, provide the information required for each field. For more details refer to this table
  5. Click Next.

  6. 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.

  • No labels