Skip to main content

Celonis Product Documentation

Manual Setup Guide


This manual setup guide is deprecated and only kept for documentation purposes. Please instead use the Workforce Productivity setup which provides out-of-the-box data processing and a pre-built analysis.


Manual Setup Guide is an advanced use case that requires customization. Please reach out to your Partner Manager, Customer Value Manager, or open a ticket via Celopeers to get access and guidance to ensure your project's success.


This guide covers the setup for the Task Mining client version 2.2 or above. For the setup of version 2.0, see Manual Setup Guide (legacy V2.0 or previous).


After finishing this walkthrough (30-45 mins), you will...

  • Have configured and installed Task Mining on your computer.

  • See the analysis with your application usage, desktop processes and screenshots of each step.

  • Understand how to run a Task Mining project.

  • Be able to adapt the project to your needs.

  • An existing EMS team.

Alternately, you can perform a quick set up to only send data to the EMS; see up API key and Data Pool or Task Mining - Configuration Editor for information about the technical details of the data connection.

Get in touch to prepare your EMS Team for Task Mining

Before running the Task Mining Setup, please get in touch with the Celonis Servicedesk to prepare your EMS team for Task Mining and enable the required components.

1. Create new Task Mining project
  1. Open the 41195498.png tab in your EMS instance.

  2. Click the 41195499.png button.

  3. In the New Project dialog, enter a name for your Task Mining project and click Save. This will set up a new data pool, API key, and storage bucket.

  4. After the project has been successfully created, click Next to get to your Task Mining project.

2. Customize configuration
  1. Open the 41195500.png section of your Task Mining project.

  2. Click the Download Files button to download the configuration file.

  3. Download and install the "CelonisTaskMining.Configuration.Installer-2.x.x.msi" file (it's not the Task Mining Client!)

  4. Start the Configuration Editor and open the configuration file. Go to the Event Processing Rules section and add one or more rules.



    The configuration does not contain any rules by default and therefore does not capture any data. You have to define at least one. For details on how to define event processing rules, see Task Mining Desktop Application documentation.

  5. Go to the User Consent section and customize the user consent text according to the requirements of your organization.

  6. After you have saved the changes, return to the Configuration section of your Task Mining project in EMS and upload the changed configuration file.

  7. Go to the 41195517.png section of your Task Mining project.

  8. Click Invite Users, copy the activation link and share it with the Task Mining users.

3. Set up Client


Even if you don't want to run Task Mining for yourself, you can use this step to run a test to check if the configuration works and the data is sent to the Datapool successfully.

  1. Download and install the Task Mining client ("CelonisTaskMining.Installer-2.x.x.msi")

  2. Start the client and when prompted, enter the shared activation link and click Activate.

  3. If the activation was successful, the client will show the user consent. You need to accept and agree to the consent to continue by setting the check box and clicking Agree. If you disagree, you can click Disagree & Quit to terminate the Task Mining client.

  4. Now the client is ready to capture data. In the Your Team section, you should now see the URL and name of the connected Task Mining project. Click Start to start capturing.

4. Analyze results


It can take 10~20 minutes to load the data into the SQL database in the EMS after it was successfully uploaded from the Client. If you are curious, you can use SQL to query the most recent data in the Data Integration Transformation using SELECT * FROM "user_interaction_event_log" order by TimestampUTC DESC.

  • ML Workbench:

    • Create a new ML workbench of Application Type 'Task Mining' if not done yet.

    • Open the ML Workbench of type Task Mining.

    • In ML Workbench for Task Mining, go to the examples_taskmining folder. In there, you will find our Jupyter Notebooks.

    • Edit and follow steps in ML Workbench Notebook A1_TM_run_default_pipeline.ipynb.

      This should transform the data, create a data model and let you use the analysis.

  • Install Analysis: If you have chosen a template to import, an analysis was already installed. If you created an empty project, you can install an analysis yourself from the notebooks:

    • From the notebook A0_TM_initial_setup.ipynb run only step 6: "Add default analyses to Workspace" to install the "Installation Report" Analysis.

    • For the Accounts Payable template, the analysis will be installed during running the notebook C1_TM_Accounts_Payable.ipynb.

  • Investigate results in the example Analysis (Installation Report Complete) which was installed in step 1.

  • If you are not seeing any data you can investigate issues by opening the log file of the Task Mining Desktop Software (Options → Show Logs) or the Task Mining Users & Invite page in the EMS for troubleshooting.

  • If you want to run the notebook automatically, you can configure an automated schedule: Scheduling notebooks

Setup the Screenshot Viewer

  • If you enabled screenshots, you can use an EMS app to inspect them.

  • To install the screenshot viewer, please go to the Marketplace -> Search for 'Task Mining Screenshots' -> Click Install.

  • Follow the Readme of the Task Mining Screenshot Package to finalize the setup.

5. Adapt to your needs

Adapt the Analysis and Data jobs to your needs, for example, to:

  • Define custom KPIs, e.g. time spent in some specific SAP view.

  • Link Task Mining to existing process mining data.

  • Define a custom start and end of your cases in the notebook B3_TM_generate_data_model.ipynb.

6. IT deployment in your organization: Installing Task Mining on selected agent computers
  1. Define a list of agents.

  2. Install Task Mining, using one of these options:

    • Share the invite link with agents which also contains a link to download the software. The agents install the Task Mining software on their own. Most Windows 10 computers don't require admin rights for this; or

    • Provide your IT department with installer software and a list of agents to install the software. Task Mining can be rolled out Central IT for everybody at once. This way, the effort for larger rollouts can be kept minimal.

  3. Share the invite link with the agents to connect them to your project. The agents click the link, Task Mining opens. After confirming the consent, Task Mining can start to capture data.

  4. In the Users & Invite section, you can monitor the connected clients and their current state.