Microsoft Azure Service Bus Connector Setup Guide

Microsoft Azure Service Bus Connector Setup Guide

by Community Manager on ‎06-06-2017 07:56 PM - edited 3 weeks ago by Community Manager (102 Views)

Microsoft Azure Service Bus is a cloud messaging service between applications and services. This article describes how to configure the service in the Universal Data Hub.

Table of Contents Placeholder

Requirements

  • Microsoft Azure Account
  • Service Bus Shared Access Policy Credentials
  • Queue or Topic to send data to

Supported Actions

Action Name Trigger on Audience Trigger on Streams
Send Event Data to Queue or Topic
Send Visitor Data to Queue or Topic
Send Customized Data to Queue or Topic

Configure Settings

Go to the Connector Marketplace and add a new Microsoft Azure Service Bus Connector. Read the Connector Overview article for general instructions on how to add a Connector.

To configure your vendor, follow these steps:

  1. In the Configure tab, provide a title for the Connector instance.

  2. Enter Service Bus Namespace, Shared Access Policy Name and Key. For more information, see Namespace & Shared Access Policies.

  3. Click Test Connection to verify API connectivity with the provided credentials.

Shared Access Policies can claim three type of permissions: Send, Listen and Manage. Provided policy must claim at least Send permission.

Action Settings - Parameters and Options

Click Next or go to the Actions tab. It's where you'll set up Actions to trigger.

This section describes how to set up Parameters and Options for each Action.

Action - Send Event Data to Queue or Topic

Parameters

  1. Queue or Topic (REQUIRED): Select a queue or topic option from this list. These options are available only if your configured policy is granted the Manage permission. If the permission is not granted, you must manually enter a queue/topic as a Custom Value.
  2. User Properties: Map Attribute(s) to a message user property in the To dropdown (entered as a Custom Value).
  3. Broker Properties: Map Attribute(s) to the message broker property of choice in the To dropdown. See available options below.
  4. Print Attribute Names: Checking this box will display names for each event data Attribute in the message payload.

All Actions support Message User and Broker properties. They provide useful and convenient information about a message using key-value pairs. But they are set as HTTP headers and do not reside within the message body. For more information see Message User & Broker Properties

Options - Broker Properties

Option Description
Content Type Sets HTTP header Content-Type for message consumers
Correlation ID Unique identifier of the correlation
Session ID Can be used to partition and route messages to particular consumers
Message ID Overrides default auto-generated Message ID
Label Application label
Reply To Can be used to specify where to send a response for message consumers
Time to Live in Seconds Expire message after X number of seconds (overrides queue/topic level)
To Send to address
Scheduled Enqueued Time Scheduled date and time at which the message is enqueued
Reply to Session ID Similar to Reply To but targets a session for a response
Partition Key Unique identifier of the partitioned queue or topic

Action - Send Visitor Data to Queue or Topic

Parameters

  1. Queue or Topic (REQUIRED): Select a queue or topic option from this list. These options are available only if your configured policy is granted the Manage permission. If the permission is not granted, you must manually enter a queue/topic as a Custom Value.
  2. User Properties: Map Attribute(s) to a message user property in the To dropdown (entered as a Custom Value).
  3. Broker Properties: Map Attribute(s) to the message broker property of choice in the To dropdown. See available Broker Properties options.
  4. Include Current Visit Data: Checking this box will include current visit data in the message payload.
  5. Print Attribute Names: Checking this box will display names for each visitor data Attribute in the message payload.

Action - Send Customized Data to Queue or Topic (Advanced)

Parameters

  1. Queue or Topic (REQUIRED): Select a queue or topic option from this list. These options are available only if your configured policy is granted the Manage permission. If the permission is not granted, you must manually enter a queue/topic as a Custom Value.
  2. User Properties: Map Attribute(s) to a message user property in the To dropdown (entered as a Custom Value).
  3. Broker Properties: Map Attribute(s) to the message broker property of choice in the To dropdown. See available Broker Properties options.
  4. Message Data (REQUIRED): Construct a custom message body. Map Attribute(s) to names for simple one level JSON format, or reference a template name (surrounded in double curly braces) and select the Custom Message Definition option.
  5. Template Variables: Map Attribute(s) to template variable names. Template variables are available for substitution and rendering of all templates. Refer to our Template Variables Guide for details.
  6. Templates: Provide one or more template to render. Typically, a single template is used to construct a message data. Refer to our Templates Guide for common syntax and extensions.

If necessary, templates can also be referenced and injected in user and broker properties.

Vendor Documentation