Microsoft Azure Service Bus Send Message activity

Introduction

A Microsoft Azure Service Bus Send Message activity, using its Microsoft Azure Service Bus connection, sends messages to a Microsoft Azure Service Bus queue or topic and is intended to be used as a target in an operation.

Create a Microsoft Azure Service Bus Send Message activity

An instance of a Microsoft Azure Service Bus Send Message activity is created from a Microsoft Azure Service Bus connection using its Send 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 Send 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 Send Message activity

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

• Step 1: Enter a name and specify settings
  Provide a name for the activity and specify settings.

• Step 2: Review the data schemas
  Any request or response schemas are displayed.

Step 1: Enter a name and specify settings

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

The interface used in this step of the configuration of a Microsoft Azure Service Bus Send Message activity depends on the Choose Activity option selected:

• Inform queue or topic manually: For this option, you will manually enter the queue or topic where the messages are to be sent.
• Select existent queue or topic: For this option, you will choose from a populated list of existing queues and topics where the messages are to be sent.

Inform queue or topic manually

If Inform Queue or Topic Manually is selected for Choose Activity, this interface is presented:

• Name: Enter a name to identify the activity. The name must be unique for each Microsoft Azure Service Bus Send Message activity and must not contain forward slashes / or colons :.

• Choose Activity: Select the method of specifying the queue or topic to be used, one of Inform Queue or Topic Manually or Select Existent Queue or Topic.

  • Inform Queue or Topic Manually: Select to manually enter the queue or topic where the messages are to be sent.

  • Select Existent Queue or Topic: Select to choose from a populated list of existing queues and topics where the messages are to be sent.

• Queue/Topic: Enter the name of the queue or topic to send the messages to.

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

Select existent queue or topic

If Select Existent Queue or Topic is selected for Choose Activity, this interface is presented:

• Name: Enter a name to identify the activity. The name must be unique for each Microsoft Azure Service Bus Send Message activity and must not contain forward slashes / or colons :.

• Choose Activity: Select the method of specifying the queue or topic to be used, one of Inform Queue or Topic Manually or Select Existent Queue or Topic.

  • Inform Queue or Topic Manually: Select to manually enter the queue or topic where the messages are to be sent.

  • Select Existent Queue or Topic: Select to choose from a populated list of existing queues and topics where the messages are to be sent.

• Select a Queue or Topic: This section displays queues and topics available in the Microsoft Azure Service Bus endpoint.

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

  • Search: Enter any column's value into the search box to filter the list of queues and topics. The search is not case-sensitive. If queues are already displayed within the table, the table results are filtered in real time with each keystroke. To reload queues and 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 queues and topics from the Microsoft Azure Service Bus endpoint. This may be useful if queues have been added to Microsoft Azure Service Bus. This action refreshes all metadata used to build the table of queues and topics displayed in the configuration.

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

    • Name: The name of the queue or topic.

    • Description: The description of the queue or topic.

  Tip

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

• 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: Review the data schemas

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

• 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 Send 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 Send Message activities can be used as a target with these operation patterns:

• Transformation pattern
• Two-transformation pattern (as the first or second target)

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.