Grouped Choice user input control
-
- UpdatedAug 3, 2023
- 4 minutes to read
- Vancouver
- Virtual Agent
Use the Grouped Choice user input control in a Virtual Agent topic to list multiple groups of choices in one message.
Grouped Choice list display
The Grouped Choice list prompts users to select related choices in one message through the default Select a choice button. You can enable multi-select for each choice's group and also provide images and short descriptions to create a richer user experience. Users are presented with groups of choices where they're required to submit one selection before returning to the Virtual Agent topic.
Grouped Choice user input control properties
| Property | Description |
|---|---|
| Node name | Name that identifies this Grouped Choice user control node in the topic flow. |
| Prompt | Prompt or question for the user. The prompt can be either a text string or a script that returns text. For example: Please select your meal preference. |
| Group name | Name that identifies the grouped choice list in the property sheet. Add one
(required) or multiple groups of related choices. Users must select one choice out
of all groups. Use short phrases in your choice lists. |
| Choices | Number of choices added to each group. |
| Add a group of choices dialog box | |
| This dialog box only appears after Add is selected. | |
| Group name | Name that identifies the grouped choice list in the property sheet. A limit
of 40 characters for choice list labels exists. The Variable name field is automatically generated from the group name. This read-only variable name appears in all lower-case text and substitutes any spaces in the group name for underscores. If multiple lists with the same name exist, the variable name is appended with _1, _2, _3, and so on. Use this variable in your conversation flow to retrieve user responses for each group within the Grouped Choice node. |
| Display as | Group heading title that appears in the rendered client. |
| Display name | Choice name that is displayed to users. At least two unique choices are required. |
| Value | String that is stored in the variable when the corresponding choice is selected. This value is automatically generated from the display name, but you can edit the field as needed. |
| Image | Option to an add image for the choice. Individual choice images are entered after you select Add details. To set this field, do
one of the following:
|
| Description | Option to provide additional information about the choice. Individual choice descriptions are entered after you select Add details. For example: If the grouped choice list is about passengers selecting airplane amenities, like headphones, you could include a description about the type of headphones such as Over-ear wired headphones. |
| Allow the user to select more than one? | Option to allow users to choose multiple options from the choice list by selecting Yes. |
| Advanced | |
| Customize group selection | |
| Update title | Option to customize the title of the grouped choice's prompt button. A limit of 40 characters for choice list labels exists. If this field is left empty, the default title that users see is Select a choice. |
| Image | Option to add an image for the grouped choice's prompt button. To set this
field, do one of the following:
|
| 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}}! . |
| 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. |
Channel support
Example Grouped Choice user input control
| Input properties | List prompt |
|---|---|
 |
|