Installing the Task Mining software

Task Mining software overview

The Task Mining software captures data from user machines and lets you specify and configure the data that is captured. You can install the Task Mining software components in different ways, depending on your user case. You must also ensure the installation prerequisites are met.

Task Mining software components

Software component	Description	Install information
Task Mining Client software	Captures the clicks, user interactions and (optionally) screenshots for allowlisted applications. Runs in the background on a user's machine or in a Virtual Desktop Infrastructure (VDI).	Installing the Task Mining Client software
Task Mining Configuration Editor (optional)	Sets or updates advanced client settings in the Task Mining software. Used to create or update Task Mining configuration files.	Installing the Task Mining Configuration Editor (optional)
Browser extensions for Google Chrome and/or Microsoft Edge (optional)	Capture advanced browser metadata. Used to specify which URLs Task Mining data will/will not be captured from.	Installing browser extensions (optional)
Task Mining Gateway (optional) Important Use of the Task Mining Gateway is currently limited to specific customers who use a hybrid environment. For more information, contact Support.	On-premise secure gateway and integration service for Task Mining.	For more information, contact Support.

Task Mining software installation prerequisites

Area	Prerequisite
Operating system	Microsoft Windows 10; or Microsoft Windows 11 from version 2.18.0 of the Task Mining Client software.
Software development framework	Microsoft .NET Framework 4.8 or higher. Note This should already be installed on Windows 10 and Windows 11 machines. If it's not, the user will be prompted to install it when installing the Task Mining Client software. Installation of the .NET Framework typically requires admin rights.
Permissions	Depends on the Task Mining software component being installed and the installation type selected. For installation information about individual Task Mining components, see Task Mining software components.
User machine and network set up	The Task Mining Client software must be able to access: The API endpoints used by the Task Mining Client software to communicate with the Celonis Platform. Specific directories and registry keys during installation of the Task Mining Client software and while the Task Mining Client software is running.

Task Mining Client software API endpoint access

Task Mining Client software (from 2.1.7.0)

Target URL	Description
`https://{team}.{realm}.celonis.cloud/task-mining/api/public/v2/activation/{activationCode}`	Connects the Task Mining Client software to a specific Task Mining project.
`https://{team}.{realm}.celonis.cloud/task-mining/api/clients/{clientId}/configuration`	Retrieves the Task Mining Client software configuration file for the connected Task Mining project.
`https://{team}.{realm}.celonis.cloud/task-mining/api/clients/{clientId}/log`	Sends log messages, for example, about Task Mining Client software errors. View these log messages in the Users & Invite screen for your Task Mining project.
`https://{team}.{realm}.celonis.cloud/task-mining/api/clients/{clientId}/status`	Sends Task Mining Client software status updates, for example, running or paused. View these status updates in the Users & Invite screen for your Task Mining project. Valid for Task Mining Client software versions 2.17 to 2.19 only.
`https://{team}.{realm}.celonis.cloud/task-mining/api/clients/{clientId}/heartbeat`	Sends an overview of the Task Mining Client software that is online to the Celonis team. Valid for Task Mining Client software versions 2.17 to 2.19 only.
`https://{team}.{realm}.celonis.cloud/task-mining/api/clients/{clientId}/state`	Sends Task Mining Client software status updates, for example, running or paused. View these status updates in the Users & Invite screen for your Task Mining project. Valid for Task Mining Client software versions 2.20 or higher only.
`https://{team}.{realm}.celonis.cloud/task-mining/api/clients/{clientId}/event`	Sends information about specific events that happened in the Task Mining Client software, for example, the software has started, Task Mining data capture has started or stopped, data uploads were successful/failed. Valid for Task Mining Client software versions 2.20 or higher only.
`https://{team}.{realm}.celonis.cloud/task-mining/api/clients/{clientId}/metrics`	Sends non-personalized usage metrics which can be used to identify potential issues with the Task Mining Client software.
`https://{team}.{realm}.celonis.cloud/continuous-batch-processing/api/v1/{PoolId}/items`	Uploads parquet files containing user interaction events to the Celonis team.
`https://{team}.{realm}.celonis.cloud/image-collector/api/v3/upload/{userId}?bucketId={bucketId}`	Uploads screenshots (if enabled) to the Celonis team storage bucket.
`https://{team}.{realm}.celonis.cloud/integration/api/v1/data-push/{PoolId}/jobs/{jobId}/chunks/upserted`	Uploads parquet files to the Celonis Platform if the Use Old Data Push API is activated. Deprecated.
`https://{team}.{realm}.celonis.cloud/image-collector/api/v2/upload/{userId}/`	Uploads image files to the Celonis Platform if the Use Old Image Upload API is activated. Deprecated.

Task Mining Client software (before 2.1.7.0)

Communication protocol and validation requirements (before 2.1.7.0)

What	Requirement
Client authentication	Authenticated in the Celonis team using an API key.
Communication encryption protocol	HTTPS using TLS 1.2 or higher on default port 443.

Client certification requirements (before 2.1.7.0)

Target URL	Description
`https://{team}.{realm}.celonis.cloud/task-mining/api/public/activation/{activationCode}`	Connects the Task Mining Client software to a specific Task Mining project.
`https://{team}.{realm}.celonis.cloud/task-mining/api/public/configuration`	Retrieves Task Mining Client software configurations from the connected Task Mining project.
`https://{team}.{realm}.celonis.cloud/task-mining/api/public/logs`	Sends log messages, for example, about Task Mining Client software errors. View these log messages in the Users & Invite screen for your Task Mining project.
`https://{team}.{realm}.celonis.cloud/task-mining/api/public/update-status`	Sends Task Mining Client software status updates, for example, running or paused. View these status updates in the Users & Invite screen for your Task Mining project.
`https://{team}.{realm}.celonis.cloud/task-mining/api/public/clients/{clientId}/states`	Sends signals to the Celonis team to show an overview of ‘online’ Task Mining Client software.
`https://{team}.{realm}.celonis.cloud/continuous-batch-processing/api/v1/{PoolId}/items`	Uploads parquet files containing user interaction events to the Celonis team.
`https://{team}.{realm}.celonis.cloud/image-collector/api/v3/upload/{userId}?bucketId={bucketId}`	Uploads screenshots (if enabled) to the Celonis team storage bucket.
`https://{team}.{realm}.celonis.cloud/integration/api/v1/data-push/{PoolId}/jobs/{jobId}/chunks/upserted`	Uploads parquet files to the Celonis Platform if the Use Old Data Push API is activated. Deprecated.
`https://{team}.{realm}.celonis.cloud/image-collector/api/v2/upload/{userId}/`	Uploads image files to the Celonis Platform if the Use Old Image Upload API is activated. Deprecated.

Task Mining Client software directory and registry key access

Note

If you're using the Task Mining Client software in a VDI environment, these directories and registry keys must be persisted between sessions.

Required directories

Directory	Access type	Description
`%ProgramFiles(x86)%\Celonis SE\Celonis Task Mining`	Read access during runtime. Write access during installation.	Installation directory if the Task Mining Client soaftware has been installed for all users of a machine.
`%LOCALAPPDATA%\Celonis SE\Celonis Task Mining`	Read access during runtime. Write access during installation.	Installation directory if the Task Mining Client software has been installed for the current user of the machine only.
`%USERPROFILE%\CelonisTaskMining`	Read/write access during runtime.	Contains cached parquet and image files. Configure the directory where these files are stored and other cached file settings in Task Mining Configuration Editor > Data Connection settings.
`%LOCALAPPDATA%\Celonis\TaskMiningClient`	Read/write access during runtime.	Contains cached configuration, application settings and logs for the Task Mining Client software.
`%LOCALAPPDATA%\Local\Celonis\TaskMiningClient\logs`	Write access during runtime. Write access during installation.	Contains the current log file `TaskMiningClientLogs.txt` and compressed archived log files for the Task Mining Client software. The log file contains information about the Task Mining Client software, including errors, but does not include captured user data. FROM Task Mining Client software version 2.18. For more information, see Using the Task Mining Client software.
`%LOCALAPPDATA%\Celonis_SE\CelonisTaskMining.Client._Url_< 32 alphanumeric characters><version of the client>`	Read/write access during runtime.	Contains required settings for the Task Mining Client software. Note We recommend making the entire `%LOCALAPPDATA%\Celonis_SE` directory persistent. This ensures files are still available when the Task Mining Client software is updated.
`<Personal Special Folder>` For more information, see Environment.SpecialFolder Enum.	Write access during runtime.	Contains crash report files.
`<Personal Special Folder/Celonis Task Mining>` For more information, see Environment.SpecialFolder Enum..	Write access during runtime.	Contains error log files if the Task Mining configuration settings could not be loaded.

Required registry keys

Registry key	Access type	Description
`HKCU\<Software>\Celonis\TaskMining\installed`	Write access during installation.	Registers installation of the Task Mining Client software.
`HKLM\<Software>\Celonis\TaskMining\activation_link_url`	Read access during runtime. Write access during installation.	Link that automatically activates the Task Mining Client software the first time the Task Mining Client software is started.
`HKLM\<Software>\Celonis\TaskMining\client_certificate_subject`	Read access during runtime. Write access during installation.	Client certificate subject used for the authentication of any secure gateway.
`HKLM\<Software>\Celonis\TaskMining\client_working_directory`	Read access during runtime. Write access during installation.	Task Mining Client software working directory.
`HKLM\<Software>\Celonis\TaskMining\connection_timeout`	Read access during runtime. Write access during installation.	Custom HTTP call connection timeout used for the Task Mining Gateway. Important Use of the Task Mining Gateway is currently limited to specific customers who use a hybrid environment. For more information, contact Support.
`HKLM\<Software>\Celonis\TaskMining\custom_extension_ids`	Read access during runtime. Write access during installation.	Custom browser extension IDs used when installing self-hosted browser extensions. For more information, see Installing self-hosted browser extensions.
`HKLM\<Software>\Celonis\TaskMining\secure_gateway_server`	Read access during runtime. Write access during installation.	Host URLs of the secure gateway server.
`HKLM\<Software>\Celonis\TaskMining\service_principal_name` Important Use of the Task Mining Gateway is currently limited to specific customers who use a hybrid environment. For more information, contact Support.	Read access during runtime. Write access during installation.	Service principal names used for the on-premise Task Mining Gateway.
`HKMU\<Software>\Celonis\TaskMining\extension_socket_port`	Read access during runtime. Write access during installation.	Custom port for browser extensions.
`HKMU\<Software>\Google\Chrome\Extensions\ndfcgjlpabkombgfpckhglibdhnipbfl\update_url`	Write access during installation.	Updates the URL of the Google Chrome browser extension.
`HKMU\<Software>\Microsoft\Edge\Extensions\ndfcgjlpabkombgfpckhglibdhnipbfl\update_url`	Write access during installation.	Updates the URL of the Microsoft Edge browser extension.
`HKMU\<Software>\Microsoft\Windows\CurrentVersion\Run\CelonisTaskMining`	Write access during installation.	Autostarts the Task Mining Client software once the user has logged into their machine.
`HKMU\<Software>\Classes\CelonisTaskMining\(Default)`	Write access during installation.	Registers the Task Mining-specific URL.
`HKMU\<Software>\Classes\CelonisTaskMining\shell\open\command\(Default)`	Write access during installation.	Registers the shell command to open the Task Mining Client software from the Task Mining-specific URL.
`HKMU\<Software>\Classes\CelonisTaskMining\URL Protocol`	Write access during installation.	Enables browsers to open the Task Mining Client software from the Task Mining-specific URL.

Important

For KMU, when the client is installed for all users of the machine (admin), the key will be under HKLM. When installed for the current user only, the key will be under HKCU.

For <SOFTWARE>: On 32-bit Windows systems, replace with Software. On 64-bit Windows systems, replace with Software\Wow6432Node. If the registry key for autostart is not writeable, the application will not autostart at system start.