Send Message To Queue activity

An activity that sends a message to a queue in Microsoft Azure Service Bus.


Send Message To Queue activity

Configure the Send Message To Queue activity

Prerequisites

Good to Know

How to Start

  1. Open Process Builder.

    For information about how to open this screen, refer to Process Builder.


    Open Process Builder
  2. In the Process Builder, in the Activity Library, open the MS Azure Service Bus tab.

    Open MS Azure Service Bus tab
  3. On the MS Azure Service Bus tab, drag the Send Message To Queue activity onto your process.

    Drag Send Message To Queue activity

General Configuration

Specifies the basic settings for the Send Message To Queue activity.

Figure: General Configuration screen

General Configuration screen

Good to Know

  • Documentation for this screen is provided for completeness. The fields are mostly self-explanatory.

Fields

Field NameDefinition

Display Name

Function:
Specifies the activity name that shows in your process.
Accepted Values:
One line of text that can have spaces.
Default Value:
None
Accepts Process Data Variables:
No
Example:
This is a common configuration field that is used in many examples. Refer to:
  • Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Description

Function:
Specifies an optional text description for your activity.
Accepted Values:
More than one line of text.
Default Value:
None
Accepts Process Data Variables:
No

Send Message To Queue Configuration > Message tab

Configures the message to send to a queue in Microsoft Azure Service Bus.

Figure: Send Message To Queue Configuration > Message tab

Send Message To Queue Configuration Message tab

Fields

Field NameDefinition

MS Azure Service Bus

Function:
Specifies the access token that connects to your Microsoft Azure Service Bus environment.
Accepted Values:
A list of access tokens configured for your environment.
Default Value:
None

Create Add Token icon

Opens this Screen:
Access Token for Microsoft Azure Service Bus
Function of this Screen:
Configure an access token to connect to Microsoft Azure Service Bus.

Queue Name

Function:
Specifies the name of the queue from Microsoft Azure Service Bus to send the message.
Accepted Values:
A queue name from Microsoft Azure Service Bus.
Default Value:
None
Accepts Process Data Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Content Type

Function:
Specifies the format of the message to send.
Accepted Values:
  • JSON
  • Text
  • XML
Default Value:
None
Accepts Process Data Variables:
No

Read Message From This Variable / Map Payload To App Schema

Function:
Specifies how to send the message to a queue in Microsoft Azure Service Bus.
Accepted Values:
  • Read Message From This Variable - Select this option if you want to send a message from a variable in the AgilePoint NX app.

    In the text field, specify a variable that stores the message.

  • Map Payload To App Schema - Specifies a payload to send a message.

    In the text field, specify a payload in JSON or XML format.

    Click Map Schema button to open the Schema Mapper screen. Use this screen to connect the values in the payload to your AgilePoint process schema.

Default Value:
Read Message From This Variable
Accepts Process Data Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Send Message To Queue Configuration > Advanced Properties tab

Configures the properties from Microsoft Azure Service Bus with values or variables in the AgilePoint NX app to send in a message.

Figure: Send Message To Queue Configuration > Advanced Properties tab

Send Message To Queue Configuration Advanced Properties tab

Fields

Field NameDefinition

MS Azure Service Bus

Function:
Specifies the access token that connects to your Microsoft Azure Service Bus environment.
Accepted Values:
A list of access tokens configured for your environment.
Default Value:
None

Create Add Token icon

Opens this Screen:
Access Token for Microsoft Azure Service Bus
Function of this Screen:
Configure an access token to connect to Microsoft Azure Service Bus.

Queue Name

Function:
Specifies the name of the queue from Microsoft Azure Service Bus to send the message.
Accepted Values:
A queue name from Microsoft Azure Service Bus.
Default Value:
None
Accepts Process Data Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Property Name

Function:
Specifies the name of the property to add to the message in a key-value pair.

When you select an access token in the MS Azure Service Bus field, this field shows the property names that configured in Microsoft Azure Service Bus.

Accepted Values:
A property name from the list.
Default Value:
None
Accepts Process Data Variables:
No
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Property Value

Function:
Specifies the value for the property in a key-value pair.
Accepted Values:
A number or a text string that can contain spaces.
Default Value:
None
Accepts Process Data Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Create Add Token icon

Function:
Adds a row for a property.

Delete Delete icon

Function:
Deletes the row.