Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
The Variables tab in the Shared Settings panel lists variables shared across every agent in the orchestration. There are three types of variables:
- System variables: Defined by the system. Most system variables are read-only.
- Custom variables: Defined by you. Custom variables are read-write, and are filled as the conversation progresses according to your own logic.
- Contact Center variables: Filled during the conversation by an external source. A variable created in the builder can be filled by the connecting contact center (external sources can set value), and a variable created in the contact center can send values to the builder (external sources can receive value).
Variable scopes
- Topic: Accessible only within the topic where the variable was created, by default. You can change this behavior to make a topic variable accessible from multiple topics.
- Global: Accessible across multiple topics. All system variables are globally scoped. Global variables appear in the
/command you use to reference objects from your instructions. - Environment: Scoped to the environment.
Common system variables
System variables are especially useful for designing conversations around voice calls. The following table lists some commonly used system variables.
| Variable | Type | Description |
|---|---|---|
System.Activity.From.Name |
String | The agent user's caller ID |
System.Activity.Recipient.Name |
String | The number used to call or connect to the agent |
System.Conversation.SipUuiHeaderValue |
String | SIP header value when transferring through a direct routing phone number |
System.Activity.UserInputType |
String | Whether the agent user used DTMF or speech in the conversation |
System.Activity.InputDTMFKey |
String | The agent user's raw DTMF input |
System.Conversation.OnlyAllowDTMF |
Boolean | Voice ignores speech input when set to true |
System.Activity.SpeechRecognition.Confidence |
Number | The confidence value (between 0 and 1) from the last speech recognition event |
System.Activity.SpeechRecognition.MinimalFormattedText |
String | Speech recognition results (as raw text) before Copilot Studio applies its dedicated natural language understanding model |
Manage variables
You can configure variables from two places: the Shared Settings panel, or a Set variable node in a topic.
- Open your agent in Copilot Studio, and select the Build tab.
- Open Shared Settings, and select the Variables tab.
- Select the Custom tab to view variables you created, or the System tab to view built-in variables provided by the platform.
- To create a custom variable, select Create.
- Use Search variables to find a specific variable by name.
Alternatively, create or set a variable directly from a topic by using a Set variable node when editing a topic.