Awaken Scripting User Guide

Please email helpdesk@awaken.io for omissions or errors.
×
Menu

System Variable List

 
The following list contains all System Variables. Please see System and Workflow variables for further guidance in creating and using both Variable types.
 
System Variable Name
Description
Auto-Populated
var_csAgentID
The ID of the Agent running the Workflow.
Yes
var_csAgentName
The full name (Firstname Lastname) of the Agent running the Workflow as defined in the Admin module.
Yes
var_csAgentUserName
The Username of the Agent running the Workflow as defined in the Admin module.
Yes
var_csCallDuration
Contains the duration (in seconds.milliseconds) of the current Session, as of the latest Page transition.
Yes
var_csCallerName
Intended to contain the name of the person being interacted with.
No
var_csCallListID
Contains the ID of the call list in which the current record currently resides.
Yes
var_csCallListName
Contains the name of the call list in which the current record currently resides.
Yes
var_csCallType
Set to 'NEW' or 'RESCHEDULED' call depending on call status of current record.
Yes
var_csCampaignAlias
The alias (if used) that launched the current campaign.
Yes
var_csCampaignID
The ID of the current campaign.
Yes
var_csCampaignName
The name of the current campaign.
Yes
var_csConnectorID
Allows a connector name to be passed into a URL when popping a Workflow from the Social Dashboard. The connector ID is the instance ID from tbl_appconfig_instances
Yes
var_csConnectorType
Allows a connector type to be passed into a URL when popping a Workflow from the Social Dashboard. The connector ID is the instance type from tbl_appconfig_instances
Yes
var_csEndDate
Contains the date of the latest Page transition (according to the database server).
Yes
var_csEndTime
Contains the time of the latest Page transition (according to the database server).
Yes
var_csFirstName
The Firstname of the Agent running the Workflow as defined in the Admin module.
Yes
var_csLastName
The Lastname of the Agent running the Workflow as defined in the Admin module.
Yes
var_csOBCallComplete
This can be set to 'yes' or 'no' to indicate whether the record needs further action. See Reschedules for further details on usage.
No
var_csOBComments
Any comments added to this variable will be added to the current record.
No
var_csOBOutcome
Sets the descriptive call outcome of the current record. This is set by the "Description" field of an Outcome - List or Outcome - Button.
No
var_csOBOutcomeCode
Sets the call outcome value of the current record. The value needs to match a campaign outcome. This is set by the "Value" field of an Outcome - List or Outcome - Button.
No
var_csOBPriority
Contains the current priority of the record on Script launch. Modifying the variable to contain a positive integer value will cause this value to overwrite the record's current priority when the script is closed. Any non-integer value will be ignored, and larger values equate to higher priority (offered first when agents open the Campaign view on the Desktop).
Yes
var_csOBRescheduleGroup
Sets the Group to reschedule the current record to by assigning the Group ID (or 0 for all Groups). var_csOBRescheduleTo must be blank, or else this is overridden. See Reschedules for further details on usage.
No
var_csOBRescheduleTime
Sets the time the current record will be rescheduled for, or alternatively choose which predefined callback time will apply (from the callbacks set up for the current campaign), by setting the name here. See Reschedules for further details on usage.
No
var_csOBRescheduleTo
Sets the User to reschedule the current record to by assigning the User ID (or 0 for all Users). See Reschedules for further details on usage.
No
var_csOutboundHistoryID
Populated with the unique ID from tbl_outbound_history for the current record being run. Unique each time a record is opened/reopened/rescheduled etc.
Yes
var_csOutboundID
Populated with the unique ID from tbl_outbound for the current record being run. Unchanging even if a record is opened/reopened/rescheduled etc.
Yes
var_csPageName
Stores the Workflow page name.
Yes
var_csReference
Unique reference identifier for the record, either provided at record creation or automatically generated in a CSAUTO-X-Y-Z format.
Yes
var_csScriptID
The ID of the current Workflow.
Yes
var_csScriptName
The name of the current Workflow.
Yes
var_csSessionID
Populated with the unique ID from tbl_Session for the current record being run. Unchanging even if a record is opened/reopened/rescheduled etc.
Yes
var_csStartDate
Contains the date on which the current Workflow run commenced (according to the database server).
Yes
var_csStartTime
Contains the time at which the current Workflow run commenced (according to the database server).
Yes