命令行参数

Install Studio from the command line with the UiPath Platform Installer, using msiexec parameters and a configuration file that selects the desktop clients.

You can install Studio and the other UiPath desktop clients from the command line by running the UiPath Platform Installer with msiexec, either interactively or silently. Silent mode is intended for unattended deployments to multiple machines.

语法

msiexec /i UiPathPlatformSTS.msi [PARAMETER=value ...] [/qn]

Pass parameters as PARAMETER=value pairs after the package path, and enclose values that contain spaces in double quotes.

• Omit /qn to run the installation wizard with its full user interface.
• Add /qn to run without a user interface. Partial-UI modes, such as /qb and /qr, are not supported for unattended installations.

The installer runs per-machine when msiexec runs elevated, from an elevated command prompt or as SYSTEM from a deployment tool. A silent installation started from a non-elevated prompt installs per-user, without an error. To make a per-machine installation explicit, pass MSIINSTALLPERUSER=0. For details, refer to Installation scope.

Installer parameters

参数	描述
FORCE_PERUSER	Set to 1 to install per user, even when an administrator runs the installer.
MSIINSTALLPERUSER	Set to 0 to make a per-machine installation explicit. The installation must still run elevated.
PLATFORM_CONFIGURATION_FILE	The absolute path to a configuration file that selects the desktop clients to install and their options. For details, refer to The configuration file.
UPDATER_CONFIGURATION_FILE	The absolute path to a configuration file for the updater, used for proxy settings.
TELEMETRY_ENABLED	Set to 0 to turn off usage data collection, or to 1 to keep it on. Telemetry is on by default.
INSTALLER_LANGUAGE	The language of the installation wizard, such as en, de, fr, ja, or pt-BR. It has no effect in silent mode.

UiPathPlatformSTS.msi sets the Enterprise STS update channel itself, so you don't pass CHANNEL.

For the full list of values and for the proxy settings, refer to Install from the command line.

The configuration file

The file passed in PLATFORM_CONFIGURATION_FILE lists the desktop clients to install, each with its own parameters:

{
  "Packages": [
    {
      "PackageName": "Studio",
      "InstallRequested": true,
      "Parameters": {
        "INSTALL_STUDIO_LEGACY": "true",
        "INSTALL_ACTIVITIES": "true"
      }
    },
    {
      "PackageName": "Robot",
      "InstallRequested": true,
      "Parameters": {
        "SERVICE_URL": "https://orchestrator.example.com/organization/tenant/orchestrator_"
      }
    },
    {
      "PackageName": "Assistant",
      "InstallRequested": true,
      "Parameters": {}
    },
    {
      "PackageName": "Runtimes",
      "InstallRequested": true,
      "Parameters": {}
    },
    {
      "PackageName": "BrowserExtensions",
      "InstallRequested": true,
      "Parameters": {
        "INSTALL_CHROME_EXTENSION": "true",
        "INSTALL_EDGE_EXTENSION": "true"
      }
    }
  ]
}

Keep the following in mind when you write the file:

• PackageName values are case sensitive: Studio, Robot, Assistant, Runtimes, and BrowserExtensions.
• List every desktop client to install. A client that is missing from the file is not installed, including Assistant, which the installation wizard selects together with Studio.
• Studio requires Robot and Runtimes, and Assistant requires Robot. A missing required package is not added, and the installation fails validation.
• Write every parameter value as a string, including "true" and "false".
• If Parameters is empty for BrowserExtensions, no browser extension is installed on a machine that doesn't have one.

Studio parameters

参数	描述
INSTALL_STUDIO_LEGACY	Installs Studio Legacy, which opens and edits Windows - Legacy projects.
INSTALL_ACTIVITIES	Installs the activity packages that ship with Studio, in a local OfficialPackages feed.
INSTALL_EXCEL_ADDIN	Installs the StudioX Excel Add-in.
INSTALL_SAP_SOLMAN	Installs the SAP Solution Manager plugin. Requires SAP_SOLMAN_HOST.
SAP_SOLMAN_HOST	SAP 解决方案管理器实例的主机名或 IP 地址。

Browser extension parameters

参数	描述
INSTALL_CHROME_EXTENSION	Installs the UiPath Extension for Chrome.
INSTALL_EDGE_EXTENSION	Installs the UiPath Extension for Edge.
INSTALL_FIREFOX_EXTENSION	Installs the UiPath Extension for Firefox.
INSTALL_JAVA_EXTENSION	Installs the UiPath Extension for Java.
INSTALL_SILVERLIGHT_EXTENSION	Installs the UiPath Extension for Silverlight.
INSTALL_CITRIX_CLIENT_EXTENSION	Installs the client side of the UiPath Extension for Citrix.
INSTALL_RDP_CLIENT_EXTENSION	Installs the client side of the UiPath Extension for Microsoft Remote Desktop.
INSTALL_VMWARE_CLIENT_EXTENSION	Installs the client side of the UiPath Extension for VMware Horizon.
INSTALL_AWS_WORKSPACES_CLIENT_EXTENSION	Installs the client side of the UiPath Extension for Amazon WorkSpaces.
CHROME_INSTALL_TYPE	The installation method of the Chrome extension: PolicyOffline, PolicyOnline, ManualPerMachine, or NativeHostOnly. The older names STORE and GLOBAL are also accepted. If it's omitted, the most appropriate method is selected automatically.
EDGE_INSTALL_TYPE	The installation method of the Edge extension, with the same values as CHROME_INSTALL_TYPE.

Robot parameters

The Robot package takes the parameters that configure the Robot, including:

• REGISTER_ROBOT_SERVICE, for service mode
• SERVICE_URL
• ORCHESTRATOR_CLIENT_ID 和 ORCHESTRATOR_CLIENT_SECRET
• LICENSE_KEY
• PACKAGES_FOLDER, CUSTOM_NUGET_FEEDS, and NUGET_OPTIONS
• ENFORCE_SIGNED_EXECUTION 和 DISABLE_SECURE_XAML

For their values, refer to Product parameters in the UiPath Platform Installer guide.

示例

Install the desktop clients selected in a configuration file, silently, per machine, from an elevated command prompt:

msiexec /i UiPathPlatformSTS.msi PLATFORM_CONFIGURATION_FILE="C:\Config\platformConfig.json" /qn

Install silently with telemetry turned off:

msiexec /i UiPathPlatformSTS.msi PLATFORM_CONFIGURATION_FILE="C:\Config\platformConfig.json" TELEMETRY_ENABLED=0 /qn

Install per user, for an administrator account:

msiexec /i UiPathPlatformSTS.msi FORCE_PERUSER=1