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 Minign 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 |
| |
Task Mining Configuration Editor (optional) |
| |
Browser extensions for Google Chrome and/or Microsoft Edge (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. |
Area | Prerequisite |
|---|---|
Operating system |
|
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:
|
Target URL | Description |
|---|---|
| Connects the Task Mining Client software to a specific Task Mining project. |
| Retrieves the Task Mining Client software configuration file for the connected Task Mining project. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| Sends non-personalized usage metrics which can be used to identify potential issues with the Task Mining Client software. |
| Uploads parquet files containing user interaction events to the Celonis team. |
| Uploads screenshots (if enabled) to the Celonis team storage bucket. |
| Uploads parquet files to the Celonis Platform if the Use Old Data Push API is activated. Deprecated. |
| Uploads image files to the Celonis Platform if the Use Old Image Upload API is activated. Deprecated. |
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. |
Target URL | Description |
|---|---|
| Connects the Task Mining Client software to a specific Task Mining project. |
| Retrieves Task Mining Client software configurations from the connected Task Mining project. |
| 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. |
| 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. |
| Sends signals to the Celonis team to show an overview of ‘online’ Task Mining Client software. |
| Uploads parquet files containing user interaction events to the Celonis team. |
| Uploads screenshots (if enabled) to the Celonis team storage bucket. |
| Uploads parquet files to the Celonis Platform if the Use Old Data Push API is activated. Deprecated. |
| Uploads image files to the Celonis Platform if the Use Old Image Upload API is activated. Deprecated. |
Note
If you're using the Task Mining Client software in a VDI environment, these directories and registry keys must be persisted between sessions.
Directory | Access type | Description |
|---|---|---|
| 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. |
| 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. |
| 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. |
| Read/write access during runtime. | Contains cached configuration, application settings and logs for the Task Mining Client software. |
| Write access during runtime. Write access during installation. | Contains the current log file FROM Task Mining Client software version 2.18. For more information, see Using the Task Mining Client software. |
| Read/write access during runtime. | Contains required settings for the Task Mining Client software. Note We recommend making the entire |
For more information, see Environment.SpecialFolder Enum. | Write access during runtime. | Contains crash report files. |
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. |
Registry key | Access type | Description |
|---|---|---|
| Write access during installation. | Registers installation of the Task Mining Client software. |
| 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. |
| Read access during runtime. Write access during installation. | Client certificate subject used for the authentication of any secure gateway. |
| Read access during runtime. Write access during installation. | Task Mining Client software working directory. |
| 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. |
| 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. |
| Read access during runtime. Write access during installation. | Host URLs of the secure gateway server. |
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. |
| Read access during runtime. Write access during installation. | Custom port for browser extensions. |
| Write access during installation. | Updates the URL of the Google Chrome browser extension. |
| Write access during installation. | Updates the URL of the Microsoft Edge browser extension. |
| Write access during installation. | Autostarts the Task Mining Client software once the user has logged into their machine. |
| Write access during installation. | Registers the Task Mining-specific URL. |
| Write access during installation. | Registers the shell command to open the Task Mining Client software from the Task Mining-specific URL. |
| 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 writable, the application will not autostart at system start.
Description | Version | File | More information |
|---|---|---|---|
Task Mining Client software install file | 2.20.0 (2025-07-31) | ||
Task Mining Configuration Editor install file. | 2.20.0 (2025-07-31) | ||
Browser extension (use for Task Mining Client software from 2.19). | 2.2.0 (2025-04-24) | Celonis Task Mining Chrome Browser Extension for version 2.0.0 | Installing browser extensions from Chrome Web Store (optional) |
Browser extension (use for Task Mining Client software before 2.19) | 1.0.2 (2023-11-25) | Celonis Task Mining Chrome Browser Extension for version 1.0.2 (legacy) | Installing browser extensions from Chrome Web Store (optional) |
Self-hosted browser extension (use for Task Mining Client software from 2.19) | 2.0.0 (2025-04-29) | ||
Self-hosted browser extension (use for Task Mining Client software from 2.19) | 1.0.2 | For more information, contact Support. |
|
Important
Use of the Task Mining Gateway is currently limited to specific customers who use a hybrid environment. For more information, contact Support.
Task Mining Gateway overview
The Task Mining Gateway is an on-premise secure gateway and data integration service for Task Mining. It provides secure authentication of the Task Mining Client software using Kerberos and saves theTask Mining data to a local MSSQL database. You must be a Celonis admin to install the Task Mining Gateway. For more information, contact Support.
Task Mining Gateway releases
Version | File | Release date | Release note | Support ends |
|---|---|---|---|---|
2.4.0 | (134 MB) | 2025-07-31 | Improvements
| September 2026 |
2.3.1 | (134 MB) | 2025-04-30 | Improvements Cloud integration Cloud integration can now be disabled using a configuration property. See section 7.5 Disable cloud integration of the Installation Guide. Fix Fixed issue that could lead to performance issues and increased latencies when used with several thousand concurrent clients. | March 2026 |
2.3.0 | (134 MB) | 2025-04-02 | Improvements Clients Dashboard: The gateway can now forward Client status information to a specified Task Mining project within the Celonis Platform. This enhancement enables a dashboard showing connected Task Mining Client software, providing visibility into key information, such as status and version. For example, this information can then be visualized in Studio, enhancing visibility for large-scale deployments. | March 2026 |
2.2.0 | (129 MB) | 2025-02-07 | Improvements
Fix Missing timeouts for the LDAP communication now have default values but can also be configured. This fix prevents the gateway from waiting indefinitely if the LDAP connection fails to respond. Instead, it will time out, log an error message, and continue operating to prevent any service disruption. | September 2025 |
2.1.3 | (129 MB) | 2023-02-28 | Fix Fixed issue with writing timestamps into MSSQL database. | September 2025 |
2.1.2 | (129 MB) | 2023-02-23 | Fix Fixed issue where database connections were not properly closed. | September 2025 |
2.1.1 | task-mining-gateway.jar (129 MB) | 2024-02-19 | Improvement Updated dependencies to fix known vulnerabilities. | September 2025 |
2.1.0 | Download the task-mining-gateway (jar, 129 MB) | 2024-01-31 | Features
Improvements
Fixes Fixed issue where yhr Task Mining Gateway could not process parquet files with different schemas. | September 2025 |
2.0.0 | Download the task-mining-gateway (jar, 123 MB) | 2023-08-31 | Feature Added possibility of inserting collected Task Mining event data directly into an MSSQL database without relying on Hybrid Data Integration service. Improvement Added retry mechanism for parquet files that were not successfully inserted into the database. | September 2024 |
Limited releases
Note
The versions referenced in the table below are not official public releases and will not apply to most customers.
Version | File | Release date | Release notes | Support ends |
|---|---|---|---|---|
2.16.1 | (4.3 MB) Task Mining Configuration Editor.msi (4.2 MB) | 2024-03-04 |
| March 2025 |
2.16.0 | Task Mining Client.msi (4.3 MB) Task Mining Configuration Editor.msi (4.2 MB) | 2024-02-20 | Added support for switching between projects on multiple secure gateways. | March 2025 |
Important
Use of the Task Mining Gateway is currently limited to specific customers who use a hybrid environment. For more information, contact Support.
Task Mining Gateway overview
The Task Mining Gateway is an on-premise secure gateway and data integration service for Task Mining. It provides secure authentication of the Task Mining Client software using Kerberos and saves theTask Mining data to a local MSSQL database. You must be a Celonis admin to install the Task Mining Gateway. For more information, contact Support.
Task Mining Gateway releases
Version | File | Release date | Release note | Support ends |
|---|---|---|---|---|
2.4.0 | (134 MB) | 2025-07-31 | Improvements
| September 2026 |
2.3.1 | (134 MB) | 2025-04-30 | Improvements Cloud integration Cloud integration can now be disabled using a configuration property. See section 7.5 Disable cloud integration of the Installation Guide. Fix Fixed issue that could lead to performance issues and increased latencies when used with several thousand concurrent clients. | March 2026 |
2.3.0 | (134 MB) | 2025-04-02 | Improvements Clients Dashboard: The gateway can now forward Client status information to a specified Task Mining project within the Celonis Platform. This enhancement enables a dashboard showing connected Task Mining Client software, providing visibility into key information, such as status and version. For example, this information can then be visualized in Studio, enhancing visibility for large-scale deployments. | March 2026 |
2.2.0 | (129 MB) | 2025-02-07 | Improvements
Fix Missing timeouts for the LDAP communication now have default values but can also be configured. This fix prevents the gateway from waiting indefinitely if the LDAP connection fails to respond. Instead, it will time out, log an error message, and continue operating to prevent any service disruption. | September 2025 |
2.1.3 | (129 MB) | 2023-02-28 | Fix Fixed issue with writing timestamps into MSSQL database. | September 2025 |
2.1.2 | (129 MB) | 2023-02-23 | Fix Fixed issue where database connections were not properly closed. | September 2025 |
2.1.1 | task-mining-gateway.jar (129 MB) | 2024-02-19 | Improvement Updated dependencies to fix known vulnerabilities. | September 2025 |
2.1.0 | Download the task-mining-gateway (jar, 129 MB) | 2024-01-31 | Features
Improvements
Fixes Fixed issue where yhr Task Mining Gateway could not process parquet files with different schemas. | September 2025 |
2.0.0 | Download the task-mining-gateway (jar, 123 MB) | 2023-08-31 | Feature Added possibility of inserting collected Task Mining event data directly into an MSSQL database without relying on Hybrid Data Integration service. Improvement Added retry mechanism for parquet files that were not successfully inserted into the database. | September 2024 |
Limited releases
Note
The versions referenced in the table below are not official public releases and will not apply to most customers.
Version | File | Release date | Release notes | Support ends |
|---|---|---|---|---|
2.16.1 | (4.3 MB) Task Mining Configuration Editor.msi (4.2 MB) | 2024-03-04 |
| March 2025 |
2.16.0 | Task Mining Client.msi (4.3 MB) Task Mining Configuration Editor.msi (4.2 MB) | 2024-02-20 | Added support for switching between projects on multiple secure gateways. | March 2025 |