Live agent chat context variables
Use chat context variables to pass certain information from the topic to share with a live agent or to control how bot conversations are routed to live agents. Virtual Agent includes some default variables, and you can define new ones.
Note: The Interaction table is part of the interaction management framework, which is activated through the Interactions Management plugin (com.glide.interaction). This plugin is included with the Agent Chat (com.glide.interaction.awa) and Connect Support (com.glide.connect.support) plugins.
| Variable | Description |
|---|---|
| application | Application scope of the chat. For example, Global, HR, CSM, or ITSM. |
| auto\_resolution\_context\_id | If Auto Resolution is enabled, the ID of the record created when a requester is redirected to Virtual Agent. |
| case | Case ID \(from the \[sn\_customerservice\_case\] table\) that is used with the Customer Service Management application when a case is related to the chat. |
| csp\_category | Category defined in the Consumer Service portal in the CSM application \(requires the com.glide.service-portal.consumer-portal plugin\). For more information, see Using the Consumer Service Portal. |
| csp\_email | Requester’s email address, as entered in a pre-chat survey on the Consumer Service Portal. |
| csp\_first\_name | Requester’s first name, as entered in a pre-chat survey on the Consumer Service Portal. |
| csp\_last\_name | Requester’s last name, as entered in a pre-chat survey on the Consumer Service Portal. |
| devicetype | Type of device being used for the chat. For example, mweb (chat widget), android, or ios. |
| esc\_pre\_chat\_ask\_a\_question | Requester response to a pre-chat survey selection from within the HR Service Delivery application ESC view of the HR Case record. |
| hr\_topic\_id | ID of the current topic. Used in Advanced Work Assignment to determine which HR queue to transfer the user for live agent chat. |
| interaction\_account | Used with CSM chats that are initiated by B2B users who are tracked as contacts for a particular account. Corresponds with the Account field on the Interaction [interaction] table, which references the Accounts [customer_account] table. |
| interaction\_consumer | Used with CSM chats that are initiated by B2C users who are tracked as consumers. Matches the interaction.consumer field referencing the csm_consumer table. Corresponds with the Consumer field on the Interaction [interaction] table, which references the Consumers [csm_consumer] table. |
| interaction\_contact | Used with CSM chats that are initiated by B2B users who are tracked as contacts for a particular account. Corresponds with the Contact field on the Interaction [interaction] table, which references the Contacts [customer_contact] table. |
| interaction\_id | Sys\_id of the interaction record associated with the chat session.For more information, see Virtual Agent interaction records. |
| language | Two-letter language code for the requester's chat.Note: Language values use ISO standard two-character language codes. For more information, see ISO 639.1 language codes. |
| mandatory\_skills | Required skills and skill level for an agent.For example, German language proficiency with an associated high skill level may be required for German-speaking requesters. You can define mandatory skills and activate skill levels in Advanced Work Assignment. For more information, see Configure agent assignment rules. |
| optional\_skills | Skills and skill levels that would be useful for a given chat scenario.You can define optional skills in Advanced Work Assignment. For more information, see Configure agent assignment rules. |
| page | The specific page \(within a portal\) that the chat was accessed from. |
| portal | Name of the portal that the chat was accessed from. |
| post\_assessment\_instance | Reference to the post-chat survey \(Assessment Instances \[asmt\_assessment\_instance\] table\), if there is one. |
| post\_chat\_survey\_name | Name of a post-chat survey that is used to gather feedback from the requester.For information about creating surveys, see Create chat surveys. For information about creating surveys in Connect Chat, see Configure a survey in Connect Chat support. |
| pre\_assessment\_instance | Reference to the pre-chat survey \(Assessment Instances \[asmt\_assessment\_instance\] table\), if there is one. |
| pre\_chat\_survey\_name | Name of a pre-chat survey that is used to gather information from the requester.For information about creating surveys, see Create chat surveys. To learn more about how chat context variables from pre-chat surveys are used in Advanced Work Assignment to route work to live agents, see Work item queues. For information about creating surveys in Connect Chat, see Configure a survey in Connect Chat support. |
| queue | Sys\_id of the pre-built Connect Support chat queue \(deprecated\). |
| search\_text | Search terms entered by the requester. Used to search Virtual Agent topics. |
| short\_description | Used to set the short description in the interaction record associated with the chat. |
| sys\_id | Sys\_id of a record that relates to the interaction. Typically, this is the record being viewed in the portal when the chat is requested. |
| table | Table containing the record that relates to the interaction. Typically, this is the record being viewed in the portal when the chat is requested. |
Additional resources
- How to transfer a chat to a specific queue using context variables
- Virtual Agent and Natural Language Understanding (NLU) community forum
- Conversational Interfaces Academy
Parent Topic:Configure context variables for storing chat-related information