High-level event data reported
For high-level event (HLE) monitoring, Pega Robot Runtime captures the information about the time and type of event, originating system, application, user, and user-interface metrics such as key presses, mouse clicks, window movements, and so on. The information that the system captures depends on the type of originating event. For example, the system only reports the IdleTimeStarted when the IdleStarted event occurs.
If you set the sendStartEvents property in the DesktopAnalyticsConfig.xml file to True, the system accumulates client-side events and sends every fact for each dimension when the LostFocus event occurs in the application that you are monitoring, resulting in significant improvements in both throughput and data interpretation.
The following table provides descriptions of the information collected for high-level events:
Column name | Definition | Type | Used by Workforce Intelligence |
object _key | A client-generated ID that is assigned to the Robot Runtime event payload. | String |
|
time_stamp | A timestamp that indicates when the even occurred, in UTC format. | Bigint | True |
time_zone_name | The time zone in which the event occurred. | String |
|
time_bucket | Events grouped in 12-second intervals. | Bigint |
|
event_sequence_number | Internal sequence number that can be used to distinguish events that occur at the same time. | Bigint |
|
event_name | The name of the event as reported by the Robot Runtime event notification service. | String | True |
event_source | An internal event source name. | String |
|
operation_id | A system-generated globally unique identifier (GUID). | String | True |
parent_operation_id | A system-generated globally unique identifier (GUID). | String | True |
process_id | The number used by the computer's operating system to uniquely identify the process for which the event was reported. | String |
|
process_state | This value is not collected. | String |
|
session_id | A system-generated GUID for the Robot Runtime instance. | String |
|
tenant_key | This value is not collected. | String | |
user_id | If a client has a standalone Workforce Intelligence deployment, then this field is empty. If a client uses Pega Robot Manager and Workforce Intelligence, then the value is generated based on the Robot Manager authentication method. | String |
|
md_adapter_name | This value is not collected. | String |
|
md_app_name | The name of the Windows executable program. | String | True |
md_cell_column | These values are not collected and will always be null. |
|
|
md_domain_name | The domain of the machine where Robot Runtime is running. | String |
|
md_duration | The amount of time between this event and its starting pair, in milliseconds. Idle events are recorded in seconds. | Bigint | True |
md_executable_path | The full installation path of the Windows executable program. | String |
|
md_hwnd | The window handle of the application object for which the event was reported. | Integer |
|
md_id md_idle_change | These values are not collected and will always be null. | ||
md_idle_start_time | The time at which the system entered the idle state. The idle state follows a period of keyboard or mouse inactivity. You specify the amount of time that passes with no user interface activity before a system is considered idle using the HighLevelEvents keys in the DesktopAnalyticsConfig.xml file. | Timestamp |
|
md_mac_address | The MAC address of the machine where Robot Runtime is installed. | String |
|
md_machine_name | The machine name of the machine where Robot Runtime is installed. | String |
|
md_metadata_version | These values are not collected and will always be null. |
| |
md_process_id | The number used by the computer's operating system to uniquely identify the process for which the event was reported. | Integer |
|
md_process_object_id | This value is not collected. |
|
|
md_process_start_args | The command line arguments that are used to start an executable. | String |
|
md_rectangle | These values are not collected and will always be null. |
|
|
md_session_id | The session identifier for the process that is running under Terminal Services, if used, for the event that was reported. | Integer |
|
md_snapshot | These values are not collected and will always be null. |
| |
md_user_name | The Windows user name (network ID) of the user where Robot Runtime is running. | String | True |
md_value md_visible | These values are not collected and will always be null. |
|
|
md_url | The full URL of the website from which the event was reported. | String | True |
md_url_path | The path part of the URL for the website from which the event was reported. | String | True |
md_url_title | The text that displays for the website in the Microsoft Internet Explorer window, excluding Windows Internet Explorer. | String | True |
md_url_query_string | The query part of the URL for the website from which the event was reported. | String | True |
md_web_domain_name | The Internet identification (Domain Name or Hostname) label for the application from which the event was reported. | String | True |
md_window_text | The text appearing in the Window title for the window for which the event was reported. For web applications, the text includes the URL title and the Internet Explorer text. | String | True |
phrases | This value is not collected. |
|
|
metadata | Contains additional metadata for the events in an array of nested JSON objects. The JSON object contains the metadata_name and metadata_value properties in the following array format. Note that the properties are separated by the pipe ( | ) symbol: [{"metadata_name":"<name_of_metadata>" | "metadata_value":"<value_of_metadata_name>"}…] | String | True |
| The following items are the possible metadata_names: |
|
|
UserEmail | The email address of the user. | String |
|
ProductVersion | The version number of the Robot Runtime on the user's desktop. | String |
|
SourceEvent | Values that represent Robot Runtime's raw event signature, which generally indicates the lower-level signal that caused Robot Runtime to generate the high-level event. This field is used for diagnosing and troubleshooting Robot Runtime events. | String |
|
BaseUrl | For web applications, this field is the URL minus the query string. This field only appears for web applications. | String |
|
ProcessTotalWaitTime | A value, in milliseconds, that represents the total time that an application was waiting, regardless of whether the application was in focus on the user's desktop. | Integer | True |
KeyPressCount | A value that represents the number of keyboard keys that are pressed (as opposed to keys released) for that particular AppLostFocus, FormLostFocus, or PageLostFocus event. The following are some examples:
To get an accurate representation of the number of characters a user may have actually typed, it is best to subtract ErrorKeyPressCount, CtrlC_Count, CtrlX_Count, and CtrlV_Count. | Integer | True |
ErroKeyPressCount | A value that represents the number of times the Backspace or Delete key was pressed for that particular AppLostFocus, FormLostFocus, or PageLostFocus event. A press and hold of the Backspace or Delete key registers a count that represents the repetition from holding the keys down for a period of time. | Integer | True |
CtrlC_Count | A value that represents the number of times the Ctrl+C key combination was pressed for that particular AppLostFocus, FormLostFocus, or PageLostFocus event. See the description of KeyPressCount for additional information. | Integer | True |
CrtlV_Count | A value that represents the number of times the Ctrl+V key combination was pressed for that particular AppLostFocus, FormLostFocus, or PageLostFocus event. See the description of KeyPressCount for additional information. | Integer | True |
CrtlX_Count | A value that represents the number of times the Ctrl+X key combination was pressed for that particular AppLostFocus, FormLostFocus, or PageLostFocus event. See the description of KeyPressCount for additional information. | Integer | True |
MouseClickCount | A value that represents the number of clicks from a pointing device (typically a mouse) during an AppLostFocus, FormLostFocus, or PageLostFocus event. If a mouse has left button, right, and clickable wheel buttons, all buttons register click counts. | Integer | True |
MouseWheelCount | A value that represents the number of mouse-wheel rotations for that particular AppLostFocus, FormLostFocus, or PageLostFocus event. | Integer | True |
WindowMoveSizeCount | A value that represents the number of times an application window is resized or moved for that particular AppLostFocus, FormLostFocus, or PageLostFocus event. | Integer | True |
ScrollCount | A value representing the number of window scrolls that occurred during that AppLostFocus, FormLostFocus, or PageLostFocus event. The following are examples:
| Integer | True |
HasScreenMapping | Represents whether an application has screen capture enabled. | Boolean | True |
IsTestScreenMapping | True indicates that the screen was captured from a test application by a user who is designated as a test user. When an application is flagged with TestScreenMapping, only test users can capture FormLostFocus and PageLostFocus events from the application. | Boolean | True |
IsTestUser | True indicates that the user is designated as a test user. | Boolean | True |
Type | This field is only available for Cut/Copy/Paste (CCP) events. It is used to distinguish between a CCP done by the keyboard, using key combinations like Ctrl+C, instead of a Cut/Copy/Paste operation performed using the application's menus or context menu. | String |
|
OriginalParentOperationID | Wait events captured for application screens which have screen capture disabled, and have the parentoperationid set to the application's OperationID as opposed to the screen's OperationId. This field contains the original screen's operation_id value captured by Robot Runtime. | String |
|
ReasonCode | Robot Runtime users select the Off Computer Code upon return to their machine when the machine wakes from an idle state. This field is available when Off Computer Codes are enabled in the system to allow users to specify what they did while they were away from their computer. | String | True |
Reason | The description associated with the ReasonCode. | String | True |
day | The day the event payload was sent by Robot Runtime. | String |
|
Previous topic High-level events monitored Next topic Enabling single sign-on for the Workforce Intelligence portal