Create an Animation Card Attachment

To create an animation card attachment for a bot message in Microsoft Azure Bot Service, do the procedure in this topic.

Figure: Animation Card Attachment Configuration > Basic tab

Basic tab
Figure: Animation Card Attachment Configuration > Card Config tab

Card Config tab

Examples

Prerequisites

Good to Know

  • 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

  1. On the Application Explorer screen, do one of these:
  2. Do one of these:
    • Add an activity:
      1. In the Process Builder, in the Activity Library open the Bot Integration Bot Integration icon tab.
      2. On the Bot Integration Bot Integration icon tab, drag the Animation Card Attachment Animation Card Attachment icon activity onto your process.
    • Change an activity:
      1. In your process, double-click your activity.
  3. Click Animation Card Attachment Configuration Animation Card Attachment Configuration icon.

Procedure

  1. On the Animation Card Attachment Configuration > Basic tab, in the Azure Bot Services field, select your Microsoft Azure Bot Service access token.

    To create a new access token, click Add Token Add Token icon. For more information, refer to Access Token for Azure Bot Service.

  2. Complete these fields.
    Field Name Definition

    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
  3. Click the Card Config tab.
  4. Complete these 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

    Animated GIF URL
    Function:
    Specifies the URL of your animated GIF image file to use in your card for the message.
    Accepted Values:
    A URL to an animated GIF image file.
    Default Value:
    None
    Accepts Process Data Variables:
    Yes
  5. Do one of these:
    • To use action buttons inline, do this procedure.
      1. Click Inline Action Buttons.
      2. Complete these fields.
        Field Name Definition

        Button Text
        Function:
        Specifies a name for the button.
        To Open this Field:
        1. 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:
        1. 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:
        1. 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?
    • To connect the repeating schema element to your process schema, complete this field as necessary.
      1. Click Map Action Buttons from Schema.
      2. Complete this field.
        Field Name Definition

        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:
        1. 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