- Benutzerhandbuch
Ü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]
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. |
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 für UiPathPlatformSTS.msi, community für UiPathPlatform.msi | Updatekanal, dem die Plattform folgt. Übergeben Sie CHANNEL=sts um den Enterprise-STS-Kanal mit einem der beiden Installationsprogramme zu installieren. |
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
Das Installationsprogramm verwendet standardmäßig eine Installation pro Benutzer. Es wird auf eine Installation pro Maschine umgestellt, wenn eine der folgenden Optionen erfüllt ist:
- msiexec wird in erhöhter Form ausgeführt – über eine Eingabeaufforderung mit erhöhten Rechten (Administrator) oder als
SYSTEMaus einem Bereitstellungstool wie Microsoft Intune oder Configuration Manager. Dies gilt auch für unbeaufsichtigte Installationen. - Ein Administrator führt die Installation im interaktiven Modus aus, wobei sie über die Benutzerkontosteuerung erhöht werden kann.
Eine unbeaufsichtigte Installation, die über eine nicht erhöhte Eingabeaufforderung gestartet wurde, bleibt pro Benutzer – auch für einen Administrator, da keine erhöhte Berechtigung dazu aufgefordert wird.
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. - Für eine Installation im Hintergrund pro Maschine führen Sie msiexec in erhöhter Form aus oder stellen Sie sie als
SYSTEMbereit.
Beispiele
Interaktive Installation
Standardkanal, vollständiger Assistent:
msiexec /i UiPathPlatform.msi
msiexec /i UiPathPlatform.msi
Spezifischer Kanal und Konfigurationsdatei:
msiexec /i UiPathPlatform.msi CHANNEL=sts PLATFORM_CONFIGURATION_FILE="C:\Config\platformConfig.json"
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
msiexec /i UiPathPlatform.msi FORCE_PERUSER=1
Automatische Installation
Pro Benutzer, Standardkanal:
msiexec /i UiPathPlatform.msi /qn
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
msiexec /i UiPathPlatform.msi CHANNEL=sts PLATFORM_CONFIGURATION_FILE="C:\Config\platformConfig.json" TELEMETRY_ENABLED=0 /qn
Installation im Hintergrund pro Maschine über ein Bereitstellungstool wie Intune oder Configuration Manager (wird als SYSTEM ausgeführt) mit einem ausführlichen Installationsprotokoll:
msiexec /i UiPathPlatformSTS.msi PLATFORM_CONFIGURATION_FILE="C:\Config\platformConfig.json" /qn /l*v "C:\Windows\Temp\UiPathPlatform-install.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
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.
Die Datei enthält eine Packages -Liste mit einem Eintrag pro Produkt:
| Feld | Beschreibung |
|---|---|
PackageName | Produktname, genau wie unter Verfügbare Produkte aufgeführt. Beim Namen wird die Groß-/Kleinschreibung beachtet. Ein Eintrag, dessen Name nicht mit einem Produkt übereinstimmt, wird ignoriert. |
InstallRequested | true um das Produkt zu installieren. Produkte, die in der Datei fehlen oder auf false festgelegt sind, werden nicht installiert. |
Parameters | Produktspezifische Einstellungen als Zeichenfolgen-Schlüssel/Wert-Paare. Verwenden Sie {} wenn ein Produkt keine Einstellungen benötigt. Siehe Produktparameter. |
Verfügbare Produkte
PackageName | Installiert | Auch auflisten (erforderlich) | Optionale Begleiter |
|---|---|---|---|
Studio | Studio, einschließlich der optionalen Pakete Studio Legacy und Aktivitäten | Robot, Runtimes | Assistant, BrowserExtensions |
Robot | Roboter, einschließlich des optionalen Live-Streaming-Pakets | Runtimes | BrowserExtensions |
Assistant | Assistant | Robot (und daher Runtimes) | – |
BrowserExtensions | Browser- und Remotedesktoperweiterungen | – | – |
Runtimes | Die Runtimes, von denen die anderen Desktop-Clients abhängen. Erforderlich für Robot und daher für Studio und Assistant. | – | – |
Erforderliche Produkte werden nicht automatisch hinzugefügt. Wenn die erforderlichen Produkte eines angeforderten Produkts nicht auch auf "InstallRequested": true festgelegt sind, schlägt die Installation fehl und wird mit Exitcode 1603 zurückgesetzt. Siehe Fehlerbehebung.
Jede Konfiguration, die Studio, Robot oder Assistant installiert, muss auch Runtimes mit "InstallRequested": true auflisten.
Die erforderlichen Produkte spiegeln die aktuelle Enterprise STS-Version wider und können sich zwischen den Versionen ändern.
Beispiel: Roboter mit Assistant
Installiert Roboter, Assistant und deren Runtimes, verbindet Roboter mit Orchestrator und stellt die Chrome- und Edge-Erweiterungen über eine Richtlinie bereit:
{
"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"
}
}
]
}
{
"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"
}
}
]
}
Beispiel: Studio
Installiert Studio mit dem Aktivitätenpaket zusammen mit den erforderlichen Robotern und Laufzeiten sowie Assistant und der Edge-Erweiterung:
{
"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"
}
}
]
}
{
"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"
}
}
]
}
Produktparameter
Bei den Parameternamen wird die Groß-/Kleinschreibung beachtet. Boolesche Parameter akzeptieren True oder False (in beliebiger Groß-/Kleinschreibung); Andere Werte, wie z. B. 1 oder 0, werden mit einer Warnung ignoriert und der Standardwert wird verwendet. Nicht erkannte Parameternamen werden ignoriert. Boolesche Parameter werden standardmäßig auf False festgelegt, sofern nicht anders angegeben.
Die meisten Parameter stimmen mit den klassischen MSI -Befehlszeilenparametern mit demselben Namen überein. Da die Studio- und Roboterpakete getrennt wurden, gehören die Verbindungseinstellungen für Roboter und Orchestrator zu Robot und nicht zu Studio.
Studio
| Parameter | Values | Beschreibung |
|---|---|---|
INSTALL_ACTIVITIES | True, False | Installiert das Aktivitätspaket. |
INSTALL_STUDIO_LEGACY | True, False | Installiert Studio Legacy. |
INSTALL_EXCEL_ADDIN | True, False | Installiert das Excel-Add-In. Erfordert Microsoft Excel und die Visual Studio-Tools für Office Runtime 10.0.50325 oder höher. |
INSTALL_SAP_SOLMAN | True, False | Installiert die SAP Lösung Manager-Integration. Erfordert den SAP Connector für Microsoft auf der Maschine und SAP_SOLMAN_HOST. |
SAP_SOLMAN_HOST | Hostname oder IP-Adresse | SAP Solution Manager-Host. Muss auf der Maschine aufgelöst werden. |
Robot
| Parameter | Values | Beschreibung |
|---|---|---|
SERVICE_URL | Absolute URL | Orchestrator-URL, mit der sich der Roboter verbindet. |
REGISTER_ROBOT_SERVICE | True, False | Registriert den Roboter als Windows-Dienst (unbeaufsichtigt). |
DISABLE_SECURE_XAML | True, False | Deaktiviert für einen Roboter, der als Windows-Dienst registriert ist, den Schutz von XAML-Dateien, sodass Benutzer die Prozessdateien lesen und ändern können. False hält XAML-Dateien gesichert. |
INSTALL_ROBOTJS | True, False | Installiert das Robot JavaScript Add-on. Immer installiert für Installationen pro Benutzer und für beaufsichtigte Installationen. |
INSTALL_LIVE_STREAMING | True, False | Installiert das Live-Streaming-Paket. |
ORCHESTRATOR_AUTO_SIGNIN | True, False | Wenn Sie einen Attended Robot pro Benutzer in einer Umgebung installieren, die Single Sign-On mit Microsoft Entra ID verwendet, wird der Benutzer automatisch angemeldet. Erfordert SERVICE_URL; kann nicht mit REGISTER_ROBOT_SERVICE=True oder Client-Anmeldeinformationen kombiniert werden. |
ENFORCE_DEFAULT_SERVICE_URL | True, False | Für Installationen pro Benutzer wird SERVICE_URL als standardmäßige Orchestrator-URL erzwungen. Erfordert SERVICE_URL. |
ORCHESTRATOR_CLIENT_ID, ORCHESTRATOR_CLIENT_SECRET | Zeichenfolgen | Client-Anmeldeinformationen für einen Unattended-Roboter. Legen Sie beides zusammen mit SERVICE_URL und REGISTER_ROBOT_SERVICE=True fest. |
LICENSE_KEY | String | Roboter-Lizenzschlüssel. |
NUGET_OPTIONS | EnableOnlineFeeds, DisableOnlineFeeds | DisableOnlineFeeds deaktiviert die offiziellen UiPath- und Community-Online-Feeds für den Roboter für Offline-Umgebungen. Standard: EnableOnlineFeeds. |
CUSTOM_NUGET_FEEDS | name,url;name2,url2 | Fügt benutzerdefinierte Aktivitätsfeeds hinzu oder aktualisiert sie. Feeds können URLs, Ordnerpfade oder Netzwerkfreigaben sein. |
ENFORCE_SIGNED_EXECUTION | True, False | Beschränkt den Roboter auf das Herunterladen, Installieren und Ausführen von Paketen, die von UiPath signiert wurden. Zusätzliche Zertifikate können als vertrauenswürdig eingestuft werden, indem sie nach der Installation zu nuget.config hinzugefügt werden. |
PACKAGES_FOLDER | Ordnerpfad | Speicherort für Workflows und deren Abhängigkeiten herunterladen. Standard: %userProfile%\.nuget\packages. |
INSTALL_WEBVIEW | True, False | Installiert die Microsoft Edge WebView2-Runtime, die während der Installation von Microsoft heruntergeladen wurde (Internetzugriff erforderlich). Wenn der Download fehlschlägt, wird die Runtime übersprungen und die Installation fortgesetzt. |
Assistant
| Parameter | Values | Beschreibung |
|---|---|---|
ASSISTANT_OPTIONS | DisableMarketplace, EnableMarketplace | Blendet das Marketplace-Widget aus oder zeigt es an. Wenn keine Angabe erfolgt, wird die aktuelle Einstellung auf der Maschine beibehalten. |
Browsererweiterungen
| Parameter | Values | Beschreibung |
|---|---|---|
CHROME_INSTALL_TYPE, EDGE_INSTALL_TYPE | PolicyOnline, PolicyOffline, ManualPerMachine, ManualPerUser, NativeHostOnly, None | Wie die Chrome- oder Edge-Erweiterung bereitgestellt wird. Bei den Werten wird nicht zwischen Groß- und Kleinschreibung unterschieden. |
INSTALL_CHROME_EXTENSION, INSTALL_EDGE_EXTENSION, INSTALL_FIREFOX_EXTENSION | True, False | Installiert die Erweiterung für diesen Browser. |
INSTALL_JAVA_EXTENSION, INSTALL_SILVERLIGHT_EXTENSION | True, False | Installiert die Java- oder Silverlight-Erweiterung. |
INSTALL_CITRIX_CLIENT_EXTENSION, INSTALL_RDP_CLIENT_EXTENSION, INSTALL_VMWARE_CLIENT_EXTENSION, INSTALL_AWS_WORKSPACES_CLIENT_EXTENSION | True, False | Installiert die Erweiterung für diesen Remotedesktopclient. |
Die Legacy-Installationstypwerte GLOBAL (entsprechen ManualPerMachine) und STORE (entsprechen PolicyOnline) werden weiterhin akzeptiert. Jeder andere Wert wird als None behandelt.
Wenn ein INSTALL_*_EXTENSION -Parameter weggelassen wird, behält die Erweiterung ihren aktuellen Status bei: Bei einer Neuinstallation wird sie nicht installiert, und beim Ändern oder Aktualisieren einer Installation bleibt eine installierte Erweiterung installiert.
Laufzeiten (Runtimes)
Runtimes akzeptiert keine Parameter. Verwenden Sie "Parameters": {}.
Die Konfigurationsdatei wird als Nur-Text gelesen. Wenn sie Geheimnisse wie ORCHESTRATOR_CLIENT_SECRET oder LICENSE_KEY enthält, schränken Sie den Zugriff auf die Datei ein und löschen Sie sie zusammen mit der Kopie, die das Installationsprogramm unter %TEMP%\UiPathConnected\ schreibt, nachdem die Installation abgeschlossen ist.
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": {
"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"
}
}
{
"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"
}
}
{
"Proxy": {
"ScriptAddress": "http://proxy.corp/proxy.pac"
}
}
ProxyAddress und ScriptAddress schließen sich gegenseitig aus. Wenn UserName festgelegt ist, muss auch Password festgelegt werden.
Fehlersuche und ‑behebung
Um eine fehlgeschlagene Installation zu untersuchen, erfassen Sie ein ausführliches Installationsprotokoll, indem Sie dem Befehl msiexec /l*v "<log path>" hinzufügen.
Die Installation schlägt mit Exitcode 1603 fehl und wird zurückgesetzt
Wenn das Verbose-Protokoll Command executed with exit code: 80 enthält, ist die Installation der Desktop-Clients selbst fehlgeschlagen. Der Grund ist im Protokoll des Installationsprogramms:
| Installations-Scope | Installationsprotokoll |
|---|---|
| Pro Maschine | %SystemRoot%\SystemTemp\UiPath.Connected.Installer.CLI.<yyyy-MM-dd>.log (unter Windows-Versionen ohne SystemTemp -Ordner, %SystemRoot%\Temp) |
| Pro Benutzer | %TEMP%\UiPath.Connected.Installer.CLI.<yyyy-MM-dd>.log |
Eine häufige Ursache ist eine Konfigurationsdatei, die ein Produkt ohne die benötigten Produkte anfordert. Das Installationsprotokoll enthält dann eine Zeile wie:
Missing required dependencies. The following products must also be installed: Runtimes (required by Robot)
Missing required dependencies. The following products must also be installed: Runtimes (required by Robot)
Behebung:
- Fügen Sie die aufgeführten Produkte mit
"InstallRequested": truezur Konfigurationsdatei hinzu, wie unter Verfügbare Produkte gezeigt. - Führen Sie die Installation erneut aus.
- Syntax
- Installationsmodi
- Unterstützte Parameter
- Installations-Scope
- Beispiele
- Interaktive Installation
- Automatische Installation
- Konfigurationsdateien
- platformConfig.json (
PLATFORM_CONFIGURATION_FILE) - updaterConfig.json (
UPDATER_CONFIGURATION_FILE) - Fehlersuche und ‑behebung
- Die Installation schlägt mit Exitcode 1603 fehl und wird zurückgesetzt