Skip to main content

Installing the Task Mining Client software

Note

The Task Mining Client software is versioned and the Task Mining Client version number is indicated where relevant. For example, functionality marked as FROM 2.1.3, was introduced in version 2.1.3 of the Task Mining Client software and is not available in versions prior to 2.1.3. For more information about Task Mining software releases, see the Task Mining software install file release notes.

Task Mining Client software installation options

Install option

Use case

For more information

User is invited to a project and emailed a link that lets them:

  • Install the Task Mining Client software using the Task Mining set-up wizard.

  • Connect to the Task Mining project.

Recommended for less technical users as this is the simplest way of installing the Task Mining Client software and connecting to a Task Mining project.

Installing the Task Mining Client software (project invite)

User:

  • Downloads the Task Mining Client software.

  • Installs the Task Mining Client software using the Task Mining set-up wizard

  • Connects to a specific Task Mining project using an activation link.

User hasn't been added to a Task Mining project or wants to create their own Task Mining project.

Installing the Task Mining Client software (installation package)

FROM 2.3.0

Admin installs the Task Mining Client software from the command line:

  • On one or more machines.

  • On a Virtual Desktop Infrastructure (VDI).

Note

Before performing a VDI install, see VDI installation considerations and limitations.

  • Recommended where the Task Mining Client software is to be installed on more that 25 machines.

  • May be used by an admin to install Task Mining Client software for individual users or on specific machines.

Installing the Task Mining Client software (command line)

Updating the Task Mining Client software.

A new version of the Task Mining Client software has been released.

Updating the Task Mining Client software.

Warning

For this installation method, you'll be emailed a link that will let you install the Task Mining Client software and connect to a Task Mining project. Before clicking the link, we strongly recommend you check the email sender is legitimate.

  1. When you receive an email invitation to join a Task Mining project, click the link in the email.

    A Task Mining invitation screen appears.

    Image of the Task Mining invitation screen
  2. Select Download for Windows.

    The Task Mining Client installation zip file downloads to your machine.

  3. Navigate to your Downloads folder and extract all files from the Task Mining Client installation zip file.

  4. Double-click the installer file.

    The Celonis Task Mining Setup Wizard appears.

    TM_setup_wizard_home_page.png
  5. Step through the wizard, referring to the Task Mining software installation settings as necessary.

  6. Select Finish when the Completed the Celonis Task Mining Setup Wizard screen appears.

  7. In the Task Mining invitation (see step 1), select Connect Client to team.

  8. Confirm your selection.

    The Celonis Task Mining Client software opens.

    TM_UI.png

For more information, see Using the Task Mining Client software.

Important

Once you've installed the Task Mining Client software, you'll need to connect to a Task Mining project. You'll be prompted for a project-specific activation link. This link is created when the Task Mining project is set up and the person who set up the Task Mining project you want to connect to will be able to send you the link. For more information, see Testing a Task Mining project.

  1. Check the installation prerequisites.

  2. Download the Task Mining Client software installation zip file.

    The Task Mining Client installation zip file downloads to your machine.

  3. Navigate to your Downloads folder and extract all files from the Task Mining Client installation zip file.

  4. Double-click the installer file.

    The Celonis Task Mining Setup Wizard appears.

    TM_install_wizard_home_page.png
  5. Step through the wizard, referring to the Task Mining software installation settings as necessary.

  6. Select Finish when the Completed the Celonis Task Mining Setup Wizard screen appears.

  7. When completed, select Finish.

  8. Go to Apps > Celonis Task Mining.

Note

You may not see all these settings and options during installation. The settings and options displayed will depend on your selections in the Task Mining Configuration Setup Wizard.

Setting

Options

Description

Default option

Recommended options

Installation Scope

  • Install for all users of this computer.

  • Install just for me.

    (<username>)

Defines whether the software is installed for all users of the machine or just for the user who installs it.

Install for all users of this computer

Depends on your use case but if you don’t have admin rights for your machine, use Install just for me.

Celonis Task Mining Extensions

  • Install Celonis Task Mining extension for Google Chrome (Recommended).

  • Install Celonis Task Mining extension for Microsoft Edge (Recommended)

Defines whether browser metadata is captured from Google Chrome and/or Microsoft Edge.

Both selected.

Both selected.

Note

If you deselect these here, you can install the browser extensions later if required. For more information, see Installing the Task Mining browser extensions (optional).

Celonis Task Mining Extensions

Enterprise policy or Developer mode installed extension (advanced)

FROM 2.7.9.

Installs the Task Mining Client software with an assigned extension ID and installs the Chrome extension automatically from your self-hosted store.

Not selected.

Depends on your use case.

For more information, see Installing self-hosted browser extensions (from 2.7.8).

Secure Gateway Configuration

Use Secure Gateway Server (optional)

FROM 2.2.2

Connects the Task Mining Client to an organization's secure gateway server and uses the API endpoints to connect to the Celonis Platform.

Not selected.

Depends on your use case. 

Note

If selected, you’ll be prompted to enter information for:

  • Secure Gateway Server.

  • Client Server Subject.

For more information, see Task Mining command line parameters.

Secure Gateway Configuration

On-Premise server (Optional)

Enables use of the Task Mining Gateway which is an on-premise secure gateway and integration service for Task Mining

Not selected.

Important

Use of the Task Mining Gateway is currently limited to specific customers who use a hybrid environment. For more information, contact Support.

Description

Version

File

More information

Task Mining Client software install file

2.20.0

(2025-07-31)

CelonisTaskMining.Client.Installer

Installing the Task Mining Client software (install file)

Task Mining Configuration Editor install file.

2.20.0

(2025-07-31)

CelonisTaskMining.Configuration.Installer

Installing the Task Mining Configuration Editor (optional)

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

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

Self-hosted browser extension (use for Task Mining Client software from 2.19)

2.0.0

(2025-04-29)

2025-04-29_CelonisTaskMiningBrowserExtension-2.0.0

Installing self-hosted browser extensions

Self-hosted browser extension (use for Task Mining Client software from 2.19)

1.0.2

For more information, contact Support.

Installing self-hosted browser extensions

2.20.0

2025-07-31

Improvements

  • Added improved and more reliable reporting of the Task Mining Client application state to the cloud backend.

  • Improved and added more detailed reporting of events and state changes to the cloud backend.

Important

We've also changed some of the endpoints used by the Task Mining Client application. For more information, see API endpoints for Task Mining.

2.19.0

2025-05-30

Improvements

Improved support for data gathering via the Chrome/Edge browser extensions to support multiple users per machine.

Important

This is a breaking change as we've released a new version 2.0.0 of the Task Mining Browser Extension for both Chrome and Edge. For more information, see Installing the Task Mining browser extensions (optional).

2.18.2

2025-05-05

Fixes

  • Fixed an issue in secure gateway environments where automatic activation did not always occur properly.

  • Fixed an issue in secure gateway environments where users were not properly notified of removed access to a project.

  • Fixed an issue in secure gateway environments where on first startup after an update from a previous version users were incorrectly notified of removed access to a project.

2.18.1

2025-03-06

Fixes

  • Fixed an issue where project activation failed from the browser with a different team or realm to the one currently in use.

  • Fixed an issue that prevented users from opening documents in SAP while the Task Mining Client was running.

  • Fixed an issue that prevented activating the client for a project in a secure gateway environment when it was already activated for a project in a different secure gateway environment.

2.18.0

2024-11-27

Features

  • Auto-activation is now available for users enrolled in a single project within a secure gateway environment.

  • Third-party licenses are now displayed in the About window for both the Task Mining Client and the Task Mining Configuration Editor.

Improvements

  • Enhanced logging capabilities in the Task Mining Client.

Fixes

  • Fixed a bug that prevented existing cached files being added to the upload queue after startup.

  • Fixed a bug that caused incorrect values for certain attributes in the Live Event Monitor.

  • Fixed a bug causing the intermittent absence of Task Mining Stopped events.

  • The mandatory event attribute SessionId can no longer be excluded from logging in the Event Processing Rules.

Note

You must update any configurations that currently exclude SessionId. See Task Mining Configuration Editor settings.

2.17.1

2024-06-06

Fixes

  • Fixed a bug that caused text being displayed twice in a toast notification.

  • Fixed a bug that prevented the Task Mining Client from properly deserializing the cached configuration file.

  • Fixed a bug that prevented the Task Mining Configuration Editor to load/save redaction rules from/to a configuration file.

2.17.0

2024-04-16

Features

  • Introduced a new feature: OAuth security, providing another option to Application Keys and API Keys for authorization.

Improvements

  • Improved client handling statistics.

  • Secure gateway selection is now stored in the User.config.

  • Path for local file storage can now be configured (important for VDI deployments).

Fixes

  • Fixed a bug that caused the processing to stop for the rest of the files in a queue if there was a corrupted file.

  • Fixed a bug that caused the Task Mining Client to hang and not respond after attempting to connect to the client.

  • Fixed a bug related to retrieving data from the user's clipboard.

  • Fixed a bug that caused attributes to still get hashed after hashing was disabled for all attributes.

  • Fixed issue where machine name was empty in VDI deployments.

2.15.2

2024-03-07

Improvements

  • Improved performance of Native URL Retrieval in Internet Explorer mode.

2.15.1

2024-02-12

Fixes

  • Fixed a bug that prevented captured events from being uploaded to the Celonis Platform after changing the team.

2.15.0

2024-02-08

Improvements:

  • Improved the encryption of files to ensure that no file is ever written to the disk unencrypted (if the feature is enabled).

  • Added a crash log to the Configuration Editor in case the application crashes due to an unknown error.

Fixes

  • Fixed a bug that prevented capturing of events triggered by the Chrome Extension after the Task Mining Client was paused and started again.

  • Fixed a bug that prevented cached parquet files to get uploaded once a connection to the Celonis Platform was re-established.

2.14.0

2023-12-07

Features

  • Redaction rules are now applied independent of diacritics.

Improvements

  • Improved network stability by ensuring that proxy changes take effect during runtime of the Task Mining Client.

Fixes

  • Fixed issue where users could apply data redaction to non-redactable attributes.

  • Fixed issue where users could slow down Task Mining Client via too complex redaction rules.

  • Fixed issue where EnteredText attribute was not properly hashed or removed in the Live Event Monitor.

  • Fixed issue where consent window is not shown when switching to a different team.

  • Fixed issue where number of uploaded/deleted files is not reset when switching to a different team.

2.13.0

2023-08-31

Features

Configure regular expressions in the Task Mining Desktop Application for redacting personally identifiable information (PII), such as credit card numbers, email addresses, and other sensitive content (see Data Redaction).

  • Redact data before sending to Celonis Platform (instead of using a custom SQL transformation after sending).

  • Mask custom patterns within a column (as an alternative to skipping the whole data point).

  • Choose what replaces the data.

Fixes

  • Fixed a bug causing the Task Mining Client to crash when the UWP Notification Platform is unavailable

2.12.1

2023-08-24

We've fixed an issue that prevented the application from retrieving the system proxy settings when a PAC script was configured.

2.12.0

2023-08-01

Features

  • Logging support is now available in the Configuration Editor for improved debugging and monitoring.

  • A new button has been incorporated into the Live Event Monitor to help users clear the event grid quickly.

  • Multiple service principal names for the custom on-premises Task Mining gateway are now supported.

  • The application now supports native URL retrieval for Microsoft Edge in Internet Explorer mode.

Improvements

  • The default mode for the Live Event Monitor is now set to Started.

  • An automatic retry mechanism is now implemented to counter configuration loading failures for inactive clients.

  • Communication performance between the client and the cloud service has been enhanced.

  • The local port of the extension's web socket is configurable now.

Fixes

  • An issue that prevented the Live Event Monitor from properly considering start/pause states has been fixed.

  • We've resolved an issue causing the application to crash while resolving inaccessible personal folders.

2.11.0

2023-05-25

Improvements

  • Added primary key as request parameter during parquet file upload to avoid duplicate events in certain edge cases.

2.10.0

2023-03-15

Improvements

  • Improved caching and sending behavior of the Client to ensure that parquet files are sent to the Celonis Platform in the order they were created.

  • Major improvement of “Native URL Retrieval” that increases the rate of successfully retrieved URLs.

  • Added user consent fields to be included when the Client settings are reloaded from the cloud.

Fixes

  • Fixed a bug in UIAA denylist that caused the feature to not work properly when switching between processes with Alt + Tab.

  • Fixed a bug causing the “User Attributes” window to constantly reappear, when a user attribute has been deleted after the user has already specified an input.

  • Fixed a bug causing the Client to throw an error when a parquet file has been manually renamed or deleted before it is sent to the Celonis Platform.

2.9.2

2023-01-03

Features

  • Preview Mode: Allows users to display the captured data in a Datagrid directly from the configuration editor without interacting with the cloud.

  • Support multiple secure gateways.

  • Exclude applications from UIAA: Specify a list of applications for which UIAA should be disabled.

  • Introduce Reload configuration button in the configuration menu.

Improvements

  • Improve the performance of the Live event monitor.

Fixes

  • Update default consent text.

  • Fixed an issue in the Live event monitor that shows attributes not part of the event processing rules.

  • Fixed an issue in the Live event monitor that shows wrong or default data.

  • Fixed an issue that allows starting recording from the context menu before entering required custom columns.

  • Fixed UI issue that overlaps the text with the icon for long texts in the User Input Window.

  • Fixed an issue that keeps prompting the User Input Window to provide User Attributes, despite the user has already given an answer (Only caused when the Project Lead changed User Attributes in the config).

2.8.1

2022-10-30

Features

  • User Attributes: Allows client users to provide additional user-specific information to calculate metrics for a subset of defined users, such as teams, regions, and roles.

Improvements

  • New Celonis logos and layout applied.

  • Capturing more Clipboard changed events for non-text data.

Fixes

  • Fixed an issue that triggers a ‘Clipboard changed‘ event when pasting in Excel or Word.

Note

With the introduction of the Celonis Platform Task Mining service in version 2.2.2, how you set up and configure Task Mining has changed.

2.7.9

2022-08-17

Features

  • Live event monitor: Enables analysts to immediately see and validate which data is captured with the applied configuration e.g. during the setup phase.

  • Customized Extension ID: This feature allows allow listing custom Chrome extension ID during installation (e.g. for self-hosted extensions).

  • Expanded Data Collection: New jQuery selectors to define custom extraction in web pages and support for input elements, content editable elements and iFrame events (With Task Mining Chrome Extension 0.8 or newer)

Improvements

  • Major performance improvements that increase efficiency and improve product performance: Users notice Task Mining even less with up to 50% reduced CPU usage.

  • SAP integration has been improved when retrieving SAP elements.

  • Optimizing file reading and writing.

  • Improved the functionality of uploading files to the cloud.

  • Improved keyboard capturing for dead keys and support for capturing different languages.

  • Improved user privacy by pausing the client when the user's consent is required.

  • Improved display notifications.

  • Set the default proxy settings to auto-detect.

  • Close all running instances of the client when uninstalling.

  • Cached proxy configuration.

Fixes

  • When the rule name is too long, the expander is not shown in the ‘Configured Applications’ window.

  • If you configured some attributes to be hashed but not to be logged, the client crashes.

Deprecated

  • ‘Application window changed‘ events are deprecated.

Note

With the introduction of the Celonis Platform Task Mining service in version 2.2.2, how you set up and configure Task Mining has changed.

2.6.1

2021-12-27

Fixes

Fixed a problem of corrupted string values when uploading multiple files in parallel.

Note

With the introduction of the Celonis Platform Task Mining service in version 2.2.2, how you set up and configure Task Mining has changed.

2.6.0

2021-11-19

Features

  • SAP integration support for SAP Business Client (SapGuiServer, NWBC).

  • SAP integration option to dynamically enable native Microsoft Windows dialogs in SAP GUI.

Fixes

  • Fixed a problem when uploading and deleting cached files.

  • Fixed consent URL visibility in consent window.

Note

With the introduction of the Celonis Platform Task Mining service in version 2.2.2, how you set up and configure Task Mining has changed.

2.5.2

2021-09-30

Fixes

  • Fix uploading issue with a proxy server.

Note

With the introduction of the Celonis Platform Task Mining service in version 2.2.2, how you set up and configure Task Mining has changed.

2.5.1

2021-09-28

Fixes

  • Error while retrieving SAP metadata.

Note

With the introduction of the Celonis Platform Task Mining service in version 2.2.2, how you set up and configure Task Mining has changed.

2.5.0

2021-09-22

Features

  • Support for on-premise gateway service

  • Extracting additional meta-data from SAP GUI

  • Project-based storage structure for cache

Fixes/Improvements

  • Fixed incorrect consent text when switching project

  • Allow multiline entry in consent textbox in config editor

  • Fixed client crashes after a change of configuration

  • Fixed connection issues to Chrome extension

  • Fixed improper change of team if centrally configured during the rollout

  • Fixed incorrect conversion of conditions with nested OR/AND in config editor UI

Note

With the introduction of the Celonis Platform Task Mining service in version 2.2.2, how you set up and configure Task Mining has changed.

2.4.1

2021-07-28

Features

  • Retrieving URLs from Google Chrome, Microsoft Edge, Mozilla Firefox, and Microsoft Internet Explorer without a browser extension.

  • Automatic update check.

  • Automatic upload of cached files from previous runs.

  • Cleaning up cache in case it exceeds the configured storage limit.

  • Capturing additional event types to analyze user activity.

Fixes/Improvements

  • Show warning in the client if no event processing rules are configured.

  • Falsely detected clipboard changed event if clipboard contains data when starting capturing.

  • Performance issue if no internet connection is available.

  • Context menu of tray icon not working if the application window is minimized.

  • Chrome extension status not updated properly.

  • Various minor bug fixes and UI improvements.

Note

With the introduction of the Celonis Platform Task Mining service in version 2.2.2, how you set up and configure Task Mining has changed.

2.3.0

2021-04-20

Features

  • Install browser extension for Chromium-based Microsoft Edge.

  • Advanced proxy support:

    • System proxy support.

    • Active Directory Authentication.

    • Support for proxy configuration scripts.

  • Activate client during centralized installation.

Fixes/Improvements

  • Keep application settings when installing a new version of Task Mining Client.

  • Improved password clearing.

  • Fixed error while loading client certificate from Windows certificate store.

  • Fixed application crash if shared clipboard on VM is not accessible.

  • Fixed application crash if the configuration contains invalid event processing rules.

  • Various user interface improvements.

Note

With the introduction of the Celonis Platform Task Mining service in version 2.2.2, how you set up and configure Task Mining has changed.

2.2.2

2021-02-25

Features

  • Central configuration: Easily manage your Task Mining projects with hundreds of users.

  • Central configuration:

    • Activation links for simple connection of the client to Task Mining project in Celonis Platform.

    • Clients fetch configuration automatically from Celonis Platform.

    • Configuration files do not need to be copied to the client machines anymore.

    • Simple and fast update of configurations.

  • Central logging and monitoring:

    • Error messages are forwarded to the cloud.

    • Show error log inside client instead of log files.

    • See the current state of all clients.

  • New, more reliable screenshot implementation.

  • Support for internet connections over secure gateways.

Fixes

  • Communication errors between client and Chrome extension.

  • Crash of configuration editor if event processing rules are missing in the configuration file.

  • Minor UI improvements.

Note

With the introduction of the Celonis Platform Task Mining service in version 2.2.2, how you set up and configure Task Mining has changed.

2.0.7

2020-12-10

Fixes

  • Resolved performance issues while capturing event data.

Note

Update from version 2.0.4 - 2.0.6: No breaking changes.

Update from older versions (1.X): See release notes for version 2.0.4.

2.0.6

2020-12-07

Fixes

  • Client UI freezing on copy to clipboard events in Internet Explorer.

Note

Update from version 2.0.4 - 2.0.5: No breaking changes.

Update from older versions (1.X): See release notes for version 2.0.4.

2.0.5

2020-11-20

Fixes

  • Fixes an issue where some attributes cannot be used in allow/deny list.

Note

Update from version 2.0.4: No breaking changes

Update from older versions (1.X): See release notes for version 2.0.4

2.0.4

2020-11-17

Features

  • New UI design of configuration editor:

    • Improved logical structure of configuration options.

    • Tooltips explaining each configuration option.

    • Visual editor for event processing rule supports IN operators.

  • New UI of Task Mining Client:

    • Customized data privacy consent.

    • Showing information on captured applications and file upload status.

    • New look and feel.

    • Control Task Mining directly from taskbar.

  • New installers:

    • Option to install Task Mining Client locally without admin rights.

  • Encryption of locally cached files (events and screenshots).

  • Extracting additional information on controls (e.g. button labels).

  • HTTP proxy support.

Fixes

  • Improved detection of functional keys as keyboard commands.

  • Cropped screenshots for Internet Explorer.

  • False detection of WIN keys after locking the screen with Win+L keyboard command.

  • Win+E is not detected as the keyboard command.

  • Events sent by Chrome events lost (requires an update of Chrome extension to Version 0.4).

  • Clipboard changes freezing Task Mining UI.

  • Retrieving URLs from Internet Explorer for clipboard change events.

Note

Incompatible changes in Celonis Platform data schema:

  • You cannot push data to event collection tables that have been created for previous versions of Task Mining.

  • You cannot push data from previous versions of Task Mining into event collection tables that have been created for this version.

1.2.7

2020-09-10

Features

  • New screenshot capturing:

    • Exact clipping of active window.

    • Avoids overlay windows of other applications.

  • Option to install Chrome extension from Task Mining installer.

  • SAP integration for clipboard events.

  • Optional name and description for event processing rules.

  • Minor UI improvements.

Fixes

  • Connection issues of SAP integration on slow machines.

  • Incorrect assignment of process name and window title when switching application.

  • Special characters entered by key commands (e.g. Ctrl+Alt+Q for @ on German keyboard layouts) detected as keyboard command events.

  • Event Processing Rules: Incorrect handling of empty fields in NOT LIKE operator.

  • Different hashed values for the same input.

  • Errors in communication between Task Mining Client and Chrome extension.

Deprecated/removed:

  • Starting mode Working Hours

  • Option Obfuscate text input

Note

Incompatible changes in Celonis Platform data schema:

  • You cannot push data to event collection tables that have been created for previous versions of Task Mining.

  • You cannot push data from previous versions of Task Mining into event collection tables that have been created for this version.

Change of system requirements:

  • The new screenshot approach requires min. Windows 10, release 1903.

  • To run Task Mining on older Windows versions, you need to enable the "Use legacy screenshot capturing" option in the configuration.

1.2.1

2020-07-02

Features

  • SAP integration: Retrieving detailed information for controls of SAP GUI.

  • Retrieving caret position.

  • Support for user-bound API keys.

Fixes

  • Crash of configuration editor after clicking a button of the default rule.

  • Incorrect size and clipping of screenshots if the screen is scaled.

Note

Incompatible changes in Celonis Platform data schema:

  • You cannot push data to event collection tables that have been created for previous versions of Task Mining.

  • You cannot push data from previous versions of Task Mining into event collection tables that have been created for this version.

1.1.7

2020-06-10

Features:

  • Visual Configuration Editor introduced.

Fixes/improvements:

  • Showing an error message when loading unreadable config files.

Version

Date

Notes

Release notes browser extension

Version

Date

Notes

1.0.1

2023-01-27

Fixes

  • Events on some elements not captured due to error when the element path was null.

1.0

2022-11-24

Fixes/Improvements

  • Chrome extension manifest update from version 2 to version 3. The current Manifest version 2 is deprecated, and support will be removed in 2023.

  • Adding graceful failing WebPage Extraction when an invalid path expression is used

0.8 and before

-

No separate release notes. Release notes have been part of the Client & Configuration Editor release notes above.

Note

You must have admin rights to install the Task Mining Client software from the command line. A system proxy is used by default. If a different setting is required for individual machines, you must configure this for each machine individually. From 2.3.0.

  1. Check the installation prerequisites.

  2. Extract all files from the Task Mining Client installation zip file.

  3. Open your command prompt with Run as administrator.

  4. Change your command line directory to point to where the files were extracted to in step 2.

  5. Copy and paste the Task Mining command line syntax at your command line.

  6. Modify the command line syntax according to your use case, using the Task Mining command line parameters.

    Tip

    You may also find the Task Mining command line examples helpful.

  7. Run your command.

    The Task Mining Client software is installed.

Note

Standard Microsoft Windows commands apply. See the Microsoft Windows documentation for more information.

msiexec.exe /qb /[i|x]CelonisTaskMining.Installer-<version>.msi 
[ACTIVATIONLINKURLPROPERTY=<activation_link_url>] 
[CHROMEEXTENSIONPROPERTY={0|1}] [EDGEEXTENSIONPROPERTY={0|1}] [CUSTOMEXTENSIONPROPERTY={0|1}] 
[CUSTOMEXTENSIONIDS=<custom_extension_id>] [CHROMEUPDATEURL=<update_url>] [EDGEUPDATEURL=<update_url>] 
[SECUREGATEWAYSERVERPROPERTY=<secure_gateway_server_url>] 
[CLIENTCERTIFICATESUBJECTPROPERTY=&lt;client_certificate_subject&gt;] 
[SPNPROPERTY=&lt;service_principal_name_identifier&gt;] 
[TIMEOUTPROPERTY=&lt;connection_timeout&gt;] [EXTENSIONWEBSOCKETPORTPROPERTY=&lt;extension_websocket_port&gt;]

Installation

Example command

Installs the Task Mining Client software using a secure gateway configuration.

Connects the Task Mining Client software to an organization's secure gateway server and uses the API endpoints to connect to the Celonis Platform.

For more information, see Running the Task Mining Client software over a secure gateway server.

msiexec.exe /qb /i CelonisTaskMining.Installer.msi SECUREGATEWAYSERVERPROPERTY="myserver.com" CLIENTCERTIFICATESUBJECTPROPERTY="certificate subject"

Installs the Task Mining Client software and enables use of the Task Mining Gateway.

For more information, see Running the Task Mining Client software over 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.

msiexec.exe /qb /i CelonisTaskMining.Installer.msi SECUREGATEWAYSERVERPROPERTY="myserver.com" CLIENTCERTIFICATESUBJECTPROPERTY="certificate subject" SPNPROPERTY="service principal name"

Installs the Task Mining Client software with an activation link.

msiexec.exe /qb /i CelonisTaskMining.Installer.msi ACTIVATIONLINKURLPROPERTY="https://team.domain.celonis.cloud/task-mining/join?code=1234-5678-9012-1234"

Installs the Task Mining Client software without browser extensions.

msiexec.exe /qb /i CelonisTaskMining.Installer.msi CHROMEEXTENSIONPROPERTY=0 EDGEEXTENSIONPROPERTY=0

Installs the Task Mining Client software with a Chrome extension from a different store.

msiexec.exe /qb /i CelonisTaskMining.Installer.msi CHROMEUPDATEURL="http://myserver.com/extension_store"

Installs the Task Mining Client software and enables the capture of Task Mining data from a browser extension with ID <custom_extension_id>.

For more information, see the Task Mining browser extensions overview.

msiexec.exe /qb /i CelonisTaskMining.Installer.msi CUSTOMEXTENSIONIDS=<custom_extension_id>

Note

Do not include a space between the comma and values if using a comma-separated list of IDs.

Installs the Task Mining Client software and enables the capture of Task Mining data from a browser extension with ID <customer_extension_id> from a self-hosted store.

 For more information, see Installing self-hosted browser extensions.

msiexec.exe /qb /i CelonisTaskMining.Installer.msi CUSTOMEXTENSIONIDS=<custom_extension_id> CHROMEUPDATEURL=https://myserver.com/mystore

Note

Do not include a space between the comma and values if using a comma-separated list of IDs.

Uninstalls the Task Mining Client software.

msiexec.exe /qb /x CelonisTaskMining.Installer.msi

Note

You can also configure the secure gateway service settings when you install the Task Mining Client software using the installation package. Both of these installation methods require admin rights. For more information, see Task Mining Client software install settings.

  1. Create a registry key at Computer\HKEY_LOCAL_MACHINE\SOFTWARE\Celonis\TaskMining.

  2. Create a registry string value at the location in step 1 with the name secure_gateway_server.

  3. Assign the URL of the secure gateway server to secure_gateway_server, for example, mysecuregatewayserver.com/company.

    Note

    You can configure multiple secure gateways by appending additional gateways using a semicolon delimiter, for example secure_gateway_server=server1.com;server2.com;mysecuregatewayserver.com/company

  4. Create a registry string value in the location in step 1 with the name client_certificate_subject.

  5. Install the client certificate that will be used to authenticate the secure gateway server in Current User/Personal store.

  6. Assign the subject of the client certificate to client_certificate_subject, for example My Certificate.

    The configuration is complete.

    Tip

    You can roll back the configuration (if necessary) by removing the registry values created in steps 2 and 4.

Important

Use of the Task Mining Gateway is currently limited to specific customers who use a hybrid environment. For more information, contact Support.

Tip

You can roll back the configuration (if necessary) by removing the registry values created in steps 2, 4 and 7.

  1. Create a registry key at Computer\HKEY_LOCAL_MACHINE\SOFTWARE\Celonis\TaskMining.

  2. Create a registry string value at the location in step 1 with the name secure_gateway_server.

  3. Assign the URL of the secure gateway server to secure_gateway_server, for example, mysecuregatewayserver.com/company.

    Note

    You can configure multiple secure gateways by appending additional gateways using a semicolon delimiter, for example secure_gateway_server=server1.com;server2.com;mysecuregatewayserver.com/company

  4. Create a registry string value in the location in step 1 with the name client_certificate_subject

  5. Install the client certificate that will be used to authenticate the secure gateway server in Current User/Personal store.

  6. Assign the subject of the client certificate to client_certificate_subject, for example My Certificate.

  7. Create a registry string value at the location in step 1 with the name service_principal_name.

  8. Assign the unique identifier of the secure gateway service instance to service_principal_name.

    The configuration is complete.

Parameter

Description

Possible values

Deafult value at install

From version

/qb

Specifies there is a basic user interface during the installation process.

--

--

2.3.0

/i

Specifies normal installation.

--

--

2.3.0

/x

Uninstalls the package.

--

--

2.4.0

ACTIVATIONLINKURLPROPERTY

Assigns the activation link URL.

Vew the activation link URL from Users & Invite > Invite Users.

URL with this format:

https://<team><realm>.celonis.cloud.celonis.cloud/task-mining/ui/join?code<uuid>

--

2.3.0

CHROMEEXTENSIONPROPERTY

Enables or disables installation of the Chrome extension.

0 (disabled)

1 (enabled)

1

2.3.0

CHROMEUPDATEURL

Changes the update URL location for installing and updating the Chrome extension to an alternative repository.

For information about using CHROMEUPDATEURL, see the Task Mining command line examples.

--

Chrome Web Store

2.4.0

CLIENTCERTIFICATESUBJECTPROPERTY

Assigns the client certificate subject name. The certificate must be installed in the Windows certificate store under Current User/Personal store.

--

<empty>

2.3.0

CUSTOMEXTENSIONIDS

Assigns the custom Chrome extension ID value (separate multiple values with commas).

For information about using CUSTOMEXTENSIONIDS, see the Task Mining command line examples.

--

<empty>

2.7.8

CUSTOMEXTENSIONPROPERTY

Specifies whether a custom Chrome extension ID is used. This is required for self-hosting of the Task Mining browser extensions.

--

--

2.7.8

EDGEEXTENSIONPROPERTY

Enables or disables installation of the Microsoft Edge extension.

0 (disabled)

1 (enabled)

1

2.3.0.

EDGEUPDATEURL

Changes the update URL location for installing and updating the Microsoft Edge extension to an alternative repository.

--

Chrome Web Store

2.4.0

EXTENSIONWEBSOCKETPORTPROPERTY

Specifies a custom web socket port for the Chrome extension.

--

8080

2.12.0

SECUREGATEWAYSERVERPROPERTY

Assigns the secure gateway URLs if the Task Mining Client software is used in a secure environment. Multiple URLs must be separated by a semicolon (;).

--

empty

2.3.0

SPNPROPERTY

Assigns the Service Principal Name (SPN) of the gateway service to enable authentication with the on-premise Task Mining Gateway. Separate multiple SPNs with a semicolon (;).

Secure gateway URLs and their corresponding SPN should be defined in the same order.

Important

Use of the Task Mining Gateway is currently limited to specific customers who use a hybrid environment. For more information, contact Support.

--

empty

2.5.0

TIMEOUTPROPERTY

Defines the timeout in seconds for HTTP connections to the Task Mining Gateway.

ImportantUse of the Task Mining Gateway is currently limited to specific customers who use a hybrid environment.

For more information, see Download Task Mining Gateway.

Any positive integer value.

180

2.5.0

WORKINGDIRECTORY

Changes the default location of the working directory. The Task Mining Client software requires read and write permissions for this directory.

--

%LOCALAPPDATA%\Celonis\TaskMiningClient

2.16.0

VDI install option

Description

Use case

Install the Task Mining Client software inside a VDI.

The Task Mining Client software captures data as if it were installed and running directly on the machine.

Full Task Mining data capture.

Install the Task Mining Client software outside a VDI.

The Task Mining Client software is installed on a user's machine and captures Task Mining data from a remote desktop without being installed in the VDI.

Screenshots (if enabled) can be captured in this setup, but data from within the VDI, such as which apps are used, is not available.

The Task Mining Client software must be connected to the VDI using:

  •  Microsoft Remote Desktop client.

  • Citrix Workspace.

  • Citrix Receiver.

  • VMware Horizon Client.

Limited capture. Used to determine whether the Task Mining Client software is running.

Consideration

Description

Recommendation

Non-Task Mining software users in the Production environment.

Production environment includes users who won’t be using the Task Mining software.

Create a VDI for the subset of Task Mining software users.

Note

This also provides a simple fallback mechanism if unforeseen issues arise and you need to roll back users. Using a VDI environment for a smaller number of users can also speed up configuration changes and deployment of new Task Mining software and SAP GUI versions.

Multi-user sessions are required.

While multiple users can connect to the same Windows instance in parallel, the Task Mining browser extensions can’t be used in parallel for multi-user sessions.

Use a VDI for multi-user sessions only if the capture of Task Mining data from the Chrome browser extensions is not required.

Update options

Use case

More information

Uninstall the Task Mining Client software and reinstall a different version.

Installation of any version of the Task Mining Client software.

Updating the Task Mining Client software (uninstall/reinstall)

Install a newer version of the Task Mining Client software ‘on top’ of the current Task Mining Client software.

Installation of a newer version of the Task Mining Client software.

Updating the Task Mining Client software (install a newer version)

  1. Uninstall the Task Mining Client software either:

    • Using Windows >Apps > Installed apps >Uninstall; or

    • From the command line.

  2. Identify the Task Mining Client software version you want to install using the Task Mining installation file release notes.

  3. Install the Task Mining Client software.

We notify users of new Task Mining Client software versions in both the Task Mining installation file release notes and in our wider product release notes.

Note

You must have admin rights to install the Task Mining Client software from the command line. A system proxy is used by default. If a different setting is required for individual machines, you must configure this for each machine individually. From 2.3.0.

  1. Check the installation prerequisites.

  2. Extract all files from the Task Mining Client installation zip file.

  3. Open your command prompt with Run as administrator.

  4. Change your command line directory to point to where the files were extracted to in step 2.

  5. Copy and paste the Task Mining command line syntax at your command line.

  6. Modify the command line syntax according to your use case, using the Task Mining command line parameters.

    Tip

    You may also find the Task Mining command line examples helpful.

  7. Run your command.

    The Task Mining Client software is installed.

Note

Standard Microsoft Windows commands apply. See the Microsoft Windows documentation for more information.

msiexec.exe /qb /[i|x]CelonisTaskMining.Installer-<version>.msi 
[ACTIVATIONLINKURLPROPERTY=<activation_link_url>] 
[CHROMEEXTENSIONPROPERTY={0|1}] [EDGEEXTENSIONPROPERTY={0|1}] [CUSTOMEXTENSIONPROPERTY={0|1}] 
[CUSTOMEXTENSIONIDS=<custom_extension_id>] [CHROMEUPDATEURL=<update_url>] [EDGEUPDATEURL=<update_url>] 
[SECUREGATEWAYSERVERPROPERTY=<secure_gateway_server_url>] 
[CLIENTCERTIFICATESUBJECTPROPERTY=&lt;client_certificate_subject&gt;] 
[SPNPROPERTY=&lt;service_principal_name_identifier&gt;] 
[TIMEOUTPROPERTY=&lt;connection_timeout&gt;] [EXTENSIONWEBSOCKETPORTPROPERTY=&lt;extension_websocket_port&gt;]

Installation

Example command

Installs the Task Mining Client software using a secure gateway configuration.

Connects the Task Mining Client software to an organization's secure gateway server and uses the API endpoints to connect to the Celonis Platform.

For more information, see Running the Task Mining Client software over a secure gateway server.

msiexec.exe /qb /i CelonisTaskMining.Installer.msi SECUREGATEWAYSERVERPROPERTY="myserver.com" CLIENTCERTIFICATESUBJECTPROPERTY="certificate subject"

Installs the Task Mining Client software and enables use of the Task Mining Gateway.

For more information, see Running the Task Mining Client software over 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.

msiexec.exe /qb /i CelonisTaskMining.Installer.msi SECUREGATEWAYSERVERPROPERTY="myserver.com" CLIENTCERTIFICATESUBJECTPROPERTY="certificate subject" SPNPROPERTY="service principal name"

Installs the Task Mining Client software with an activation link.

msiexec.exe /qb /i CelonisTaskMining.Installer.msi ACTIVATIONLINKURLPROPERTY="https://team.domain.celonis.cloud/task-mining/join?code=1234-5678-9012-1234"

Installs the Task Mining Client software without browser extensions.

msiexec.exe /qb /i CelonisTaskMining.Installer.msi CHROMEEXTENSIONPROPERTY=0 EDGEEXTENSIONPROPERTY=0

Installs the Task Mining Client software with a Chrome extension from a different store.

msiexec.exe /qb /i CelonisTaskMining.Installer.msi CHROMEUPDATEURL="http://myserver.com/extension_store"

Installs the Task Mining Client software and enables the capture of Task Mining data from a browser extension with ID <custom_extension_id>.

For more information, see the Task Mining browser extensions overview.

msiexec.exe /qb /i CelonisTaskMining.Installer.msi CUSTOMEXTENSIONIDS=<custom_extension_id>

Note

Do not include a space between the comma and values if using a comma-separated list of IDs.

Installs the Task Mining Client software and enables the capture of Task Mining data from a browser extension with ID <customer_extension_id> from a self-hosted store.

 For more information, see Installing self-hosted browser extensions.

msiexec.exe /qb /i CelonisTaskMining.Installer.msi CUSTOMEXTENSIONIDS=<custom_extension_id> CHROMEUPDATEURL=https://myserver.com/mystore

Note

Do not include a space between the comma and values if using a comma-separated list of IDs.

Uninstalls the Task Mining Client software.

msiexec.exe /qb /x CelonisTaskMining.Installer.msi

Note

You can also configure the secure gateway service settings when you install the Task Mining Client software using the installation package. Both of these installation methods require admin rights. For more information, see Task Mining Client software install settings.

  1. Create a registry key at Computer\HKEY_LOCAL_MACHINE\SOFTWARE\Celonis\TaskMining.

  2. Create a registry string value at the location in step 1 with the name secure_gateway_server.

  3. Assign the URL of the secure gateway server to secure_gateway_server, for example, mysecuregatewayserver.com/company.

    Note

    You can configure multiple secure gateways by appending additional gateways using a semicolon delimiter, for example secure_gateway_server=server1.com;server2.com;mysecuregatewayserver.com/company

  4. Create a registry string value in the location in step 1 with the name client_certificate_subject.

  5. Install the client certificate that will be used to authenticate the secure gateway server in Current User/Personal store.

  6. Assign the subject of the client certificate to client_certificate_subject, for example My Certificate.

    The configuration is complete.

    Tip

    You can roll back the configuration (if necessary) by removing the registry values created in steps 2 and 4.

Important

Use of the Task Mining Gateway is currently limited to specific customers who use a hybrid environment. For more information, contact Support.

Tip

You can roll back the configuration (if necessary) by removing the registry values created in steps 2, 4 and 7.

  1. Create a registry key at Computer\HKEY_LOCAL_MACHINE\SOFTWARE\Celonis\TaskMining.

  2. Create a registry string value at the location in step 1 with the name secure_gateway_server.

  3. Assign the URL of the secure gateway server to secure_gateway_server, for example, mysecuregatewayserver.com/company.

    Note

    You can configure multiple secure gateways by appending additional gateways using a semicolon delimiter, for example secure_gateway_server=server1.com;server2.com;mysecuregatewayserver.com/company

  4. Create a registry string value in the location in step 1 with the name client_certificate_subject

  5. Install the client certificate that will be used to authenticate the secure gateway server in Current User/Personal store.

  6. Assign the subject of the client certificate to client_certificate_subject, for example My Certificate.

  7. Create a registry string value at the location in step 1 with the name service_principal_name.

  8. Assign the unique identifier of the secure gateway service instance to service_principal_name.

    The configuration is complete.

Parameter

Description

Possible values

Deafult value at install

From version

/qb

Specifies there is a basic user interface during the installation process.

--

--

2.3.0

/i

Specifies normal installation.

--

--

2.3.0

/x

Uninstalls the package.

--

--

2.4.0

ACTIVATIONLINKURLPROPERTY

Assigns the activation link URL.

Vew the activation link URL from Users & Invite > Invite Users.

URL with this format:

https://<team><realm>.celonis.cloud.celonis.cloud/task-mining/ui/join?code<uuid>

--

2.3.0

CHROMEEXTENSIONPROPERTY

Enables or disables installation of the Chrome extension.

0 (disabled)

1 (enabled)

1

2.3.0

CHROMEUPDATEURL

Changes the update URL location for installing and updating the Chrome extension to an alternative repository.

For information about using CHROMEUPDATEURL, see the Task Mining command line examples.

--

Chrome Web Store

2.4.0

CLIENTCERTIFICATESUBJECTPROPERTY

Assigns the client certificate subject name. The certificate must be installed in the Windows certificate store under Current User/Personal store.

--

<empty>

2.3.0

CUSTOMEXTENSIONIDS

Assigns the custom Chrome extension ID value (separate multiple values with commas).

For information about using CUSTOMEXTENSIONIDS, see the Task Mining command line examples.

--

<empty>

2.7.8

CUSTOMEXTENSIONPROPERTY

Specifies whether a custom Chrome extension ID is used. This is required for self-hosting of the Task Mining browser extensions.

--

--

2.7.8

EDGEEXTENSIONPROPERTY

Enables or disables installation of the Microsoft Edge extension.

0 (disabled)

1 (enabled)

1

2.3.0.

EDGEUPDATEURL

Changes the update URL location for installing and updating the Microsoft Edge extension to an alternative repository.

--

Chrome Web Store

2.4.0

EXTENSIONWEBSOCKETPORTPROPERTY

Specifies a custom web socket port for the Chrome extension.

--

8080

2.12.0

SECUREGATEWAYSERVERPROPERTY

Assigns the secure gateway URLs if the Task Mining Client software is used in a secure environment. Multiple URLs must be separated by a semicolon (;).

--

empty

2.3.0

SPNPROPERTY

Assigns the Service Principal Name (SPN) of the gateway service to enable authentication with the on-premise Task Mining Gateway. Separate multiple SPNs with a semicolon (;).

Secure gateway URLs and their corresponding SPN should be defined in the same order.

Important

Use of the Task Mining Gateway is currently limited to specific customers who use a hybrid environment. For more information, contact Support.

--

empty

2.5.0

TIMEOUTPROPERTY

Defines the timeout in seconds for HTTP connections to the Task Mining Gateway.

ImportantUse of the Task Mining Gateway is currently limited to specific customers who use a hybrid environment.

For more information, see Download Task Mining Gateway.

Any positive integer value.

180

2.5.0

WORKINGDIRECTORY

Changes the default location of the working directory. The Task Mining Client software requires read and write permissions for this directory.

--

%LOCALAPPDATA%\Celonis\TaskMiningClient

2.16.0