Skip to Content

Microsoft Azure ESB Consume Topic (Beta) Activity

Introduction

A Microsoft Azure ESB Consume Topic (Beta) activity, using its Microsoft Azure ESB connection, consumes messages from a Microsoft Azure Service Bus topic and is intended to be used as a source in an operation.

Important

To use the Consume Topic (Beta) activity, the authorization policy rule referenced in the Microsoft Azure ESB connection Policy Name must include listen rights.

Note

This activity is currently released as a beta version. Feedback on bugs and suggested enhancements can be provided through your Customer Success Manager (CSM).

Prerequisites

To use the Consume Queue (Beta) activity, these prerequisites must be met:

  • A Private Agent version 10.70 or later (for 10.x Private Agents) or 11.8 or later (for 11.x Private Agents). For Private Agent Groups that contain multiple agents, the Private Agent version must be 10.78 or later (for 10.x Private Agents), or 11.8 or later (for 11.x Private Agents).

  • To fully benefit from the listening service's load-balancing and fault-tolerance features, it is recommended to have a minimum of two Private Agents in the Agent Group.

  • The Private Agent must have the listening service enabled as described in Enable the Listening Service on the Agent. This is a manual step in configuration and is not enabled by default.

  • Once an operation is deployed, the Cloud Studio project must have the listening service enabled at both the operation level and the activity level as described in Enable the Listening Service on the Operation and Activity. This is manual step performed at the time of project design or project management.

Create a Microsoft Azure ESB Consume Topic (Beta) Activity

An instance of a Microsoft Azure ESB Consume Topic (Beta) activity is created from a Microsoft Azure ESB connection using its Consume Topic (Beta) activity type.

To create an instance of an activity, drag the activity type to the design canvas or copy the activity type and paste it on the design canvas. For details, see Create an Activity Instance in Component Reuse.

An existing Microsoft Azure ESB Consume Topic (Beta) activity can be edited from these locations:

Configure a Microsoft Azure ESB Consume Topic (Beta) Activity

Follow these steps to configure a Microsoft Azure ESB Consume Topic (Beta) activity:

Step 1: Enter a Name and Select a Topic

In this step, provide a name for the activity and select a topic. Each user interface element of this step is described below.

Microsoft Azure ESB Consume Topic (Beta) Activity Configuration Step 1

  • Name: Enter a name to identify the activity. The name must be unique for each Microsoft Azure ESB Consume Topic (Beta) activity and must not contain forward slashes / or colons :.

  • Select a Topic: This section displays topics available in the Microsoft Azure ESB endpoint.

    • Selected Topic: After a topic is selected, it is listed here.

    • Search: Enter any part of the topic name into the search box to filter the list of topics. The search is not case-sensitive. If topics are already displayed within the table, the table results are filtered in real time with each keystroke. To reload topics from the endpoint when searching, enter search criteria and then refresh, as described below.

    • Refresh: Click the refresh icon Refresh icon or the word Refresh to reload topics from the Microsoft Azure ESB endpoint. This may be useful if topics have been added to Microsoft Azure Service Bus. This action refreshes all metadata used to build the table of topics displayed in the configuration.

    • Selecting a Topic: Within the table, click anywhere on a row to select a topic. Only one topic can be selected. The information available for each topic is fetched from the Microsoft Azure ESB endpoint:

      • Name: The name of the topic.

      • Description: The description of the topic.

    Tip

    If the table does not populate with available topics, the Microsoft Azure ESB connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.

  • Receive Mode: Select a receive mode, one of Peek Lock or Receive and Delete.

  • Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.

  • Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 2: Select a Subscription

In this step, select a subscription. Each user interface element of this step is described below.

Microsoft Azure ESB Consume Topic (Beta) Activity Configuration Step 2

  • Select a Subscription: This section displays subscriptions available in the Microsoft Azure ESB endpoint.

    • Selected Topic: The topic selected in the previous step is listed here.

    • Selected Subscription: After a subscription is selected, it is listed here.

    • Search: Enter any part of the subscription name into the search box to filter the list of subscriptions. The search is not case-sensitive. If subscriptions are already displayed within the table, the table results are filtered in real time with each keystroke. To reload subscriptions from the endpoint when searching, enter search criteria and then refresh, as described below.

    • Refresh: Click the refresh icon Refresh icon or the word Refresh to reload subscriptions from the Microsoft Azure ESB endpoint. This may be useful if subscriptions have been added to Microsoft Azure Service Bus. This action refreshes all metadata used to build the table of subscriptions displayed in the configuration.

    • Selecting a Subscription: Within the table, click anywhere on a row to select a subscription. Only one subscription can be selected. The information available for each subscription is fetched from the Microsoft Azure ESB endpoint:

      • Name: The name of the subscription.

      • Description: The description of the subscription.

    Tip

    If the table does not populate with available subscriptions, the Microsoft Azure ESB connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.

  • Back: Click to temporarily store the configuration for this step and return to the previous step.

  • Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 3: Review the Data Schemas

Any request or response schemas are displayed. Each user interface element of this step is described below.

Microsoft Azure ESB Consume Topic (Beta) Activity Configuration Step 3

  • Data Schemas: These data schemas are inherited by adjacent transformations and are displayed again during transformation mapping.

    The Microsoft Azure ESB connector uses the Microsoft Azure Service Bus Client for Java v3.6.7. Refer to the API documentation for information on the schema nodes and fields.

  • Refresh: Click the refresh icon Refresh icon or the word Refresh to regenerate schemas from the Microsoft Azure ESB endpoint. This action also regenerates a schema in other locations throughout the project where the same schema is referenced, such as in an adjacent transformation.

  • Back: Click to temporarily store the configuration for this step and return to the previous step.

  • Finished: Click to save the configuration for all steps and close the activity configuration.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Next Steps

After configuring a Microsoft Azure ESB Consume Topic (Beta) activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure the operation settings, which include the ability to chain operations together that are in the same or different workflows.

Menu actions for an activity are accessible from the project pane and the design canvas. For details, see Activity Actions Menu in Connector Basics.

Microsoft Azure ESB Consume Topic (Beta) activities can be used as a source with these operation patterns:

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

Deploy the Operation and Enable Events

Once the operation is configured, deploy it. Deploying the operation activates a toggle that is present at the bottom of the operation on the design canvas. By default, event listening is disabled.

To enable event listening for the operation, click the toggle:

consume topic activity events enabled

When event listening is enabled, the operation will run when it is triggered by the configured event.

Note

Activities that listen to the same event in multiple operations or multiple projects will track those events separately and consume a message in each configured activity. That is, each operation configured with an enabled event will run when the event occurs.

After the operation triggers, you can validate behavior by checking the operation logs. A log entry is made for every message processed by the listening operation.

Administrators can also enable or disable event listening from the Management Console Projects page.