Skip to main content

Celonis Product Documentation

Task Mining Desktop Application

The Task Mining Client software runs in the background on your employees’ computers, and captures clicks, user interactions, and (optionally) screenshots for the applications that you allowlist. You or the user need to install the client on the user’s machine and keep it updated.

With a default Microsoft Windows configuration, you can install the Task Mining Client software for the current user only, or for all users of the machine. Our installer offers the option to install for the current user if it’s available. If you install the software for the current user only, administrator rights are not required. If you install the software for all users of the machine, administrator rights are required.

System requirements

To run the Task Mining Client software, a user’s machine must have:

  • The Microsoft Windows 10 or Windows 11 operating system. Windows 11 is supported in General Availability from version 2.18.0 of the Task Mining Client software.

  • .NET Framework 4.8 or higher. This software should already be available on an up-to-date Windows 10 or Windows 11 machine. If it isn’t, a pop-up appears when the user starts the Task Mining Client and prompts them to download the .NET Framework software. They’ll need administrator rights to do this.

You can install the Task Mining Client in a virtual desktop infrastructure (VDI) environment, or install it outside the VDI to capture information from the VDI, with some limitations. For the details, see Virtual desktop infrastructure options for Task Mining.

Required permissions

The Task Mining Client software needs these permissions on a user’s machine:

  • Permissions for outgoing connections using HTTPS from the Task Mining Client to your Celonis Platform team.

  • Access to the directories and registry keys listed in the tables in Required directories and registry keys for Task Mining. In a VDI environment, these directories and registry keys must be persisted between sessions.

  • Permissions to access the Celonis Platform API endpoints listed in API endpoints for Task Mining.

Installing the Desktop Application software

  1. Download "CelonisTaskMining.Installer-2.x.x.msi".

  2. Run the installer package and follow the instructions of the installation wizard.

On default Windows setups, the installer provides an option to install only for the current user; admin rights are not required.

Updating an existing installation

Note

This is for both desktop applications, the Task Mining client and the Configuration Editor.

If the currently-installed version is 1.x.x:

The old version is restricted to per machine context (admin):

  • Newer version installed per user (not admin); this replaces the 1.x.x version.

  • Newer version installed per user (not admin); this replaces the 1.x.x version.

Note

For both of these scenarios, admin rights are required and you will be prompted to enter your credentials.

If the currently-installed version is 2.x.x:

  • old version per machine and new version per machine; prompts for admin rights and replaces the older version.

  • old version per user and new version per machine; prompts for admin rights and keeps the older version. This means there will be two different installation folders and two Start menu entries for .

  • old version per machine and new version per user; prompts for admin rights and replaces the older version.

  • old version per user and new version per user; replaces the older version without prompting for admin rights.

Tip

You can also (optionally) install browser extensions for Chrome and Edge. For further information, see Task Mining Desktop Application browser extensions (optional).

Logging for the Task Mining Client software

From version 2.18 of the Task Mining Client software, all log entries for Task Mining are placed in a unified log file TaskMiningClientLogs.txt on the user’s machine. The log entries include client information and errors, and do not include captured user data. The log file is stored in the logging folder %LOCALAPPDATA%\Local\Celonis\TaskMiningClient\logs, to which the Task Mining Client software needs write access during installation and at runtime.

A new log file is created on every calendar day that the Task Mining Client software is started on the user’s machine. If the client is started more than once during the day, the previous log file from that day is appended to the new log file. When a new log file is created, the existing log file is compressed and archived. The maximum size of the log file is 100 MB - if this is exceeded, a new log file is created immediately, and the existing log file is archived.

Archived log files are stored in the logging folder %LOCALAPPDATA%\Local\Celonis\TaskMiningClient\logs for up to 90 days, then deleted. The name of each archived log file is TaskMiningClientLogs-YYYYMMDD.n.zip, where YYYYMMDD is the date the log file was created, and n is the index for the file in case multiple log files were created during the same day.