Über die Befehlszeile installieren

Installieren Sie die UiPath-Desktop-Clients über die Befehlszeile im interaktiven Modus oder im Silent-Modus unter Verwendung der unterstützten UiPathPlatform.msi-Parameter und Konfigurationsdateien.

Sie können die UiPath-Desktop-Clients mit dem UiPath Platform Installer (UiPathPlatform.msi) über die Befehlszeile installieren, entweder im vollständig interaktiven oder vollständig stillen Modus und mithilfe der unterstützten MSI-Parameter. Der Silent-Modus ist für unbeaufsichtigte Bereitstellungen vorgesehen. Die interaktive Installation finden Sie unter Installieren der Desktop-Clients.

Syntax

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

Parameter werden als PARAMETER=value-Paare nach dem Paketpfad übergeben. Setzen Sie Werte, die Leerzeichen enthalten, in doppelte Anführungszeichen.

Installationsmodi

Mode	Umschalten (Switch)	Beschreibung
Vollständig interaktiv	(weglassen)	Führt den Installationsassistenten mit vollständiger Benutzeroberfläche aus. Der Benutzer sieht den Fortschritt und alle Prompts.
Vollständig im Hintergrund laufend	/qn	Läuft ohne Benutzeroberfläche und ohne Dialogfelder. Erforderlich für unbeaufsichtigte Bereitstellungen.

Hinweis:

Verwenden Sie /qn für unbeaufsichtigte Installationen. Teilbenutzeroberflächen-Modi (/qb, /qr) werden für unbeaufsichtigte Szenarien nicht unterstützt, da das Installationsprogramm möglicherweise weiterhin Blockierungsdialoge anzeigt.

Unterstützte Parameter

Parameter	Values	Standard	Beschreibung
FORCE_PERUSER	1	–	Erzwingt eine Installation pro Benutzer, auch wenn der aktuelle Benutzer ein Administrator ist.
CHANNEL	sts	sts for UiPathPlatformSTS.msi, community for UiPathPlatform.msi	Update channel the platform follows. Pass CHANNEL=sts to install the Enterprise STS channel with either installer.
PLATFORM_CONFIGURATION_FILE	Absoluter Dateipfad	–	Pfad zu einer Produktkonfigurationsdatei, die während der Installation angewendet wird.
UPDATER_CONFIGURATION_FILE	Absoluter Dateipfad	–	Pfad zu einer aktualisierungsspezifischen Konfigurationsdatei, die während der Installation angewendet wird.
TELEMETRY_ENABLED	1 = aktiviert, 0 = deaktiviert	enabled	Steuert, ob Telemetriedaten gesendet werden.
INSTALLER_LANGUAGE	de, en, es, es-MX, fr, ja, ko, pt-BR, pt, ro, ru, tr, zh-CN, zh-TW	Systemsprache	UI-Sprache des Installationsassistenten. Kein Effekt im stillen Modus.

Installations-Scope

The installer defaults to a per-user installation. It switches to a per-machine installation when either of the following is true:

• msiexec runs elevated — from an elevated (administrator) command prompt, or as SYSTEM from a deployment tool such as Microsoft Intune or Configuration Manager. This applies to silent installations too.
• An administrator runs the installation in interactive mode, where it can elevate through User Account Control.

A silent installation started from a non-elevated prompt stays per-user, even for an administrator, because it cannot prompt for elevation.

Hinweis:

UiPath empfiehlt eine Installation pro Maschine, bei der die Desktop-Clients für alle Benutzer verfügbar bleiben und zentral verwaltet werden.

• Um „Pro-Benutzer“ auch für einen Administrator zu erzwingen, übergeben Sie FORCE_PERUSER=1.
• For a per-machine silent installation, run msiexec elevated, or deploy it as SYSTEM.

Beispiele

Interaktive Installation

Standardkanal, vollständiger Assistent:

msiexec /i UiPathPlatform.msi

Spezifischer Kanal und Konfigurationsdatei:

msiexec /i UiPathPlatform.msi CHANNEL=sts PLATFORM_CONFIGURATION_FILE="C:\Config\platformConfig.json"

Pro-Benutzer-Installation für einen Administrator erzwingen

msiexec /i UiPathPlatform.msi FORCE_PERUSER=1

Automatische Installation

Pro Benutzer, Standardkanal:

msiexec /i UiPathPlatform.msi /qn

Stille Installation mit einem bestimmten Kanal, einer Konfigurationsdatei und deaktivierter Telemetrie:

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

Per-machine silent install from a deployment tool such as Intune or Configuration Manager (runs as SYSTEM), with a verbose installation log:

msiexec /i UiPathPlatformSTS.msi PLATFORM_CONFIGURATION_FILE="C:\Config\platformConfig.json" /qn /l*v "C:\Windows\Temp\UiPathPlatform-install.log"

Neuinstallation hinter einem Unternehmens-Proxy (Proxy, der über die Updater-Konfigurationsdatei bereitgestellt wird):

msiexec /i UiPathPlatform.msi UPDATER_CONFIGURATION_FILE="C:\Config\updaterConfig.json" /qn

Konfigurationsdateien

platformConfig.json (PLATFORM_CONFIGURATION_FILE)

Wählt aus, welche Desktop-Clients installiert werden sollen, sowie alle produktspezifischen Parameter.

The file contains a Packages list with one entry per product:

Feld	Beschreibung
PackageName	Product name, exactly as listed in Available products. The name is case-sensitive. An entry whose name does not match a product is ignored.
InstallRequested	true to install the product. Products that are missing from the file, or set to false, are not installed.
Parameters	Product-specific settings, as string key/value pairs. Use {} when a product needs no settings. See Product parameters.

Available products

PackageName	Installs	Also list (required)	Optional companions
Studio	Studio, including the optional Studio Legacy and Activities packages	Robot, Runtimes	Assistant, BrowserExtensions
Robot	Robot, including the optional Live Streaming package	Runtimes	BrowserExtensions
Assistant	Assistant	Robot (and therefore Runtimes)	–
BrowserExtensions	Browser and remote-desktop extensions	–	–
Runtimes	The runtimes the other desktop clients depend on. Required by Robot, and therefore by Studio and Assistant.	–	–

Wichtig:

Required products are not added automatically. If a requested product's required products are not also set to "InstallRequested": true, the installation fails and rolls back with exit code 1603. See Troubleshooting.

Every configuration that installs Studio, Robot, or Assistant must also list Runtimes with "InstallRequested": true.

The required products reflect the current Enterprise STS release and may change between releases.

Example: Robot with Assistant

Installs Robot, Assistant, and their runtimes, connects the Robot to Orchestrator, and deploys the Chrome and Edge extensions through policy:

{
  "Packages": [
    {
      "PackageName": "Robot",
      "InstallRequested": true,
      "Parameters": {
        "SERVICE_URL": "https://cloud.uipath.com/org/tenant/orchestrator_"
      }
    },
    {
      "PackageName": "Runtimes",
      "InstallRequested": true,
      "Parameters": {}
    },
    {
      "PackageName": "Assistant",
      "InstallRequested": true,
      "Parameters": {}
    },
    {
      "PackageName": "BrowserExtensions",
      "InstallRequested": true,
      "Parameters": {
        "INSTALL_CHROME_EXTENSION": "True",
        "INSTALL_EDGE_EXTENSION": "True",
        "CHROME_INSTALL_TYPE": "PolicyOnline",
        "EDGE_INSTALL_TYPE": "PolicyOnline"
      }
    }
  ]
}

Example: Studio

Installs Studio with the Activities package, together with its required Robot and Runtimes, plus Assistant and the Edge extension:

{
  "Packages": [
    {
      "PackageName": "Studio",
      "InstallRequested": true,
      "Parameters": {
        "INSTALL_ACTIVITIES": "True"
      }
    },
    {
      "PackageName": "Robot",
      "InstallRequested": true,
      "Parameters": {
        "INSTALL_ROBOTJS": "True",
        "SERVICE_URL": "https://cloud.uipath.com/org/tenant/orchestrator_"
      }
    },
    {
      "PackageName": "Runtimes",
      "InstallRequested": true,
      "Parameters": {}
    },
    {
      "PackageName": "Assistant",
      "InstallRequested": true,
      "Parameters": {}
    },
    {
      "PackageName": "BrowserExtensions",
      "InstallRequested": true,
      "Parameters": {
        "INSTALL_EDGE_EXTENSION": "True"
      }
    }
  ]
}

Product parameters

Parameter names are case-sensitive. Boolean parameters accept True or False (in any letter case); other values, such as 1 or 0, are ignored with a warning and the default is used. Unrecognized parameter names are ignored. Boolean parameters default to False unless noted otherwise.

Most parameters match the classic MSI command-line parameters of the same name. Since the Studio and Robot packages were separated, Robot and Orchestrator connection settings belong to Robot, not Studio.

Studio

Parameter	Values	Beschreibung
INSTALL_ACTIVITIES	True, False	Installs the Activities package.
INSTALL_STUDIO_LEGACY	True, False	Installs Studio Legacy.
INSTALL_EXCEL_ADDIN	True, False	Installs the Excel add-in. Requires Microsoft Excel and the Visual Studio Tools for Office Runtime 10.0.50325 or later.
INSTALL_SAP_SOLMAN	True, False	Installs the SAP Solution Manager integration. Requires the SAP Connector for Microsoft on the machine, and SAP_SOLMAN_HOST.
SAP_SOLMAN_HOST	Host name or IP address	SAP Solution Manager host. Must resolve on the machine.

Robot

Parameter	Values	Beschreibung
SERVICE_URL	Absolute URL	Orchestrator URL the Robot connects to.
REGISTER_ROBOT_SERVICE	True, False	Registers the Robot as a Windows service (unattended).
DISABLE_SECURE_XAML	True, False	For a Robot registered as a Windows service, disables the protection of XAML files, which lets users read and modify the process files. False keeps XAML files secured.
INSTALL_ROBOTJS	True, False	Installs the Robot JavaScript add-on. Always installed for per-user and attended installations.
INSTALL_LIVE_STREAMING	True, False	Installs the Live Streaming package.
ORCHESTRATOR_AUTO_SIGNIN	True, False	For an attended Robot installed per-user in an environment that uses single sign-on with Microsoft Entra ID, signs the user in automatically. Requires SERVICE_URL; cannot be combined with REGISTER_ROBOT_SERVICE=True or client credentials.
ENFORCE_DEFAULT_SERVICE_URL	True, False	For per-user installations, enforces SERVICE_URL as the default Orchestrator URL. Requires SERVICE_URL.
ORCHESTRATOR_CLIENT_ID, ORCHESTRATOR_CLIENT_SECRET	Strings	Client credentials for an unattended Robot. Set both, together with SERVICE_URL and REGISTER_ROBOT_SERVICE=True.
LICENSE_KEY	String	Robot license key.
NUGET_OPTIONS	EnableOnlineFeeds, DisableOnlineFeeds	DisableOnlineFeeds turns off the UiPath Official and Community online feeds for the Robot, for offline environments. Default: EnableOnlineFeeds.
CUSTOM_NUGET_FEEDS	name,url;name2,url2	Adds or updates custom activity feeds. Feeds can be URLs, folder paths, or network shares.
ENFORCE_SIGNED_EXECUTION	True, False	Restricts the Robot to downloading, installing, and running packages signed by UiPath. Additional certificates can be trusted by adding them to nuget.config after the installation.
PACKAGES_FOLDER	Ordnerpfad	Download location for workflows and their dependencies. Default: %userProfile%\.nuget\packages.
INSTALL_WEBVIEW	True, False	Installs the Microsoft Edge WebView2 runtime, downloaded from Microsoft during the installation (internet access required). If the download fails, the runtime is skipped and the installation continues.

Assistant

Parameter	Values	Beschreibung
ASSISTANT_OPTIONS	DisableMarketplace, EnableMarketplace	Hides or shows the Marketplace widget. If omitted, the current setting on the machine is kept.

BrowserExtensions

Parameter	Values	Beschreibung
CHROME_INSTALL_TYPE, EDGE_INSTALL_TYPE	PolicyOnline, PolicyOffline, ManualPerMachine, ManualPerUser, NativeHostOnly, None	How the Chrome or Edge extension is deployed. Values are not case-sensitive.
INSTALL_CHROME_EXTENSION, INSTALL_EDGE_EXTENSION, INSTALL_FIREFOX_EXTENSION	True, False	Installs the extension for that browser.
INSTALL_JAVA_EXTENSION, INSTALL_SILVERLIGHT_EXTENSION	True, False	Installs the Java or Silverlight extension.
INSTALL_CITRIX_CLIENT_EXTENSION, INSTALL_RDP_CLIENT_EXTENSION, INSTALL_VMWARE_CLIENT_EXTENSION, INSTALL_AWS_WORKSPACES_CLIENT_EXTENSION	True, False	Installs the extension for that remote-desktop client.

The legacy install type values GLOBAL (equivalent to ManualPerMachine) and STORE (equivalent to PolicyOnline) are still accepted. Any other value is treated as None.

When an INSTALL_*_EXTENSION parameter is omitted, the extension keeps its current state: on a clean installation it is not installed, and when changing or upgrading an installation, an installed extension stays installed.

Laufzeiten (Runtimes)

Runtimes takes no parameters. Use "Parameters": {}.

Warnung:

The configuration file is read as plain text. If it contains secrets such as ORCHESTRATOR_CLIENT_SECRET or LICENSE_KEY, restrict access to the file, and delete it, along with the copy the installer writes under %TEMP%\UiPathConnected\, after the installation completes.

updaterConfig.json (UPDATER_CONFIGURATION_FILE)

Konfiguriert den Updater. Hier werden die Proxyeinstellungen bereitgestellt. Bei einer Installation pro Maschine wird der Proxy für die systemweite Verwendung beibehalten.

Minimale Proxykonfiguration:

{
  "Proxy": {
    "ProxyAddress": "http://proxy.corp:8080",
    "BypassLocalAddresses": true
  }
}

Proxy mit Authentifizierung und einer Bypass-Liste:

{
  "Proxy": {
    "ProxyAddress": "http://proxy.corp:8080",
    "BypassList": "localhost;*.corp.local",
    "BypassLocalAddresses": true,
    "UserName": "proxyuser",
    "Password": "proxypassword",
    "Domain": "CORP"
  }
}

Alternativ kann ein Skript für die automatische Proxy-Konfiguration (PAC) anstelle einer festen Adresse verwendet werden:

{
  "Proxy": {
    "ScriptAddress": "http://proxy.corp/proxy.pac"
  }
}

Hinweis:

ProxyAddress und ScriptAddress schließen sich gegenseitig aus. Wenn UserName festgelegt ist, muss auch Password festgelegt werden.

Fehlersuche und ‑behebung

To investigate a failed installation, capture a verbose installation log by adding /l*v "<log path>" to the msiexec command.

The installation fails with exit code 1603 and rolls back

If the verbose log contains Command executed with exit code: 80, the installation of the desktop clients themselves failed. The reason is in the installer log:

Installations-Scope	Installer log
Per-machine	%SystemRoot%\SystemTemp\UiPath.Connected.Installer.CLI.<yyyy-MM-dd>.log (on Windows versions without a SystemTemp folder, %SystemRoot%\Temp)
Per-user	%TEMP%\UiPath.Connected.Installer.CLI.<yyyy-MM-dd>.log

A common cause is a configuration file that requests a product without the products it requires. The installer log then contains a line such as:

Missing required dependencies. The following products must also be installed: Runtimes (required by Robot)

Behebung:

1. Add the listed products to the configuration file with "InstallRequested": true, as shown in Available products.
2. Run the installation again.