task-mining
latest
false
UiPath logo, featuring letters U and I in white
Task Mining
Automation CloudAutomation Cloud Public SectorAutomation Suite
Last updated Nov 13, 2024

Command line parameters

Installation command line arguments descriptions

You can install or update Task Mining using command lines if you have the task-mining-setup.msi installer. Below is an overview of the available parameters.

Note:
  • This package natively supports all msiexec commands.

  • Administrator rights are required to execute these commands.

Install options

Command

Description

/i

Used for normal installation.

/a

Used for administrative installation

/x

Used to uninstall the package

INSTALLFOLDER='{folder_path}'

Used to change the installation directory

SERVERURL="serverURLpath"

Used to install the application with the service URL preset. Default https://cloud.uipath.com (Not available in 22.10)

MSIINSTALLPERUSER=1

Install for current user only (default per machine)

ADDLOCAL=ChromeExtension,EdgeExtension,

FirefoxExtension,JavaExtension,

CitrixExtension,RdpExtension,VmwareExtension

List of extensions to install

22.10 - all extensions installed by default

23.4 - Chrome Extension, Edge Extension, Firefox Extension installed by default

ADDLOCAL=ProductFeature to skip all extensions

CHROME_INSTALL_TYPE

Allows you to choose the installation method for the Chrome extension.

It supports the following options:

  • POLICYOFFLINE - The Chrome Extension is automatically installed per system via the Group Policy Offline method, the equivalent of calling the /Chrome-Policy-Offline command using the SetupExtensions tool.
  • POLICYONLINE - The Chrome Extension is automatically installed per system via the Group Policy Online method, the equivalent of calling the /Chrome-Policy-Online command using the SetupExtensions tool.
  • MANUALPERMACHINE - The Chrome Extension is installed for all users.
  • NATIVEHOSTONLY - Only the Native Messaging Host component (ChromeNativeMessaging.exe) is installed.
Note: The CHROME_INSTALL_TYPE parameter requires the installer to run with admin rights. If the CHROME_INSTALL_TYPE parameter is omitted, the most appropriate installation method is selected automatically.

EDGE_INSTALL_TYPE

Allows you to choose the installation method for the Edge extension. This parameter requires the installer to run with admin rights. If it's omitted, the most appropriate installation method is selected automatically.

It supports the following options:

  • POLICYOFFLINE - The Edge Extension is automatically installed per system via the Group Policy Offline method, the equivalent of calling the /Edge-Policy-Offline command using the SetupExtensions tool.
  • POLICYONLINE - The Edge Extension is automatically installed per system via the Group Policy Online method, the equivalent of calling the /Edge-Policy-Online command using the SetupExtensions tool.
  • MANUALPERMACHINE - The Edge Extension is installed for all users.
  • NATIVEHOSTONLY - Only the Native Messaging Host component (ChromeNativeMessaging.exe) is installed.
Refer to Install from Group Policy and SetupExtensions tool for details.
Note: The EDGE_INSTALL_TYPE parameter requires the installer to run with admin rights. If the EDGE_INSTALL_TYPE parameter is omitted, the most appropriate installation method is selected automatically.

Display options

Command

Description

/quiet, /qn

quiet mode (no UI)

/qf

Full User Interface(default)

Restart options

Command

Description

/norestart

The machine will not be restarted after the installation is completed.

/promptrestart

The user will be prompted if a reboot is required

/forcerestart

The machine will be restarted after the installation is complete

Other options

Command

Description

PROXY_SETTINGS= (example below)

Set proxy settings

TELEMETRY_ENABLED

Enable telemetry in the application

APPLICATION_LANGUAGE

Set language by default

Examples

Below are some examples of adding CLI parameters for the unified installer:

msiexec /i UiPathTaskMining.msi /qr MSIINSTALLPERUSER=1 PROXY_SETTINGS="{""host"":""localhost"",""port"":12345,""authIsEnabled"":false,""useProxyServer"":true}"msiexec /i UiPathTaskMining.msi /qr MSIINSTALLPERUSER=1 PROXY_SETTINGS="{""host"":""localhost"",""port"":12345,""authIsEnabled"":false,""useProxyServer"":true}"
msiexec /i UiPathTaskMining.msi /qr MSIINSTALLPERUSER=1 PROXY_SETTINGS="{""host"":""localhost"",""port"":12345,""authIsEnabled"":true,""username"":""user"",""password"":""pass"",""domain"":""domain"",""useProxyServer"":true}"msiexec /i UiPathTaskMining.msi /qr MSIINSTALLPERUSER=1 PROXY_SETTINGS="{""host"":""localhost"",""port"":12345,""authIsEnabled"":true,""username"":""user"",""password"":""pass"",""domain"":""domain"",""useProxyServer"":true}"
msiexec /i UiPathTaskMining.msi /qr MSIINSTALLPERUSER=1 PROXY_SETTINGS="{""usePacScript"":true,""pacScriptAddress"":""localhost:8888/proxy.pac""}"msiexec /i UiPathTaskMining.msi /qr MSIINSTALLPERUSER=1 PROXY_SETTINGS="{""usePacScript"":true,""pacScriptAddress"":""localhost:8888/proxy.pac""}"
msiexec /i UiPathTaskMining.msi /qr MSIINSTALLPERUSER=1 PROXY_SETTINGS="{""host"":""localhost"",""port"":12345,""authIsEnabled"":false,""useProxyServer"":true,""bypassList"":""google.com""}"msiexec /i UiPathTaskMining.msi /qr MSIINSTALLPERUSER=1 PROXY_SETTINGS="{""host"":""localhost"",""port"":12345,""authIsEnabled"":false,""useProxyServer"":true,""bypassList"":""google.com""}"

Config.json

After successful installation, before launching the recorder, you can edit the proxySettings property in the <installation_directory>/config.json configuration file.

Below is an example.

{
  "serverURL": "https://cloud.uipath.com",
  "telemetryEnabled": "1",
  "applicationLanguage": "",
  "proxySettings": "{\"host\":\"localhost\",\"port\":12345,\"authIsEnabled\":true,\"username\":\"user\",\"password\":\"pass\",\"domain\":\"domain\",\"useProxyServer\":true}",
}{
  "serverURL": "https://cloud.uipath.com",
  "telemetryEnabled": "1",
  "applicationLanguage": "",
  "proxySettings": "{\"host\":\"localhost\",\"port\":12345,\"authIsEnabled\":true,\"username\":\"user\",\"password\":\"pass\",\"domain\":\"domain\",\"useProxyServer\":true}",
}

Install from Group Policy

You can also install the extension for Chrome or the extension for Edge by using Group Policies. This method silently installs the extension and enables it, without requiring user confirmation.

Offline

The Group Policy Offline installation method requires that the target machine is joined to a Microsoft Active Directory domain or Azure Active Directory.

It does not require access to the Chrome Web Store/Edge Web Store so it can be used for machines that have restricted Internet access.

UiPathTaskMining.msi uses this installation method by default if its requirements are met.

If your organization uses Group Policies for browser extension management then the following changes are also required:

  1. In the ExtensionInstallForceList policy, add the value for Chrome:

    ndmegdjihnhfmljjoaiimbipfhodnbgf;file:///C:/ProgramData/UiPath/UiPath.Common/ChromeExtension_SelfHosted/extension_manifest_chrome.xml , or for Edge:
    ndmegdjihnhfmljjoaiimbipfhodnbgf;file:///C:/ProgramData/UiPath/UiPath.Common/EdgeExtension_SelfHosted/extension_manifest_edge.xml.
  2. In the NativeMessagingAllowList policy, add the value: com.uipath.chromenativemsg_v2

Online

The Group Policy Online installation method requires that the target machine has access to the Chrome Web Store (https://clients2.google.com/service/update2/crx and https://clients2.googleusercontent.com/crx).
UiPathTaskMining.msi uses this installation method if its requirements are met and the machine is not joined to a Microsoft Active Directory.

If your organization uses Group Policies for browser extension management then the following changes are also required:

  1. In the ExtensionInstallForceList policy, add the value for Chrome:

    jfcmnbofjlffnejneillkgbniiidiigd;https://clients2.google.com/service/update2/crx , or for Edge:
    aolkfhjgbinoablafekggeglohbacjih;https://edge.microsoft.com/extensionwebstorebase/v1/crx.
  2. In the NativeMessagingAllowList policy, add the value:

    com.uipath.chromenativemsg_v2

Refer to ExtensionInstallForceList in the the official Chrome enterprise documentation for more information on the ExtensionInstallForceList policy.

Refer to NativeMessagingAllowList in the official Chrome enterprise documentation for more information on the NativeMessagingAllowList policy.

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.