Send Message To Conversation

An activity that sends a message to the specified conversation in Microsoft Azure Bot Service.

Configure the Send Message To Conversation activity

To configure the Send Message To Conversation activity, do the procedure in this topic.

Examples

(Example) How to Get the Access Token Credentials from Microsoft Azure Bot Service

Prerequisites

AgilePoint NX OnDemand (public cloud), or AgilePoint NX Private Cloud or AgilePoint NX OnPremises v7.0 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 Bot Service tab.
On the MS Azure Bot Service tab, drag the Send Message To Conversation activity onto your process.

General Configuration

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

Good to Know

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

Fields

Field Name	Definition
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

Field Name

Definition

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:

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 Conversation Configuration

Configures the message to send to conversation.

Fields

Field Name	Definition
MS Azure Bot Service	Function: Specifies the access token that connects to your Microsoft Azure Bot Service. Accepted Values: A list of access tokens configured for your environment. Default Value: None Accepts Process Data Variables: No Example: (Example) How to Get the Access Token Credentials from Microsoft Azure Bot Service
Create	Opens this Screen: Access Token for Microsoft Azure Bot Service Function of this Screen: Configure an access token to connect to Microsoft Azure Bot Service. Example: (Example) How to Get the Access Token Credentials from Microsoft Azure Bot Service
Service URL	Function: Specifies the URL for your bot. Accepted Values: A valid bot URL. 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?
Conversation ID	Function: Specifies the conversation ID for which to send the message. Accepted Values: A valid conversation ID. When you create a conversation in your bot, you get the conversation ID for each conversation. 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?
Attachment Types	Function: Specifies the type of attachment to include in your message. Accepted Values: Add media attachments to messages - Adds media files to your message. Add rich card attachments to messages - Adds rich cards to your message. Add suggested actions to messages - Adds suggested actions to apply to your message. Default Value: None Accepts Process Data Variables: No
Request Mapping	Function: Connects the bot API request parameter to your process schema. This is mandatory only if the request passes data from the process schema to parameters in the bot API. Accepted Values: Click the Schema Mapping button to open the Schema Mapper. Use this screen to connect the request to the data model for your process. Default Value: None Example: Refer to: (Example) Schema Mapper
Store Response Activity ID in this Variable	Function: Specifies the process data variable that stores your message ID from Microsoft Azure Bot Service. Accepted Values: A process data variable that accepts an alphanumeric string with no spaces or special characters. 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?