Task Mining Agent

URL of the authentication service: The URL of task mining services, for example, https://TM_HOST/.

URL of the API service: The URL can be apiAuthEndpoint + /api/, for example, https://TM_HOST/api/.

The key is used to use untrusted HTTPS certificates. Set the key to `truev only if used in a non-production environment.

Possible values: true/false (Default: false)

The key is used in the Manual Sending mode to create a copy of the files before sending them to the server (can be set to true for safety purposes).

Possible values: true/false (Default: false)

The key is used to encrypt files that are stored in the TaskMining_RecordingData\app folder.

Possible values: true/false (Default: true)

The key is used to activate the Auto Sending mode of recorded data to the server.

Possible values: true/false (Default: true)

They key is used in the Auto Sending mode to define the waiting time in seconds before sends to the server.

Possible values: a positive integer less than 60 (Default: 10)

The key used in the Auto Sending mode to define the maximum chunk size in MB that is sent to the server.

Possible values: a positive integer less than 10 (Default: 3)

Possible values: true/false (Default: false)

Possible values: true/false (Default: false)

Possible values: true/false (Default: true)

Note: Before turning to a different server, you need to delete the following folder: C:\Users\<your_username>\AppData\Roaming\TaskMining_RecordingData\app.

Parameter Description Value
IsVerboseMode To enable verbose logging, that is: tracing all actions carried out by the TM Agent true|false
IsTraceMode To enable trace logging, that is: tracing only information, warning and errors true|false
IsErrorMode To enable error logging, that is: tracing only errors true|false
environmentName Environment Name, only for internal usage in the test environment Default: local
IsEnabledCreateCopyOfZipFolder To enable the local copy of files, that is: create a local copy of the files that are sent to the server, only for debug purposes true|false
IsEnabledSettingsEncryption To enable the encryption of the settings file used by the TM Agent true|false
IsEnabledAutomaticZipAndSend To enable the Auto Sending mode, that is: enable the automatic creation and sending of data chunks in continuous mode true|false
AutomaticZipAndSendRollingThresholdInMb To set the max threshold (MB) for a data chunk in auto sending mode Default: 3
BackgroundWorkersIntervalInSeconds To set the time interval (seconds) between two consecutive sending of data chunks in auto sending mode Default: 10
SapWatchDogMaxDatetimeItemsInList Technical parameter to monitor the connection between the TM Agent and the SAP client, used only for SAP. This value must not be changed. Default: 50
SapWatchDogWindowsEventsThreshold Technical parameter to monitor the connection between the TM Agent and the SAP client, used only for SAP. This value must not be changed. Default: 30
apiAuthEndpoint To set the URL of the task mining services. https://TM_HOST/
apiEndpoint To set the base URL of the API services. This URL is apiAuthEndpoint + /api/. https://TM_HOST/api/
AllowingUntrustedSslCertificates Used to allow the use of untrusted https certificate. Set to true only if used in a non-production environment. true|false
apiAuthRouteLogin To set the path of the API service providing the user login. This value must not be changed. Default: Login
apiAuthRouteJwtLong To set the path of the API service providing the JWT (authentication token). This value must not be changed. Default: jwtlong
apiAuthRoutePermissions To set the path of the API service providing the user permissions. This value must not be changed. Default: api/permissions
apiRouteUploadAgentData To set the path of the API service providing the data uploading. This value must not be changed. Default: integration/agent/upload
apiRouteUploadAgentCertificate To set the path of the API service providing the Digital Certificate for authentication. This value must not be changed Default: integration/agent/certificate
apiRouteMonitoringList To set the path of the API service providing the monitoring list. This value must not be changed. Default: integration/agent/monitorlist
apiRouteEncryptionKey To set the path of the API service providing the encryption key. This value must not be changed. Default: integration/agent/encryptionKey
apiRouteEncryptionKeyUpAndRunning To set the path of the API service to check that the encryption is enabled. This value must not be changed. Default: integration/agent/encryptionPing
chromePluginUri The URL of the Chrome plug-in. The plug-in is required to enable the recording of user actions on a web application, using Google Chrome. This value must not be changed. Default: https://chrome.google.com/webstore/detail/myinvenio-task-mining/gmpnnjghibofefmnppkgkadiijlblhia
msedgePluginUri The URL of the Edge plug-in. The plug-in is required to enable the recording of user actions on a web web application, using Mozilla Firefox. This value must not be changed. Default: https://chrome.google.com/webstore/detail/myinvenio-task-mining/gmpnnjghibofefmnppkgkadiijlblhia
IsSAPPluginDisabled Technical parameter to disable the sap plugin in case this application is not installed on the workstation in use. false|true
UploadChunkTimeoutIntervalInSeconds Technical parameter that defines the timeout (in seconds) for loading chunks on the backend. Default: 120
MaxChunkToUploadInParallel Technical parameter that defines the number of threads that can load blocks on the backend in parallel. Default: 2
ErrorCollectorWatcherIntervalInSeconds Technical parameter that defines the time interval (in seconds) within which the error check is performed. Default: 120
OfficeWatchDogWaitTimeBeforeNotificationInSeconds Technical parameter that defines the time (in seconds) that elapses before receiving the excel notification. Default: 60
apiRouteStartRecording To set the API service path that provides information about the start of agent registration. This value must not be changed. Default: integration/agent/startRecording
apiRouteStopRecording To set the API service path that provides information about the end of agent registration. This value must not be changed. Default: integration/agent/stopRecording
apiRouteDeviceEvents To set the path of the API service that sends agent logs to the backend. This value must not be changed. Default: integration/agent/deviceEvents
apiRouteProjects To set the API service that provides the information of the projects on which the user logged in the agent has visibility. This value must not be changed. Default: projects
apiRouteEnvInfo To set the API service that provides the information of the enviroments. This value must not be changed. Default: envinfo
apiRouteUserInfo To set the API service that provides the permissions of the user logged into the agent. This value must not be changed. Default: userinfo

As previously illustrated, the logging level is configurable.

Some examples of logs are reported as follows: Log with: IsErrorMode=true, IsTraceMode=false, IsVerboseMode=false INFO 2020-12-04 13:19:17,020 [1] App - OnStartup

------------------------------------------------

 DeviceId:
 184b67d829f2713fd6dd843437dd0f23e7a8fa94d3bd5bd644b314936798487e
 ServicePointManager: Tls, Tls11, Tls12, Tls13

 Platform: 1.9.10.1 Version: 1.0.0.31 25c22b7

 Endpoints: apiAuthEndpoint=https://taskmining.my-domain.com/
 apiEndpoint=https://taskmining.my-domain.com/api/

 Parameters: IsEnabledCreateCopyOfZipFolder=False
 IsEnabledAutomaticZipAndSend=True IsEnabledSettingsEncryption=True
 AutomaticZipAndSendRollingThresholdInMb=3072000
 BackgroundWorkersInterval=00:00:10

 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\--

 INFO 2020-12-04 13:19:17,181 [1] App -
 IsEnabledAutomaticZipAndSend=True
 ActivityWriterOptions=RollingDisabled=False RollingThreshold=2.93 MB

 INFO 2020-12-04 13:19:18,243 [22] App -
 AesEncryptionService=IsEnabledFileSystemEncryption=True
 Date=04/12/2020 12:19:18 +00:00 Key=32

 INFO 2020-12-04 13:19:23,265 [1] ActivityListener -

 Monitoring List:

 AllowedApps

 Name: "saplogon" TitleMatcher: "" Selectors: ""

 Name: "EXCEL" TitleMatcher: "" Selectors: ""

 Name: "chrome" TitleMatcher: "" Selectors: ""

 Name: "Calculator" TitleMatcher: "" Selectors: ""

 Name: "notepad" TitleMatcher: "" Selectors: ""

 BlockedApps

 AllowedUris

 Uri: "https://processmining.my-company.com/index.html#!/workspace" DnsSafeHost: "processmining.my-company.com" CheckAbsoluteUri: False

 Uri: "https://issuetracker.mycompany.com/projects/MTM/board" DnsSafeHost: "issuetracker.mycompany.com" CheckAbsoluteUri: False

 BlockedUris

 Uri: "https://issuetracker.mycompany.com/people/5e380e3b4c33950ca580a990" DnsSafeHost: "issuetracker.mycompany.com" CheckAbsoluteUri: True

 \-\-\-\-\-\-\-\-\-\-\-\--

 Session Encryption Options:

 IsEnabledFileSystemEncryption=True Date=04/12/2020 12:19:18 +00:00
 Key=32

 \-\-\-\-\-\-\-\-\-\-\-\--

Activity Writer Options:

RollingDisabled=False RollingThreshold=2.93 MB

INFO 2020-12-04 13:19:49,930 [13] IApiRestClient -
ChunkType=FinalChunk; ChunkId=1915; FileName=20201204121945388.enc;
UserActionsFileLog=user_actions_04122020.txt;
MachineName=DESKTOP-PIL0QL8

**Log with: IsErrorMode=true, IsTraceMode=true, IsVerboseMode=true**

INFO 2020-12-04 13:12:23,493 [1] App - OnStartup

 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\--

DeviceId:
184b67d829f2713fd6dd843437dd0f23e7a8fa94d3bd5bd644b314936798487e
ServicePointManager: Tls, Tls11, Tls12, Tls13

Platform: 1.9.10.1 Version: 1.0.0.31 25c22b7

Endpoints: apiAuthEndpoint=https://tm-test.my-domain.com/
apiEndpoint=https://tm-test.my-domain.com/api/

Parameters: IsEnabledCreateCopyOfZipFolder=False
IsEnabledAutomaticZipAndSend=True IsEnabledSettingsEncryption=True
AutomaticZipAndSendRollingThresholdInMb=3072000
BackgroundWorkersInterval=00:00:10

 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\--

INFO 2020-12-04 13:12:23,674 [1] App -
IsEnabledAutomaticZipAndSend=True
ActivityWriterOptions=RollingDisabled=False RollingThreshold=2.93 MB

INFO 2020-12-04 13:12:24,655 [22] App -
AesEncryptionService=IsEnabledFileSystemEncryption=True
Date=04/12/2020 12:12:24 +00:00 Key=32

INFO 2020-12-04 13:12:30,700 [1] ActivityListener -

Monitoring List:

AllowedApps

Name: "saplogon" TitleMatcher: "" Selectors: ""

Name: "chrome" TitleMatcher: "" Selectors: ""

Name: "Calculator" TitleMatcher: "" Selectors: ""

BlockedApps

AllowedUris

Uri: "https://issuetracker.mycompany.com/projects/MTM/board"
DnsSafeHost: "issuetracker.mycompany.com" CheckAbsoluteUri: False

Uri: "https://issuetracker.mycompany.com/index.html\#!/workspace"
DnsSafeHost: "issuetracker.mycompany.com" CheckAbsoluteUri: False

Uri: "http://rpachallenge.com/" DnsSafeHost: "rpachallenge.com"
CheckAbsoluteUri: False

Uri:
"https://mail.google.com/mail/u/0/#inbox/FMfcgxwKjTMPztPGGtKqSdVBvqVVnwQb"
DnsSafeHost: "mail.google.com" CheckAbsoluteUri: False

BlockedUris

Uri:
"https://issuetracker.mycompany.com/secure/ViewPersonalSettings.jspa"
DnsSafeHost: "issuetracker.mycompany.com" CheckAbsoluteUri: True

\-\-\-\-\-\-\-\-\-\-\-\--

Session Encryption Options:

IsEnabledFileSystemEncryption=True Date=04/12/2020 12:12:24 +00:00
Key=32

\-\-\-\-\-\-\-\-\-\-\-\--

Activity Writer Options:

RollingDisabled=False RollingThreshold=2.93 MB

INFO 2020-12-04 13:12:34,192 [9] ActivityListener - Created Event:
Click PointId: 118e9245eb4542bf910070bbb3de8cc6

INFO 2020-12-04 13:12:34,266 [4] ActivityListener - Created Event:
Click PointId: eb4faf8daf6348b9beb20eef31ddb6a7

INFO 2020-12-04 13:12:34,288 [8] ActivityListener - Terminated
Event: Click PointId: 118e9245eb4542bf910070bbb3de8cc6

INFO 2020-12-04 13:12:34,470 [19] ActivityListener - Created Event:
Click PointId: 5b1780775818478395c650fd2c2fe7f8

INFO 2020-12-04 13:12:34,486 [19] ActivityListener - Terminated
Event: Click PointId: eb4faf8daf6348b9beb20eef31ddb6a7

INFO 2020-12-04 13:12:34,579 [10] ActivityListener - Created Event:
Click PointId: 9bc4e91ca6aa43cca6f079bba69536d2

INFO 2020-12-04 13:12:34,579 [10] ActivityListener - Terminated
Event: Click PointId: 5b1780775818478395c650fd2c2fe7f8

INFO 2020-12-04 13:12:34,809 [9] ActivityListener - Created Event:
Click PointId: 66f61edd356e48f686a78a6273881673

INFO 2020-12-04 13:12:34,825 [19] ActivityListener - Terminated
Event: Click PointId: 9bc4e91ca6aa43cca6f079bba69536d2

INFO 2020-12-04 13:12:34,903 [4] ActivityListener - Created Event:
Click PointId: 420e12e14afc40d0882379d67720cb7e

INFO 2020-12-04 13:12:34,918 [6] ActivityListener - Terminated
Event: Click PointId: 66f61edd356e48f686a78a6273881673

INFO 2020-12-04 13:12:35,470 [6] ActivityListener - Created Event:
Click PointId: 5eb86994e48e4cb0acf6629d04e0d3c9

INFO 2020-12-04 13:12:35,475 [6] ActivityListener - Terminated
Event: Click PointId: 420e12e14afc40d0882379d67720cb7e

INFO 2020-12-04 13:12:35,599 [8] ActivityListener - Created Event:
Click PointId: 6b9daf2133d3403c90f8494bd9c5c0b3

INFO 2020-12-04 13:12:35,606 [1] ActivityListener - Terminated
Event: Click PointId: 5eb86994e48e4cb0acf6629d04e0d3c9

INFO 2020-12-04 13:12:35,950 [9] ActivityListener - Created Event:
Click PointId: 610135df9ee64a10983cd0a0506396db

INFO 2020-12-04 13:12:35,956 [9] ActivityListener - Terminated
Event: Click PointId: 6b9daf2133d3403c90f8494bd9c5c0b3

INFO 2020-12-04 13:12:36,117 [10] ActivityListener - Created Event:
Click PointId: bb65fa16bddc41939bf40c962a76814c

INFO 2020-12-04 13:12:36,123 [6] ActivityListener - Terminated
Event: Click PointId: 610135df9ee64a10983cd0a0506396db

INFO 2020-12-04 13:12:36,410 [10] ActivityListener - Created Event:
Click PointId: c35d730034c34d61926f8cb8edccfdc6

INFO 2020-12-04 13:12:36,416 [8] ActivityListener - Terminated
Event: Click PointId: bb65fa16bddc41939bf40c962a76814c

...

...

...

INFO  2020-12-04 13:12:48,347 [7] ActivityListener - Terminated Event: Click  mySAP PointId: 943b2cee22d645c69c582eefef400913
INFO  2020-12-04 13:12:52,599 [8] ActivityEmitter - [chrome][Plugin_OnUserActionRecordEvent] Event: Click Mouse: {X=1014,Y=474} WM_LBUTTONUP AutomationElement: AutomationId:, Name:processmining SW Factory, ControlType:text, FrameworkId:Chrome RecordPlugin: NM/online RecordEvent: {   "xpath": "//div[@id=\"helpPanelContainer\"]/div/div/div[3]/div[1]/div/div/div/div/div/div[2]/section/div[2]/section/div[1]/a/div/p[1]" } {   "Selector": "NM",   "browser": "chrome",   "frame": "-1",   "url": "https://issuetracker.mycompany.com/your-work" } 
INFO  2020-12-04 13:12:52,790 [6] ActivityListener - Created Event: Click  NM PointId: 9c87200ae7ba4d15956df298dbc8f77f
INFO  2020-12-04 13:12:52,799 [7] ActivityListener - Terminated Event: Click  mySAP PointId: bbf28f345ee64d9d87db1cc2e4127582
INFO  2020-12-04 13:12:54,180 [19] ActivityEmitter - [chrome][Plugin_OnUserActionRecordEvent] Event: Click Mouse: {X=1014,Y=474} WM_LBUTTONUP AutomationElement: AutomationId:, Name:Roadmap BETA, ControlType:link, FrameworkId:Chrome RecordPlugin: NM/online RecordEvent: {   "xpath": "//div[@id=\"helpPanelContainer\"]/div/div/div[2]/div[1]/div/div[2]/div/nav/div[2]/div/div/div/div/div[2]/a[1]/div" } {   "Selector": "NM",   "browser": "chrome",   "frame": "-1",   "url": "https://issuetracker.mycompany.com/secure/RapidBoard.jspa?rapidView=72&projectKey=MSF&selectedIssue=MSF-1436" } 
INFO  2020-12-04 13:12:54,384 [6] ActivityListener - Created Event: Click  NM PointId: be71664822314ed9878409ddc5ee74ee
INFO  2020-12-04 13:12:54,403 [24] ActivityListener - Terminated Event: Click  NM PointId: 9c87200ae7ba4d15956df298dbc8f77f
INFO  2020-12-04 13:12:56,081 [4] ActivityEmitter - [chrome][Plugin_OnUserActionRecordEvent] Event: Click Mouse: {X=1197,Y=295} WM_MOUSEMOVE AutomationElement: AutomationId:, Name:Your work, ControlType:text, FrameworkId:Chrome RecordPlugin: NM/online RecordEvent: {   "xpath": "//div[@id=\"helpPanelContainer\"]/div/div/div[1]/header/nav/div[3]/div[1]/a/span/span" } {   "Selector": "NM",   "browser": "chrome",   "frame": "-1",   "url": "https://issuetracker.mycompany.com/software/c/projects/MSF/boards/72/roadmap" } 
INFO  2020-12-04 13:12:56,267 [19] ActivityListener - Created Event: Click  NM PointId: 8858a67a52574baf8d9e7879581bf5aa
INFO  2020-12-04 13:12:56,284 [9] ActivityListener - Terminated Event: Click  NM PointId: be71664822314ed9878409ddc5ee74ee
INFO  2020-12-04 13:12:57,395 [7] ActivityEmitter - [chrome][Plugin_OnUserActionRecordEvent] Event: Click Mouse: {X=1129,Y=303} WM_LBUTTONUP AutomationElement: AutomationId:, Name:Primary Navigation, ControlType:navigation, FrameworkId:Chrome RecordPlugin: NM/online RecordEvent: {   "xpath": "//div[@id=\"helpPanelContainer\"]/div/div/div[1]/header/nav/div[2]/div" } {   "Selector": "NM",   "browser": "chrome",   "frame": "-1",   "url": "https://issuetracker.mycompany.com/your-work" } 
INFO  2020-12-04 13:12:57,514 [19] ActivityListener - Created Event: Click  NM PointId: a3d42a11b8694db3a2228a1f01ae5a1c
INFO  2020-12-04 13:12:57,522 [19] ActivityListener - Terminated Event: Click  NM PointId: 8858a67a52574baf8d9e7879581bf5aa
INFO  2020-12-04 13:12:57,878 [24] ActivityEmitter - [chrome][Plugin_OnUserActionRecordEvent] Event: Click Mouse: {X=1112,Y=299} WM_LBUTTONUP AutomationElement: AutomationId:, Name:processmining, ControlType:text, FrameworkId:Chrome RecordPlugin: NM/online RecordEvent: {   "xpath": "//div[@id=\"helpPanelContainer\"]/div/div/div[1]/header/nav/div[2]/div" } {   "Selector": "NM",   "browser": "chrome",   "frame": "-1",   "url": "https://issuetracker.mycompany.com/your-work" } 
INFO  2020-12-04 13:12:58,007 [6] ActivityListener - Created Event: Click  NM PointId: fdfce5fc5a5e4107927f7c50d2943f44
INFO  2020-12-04 13:12:58,013 [10] ActivityListener - Terminated Event: Click  NM PointId: a3d42a11b8694db3a2228a1f01ae5a1c
INFO  2020-12-04 13:12:59,368 [10] ActivityListener - Created Event: Click PointId: c447c43007b541ed98d907f0ab536596
INFO  2020-12-04 13:12:59,368 [6] ActivityListener - Terminated Event: Click  NM PointId: fdfce5fc5a5e4107927f7c50d2943f44
INFO  2020-12-04 13:13:07,497 [13] IApiRestClient - ChunkType=FinalChunk; ChunkId=1913; FileName=20201204121259639.enc; UserActionsFileLog=user_actions_04122020.txt; MachineName=DESKTOP-PIL0QL8