Centralized admin rollout options
Installing the Task Mining Client software from the command line (from version 2.3.0)
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, you must configure this for each machine individually.
Connecting the Task Mining Client to the team/project during centralized installation
During installation, an admin can instruct the Task Mining Client software to connect to a team and project, allowing end users to start capturing data.
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=<client_certificate_subject>] [SPNPROPERTY=<service_principal_name_identifier>] [TIMEOUTPROPERTY=<connection_timeout>] [EXTENSIONWEBSOCKETPORTPROPERTY=<extension_websocket_port>]Centralized admin rollout option parameters
Important
We recommend organizations host their own app (extension) store where end users actively consent before extensions are enabled. This will help prevent third-party software installing and enabling malicious extensions without end-user consent. For more information, see Self-hosting Chrome extensions.
Parameter | Description | Possible values | Default value at installation | From version |
|---|---|---|---|---|
| Specifies there is a basic UI during the installation process. | -- | -- | -- |
| Specifies normal installation. | -- | -- | -- |
| Uninstalls the package. | -- | -- | -- |
| Assigns the activation link URL. View the activation link URL from Users & Invite > Invite Users. Deprecated from 2.10. | URL with this format:
| -- | 2.3.0 |
| Enables or disables installation of the Google Chrome extension. |
|
| 2.3.0 |
| Changes the update URL location for installing and updating the Chrome extension to an alternative repository. For more information on using | -- |
| 2.4.0 |
| Assigns the client certificate subject name. The certificate must be installed in the Windows certificate store under | -- |
| 2.3.0 |
| Assigns the custom Chrome extension ID value (separate multiple values with commas). For information on using | -- |
| 2.7.8 |
| Specifies whether a custom Chrome extension ID is used. This is required for self-hosted rollouts of the Task Mining Chrome extension. | -- | -- | 2.7.8 |
| Enables or disables installation of the Microsoft Edge extension. |
|
| 2.3.0 |
| Changes the update URL location for installing and updating the Edge extension to an alternative repository. | -- |
| 2.4.0 |
| Specifies a custom web socket port for the Chrome extension. | -- |
| 2.12.0 |
| 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 (;). | -- |
| 2.3.0 |
| Assigns the Service Principal Name (SPN) of the gateway service to enable authentication with the on-premise Task Mining Gateway. Multiple SPNs should be separated by 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, see Download Task Mining Gateway. | -- |
| 2.5.0 |
| Defines the timeout in seconds for HTTP connections to 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, see Download Task Mining Gateway. | Any positive integer value. |
| 2.5.0 |
| Changes the default location of the working directory. The Task Mining Client software requires read and write permissions for this directory. |
|
Centralized admin rollout option examples
Install type | Example command |
|---|---|
With a secure gateway configuration. For more information, see Configuring the Task Mining Client software to run over a secure gateway. |
|
With a Task Mining Gateway configuration. For more information, see Configuring the Task Mining Client software to run 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, see Download Task Mining Gateway. |
|
With an activation link on installation. |
|
Without extensions. |
|
With a custom extension ID. |
|
With a Chrome extension from a different store. |
|
Uninstall. |
|
Note
You can also configure the secure gateway service settings from the MSI installer when installing the Task Mining Client software. Both methods require admin rights. For more information, see Installing the Desktop Application software.
Create a registry key for the path
Computer\HKEY_LOCAL_MACHINE\SOFTWARE\Celonis\TaskMining.Create a registry string value under the previous path with the name
secure_gateway_server.Assign the URL of the secure gateway server to the
secure_gateway_server, for example:mysecuregatewayserver.com/companyNote
You can configure multiple secure gateways by appending additional gateways using a semicolon delimiter, for example
secure_gateway_server=server1.com;server2.commysecuregatewayserver.com/company.Create a registry string value under the same path with the name
client_certificate_subject.Install the client certificate that will be used to authenticate the secure gateway server under
Current User/Personal store.Assign the Subject of the client certificate to the
client_certificate_subject, for exampleMy Certificate.The configuration is complete.
Tip
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, see Download Task Mining Gateway.
Create a registry key for the path
Computer\HKEY_LOCAL_MACHINE\SOFTWARE\Celonis\TaskMining.Create a registry string value under the previous path with the name
secure_gateway_server.Assign the URL of the secure gateway server to the
secure_gateway_server, for example:mysecuregatewayserver.com/companyNote
You can configure multiple secure gateways by appending additional gateways using a semicolon delimiter, for example
secure_gateway_server=server1.com;server2.commysecuregatewayserver.com/company.Create a registry string value under the same path with the name
client_certificate_subject.Install the client certificate that will be used to authenticate the secure gateway server under
Current User/Personal store.Assign the Subject of the client certificate to the
client_certificate_subject, for exampleMy Certificate.Create a registry string value under the same path with the name
service_principal_name.Assign the unique identifier of the secure gateway service instance to the
service_principal_name.The configuration is complete.
Tip
Roll back the configuration (if necessary) by removing the registry values created in steps 2, 4 and 7.