Define Session Variables
Session Variables are an important and powerful part of X‑Platform Flow design. They can supply dynamic runtime information, determine whether input is saved in the database, and even help to route a call.
Session Variables are used for storing values globally for access by more than one Flow. When you create a Session Variable, it is available for use in Designer Flows, and any default value set for it will automatically be assigned to it in the Designer and during runtime.
X‑Platform provides the following two scopes for Session Variables:
Customer Session - Variables available in all Flows (including self-service Flows and agent-assisted Flows). The variable value is reset whenever the Flow is run. Example variables include: Customer Name, Device OS and Phone Number Email.
Agent Session - Variables available to all Agent sessions, i.e., when an Agent is using the Agent application. (Variables are available even when a Flow is not running.) The variable value is reset only after the Agent logs out of a session. Example variables include: Agent Name, Agent ID and Agent Supervisor.
Note
Until X‑Platform Release 14.0, Session Variables were called System Variables.
X‑Platform comes with a set of pre-configured Session Variables and you can also create additional Session Variables, as needed.
You use the Session Variables page in the X-Console to view, create and update Session Variables.
You access Session Variables in the X-Designer via the Solution Explorer or the Variables List dropdown that appears when you enter a "@" in the definition field for many X‑Platform elements.
The following data types can be used as the basis for a Session Variable:
Text
Number
Currency
Boolean
Date
Image (viewable when working in the X-Designer)
Custom Type and Enum Type (created using the Custom Types page)
Collection (see Adding a Collection as a Session Variable for details)
Dynamic (see Using Dynamic Variables for details)
Whenever a Flow is opened using the Designer, X‑Platform automatically checks to see whether the Session Variables used in the Flow have been changed in the X-Console. If there is a mismatch between the attributes of new and previously-set Variables, the Conflicts Center panel is displayed to show the conflicts that were found.
If a Flow is already open in the X-Designer when a change is made to a Session Variable, you must manually update it by clicking Refresh in the Flow Toolbar. The Refresh updates Session Variables as well as other resources for the Flow.