Hero Card Attachment

An activity that creates a hero card attachment for a bot message in Microsoft Azure Bot Service.

Configure the Hero Card Attachment activity

To configure the Hero Card Attachment activity, do the procedure in this topic.

Examples

(Example) How to Get the Access Token Credentials from Bot Services

Prerequisites

AgilePoint NX OnDemand (public cloud), or AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v7.0 or higher.

Good to Know

To send an e-mail notification, click Advanced > E-mail Notifications .
For more information, refer to Configure E-mail Notifications for Any Activity.
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?
Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses 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, and 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

On the Application Explorer screen, do one of these:
- Open a Process.
- Create a Process.
Do one of these:
- Add an activity:
  1. In the Process Builder, in the Activity Library open the Bot Integration tab.
  2. On the Bot Integration tab, drag the Hero Card Attachment activity onto your process.
- Change an activity:
  1. In your process, double-click your activity.

General Configuration

Specifies the basic settings for the Hero Card Attachment activity.

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

Hero Card Attachment Configuration > Basic

Configures the basic information for a hero card.

Fields

Field Name	Definition
Azure Bot Services	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 Bot Services
Add Token	Opens this Screen: Access Token for 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 Bot Services
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, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses 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, and 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, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses 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, and 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?
From ID	Function: Specifies the ID for your bot. Accepted Values: A valid bot ID. 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, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses 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, and 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?
From Name	Function: Specifies the name for your bot. Accepted Values: A valid bot name. Default Value: None Accepts Process Data Variables: Yes
Recipient ID	Function: Specifies the user ID of the channel to associate with the action. Accepted Values: A valid user ID of the channel. 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, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses 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, and 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?
Recipient Name	Function: Specifies the user name to associate with the action.. Accepted Values: A valid user name. Default Value: None Accepts Process Data Variables: Yes
Message	Function: Specifies the content of the message. Accepted Values: More than one line of text. Default Value: None Accepts Process Data Variables: Yes

Hero Card Attachment Configuration > Card Config

Configures the hero card.

Fields

Field Name	Definition
Title	Function: Specifies the title for your card. Accepted Values: One line of text that can have spaces. Default Value: None Accepts Process Data Variables: Yes
Subtitle	Function: Specifies the subtitle for your card. Accepted Values: One line of text that can have spaces. Default Value: None Accepts Process Data Variables: Yes
Description	Function: Specifies an optional text description for your card. Accepted Values: More than one line of text. Default Value: None Accepts Process Data Variables: No
Image URL	Function: Specifies the URL of an image to use in your card for the message. Accepted Values: A valid image URL. Default Value: None Accepts Process Data Variables: Yes
Inline Action Buttons	Function: Specifies whether to use action buttons on your card with literal values. Accepted Values: Selected - Lets you specify action buttons on your card with literal (hard coded) values. Deselected - Lets you specify action buttons on your card with repeating schema elements. Default Value: None
Button Text	Function: Specifies a name for the button. To Open this Field: On the Card Config tab, click Inline Action Buttons. Accepted Values: One line of text that can have spaces Default Value: None
Action to Perform	Function: Specifies what the button does. To Open this Field: On the Card Config tab, click Inline Action Buttons. Accepted Values: Open URL - Opens a specified URL in a web browser. Download File - Opens a file at a specified URL. IM Back - Sends specified text to send to the bot. Message Back - Sends a specified message to the bot. Post Back - Sends a specified post to the bot. Show Image - Shows an image from a specified URL. Sign In - Specifies the URL for an OAuth 2.0 sign-in procedure. Play Audio - Plays an audio file from a specified URL. Play Video - Plays a video file from a specified URL. Default Value: None
Value	Function: Specifies the value for your action. To Open this Field: On the Card Config tab, click Inline Action Buttons. Accepted Values: The value of this field depends on the action type you select in the Action to Perform list. Default Value: None Limitations: Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses 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, and 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?
Add	Function: Adds a button for action. To Open this Field: On the Card Config tab, click Inline Action Buttons.
Select the repeating data node that will contain the Buttons data	Function: Specifies a repeating schema element that stores the data for your buttons. To Open this Field: On the Card Config tab, click Map Action Buttons from schema. Accepted Values: A valid repeating schema element. Default Value: None Accepts Process Data Variables: Yes