Receive Message From Queue activity

An activity that receives a message from a queue in Microsoft Azure Service Bus.

Configure the Receive Message From Queue activity

Prerequisites

AgilePoint NX OnDemand (public cloud), or AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v9.0 Software Update 1 or higher.

Good to Know

To send an email notification, click Advanced > Email Notifications .
For more information, refer to Email Notifications screen (Process Activities).
In most text fields, you can use process data variables as an alternative to literal data values.
You can configure whether this activity waits for other activities before it runs.
For more information, refer to How Do I Configure an Activity to Wait for Other Incoming Activities?
This section shows the configuration settings on the configuration screens for this activity. Other configuration settings apply to system activities. For more information, refer to:
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?

How to Start

Open Process Builder.
For information about how to open this screen, refer to Process Builder.
In Process Builder, in the Activity Library, open the MS Azure Service Bus tab.
On the MS Azure Service Bus tab, drag the Receive Message From Queue activity onto your process.

General Configuration

Specifies the basic settings for the Receive Message From Queue activity.

Good to Know

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

Fields

Field Name	Definition
Display Name	Description: Specifies the activity name that shows in your process. Allowed Values: One line of text (a string). Accepted: Letters Numbers Spaces Default Value: None Accepts 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	Description: Specifies an optional text description for your activity. Allowed Values: More than one line of text. Default Value: None Accepts Variables: No

Field Name

Definition

Display Name

Description:

Specifies the activity name that shows in your process.

Allowed Values:

One line of text (a string).

Accepted:

Letters
Numbers
Spaces

Default Value:

None

Accepts Variables:

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

Description:: Specifies an optional text description for your activity.
Allowed Values:: More than one line of text.
Default Value:: None
Accepts Variables:: No

Receive Message From Queue Configuration > Message tab

Specifies the information to receive the message from a queue in Microsoft Azure Service Bus.

Fields

Field Name	Definition
MS Azure Service Bus	Description: Specifies the access token that connects to your Microsoft Azure Service Bus environment. Allowed Values: A list of access tokens configured for your environment. Default Value: None
Create	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	Description: Specifies the name of the queue from Microsoft Azure Service Bus to receive the message. Allowed Values: A queue name from Microsoft Azure Service Bus. Default Value: None Accepts 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?
Retry Count	Description: Specifies the number of times Microsoft Azure Service Bus attempts to receive the message from the queue. Allowed Values: An integer. Range: 1-100 Default Value: 60 Accepts Variables: No
Delay Between Retries (ms)	Description: Specifies a time interval in milliseconds between each retry. Allowed Values: An integer. Range: 1000-60000 Default Value: 1000 Accepts Variables: No
Content Type	Description: Specifies the format of the message to receive. Allowed Values: JSON Text XML Default Value: None Accepts Variables: No
Store Message In This Variable / Map Response To App Schema	Description: Specifies how to store the message from the queue in Microsoft Azure Service Bus. Allowed Values: Store Message In This Variable - Select this option if you want to store the message in a variable in the AgilePoint NX app. In the text field, specify a variable to store the message. Map Response To App Schema - Specifies a payload to receive a message. In the text field, specify a payload in JSON or XML format. Click the Schema Mapping button to open the Schema Mapper. Use this screen to connect the response to the data model for your process. Default Value: Store Message In This Variable Accepts 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?

Receive Message From Queue Configuration > Store Advanced Properties tab

Receives the value from a queue property in Microsoft Azure Service Bus, and stores the property value in a variable in the AgilePoint NX app.

Fields

Field Name	Definition
MS Azure Service Bus	Description: Specifies the access token that connects to your Microsoft Azure Service Bus environment. Allowed Values: A list of access tokens configured for your environment. Default Value: None
Create	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	Description: Specifies the name of the queue from Microsoft Azure Service Bus to receive the message. Allowed Values: A queue name from Microsoft Azure Service Bus. Default Value: None Accepts 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?
Retry Count	Description: Specifies the number of times Microsoft Azure Service Bus attempts to receive the message from the queue. Allowed Values: An integer. Range: 1-100 Default Value: 60 Accepts Variables: No
Delay Between Retries (ms)	Description: Specifies a time interval in milliseconds between each retry. Allowed Values: An integer. Range: 1000-60000 Default Value: 1000 Accepts Variables: No
Property Name	Description: Specifies a queue property whose information to receive. When you select an access token in the MS Azure Service Bus field, this field shows the property names that are configured in Microsoft Azure Service Bus. Allowed Values: A property name from the list. Default Value: None Accepts 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	Description: Specifies a variable to store the value of the property. The value is passed from the property to the variable specified in this field. Allowed Values: A variable that accepts a value of the same data type as the property. Default Value: None Accepts 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	Function: Adds a row for the Property Name and Property Value fields.
Delete	Function: Deletes the row.