Skip to main content

Celonis Product Documentation

Task Mining Desktop Application

System requirements

  • Operating system:

    • Windows 10 (from version 2.2) or Windows 10 release 1903 or higher (version 2.0).

    • Windows 11 (beta).

      Important

      Support for Windows 11 is currently in beta. Get in touch if you have any feedback.

  • .NET Framework 4.8 (or higher).

  • Firewall: Outgoing connections from the Task Mining client to your Celonis Platform team via HTTPS.

Note

If your machine is running on up-to-date Windows 10, this .NET Framework should already be installed. If it is not installed, you will see a pop-up window when you first start Task Mining; this includes a link to the .NET Framework download page. You should download the correct version from there; you will need admin rights to do so.

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.

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).

Configuration Editor (optional)

Note

This is only required if you want to create or change the Task Mining XML configuration file.

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

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

Installation without admin rights

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

Configure Task Mining (deprecated)

Notice

This section only applies to version 2.0 and prior. From version 2.2, the configuration is centrally-managed in the Celonis Platform and automatically downloaded by clients.

The Task Mining desktop application requires a configuration file (with file name extension .recconf) in XML format. This configuration file can be created with the Task Mining Configuration Editor.

The Celonis Task Mining desktop application tries to automatically retrieve a configuration file and searches in the following order:

  1. Recently-used configuration file: the desktop application stores this and will re-use it if possible.

  2. List of paths: the desktop application searches for a configuration file in a pre-defined list of paths (subfolders are not searched) in the following order:

    1. The current directory (installation directory of the desktop application).

    2. The home directory of the user.

    3. The user's My Documents directory.

    4. Celonis Task Mining subdirectory in the Windows application data folder.

  3. Manually-selected configuration file: the user is prompted to select a configuration file.

Warning

Based on the order given, the desktop application will always use the first configuration file that can be loaded successfully. If you have multiple files stored in different folders, the configuration file that is actually loaded may not be as expected.

Password input

If the field type is known and the type is a password field, the text input will not be captured. This means the content of password fields is ignored if they are extracted via the Chrome extension or the SAP integration; the fields 'EnteredText', 'ClipboardContent', 'TargetElementValue' and 'ElementTextSAP' respectively will be set to Null. For other applications, custom rules can be used to either generally hash the fields 'EnteredText' and 'ClipboardContent' or hash them for specific login screens. These can be identified, for example, using the fields 'URL' or 'ActiveWindow'.

Persisted directories and registry keys

Note

The Task Mining Desktop Application needs access to some directories and registry keys to work as expected.

Persisted directories

Directory

Access type

Description

%ProgramFiles(x86)%\Celonis SE\Celonis Task Mining

  • Read access during runtime.

  • Write access during installation.

Installation directory when installed per machine context.

%LOCALAPPDATA%\Celonis SE\Celonis Task Mining

  • Read access during runtime.

  • Write access during installation.

Installation directory when installed per user context.

%USERPROFILE%\CelonisTaskMining

Read/write access during runtime.

Contains cached parquet and image files. Can be configured in the project configuration.

%LOCALAPPDATA%\Celonis\TaskMiningClient

Read/write access during runtime.

Contains cached configuration, application settings and logs.

%LOCALAPPDATA%\Celonis_SE\CelonisTaskMining.Client._Url_< 32 alphanumeric characters><version of the client>

Read/write access during runtime.

Contains required application settings.

We recommend making the entire %LOCALAPPDATA%\Celonis_SE directory persistent to ensure files are still available when the Task Mining Desktop Application is updated.

<Personal Special Folder>

For further information, see Environment.SpecialFolder Enum.

Important

Any references to third-party products or services do not constitute Celonis Product Documentation nor do they create any contractual obligations. This material is for informational purposes only and is subject to change without notice.

Celonis does not warrant the availability, accuracy, reliability, completeness, or usefulness of any information regarding the subject of third-party services or systems.

Write access during runtime.

Contains crash report files.

<Personal Special Folder>/Celonis Task Mining

For further information, see Environment.SpecialFolder Enum.

Important

Any references to third-party products or services do not constitute Celonis Product Documentation nor do they create any contractual obligations. This material is for informational purposes only and is subject to change without notice.

Celonis does not warrant the availability, accuracy, reliability, completeness, or usefulness of any information regarding the subject of third-party services or systems.

Write access during runtime.

Contains error log files if configuration could not be loaded.

Persisted registry keys

Note

For:

  • KMU, when the client is installed per machine context (admin), the key will be under HKLM. When installed per user context, the key will be under HKCU.

  • <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.

Registry key

Access type

Description

HKCU\<Software>\Celonis\TaskMining\installed

Write access during installation.

Registers installation of the application.

HKLM\<Software>\Celonis\TaskMining\activation_link_url

  • Read access during runtime.

  • Write access during installation.

Activation link to automatically activate the client on the first start.

HKLM\<Software>\Celonis\TaskMining\client_certificate_subject

  • Read access during runtime.

  • Write access during installation.

Client certificate subject used for secure gateway authentication.

HKLM\<Software>\Celonis\TaskMining\client_working_directory

  • Read access during runtime.

  • Write access during installation.

Working directory of the Task Mining client.

HKLM\<Software>\Celonis\TaskMining\connection_timeout

  • Read access during runtime.

  • Write access during installation.

Custom connection timeout.

HKLM\<Software>\Celonis\TaskMining\custom_extension_ids

  • Read access during runtime.

  • Write access during installation.

Custom browser extension IDs for self-hosted rollouts.

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

  • Read access during runtime.

  • Write access during installation.

Service principle 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 the Chrome Extension.

HKMU\<Software>\Google\Chrome\Extensions\ndfcgjlpabkombgfpckhglibdhnipbfl\update_url

Write access during installation.

Update URL of the Chrome Extension.

HKMU\<Software>\Microsoft\Edge\Extensions\ndfcgjlpabkombgfpckhglibdhnipbfl\update_url

Write access during installation.

Update URL of the Edge Extension.

HKMU\<Software>\Microsoft\Windows\CurrentVersion\Run\CelonisTaskMining

Write access during installation.

Autostart entry for the Task Mining client.

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 client from URL.

HKMU\<Software>\Classes\CelonisTaskMining\URL Protocol

Write access during installation.

Enables browsers to open the Task Mining client from URL.

API endpoints

The Task Mining client must have access to these API endpoints.