Microsoft Azure Service Bus Get Topic Message activity

Introduction

A Microsoft Azure Service Bus Get Topic Message activity, using its Microsoft Azure Service Bus connection, retrieves messages from a Microsoft Azure Service Bus topic and is intended to be used as a source in an operation.

Create a Microsoft Azure Service Bus Get Topic Message activity

An instance of a Microsoft Azure Service Bus Get Topic Message activity is created from a Microsoft Azure Service Bus connection using its Get Topic Message 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 Service Bus Get Topic Message activity can be edited from these locations:

The design canvas (see Component actions menu in Design canvas).
The project pane's Components tab (see Component actions menu in Project pane Components tab).

Configure a Microsoft Azure Service Bus Get Topic Message activity

Follow these steps to configure a Microsoft Azure Service Bus Get Topic Message activity:

Step 1: Enter a name and select a topic
Provide a name for the activity and select a topic.
Step 2: Select a subscription
Select a subscription.
Step 3: Review the data schemas
Any request or response schemas are displayed.

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 Service Bus Get Topic Message activity configuration step 1

Tip

Fields with a variable icon support using global variables, project variables, and Jitterbit variables. Begin either by typing an open square bracket [ into the field or by clicking the variable icon to display a list of the existing variables to choose from.

Name: Enter a name to identify the activity. The name must be unique for each Microsoft Azure Service Bus Get Topic Message activity and must not contain forward slashes / or colons :.
Select a Topic: This section displays topics available in the Microsoft Azure Service Bus endpoint.
- Selected Topic: After a topic is selected, it is listed here.
- Search: Enter any column's value 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 or the word Refresh to reload topics from the Microsoft Azure Service Bus 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 Service Bus 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 Service Bus 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.
- Peek Lock: Messages are locked to be explicitly processed. For more information, see Microsoft's documentation on settling receive operations.
  
  Important
  
  Locked topic messages can be unlocked using a Microsoft Azure Service Bus Unlock topic message activity or renewed using a Microsoft Azure Service Bus Renew topic message lock activity.
- Receive and Delete: Messages are considered processed as soon as the Service Bus message broker transfers them. If transfers fail, the messages are lost. For more information, see Microsoft's documentation on settling receive operations.
Session ID: Enter the session ID for the messages being retrieved. For more information, see Microsoft's documentation on message sessions.
Number of Messages (Default: 1 - Max: 100): Enter the number of messages to retrieve.
Wait Time (Default: 10 Seconds - Max: 245 Seconds): Enter the maximum time in seconds to wait for messages. If empty, 10 is used.
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 Service Bus Get Topic Message activity configuration step 2

Select a Subscription: This section displays subscriptions available in the Microsoft Azure Service Bus 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 column's value 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 or the word Refresh to reload subscriptions from the Microsoft Azure Service Bus 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 Service Bus 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 Service Bus 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 Service Bus Get Topic Message activity configuration step 3

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

The Microsoft Azure Service Bus 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 or the word Refresh to regenerate schemas from the Microsoft Azure Service Bus 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 Service Bus Get Topic Message 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 Service Bus Get Topic Message activities can be used as a source with these operation patterns:

Transformation pattern
Two-target archive pattern (as the first source only)
Two-target HTTP archive pattern (as the first source only)
Two-transformation pattern (as the first source only)

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

When ready, deploy and run the operation and validate behavior by checking the operation logs.