QPR TaskRecorder: Difference between revisions

From QPR ProcessAnalyzer Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 22: Line 22:
QPR TaskRecorder has configuration file '''appsettings.json''' containing the following settings:
QPR TaskRecorder has configuration file '''appsettings.json''' containing the following settings:
* '''OutputFile''': The CSV file containing the recorded events.
* '''OutputFile''': The CSV file containing the recorded events.
* '''LogFile''': Log file of QPR TaskRecorder.
* '''LogFile''': Application log file of QPR TaskRecorder. When set, the application logging is enabled.


== Recorded UI events ==
== Recorded UI events ==
QPR TaskRecorder is able to record the following types of UI events:
QPR TaskRecorder is able to record the following types of UI events:
== Mathematical functions ==


== Recorded tasks CSV ==
== Recorded tasks CSV ==
The user actions are recorded to a CSV file, that is stored to the user '''Documents''' (by default) or a some other location user has specified. The CSV file can be uploaded to QPR ProcessAnalyzer for the analysis like any [[Importing_Data_to_Datatable_from_CSV_File|CSV file]].
The user actions are recorded to a CSV file, that is stored to the user own '''Documents''' (by default when no other location is set) or a some other location user has specified. The default name of the CSV file is '''taskrecorder.csv'''. The CSV file can be uploaded to QPR ProcessAnalyzer for the analysis like any [[Importing_Data_to_Datatable_from_CSV_File|CSV file]].


The CSV file has the following columns:
The CSV file has the following columns:
Line 99: Line 98:
||
||
|}
|}
== Anonymized user id ==
User performing the tasks is identified by an anonymized user id, so persons analyzing the task log cannot identify the actual user based on the user id. When QPR TaskRecorder starts, it checks if the settings file exists in the user's application data folder, and the settings file contains user id. If the user id does not exist, a new GUID is created and saved to the user settings file.


== QPR TaskRecorder logging ==
== QPR TaskRecorder logging ==
QPR TaskRecorder is able to write a logfile of its operation. Note that the logfile is different than the recorded UI events. The location of the log file is set in the QPR TaskRecorder configuration file. If no log file location is set, no logging is done. The log file contain information about QPR TaskRecorder application functionality and application errors.
QPR TaskRecorder is able to write a logfile of its operation. Note that the logfile is different than the recorded UI events. The location of the log file is set in the QPR TaskRecorder configuration file. If no log file location is set, no logging is done. The log file contain information about QPR TaskRecorder application functionality and application errors.

Revision as of 23:16, 29 January 2022

QPR TaskRecorder is a desktop application, that records actions done by the user. The actions can be for example mouse clicks, key presses, ui elements focusing, button clicks, selections and text input.

QPR TaskRecorder installation

QPR TaskRecorder is a desktop application for Windows operating systems

  1. Download the QPR TaskRecorder in the downloads section.
  2. Extract the zip package to a suitable location, for example: C:\Program Files\QPR TaskRecorder.
  3. Configure the QPR TaskRecorder

Starting QPR TaskRecorder

QPR TaskRecorder can be started simply by double-clicking the TaskRecorder.exe file.

Using TaskRecorder

The main dialog of QPR TaskRecorder contains a table of all currently open applications. You can choose which applications are recorded from the checkboxes. Each application is listed only ones, and when checked, all running instances of the application are recorded. E.g. there may several Word files open at the same time and all are recorded.

When open, QPR TaskRecorder is all the time active and records the selected applications. If there is an error situation, e.g., the CSV file is reserved by another application, the Status field shows the situation

Adding Annonations

User can add manual annotations during the task recording, to help analyzing the recorded UI events. An annotation is added by writing the annotation text to the Annonation textbox and clicking the Save annotation button.

QPR TaskRecorder configuration

QPR TaskRecorder has configuration file appsettings.json containing the following settings:

  • OutputFile: The CSV file containing the recorded events.
  • LogFile: Application log file of QPR TaskRecorder. When set, the application logging is enabled.

Recorded UI events

QPR TaskRecorder is able to record the following types of UI events:

Recorded tasks CSV

The user actions are recorded to a CSV file, that is stored to the user own Documents (by default when no other location is set) or a some other location user has specified. The default name of the CSV file is taskrecorder.csv. The CSV file can be uploaded to QPR ProcessAnalyzer for the analysis like any CSV file.

The CSV file has the following columns:

Column name Description
TimeStamp
UserName
SessionId
EventType
MouseX
MouseY
KeyCode
Key
ModifierKeys
ProcessName
ClassName
ControlType
Name
Value
LabelName
ElementX
ElementY
ElementWidth
ElementHeight
ElementHierarchy
ElapsedTime

Anonymized user id

User performing the tasks is identified by an anonymized user id, so persons analyzing the task log cannot identify the actual user based on the user id. When QPR TaskRecorder starts, it checks if the settings file exists in the user's application data folder, and the settings file contains user id. If the user id does not exist, a new GUID is created and saved to the user settings file.

QPR TaskRecorder logging

QPR TaskRecorder is able to write a logfile of its operation. Note that the logfile is different than the recorded UI events. The location of the log file is set in the QPR TaskRecorder configuration file. If no log file location is set, no logging is done. The log file contain information about QPR TaskRecorder application functionality and application errors.