System-Defined trigger variable types

The following trigger variable types are included for use with DPA triggers by default. These variable types can be used with user-defined variables and within operations. Because the value for these variables is sent from the system a default value cannot be set.

Variable Type	Description	Additional Information
AgentID	The ID of the agent who is using the DPA client. Contains the ID number assigned to the agent in the User Management module.	AgentID is also known as the External or Ultra ID and is useful as a parameter for certain recording commands.
AudioRecordingError	These variables are used to alert a user when there is a recording error. This variable will only receive a value when a recording trigger fires.	The value for this variable type is the error that is received from the Recorder. If you assign this variable type to a variable you can refer to it by using your variable in trigger operations.
AudioRecordingStatus	These variables are used to alert a user about the Recorder's status. This variable will only receive a value when a recording trigger fires.	The value for this variable type is the status that is received from the Recorder. If you assign this variable type to a variable you can refer to it by using your variable in trigger operations. The recorder status can be any of the following: DeviceNotFound NotOnCall NOTRecording RecordingRequested Paused Recording
Command Line	The full command line of the application, in the format: "drive\file path\filename” “parameters used”	The reported file name and command line of the current in-focus application is stored as read-only in this type of variable. The first 2,047 characters of the command line are included in the trigger variable. Subsequent data is not stored. Example: Use it to fire triggers for Java only where the command line contains “-classpath SomeJavaApplication.jar” Example: Use it to fire triggers for MyApplication only where the command line contains “\Program files\MyApplicationVersion123\”.
Computer name	The computer (machine) name	Contains the machine name on which the DPA Client has been installed and is running.
Date	The value of the current date as detected by the DPA Client. The default value represents the format in which the date should be used.	Default values for Date are different from other values as they must contain the date output format string. For example, a valid default value for a Date variable is YYYY MM DD, or MM, or DD. Although you cannot dictate the specific date as this is set by the system, you can specify which part of the date (day, month, or year) to use as the value for the variable.
Employee ID	The ID of the employee who is using the DPA client. Contains the ID number assigned to the agent in the User Management module.	Employee ID is also known as the WFO or Internal ID and is useful when integrating to WFO Notification rules or other WFO integrations.
QueryString	The portion of the URL of the active web page containing the parameters after the end of the URL	Any trigger variable of this type is populated as soon as the active window contains a QueryString. This is valid for Chrome, Edge, Internet Explorer and Firefox browsers. If the current active window does not contain a valid QueryString, then the trigger variable will be blank. The QueryString contains all text from the end of the URL up to the end of the browser address.
Time	The value of the current time as detected by the DPA Client. The default value in this case dictates the format that should be used.	Default values for time are different from other values as they must contain the time output format string. For example, a valid default value for a Time variable is HH MM SS, Or HH, or MM. Although you cannot dictate the specific time as this is set by the system, you can specify which part of the time (hour, minute, or second) to use as the value for the variable.
URL	The URL of the active web page, without the querystring	Any trigger variable of this type is populated as soon as the active window contains a URL. This is valid for Chrome, Edge, Internet Explorer and Firefox browsers. If the current active window does not contain a valid URL, then the trigger variable will be blank. The URL contains all text from the protocol (for example, http) to the end of the location of the page (for example. .html).
User Name	Contains the user name used to log onto the DPA Client
VideoRecordingError	Variables used to alert a user when there is a video recording error	Same as the AudioRecordingError. The value for this variable is the error that is received from the Recorder. If you assign this variable type to a variable you can refer to it by using your variable in trigger operations.
VideoRecordingStatus	Variables used to alert a user when there is a video recording status	Same as AudioRecordingStatus. The value for this variable is the status that is received from the Recorder. If you assign this variable type to a variable you can refer to it by using your variable in trigger operations.
Window Title	The window title of the window that is currently in focus. If you are using Internet Explorer, the window title contains the current URL of the browser tab in focus.	Enables a trigger to parse the window title and assign a portion of it to a specific trigger variable. For example, you can parse a transaction ID from the window title, and store it in a “transaction” trigger variable, which is then used as the transaction ID for any number of subsequent triggers.