Receipt Card Attachment

An activity that creates a receipt card attachment that enables a bot attachment to give a receipt to the user with Microsoft Azure Bot Service.


Receipt Card Attachment activity

Configure the Sign In Card Attachment activity

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

Examples

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 Process Builder, in the Activity Library open the MS Azure Bot Service tab.

    Open MS Azure Bot Service tab
  3. On the MS Azure Bot Service tab, drag the Receipt Card Attachment activity onto your process.

    Drag Receipt Card Attachment activity

General Configuration

Specifies the basic settings for the Receipt Card Attachment 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
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

Receipt Card Attachment Configuration screen > Basic tab

Configures the basic information for a receipt card.

Figure: Receipt Card Attachment Configuration > Basic tab

Receipt Card Attachment Configuration Basic tab

Fields

Field NameDefinition

MS Azure Bot Service
Description:
Specifies the access token that connects to your Microsoft Azure Bot Service.
Allowed Values:
A list of access tokens configured for your environment.
Default Value:
None
Accepts Variables:
No
Example:

Create Add Token icon
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:

Service URL
Description:
Specifies the URL for your bot.
Allowed Values:
A valid bot URL.
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?

Conversation ID
Description:
Specifies the conversation ID for which to send the message.
Allowed 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 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?

From ID
Description:
Specifies the ID for your bot.
Allowed Values:
A valid bot ID.
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?

From Name
Description:
Specifies the name for your bot.
Allowed Values:
A valid bot name.
Default Value:
None
Accepts Variables:
Yes

Recipient ID
Description:
Specifies the user ID of the channel to associate with the action.
Allowed Values:
A valid user ID of the channel.
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?

Recipient Name
Description:
Specifies the user name to associate with the action..
Allowed Values:
A valid user name.
Default Value:
None
Accepts Variables:
Yes

Message
Description:
Specifies the content of the message.
Allowed Values:
More than one line of text.
Default Value:
None
Accepts Variables:
Yes

Receipt Card Attachment Configuration screen > Receipt Config tab

Configures the receipt.

Figure: Receipt Card Attachment Configuration > Receipt Config tab

Receipt Card Attachment Configuration Receipt Config tab

Fields

Field NameDefinition

Title
Description:
Specifies the title for your card.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
None
Accepts Variables:
Yes

Tax
Description:
Specifies the amount of tax applied to the purchase.
Allowed Values:
A currency-formatted string.
Default Value:
None
Accepts Variables:
Yes

Vat
Description:
Specifies the amount of value added tax (VAT) applied to the purchase price.
Allowed Values:
A currency-formatted string.
Default Value:
None
Accepts Variables:
Yes

Total
Description:
Specifies the total purchase price that includes all applicable taxes.
Allowed Values:
A currency-formatted string.
Default Value:
None
Accepts Variables:
Yes

Inline Action Buttons / Map Action Buttons from schema
Description:
Specifies whether to use action buttons on your card with literal values.
Allowed Values:
  • Inline Action Buttons - Lets you specify action buttons on your card with literal (hard coded) values.
  • Map Action Buttons from schema - Lets you specify action buttons on your card with repeating schema elements.
Default Value:
None

Button Text
Description:
Specifies a name for the button.
To Open this Field:
  1. On the Receipt Config tab, click Inline Action Buttons.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
None

Action to Perform
Description:
Specifies what the button does.
To Open this Field:
  • 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.
Allowed Values:
  1. On the Receipt Config tab, click Inline Action Buttons.
Default Value:
None

Value
Description:
Specifies the value for your action.
To Open this Field:
  1. On the Receipt Config tab, click Inline Action Buttons.
Allowed 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. 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?

Add Add icon
Function:
Adds a button for action.
To Open this Field:
  1. On the Receipt Config tab, click Inline Action Buttons.

Select the repeating data node that will contain the Buttons data
Description:
Specifies a repeating schema element that stores the data for your buttons.
To Open this Field:
  1. On the Receipt Config tab, click Map Action Buttons from schema.
Allowed Values:
A valid repeating schema element.
Default Value:
None
Accepts Variables:
Yes

Receipt Card Attachment Configuration screen > Item Config tab

Configures items that are used for the purchase.

Figure: Receipt Card Attachment Configuration > Item Config tab

Receipt Card Attachment Configuration Item Config tab

Good to Know

Fields

Field NameDefinition

Select the repeating data node that will contain the Facts data
Description:
Specifies a repeating schema element that stores the data for your fact.

Facts are used to specify the information about the purchase such as order number and payment method.

Allowed Values:
A valid repeating schema element.
Default Value:
None
Accepts Variables:
Yes

Fact
Description:
Specifies a fact from the list to show on the receipt.

When you specify a repeating schema element in Select the repeating data node that will contain the Facts data field, this field shows the child elements of the repeating schema element.

Allowed Values:
A child element of the repeating schema element.
Default Value:
None
Accepts Variables:
No

Fact Value
Description:
Specifies a value from the list for a fact to show on the receipt.

When you specify a repeating schema element in Select the repeating data node that will contain the Facts data field, this field shows the child elements of the repeating schema element.

Allowed Values:
A child element of the repeating schema element.
Default Value:
None
Accepts Variables:
Yes

Select the repeating data node that will contain the Items data
Description:
Specifies a repeating schema element that stores the list of items you purchased.
Allowed Values:
A valid repeating schema element.
Default Value:
None
Accepts Variables:
Yes

Title
Description:
Specifies a title from the list for purchased item to show on the receipt.

When you specify a repeating schema element in Select the repeating data node that will contain the Items data field, this field shows the child values of the repeating schema element.

Allowed Values:
A child element of the repeating schema element.
Default Value:
None
Accepts Variables:
Yes

Subtitle
Description:
Specifies a subtitle from the list for purchased item to show on the receipt.

When you specify a repeating schema element in Select the repeating data node that will contain the Items data field, this field shows the child values of the repeating schema element.

Allowed Values:
A child element of the repeating schema element.
Default Value:
None
Accepts Variables:
No

Price
Description:
Specifies the price from the list for a purchased item to show on the receipt.

When you specify a repeating schema element in Select the repeating data node that will contain the Items data field, this field shows the child values of the repeating schema element.

Allowed Values:
A child element of the repeating schema element.
Default Value:
None
Accepts Variables:
No