Workflow Variables
This section describes the variables that are used in Bright Pattern Contact Center workflows and scenarios.
Variables are accessed using the common $(varname) format. They can be used in integer and string expressions.
Note: If you would like to pass information from scenarios to workflows, note that not all scenario variables pass information to workflows; however, local variables are always passed to workflows. Local variables do not contain a prefix (e.g., item., user., etc.) and their values are available to the scenario where they are defined and to the sub-scenarios that are started from that parent scenario using the Start Another Scenario block. For any variables that are not passed to workflows, you may use a Set Variable block to rename the required scenario variable into a local variable (e.g., set "varDNIS" to $(item.DNIS)).
Common Variables
$(user.loginId)
$(user.loginId) specifies the agent's login ID if the workflow is started due to agent action.
Note: This variable is available in scenarios.
$(user.firstName)
$(user.firstName) specifies the agent's first name.
Note: This variable is available in scenarios.
$(user.lastName)
$(user.lastName) specifies the agent's last name.
Note: This variable is available in scenarios.
$(item.caseId)
$(item.caseId) specifies the case ID of the interaction, if available.
$(item.caseNumber)
$(item.caseNumber) specifies the case number of the interaction, if available.
$(item.contactId)
$(item.contactId) specifies the contact ID of the customer, if available.
Note: This variable is available in scenarios.
$(item.firstName)
$(item.firstName) specifies the first name of the customer, if available.
Note: This variable is available in scenarios.
$(item.lastName)
$(item.lastName) specifies the last name of the customer, if available.
Note: This variable is available in scenarios.
$(global_interaction_id)
$(global_interaction_id) specifies the Global interaction identifier. This variable is also known as $(item.globalInteractionId).
Note: This variable is available in scenarios.
$(disposition)
$(disposition) specifies the disposition that was used in an interaction.
Note: This variable is available in scenarios.
Variables for Chat
$(item.averageSentiment)
If sentiment analysis is being performed on interaction, this variable is set to the current average sentiment value.
Variables for Email
$(item.language)
Auto detected language from email content
$(item.replyTo)
Email reply-to address
Variables for pre-processing Email
$(item.to)
Email To address
$(item.subject)
Email subject
$(item.body)
Email body
$(item.language)
Detected language
$(item.newCaseFlag)
$(serviceId)
Service ID
$(service)
Service name
Variables for Voice
$(LanguageAsked)
$(LanguageAsked) specifies whether the customer asked for a specific language (e.g., "Yes").
$(NPS_raw)
$(NPS_raw) specifies the Net Promoter Score (NPS) value (e.g., "11").
$(contact_satisfaction)
$(contact_satisfaction) specifies the customer's contact satisfaction rating (e.g., "1").
$(destination)
$(destination) specifies the destination for the Connect Call block (e.g., "2042").
Note: This variable is available in scenarios.
$(first_call)
$(first_call) specifies whether this voice interaction is the first placed call (e.g., "1").
$(screenpopData)
$(screenpopData) specifies the list of the screen pop data received or set by interactive voice response (IVR). An actual list of available screen pop data elements depends on the particular IVR and integration.
Note: This variable is available in scenarios.
$(item.ANI)
$(item.ANI) specifies the Automatic Number Identification (ANI), a telephone company service providing a calling party with a number of the calling party. "ANI" is often used instead of “calling party number.”
Note: This variable is available in scenarios.
$(item.DNIS)
$(item.DNIS) specifies the Dialed Number Identification Service (DNIS), a telephone company service providing the called party with a number that was dialed by the calling party. "DNIS" is often used as a shorthand for "called party number."
Note: This variable is available in scenarios.
$(item.cnam)
$(item.cnam) is the caller ID display name (if provided by the SIP network).
$(item.customerPhone)
$(item.customerPhone) specifies the customer phone number. This variable enables passing customer phone information from scenarios of primary inbound and outbound customer calls to scenarios of the associated consultations and blind transfers.
- In scenarios launched for new incoming calls, its value matches the value of the $(item.from) variable.
- In scenarios launched for new outgoing calls, its value matches the value of the $(item.to) variable.
- In scenarios launched for consult calls and blind transfers, the value of the $(item.customerPhone) is inherited from the scenarios of the associated primary calls.
Note: This variable is available in scenarios.
$(item.email)
Customer e-mail address. Scenario may get or set this variable.
$(item.averageSentiment)
If sentiment analysis is being performed on interaction, this variable is set to the current average sentiment value.
$(item.from)
$(item.from) specifies the origination address (i.e., phone number or chat user display name). This variable is also known as ANI.
$(item.interactionId)
$(item.interactionId) specifies the interaction identifier.
Note: This variable is available in scenarios.
$(item.media)
$(item.media) specifies the media type (e.g., "voice").
Note: This variable is available in scenarios.
$(outbound_data)
$(outbound_data) contains data from calling lists and is available if the workflow is triggered from outbound campaign.
$(notes)
Case/ Disposition notes, if available
$(item.transcript.JSON)
$(item.transcript.JSON) specifies the full JSON transcript of the chat session or voice call.
Note: This variable can pass information from scenarios.
$(item.transcript.HTML)
$(item.transcript.HTML) specifies the HTML formatted transcript of the chat session or voice call.
Note: This variable can pass information from scenarios.
$(item.transcript.text)
$(item.transcript.text) specifies the text transcript of the chat session or voice call.
Note: This variable can pass information from scenarios.