Task Mining Configuration Editor settings
Note
The Task Mining Client software is versioned and the 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 for versions prior to 2.1.3. For more information about Task Mining software releases, see the Task Mining software installation release notes.
The Configuration Editor settings given here are for the latest version of the Configuration Editor, If you're using an older version, the sections and fields may vary slightly but the possible and default values shoud be the same.
Menu item | Menu option | Description |
|---|---|---|
File | New | Creates a new Task Mining configuration file. |
File | Open | Opens an existing Task Mining configuration file. |
File | Save | Saves the Task Mining configuration file that is currently open. |
File | Save as | Saves the Task Mining configuration file that is currently open under a name and to a location of your choice. |
File | Quit | Exits Configuration Editor. |
Tools | Generate SQL 'CREATE TABLE' query | Generates a SQL query from the Task Mining configuration file. The SQL query is copied to the clipboard. Running this script in a transformation creates the target table in the Celonis Platform. For more information, see Extracting and transforming data. |
Tools | Export JSON (base64 encoded) | Generates a Base64 encoded JSON representation of the Task Mining configuration file and copies it to the clipboard. |
Tools | Import JSON (base64 encoded) | Opens a dialog to import and open a Base64 encoded JSON representation of a Task Mining configuration file. |
About | -- | Contains information about the Task Mining Configuration Editor version and third-party licensing. |
Section | Field | Description | Possible values | Default value |
|---|---|---|---|---|
IBC Upload | Send Data to IBC | Sets whether captured events are:
Note Version requirement: FROM 2.0.4 |
|
Note If IBC Upload is disabled, the other IBC Upload fields are not displayed. |
IBC Upload | Data Pool ID | Identifier of the Celonis Platform Data Pool where captured Task Mining events are stored. | Usually a UUID with this format:
| |
IBC Upload | IBC Team Subdomain | Celonis Platform team subdomain. | Usually the first part of the Celonis Platform URL, for example:
| |
IBC Upload: Send Data to IBC | Server ID | Celonis Platform realm. | Usually the second part of the Celonis Platform URL for example:
| |
IBC Upload: Send Data to IBC | Target Table Name Note The Generate SQL Query button performs the same function as the Generate SQL 'CREATE TABLE' query option in Configuration Editor Application menu > Tools. | Name of the Celonis Platform database table where captured Task Mining events are stored. | -- | |
IBC Upload: Send Data to IBC | Image Service Bucket Name | Name of the bucket where Task Mining screenshots are stored. FROM 1.2.1 | Usually a UUID with this format:
| |
IBC Upload: Send Data to IBC | Update Cloud Period (in Minutes) | Time period (in minutes) during which captured Task Mining events stored in parquet files are sent to the Celonis Platform. | Min value: |
|
Caching | Encrypt Local Data | Sets whether captured Task Mining events temporarily stored on local disk are encrypted. FROM 2.0.4 |
|
|
Caching | Path for Transfer File Cache | Directory where temporary parquet files are stored. If a valid directory isn't specified, the parquet files are stored in the user's temp folder (managed by Windows). Important While UNC paths (e.g. \\server\share) are not supported by default due to security considerations, we can enable them on request if your organization accepts the associated security risk. You can use Windows system variables (like |
| |
Caching | Number of Entries Limit | Maximum number of captured Task Mining events that are cached. If the number of cached events exceeds this value, the cached events are written to a parquet file. | Min value: |
|
Caching | Time Limit in Minutes | Time limit for writing cached events into parquet files (in minutes). If the time limit is exceeded, all cached events are written to parquet. | Min value: |
|
Caching | Timeout in seconds | Time limit for uploading data to the Celonis Platform before terminating the Task Mining Client software. FROM 2.0.4 | Min value: |
|
Caching | Auto Upload Old Cached Files | Sets whether cached files from prevous runs that failed to load are:
FROM 2.4.1 |
|
|
Caching | Maximum Cached File Age (optional) | Number of days cached files are retained before deletion. FROM 2.4.1 | Min value: |
|
Caching | Maximum Cached File Size (optional) |
FROM 2.4.1 | Min value: |
|
Compatibility | Use Old Data Push API | Old Data Push API implementation. Important This is included for backwards compatibility only and will be removed in future releases. FROM 1.1.1 DEPRECATED AFTER 1.1.1 |
|
|
Compatibility | Use Old Image Upload API | Old Image Upload API. Important This is included for backwards compatibility only and will be removed in future releases. FROM 1.2.1 DEPRECATED AFTER 1.2.1 |
|
|
Section | Field | Description | Possible values | Default value |
|---|---|---|---|---|
General | Snippet Split Time | Time period (in seconds) used to split event sequences into snippets. If the elapsed time between two consecutive events exceeds this limit, the later event will be assigned to a new snippet. | Min value: |
|
General | Idle Waiting Time | Time period (in minutes) after which the user is considered absent due to no keyboard or mouse input. FROM 2.4.1 | Min value: |
|
General | Alive Interval | Time between events that are added periodically to the data uploaded to the Celonis Platform to indicate the Task Mining Client is running (in minutes). FROM 2.4.1 | Min value: |
|
General | Use Native URL Retrieval | Sets whether URLs are extracted directly from browsers:
FROM 2.4.1 Note For more information about Chrome and Edge browser extensions, see Task Mining browser extensions overview. |
|
|
General | Show Live Event Monitor in Client | Sets whether the Live Event Monitor menu item in the Task Mining Client software:
Caution When enabled, all users connected to the Task Mining project will have access to the Live Event Monitor. We therefore advise that this is not enabled for productive rollouts but for testing or during the setup phase only. FROM 2.8.1 |
|
|
General | Use UIAA | Sets whether additional information on controls is:
FROM 2.0.4 |
|
|
General | Applications to exclude from UIAA | Applications excluded from additional information extraction by Microsoft UI Automation (UIAA). Tip The application name must exactly match the process name displayed in Windows Task Manager without the .exe extension. The application name is case sensitive. FROM 2.0.4 | -- |
|
Startup Mode | Minimize Task Mining's Window When It Starts | Defines whether the Celonis Task Mining Desktop software starts:
Note The application window can always be restored by clicking the system tray icon. |
|
|
Startup Mode | Startup Mode | Sets whether the Task Mining Desktop software starts the data capture:
Important The Task Mining Desktop software will start to capture data only if the user has already accepted the legal terms. The user can always start or stop Task Mining manually, even if |
|
|
Capturing UI Automation (UIA) data
When UIA capture is enabled, the Task Mining Client software acts as a Microsoft UI Automation (UIA) client and captures data from third-party application interfaces. When a user interacts with a UIA-enabled screen element of an application that exposes UIA attributes, data such as field names and values is captured and stored. Applications based on Win32 and .NET programs typically expose UIA attributes.
Note
If you’re using basic client settings, enable the Context of application or webpage in the Captured Details section. This setting is disabled by default.
Testing UIA data capture
If you want to use UIA data capture in your Task Mining project, we recommend preliminary testing to determine the quality of data captured. Start with a small representative user sample and validate that the data provided by the third-party application is helpful for your project before rolling it out to more users. This is particularly important if you’re working with in-house custom applications that may not have been previously tested for Task Mining.
UIA data capture issues
Issue | Description | Example |
|---|---|---|
The Task Mining Client software cannot reliably capture the UIA data if:
| The closure/ removal of the element means the information on it may already be gone by the time the Task Mining Client software queries it. | User selects:
|
UIA data capture causes a noticeable performance slowdown for some applications in some situations. | According to our testing, applications that must provide UIA data to the Task Mining Client software, as well as performing their standard tasks, may experience performance issues. | Large Microsoft Excel files may cause performance issues so the Task Mining Client software does not send UIA requests to Microsoft Excel by default. |
Section | Description | Possible values | Default value |
|---|---|---|---|
Retrieve SAP Data | Sets the Task Mining Client software to:
Note SAP GUI scripting must be enabled for this to work. For more information, see Configuring SAP for Task Mining integration. FROM 1.2.1 |
|
|
Number of Retry Attempts | Number of times the Task Mining Client software tries to re-establish a lost connection to the SAP GUI. FROM 1.2.1 | Min value: |
|
Waiting Time for Retry | Time the Task Mining Client software waits before trying to re-establish a lost connection to the SAP GUI (in miliseconds). FROM 1.2.1 | Min value: |
|
SAP Process Monitor Interval | Time interval between Task Mining Client software checks for a running SAP GUI instance. FROM 1.2.1 | Min value: |
|
Dynamically Enable Native Windows Dialogs for SAP GUI Scripting | Sets whether native Windows dialogs for SAP GUI scripting is:
Note This setting affects how the SAP GUI works. We recommended enabling it only if users are recording and executing SAP GUI scripts while running Task Mining. |
|
|
Configuring SAP for Task Mining integration
Ensure Retrieve SAP Data is enabled in the configuration settings.
Enable GUI scripting on both the client and server sides.
Change the settings using the information in SAP settings for Task Mining integration.
Important
We recommend disabling Notify when a script attaches to SAP GUI and Notify when a script opens a connection in the SAP GUI options. This prevents users being prompted for permission each time the Task Mining Client software starts and tries to connect to the SAP GUI.
SAP settings for Task Mining integration
Location | Setting | Further information |
|---|---|---|
Server side | Set | Applies to all related profiles. |
Server side | Dynamically enable SAP scripting using RZ11 to take effect immediately. | Consult the SAP help for further information. |
Server side | Permanently enable SAP scripting in RZ10 to take effect after a server restart and for future restarts. | Values changed in RZ11 are temporary and lost after a system restart. To make values permanent, you need to change this in RZ10 too.Consult the SAP help for further information. |
Client side | In Accessibility & Scripting >Scripting, enable these options:
| Start the SAP GUI Configuration app to open the settings. |
Note
For information on data privacy and security, see Task Mining data privacy and security.
Section | Possible values | Default value |
|---|---|---|
Consent Text | -- | Placeholder text. |
Link to Additional Information (optional) | -- | -- |
Label of Consent Checkbox |
|