Skip to main content

Celonis Product Documentation

Centralized Admin Rollout Options

How to Install the Application from Command Prompt from version 2.3.0
Proxy Support

Note

You must have admin rights to install the application from a command prompt.

Task Mining Client supports:

  • System proxy support

  • Active Directory Authentication

  • Support for proxy configuration scripts

Connect Client to Team/Project during centralized installation

During the installation, an admin can instruct the Task Mining Client to directly connect to a team and project. In this way, the end-users don't have to be instructed to do it and can directly start with capturing data.

msiexec.exe /qb /[i|x] CelonisTaskMining.Installer.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>]
Parameters - Centralized Admin Rollout Options

Parameter

Description

Started in version

/qb

Specifies there is a basic UI during the installation process.

n/a

/i

Specifies normal installation.

n/a

/x

Uninstalls the package.

n/a

ACTIVATIONLINKURLPROPERTY

Assigns the activation link URL.

2.3.0

CHROMEEXTENSIONPROPERTY

Enables or disables installation of the Google Chrome extension, default value is 1.

2.3.0

CHROMEUPDATEURL

Changes the Update URL location for installing and updating the Chrome extension to an alternative repository. Default value is 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.

2.3.0

CUSTOMEXTENSIONIDS

Assigns custom Chrome extension id value (in case of multiple values, they should be separated by commas ‘,’).

2.7.8

CUSTOMEXTENSIONPROPERTY

Specifies whether a custom Chrome extension IDs is used. This is required for self-hosted rollouts of the Task Mining Chrome extension.

2.7.8

EDGEEXTENSIONPROPERTY

Enables or disables installation of the Microsoft Edge extension, default value is 1.

2.3.0

EDGEUPDATEURL

Changes the Update URL location for installing and updating the Edge extension to an alternative repository. Default value is Chrome Web Store.

2.4.0

EXTENSIONWEBSOCKETPORTPROPERTY

Specifies a custom web socket port for the Chrome extension (default is 8080).

2.12.0

SECUREGATEWAYSERVERPROPERTY

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

Multiple URLs should be separated by semicolon (;).

2.3.0

SPNPROPERTY

Assigns the Service Principal Name of the Gateway service to enable authenticating with on-premise Task Mining Gateway. Multiple SPNs should be separated by semicolon (;). Further, secure gateway URLs and their corresponding SPN should be defined in the same order.

2.5.0

TIMEOUTPROPERTY

Assigns the connection timeout.

2.5.0

Examples of Centralized Admin Rollout Options

To install the application:

  • With a secure gateway configuration:

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

  • With an activation link on installation:

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

  • Without extensions:

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

  • With custom extension Id:

    msiexec.exe /qb /i CelonisTaskMining.Installer.msi CUSTOMEXTENSIONIDS="abcdefghijklmnopqrstuvwxyz"

  • With Chrome extension from a different store:

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

To uninstall the application:

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

How to configure the application to run over a secure gateway service (from version 2.1.4)

Note

You can either configure the secure gateway service settings from the MSI installer while installing the application or perform the steps given below. Both require Admin rights.

  1. Create a registry key for the path Computer\HKEY_LOCAL_MACHINE\SOFTWARE\Celonis\TaskMining

  2. Create a registry string value under the previous path with the name secure_gateway_server

  3. Assign the URL of the secure gateway server to the secure_gateway_server ex: mysecuregatewayserver.com/company

    You can secure multiple gateways here by appending additional gateways using a semi-colon delimiter. For example: secure_gateway_server=server1.com;server2.commysecuregatewayserver.com/company

  4. Create a registry string value under the same path with the name client_certificate_subject

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

  6. Assign the Subject of the client certificate to the client_certificate_subject ex: My Certificate

  7. Create a registry string value under the same path with the name: service_principal_name.

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

  9. To rollback, remove the registry values given above.