Static Choice user input control

  • Release version: Washingtondc
  • Updated May 9, 2024
  • 8 minutes to read

    • Use the Static Choice user input control in a Virtual Agent topic to list predefined choices available to the user. You can select only one item from a choice list.

    Choice display

    The choice list contains up to 10 items per page. When more than 10 items exist, you have the option to display the additional items and filter the search results. The choice list prompt contains a search icon Search icon. that users can select to filter the results.

    The Static Choice control provides the option to add a header card that displays above the choice list. Header cards are supported in web and mobile channels.

    • The header card can contain a large or small image or a YouTube video card, along with descriptive text. The choice list contains up to five items by default, but the search feature is suppressed. If there are more than five items, users can choose to show the additional items.

    • To control the number of items displayed below a header card, add the com.glide.cs.web_header_picker_page_limit system property. Use the Value to specify the number of items displayed in the choice list. For details about creating a system property, see Add a system property.

    Static Choice user input control properties for LLM topic discovery

    Property Description
    Name Name that identifies this Static Choice user control node in the topic flow.
    Detail description

    The one piece of information needed from the user. For example, Ask the user which service catalog item they need.
    Choices
    Display name
    For each choice, the text that appears to the user for that choice. Use short phrases in your choice lists.
    • Slack has a limit of 30 characters for choice list labels.
    • Workplace has a limit of 20 characters for choice list labels.
    Value For each choice, the string that is stored in the variable when the corresponding choice is selected.
    Advanced
    Header card

    Toggle to open a field to add cards which may include images or YouTube videos. For more information, see Insert a header card in a Static Choice or Dynamic Choice control
    Additional instructions for LLM

    Further instructions to the LLM, such as adding data formats, restrictions, or default values for user responses. You can create additional instructions in plain language, input a script, or define conditions with the data pill picker.
    Enforce user prompt

    Toggle to open a field for a custom message shown to the user instead of the message generated by the LLM. You can create custom messages in plain language, input a script, or define conditions with the data pill picker.
    Hide or skip this node
    Conditionally use this node if No-code condition statement or low-code script that specifies a condition for presenting this node in the conversation. The condition must evaluate to true.
    Allow user to skip this node if

    No-code condition statement or low-code script that specifies a condition for letting users skip this node in the conversation. The condition must evaluate to true. You can set this field using either the condition builder or a script. When this field is active, the node presents the user with a Skip option in the Virtual Agent conversation. Alternatively, in an LLM topic, you can reply with an utterance such as I want to skip this question. Virtual Agent chat window with Skip button following a query from the Virtual Agent.

    Example Static Choice user input control for LLM topic discovery

    Note:
    Virtual Agent Designer controls may display and function differently in other channels.
    Input properties List prompt

    Static choice input properties include node name, detail description, and choices. Advanced options include Header card, Enforce user prompt, Additional instructions for LLM, and Hide or skip this node.
    Figure 1. Web UI Static Choice list prompt
    A basic Static Choice list prompt that reads, "Could you please tell me how urgent is your issue? You can choose between Low, Medium, and High."
    Figure 2. Web UI Static Choice list prompt with more than 10 items
    Static Choice list in web UI with the header, "Could you please select your preferred breakfast items from the following list," followed by a list of more than 10 items.
    The choice list displays 10 items per page. When 10 or more results are returned, the following occurs:
    • The list includes a link at the end of the list to show more results.
    • A search icon displays in the prompt for filtering search results. Select the icon to open a search box and enter the filter.

    Static Choice user input control properties for NLU topic discovery

    Property Description
    Node name Name that identifies this Static Choice user control node in the topic flow.
    Detail description The one piece of information needed from the user. For example, Ask the user which service catalog item they need.
    Variable name Name of the variable that stores the user response to this prompt. The variable name is automatically created from the Node name property.
    Prompt

    Prompt or question for the user. The prompt can be either a text string or a script that returns text. This value is used only when the default value is not specified. For example: What's your name?

    NLU entity

    Option to associate an NLU entity with the node. If an NLU entity is associated with the input variable for this node, Virtual Agent can slot-fill the specified value based on the user's utterance. Select an entity from the list of entities associated with the topic intent.

    When you specify an entity for the node, the Do not ask users to confirm recognized entity toggle switch displays. When enabled, users are not prompted to confirm the extracted entity.

    This field is available only when NLU discovery is enabled on the instance.
    Choices
    Display name
    For each choice, the text that appears to the user for that choice. Use short phrases in your choice lists.
    • Slack has a limit of 30 characters for choice list labels.
    • Workplace has a limit of 20 characters for choice list labels.
    Value For each choice, the string that is stored in the variable when the corresponding choice is selected.
    Advanced
    Header card

    Toggle to open a field to add cards which may include images or YouTube videos. For more information, see Insert a header card in a Static Choice or Dynamic Choice control
    Default value
    Default Value

    Predefined value for the user response to the question or prompt. The response defined in the Default value confirmation field asks the user to confirm the default value. If the user responds with no, the value becomes null. The default value can be either a text string or a script that returns text. For example, if you're using dot-walking, the default value might be: Script Variables > Last username. Or if you're using a script, the default value might be: {{vaScripts.lastUsername}}.
    Confirmation messages
    Input completion confirmation

    Bot response shown to the user when the node interaction is complete. The message can be either a text string or a script that returns text. For example, if you're using dot-walking: Thanks, (Input Variables > Username)! Or if you're using a script, the acknowledgement might be: Thanks, {{vaInputs.username}}!

    Default value confirmation

    Message that asks the user to verify that the value in the Default value field is correct. This message is used instead of a value in the Prompt field. It can contain either a text string or a script that returns text. For example, if you're using dot-walking: Are you (Input Variables > Username)? Or if you're using a script, the confirmation message might be: Are you {{vaScripts.lastUsername}}?.
    Conversation switching
    This section is available only when NLU discovery is enabled on the instance.
    Turn on to let users change the subject

    Option to enable NLU prediction for this node. If enabled, users can enter text to answer questions, regardless of the type of input control being used. Virtual Agent uses this utterance to match another existing intent, letting the user switch topics.
    Hide or skip this node
    Conditionally show this node if

    No-code condition statement or low-code script that specifies a condition for presenting this node in the conversation. The condition must evaluate to true.
    Allow user to skip this node if

    No-code condition statement or low-code script that specifies a condition for letting users skip this node in the conversation. The condition must evaluate to true. You can set this field using either the condition builder or a script. When this field is active, the node presents the user with a Skip option in the Virtual Agent conversation. Alternatively, in an LLM topic, you can reply with an utterance such as I want to skip this question. Virtual Agent chat window with Skip button following a query from the Virtual Agent.
    Skip reprompting if No-code condition statement or low-code script that specifies a condition for letting users skip reprompting in the conversation. When a preceding node is revisited through a topic loopback or Dialog Act, the Virtual Agent bypasses this node and automatically retain its original value.

    Example Static Choice user input control for NLU topic discovery

    Note:
    Virtual Agent Designer controls may display and function differently in other channels.
    Input properties List prompt
    Figure 3. Static choice input control basic properties
    Basic properties include the node name, prompt, associated NLU entity, and a defined list of choices.
    Figure 4. Add card dialog box (Header card advanced option)
    Fields include Card type, title, description, image link, and image alt text.
    Figure 5. Web UI Static Choice list prompt
    A basic Static Choice list prompt that reads, "OK, what's the urgency of your issue?" Response include 1-High, 2-Medium, and 3-Low.
    Figure 6. Web UI Static Choice list prompt with more than 10 items
    Static Choice list in the web UI with the header, "Here are the breakfast items," followed by a list of more than 10 items.
    The choice list displays 10 items per page. When 10 or more results are returned, the following occurs:
    • The list includes a link at the end of the list to show more results.
    • A search icon displays in the prompt for filtering search results. Select the icon to open a search box and enter the filter.
    Figure 7. Web UI Static Choice list with header card
    Example Static Choice list. The header title reads "From your neighborhood candy store," followed by an embedded video and a list of five items.
    The choice list contains five items per page. When five or more results are returned, the list provides an option to show more results.
    Note:
    The search feature is suppressed when a header card is used.

    Channel support

    Table 1. Channel support for the Static Choice user input control
    Channel Support Constraints
    Web UI Supported None
    Mobile UI Supported None
    Now Assist panel Supported None
    Microsoft Teams Supported None
    Slack Supported Header cards aren’t supported.

    When a choice list has three or fewer choices, Slack displays the list as buttons.
    Workplace Supported Header cards aren’t supported.
    Facebook Messenger Supported In a quick reply, the label has the maximum character limit of 20 characters. You can view only 13 quick replies at a time. If there are more than 13 quick replies, the pagination format is used to view more options. The default value of the maximum number of replies for a page is set in the sn_va_fb_messenger.max_quick_replies system property. This property is located in the System Property [sys_properties] table.
    SMS Twilio Supported Header cards aren’t supported.
    LINE Supported In a quick reply, the label has a maximum limit of 20 characters. You can view only 13 quick replies at a time. If there are more than 13 quick replies, the pagination format is used to view more options. The default value of the maximum number of replies for a page is set in the sn_va_line.max.picker.choices system property. The property is located in the System Property [sys_properties] table.
    WhatsApp Supported None
    Apple Messages for Business Supported None
    Alexa (Voice) Supported For screen devices, use touch scroll. For nonscreen devices, use voice pagination.