Abonnieren

UiPath Installation and Upgrade

Die UiPath-Installations- und Upgrade-Anleitung

Kommandozeilenparameter

Sie können Studio und den Robot installieren und aktualisieren oder eine vorhandene Installation ändern, indem Sie das UiPathStudio.msi-Installationsprogramm über die Befehlszeile ausführen.

In den folgenden Abschnitten finden Sie Beschreibungen der verfügbaren Parameter und einige Anwendungsbeispiele.

📘

Hinweise:

  • Zur Durchführung dieser Anweisungen sind Administratorrechte erforderlich.
  • Das Ändern einer vorhandenen Installation durch Ausführen des Installationsprogramms über die Befehlszeile im Silent-Modus wird nicht unterstützt. Sie können das Installationsprogramm jedoch im Silent-Modus ausführen, um von einer älteren Version zu aktualisieren.
  • Die Verwendung der /passive-Option von msiexec.exe zur Ausführung einer Unattended-Installation wird nicht unterstützt.

Beschreibung der Kommandozeilenargumente

In der folgenden Tabelle sind alle verfügbaren Befehlszeilenparameter aufgeführt.

Alle Parameter können für Neuinstallationen verwendet werden, aber nur die folgenden werden unterstützt, wenn Sie von einer älteren Version aktualisieren oder eine vorhandene Installation ändern:

  • Aktivieren Sie Funktionen mit ADDLOCAL.
  • Deaktivieren Sie Funktionen mithilfe von REMOVE. Bitte beachten Sie, dass der Robot nicht deaktiviert werden kann.
  • SERVICE_URL – verfügbar, wenn Sie den Roboter vom Dienstmodus in den Benutzermodus wechseln, indem das Argument RegisterService nicht berücksichtigt wird.
  • NUGET_OPTIONS, ENFORCE_SIGNED_EXECUTION, DISABLE_SECURE_XAML und TELEMETRY_ENABLED – verfügbar beim Aktualisieren von einer älteren Version, nicht verfügbar beim Ändern einer vorhandenen Installation.
CommandDescription
/qHelps you install the specified UiPath features silently, without displaying the user interface.
/l*vx <LogFile>Generates an installer log file at the specified path. Starting with v2018.4.2, this file can also include licensing information if you license Studio or Robot at install time.

You can send the file further to our support team if, for any reason, you encounter difficulties during the installation process.
ADDLOCALEnables you to select what features to install. If ADDLOCAL is used, only the features specified in it are installed. If ADDLOCAL is not used, the following features are installed: Studio, the Robot in service mode, the activities packages, and the JavaScript add-on.

It supports the following options:

DesktopFeature - indicates that you want to install Robot and Studio features.

Studio - Installs Studio. It cannot be used without DesktopFeature.

ExcelAddin - Installs the StudioX Excel Add-in. It cannot be used without Studio.

Robot - Installs the Robot in user mode or service mode, as well as the Assistant. It cannot be used without DesktopFeature.
To install the Robot in service mode, also add the RegisterService option. This is the recommended choice for unattended Robots.
To install the Robot in user mode, do not add the RegisterService option. This is the recommended choice for attended and development Robots.
:information-source: Note: If you convert the Robot from service mode to user mode, the Robot might not be able to access the .xaml files from the original NuGet Packages folder. For details on how to resolve this, see the NuGet packages not accessible after migration troubleshooting article.

Packages - Installs the activities packages. It cannot be used without the Robot argument.

StartupLauncher - Runs the Robot at Windows startup. It cannot be used without the Robot argument.

JavaBridge - Installs the UiPath Java Bridge for a better integration and automation in regards to Java applications. Please note that installing the Java Bridge may cause the installation to last longer than usual. It cannot be used without the Robot argument.

ChromeExtension - Installs the UiPath Google Chrome Extension. It cannot be used without the Robot argument.

FirefoxExtension - e.g. : UiPathStudio.msi ADDLOCAL=Studio,Robot,ChromeExtension,FirefoxExtension /Q

EdgeExtension - Installs the UiPath Microsoft Edge Chromium-based Extension. It cannot be used without the Robot argument.

CitrixClient - Installs the UiPath Citrix Client Extension. It cannot be used without the Robot argument.

JavaScriptAddOn - Installs the browser embedding JavaScript add-on for robot.

SapPlugin - Installs the SAP Solution Manager plugin. Requires the SAP Connector for Microsoft to be installed on your machine. On clean installs, you must also provide an address for the instance using the SAP_SOL_MAN_HOST parameter. It cannot be used without Studio.

VMwareExtension - Installs the UiPath Extension for VMware Horizon. It cannot be used without the Robot argument.

WindowsRdpExtension - Installs the UiPath Extension for Microsoft Remote Desktop. It cannot be used without the Robot argument.
MSIINSTALLPERUSEREnables you to install Studio and Robot only for the current user. To install per user, add MSIINSTALLPERUSER=1. To install per machine, do not include this parameter.

The following options are not available in per-user installations: RegisterService, CitrixExtension, VMwareExtension, SapPlugin, PACKAGES_FOLDER, CODE.
SAP_SOL_MAN_HOSTHostname or IP address for your SAP Solution Manager instance. Required for clean installs if the SapPlugin argument was provided for the ADDLOCAL option.

For example UiPathStudio.msi ADDLOCAL=DesktopFeature,Studio,Robot,SapPlugin SAP_SOL_MAN_HOST=ip_address
APPLICATIONFOLDEREnables you to install Studio and Robot in a custom location.
NUGET_OPTIONSThis parameter is recommended if you are working in an offline environment. If set to DisableOnlineFeeds, this parameter helps you disable the online UiPath official and Community feeds for the Robot - only the Orchestrator and local feeds are taken into consideration.

Please note that the URL feeds are not deleted from the configuration files, just ignored.

It can be used for both installations and upgrades.
PACKAGES_FOLDEREnables you to change the download location of your workflows and their dependencies for Studio and/or Robot. This folder can be user specific or accessible by all users from a machine. This parameter can be used for both service mode or user mode robots. If you do not provide this parameter the default folder is %userProfile%\.nuget\packages.

:information-source: When changing the packages folder, make sure that all the users that need to execute processes have read access to this folder.

:information-source: When using the PACKAGES_FOLDER parameter, there are some limitations. Find out more in the custom package folders and network paths documentation.

If you need to use environment variables such as %USERNAME% or %USERPROFILE%, the % special character needs to be escaped as follows:
When the setup is invoked from Command Prompt - use - UiPathStudio.msi PACKAGES_FOLDER=C:\Some\Path\^%USERNAME^%.
In batch scripts - use % - UiPathStudio.msi PACKAGES_FOLDER=C:\Some\Path\^%USERNAME^%.
In PowerShell console or scripts - no escaping is needed.
When using Active Directory domain accounts, it is recommended to specify the domain name in the folder structure too, such as C:\packages\^%UserDomain^%.^%Username^%.

For information on how to change the download folder for packages after installation, see Managing Activities Packages in the Studio Guide.
CUSTOM_NUGET_FEEDSEnables you to add custom NuGet activities feeds for Studio and/or Robot. This command only adds or updates the existing list of feeds.

It must be populated with key-value pairs of type string. Valid locations include online feeds, folder paths, and shared network drives. Make sure that the provided feeds are reachable by all users from a given machine. Separate feeds with semicolons (;).

Example: CUSTOM_NUGET_FEEDS="FeedName1,https://my.custom.nuget.feed; FeedName2,D:\Custom\Activities\Packages\".
ENFORCE_SIGNED_EXECUTIONOptional. Enables you to enforce your Robots to execute only signed packages. It can be used at clean installs or updates of your instances. If this parameter is not specified at deploy-time, package signing is not enabled.

It supports the following options:
1 - The Robot is able to download, install, or execute only packages author or repository signed by UiPath. If you want to add your own certificate as a trusted source, you have to do so by modifying the nuget.config file. To learn how to do this, please see this page.
0 - No package signing rule is enforced on your Robot deployment.

For information on how to enforce signed execution after installation, see Signing Packages in the Studio Guide.
CODELicenses your Studio instance.
CONNECTIONSTRINGAutomatically connects the Robot to Orchestrator on-premises using the connection string while also installing it. Please note that the following are required:
the WindowsAuth.Enabled parameter from the UiPath.Orchestrator.dll.config file has to be set to true
the WindowsAuth.Domain parameter has to be set to a valid domain
the Service Mode Robot
a Standard Machine configuration has to be in place.

:information-source: Automatic enrollment with standard machines using the CONNECTIONSTRING can only be used with Orchestrator v2020.10.
CLIENT_ID and CLIENT_SECRETAutomatically connects the Robot to Orchestrator using client credentials while also installing it.

Example: UiPathStudio.msi ORCHESTRATOR_URL=https://demo.uipath.com/company/tenant/orchestrator_ CLIENT_ID=1234-abcd-1ab2-cd32-1111 CLIENT_SECRET=2143ndafj32k
CHROME_INSTALL_TYPEAllows you to choose the installation method for the Chrome 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 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 /ChromePolicyGlobal command using the SetupExtensions tool.

MANUALPERMACHINE - The Chrome Extension is installed for all users, the equivalent of calling the /ChromeGlobal command using the SetupExtensions tool.

NATIVEHOSTONLY - Only the Native Messaging Host component (ChromeNativeMessaging.exe) is installed, the equivalent of calling the /ChromeNativeHostGlobal command using the SetupExtensions tool.

Note: The old installation methods names (STORE, GLOBAL) are kept for backwards compatibility.
EDGE_INSTALL_TYPEAllows 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-Chromium-PolicyGlobal command using the SetupExtensions tool.

MANUALPERMACHINE - The Edge Extension is installed for all users, the equivalent of calling the /Edge-Chromium-Global command using the SetupExtensions tool.

NATIVEHOSTONLY - Only the Native Messaging Host component (ChromeNativeMessaging.exe) is installed, the equivalent of calling the /Edge-Chromium-NativeHostGlobal command using the SetupExtensions tool.

Note: The old installation methods names (STORE, GLOBAL) are kept for backwards compatibility.
DISABLE_SECURE_XAMLAllows you to disable security of XAML files for Robots installed as a Windows service. Unsecured XAML files allow users to read and modify the process files and logic.

It supports the following options:
0 - The default option. When used, it enables security for XAML files for Windows service Robots.
1 - Disables security for XAML files for Windows service Robots.

Note: This parameter can only be used during a clean install or an update.
SERVICE_URLAllows you to define the URL of the Orchestrator instance users will connect to using Interactive Sign-In.
The provided URL is saved in the uipath.config file, and it's only saved for user-mode Robots. For service-mode installations, the argument is ignored.

When running the installer to update from an older version or change your existing installation, this parameter is supported if you are switching the Robot from service mode to user mode (the RegisterService option is not included).
ORCHESTRATOR_URLIn a clean installation, you can specify the main Orchestrator URL, used for retrieving auto-update information (e.g. https://orchestrator.local/organizationName/tenantName).
TELEMETRY_ENABLEDAllows you to disable the usage data collection and can be done at install time for Studio and Robot.

Note: This parameter can only be used during a clean install or an update.

Telemetry is enabled by default for Studio and Robot. To disable it, use the following value for the parameter whenever you perform a clean installation or an update:

TELEMETRY_ENABLED=0

Note: This disables telemetry for both Studio and Robot.

If you want to enable telemetry, do not include the parameter, or include it with the following value:

TELEMETRY_ENABLED=1

For more information about usage data collection and how to change telemetry settings, see the Opting Out of Telemetry document.
ENABLE_PIPAllows you to enable the Picture in Picture functionality of the machine during the UiPath command-line installation.

To enable it, use the following parameter:
ENABLE_PIP=1

Example:

UiPathStudio.msi ADDLOCAL=DesktopFeature,Studio,Robot,RegisterService,Packages ENABLE_PIP=1
INSTALLER_LANGUAGEEnables you to select the display language of the installer. If not specified, the language settings in Windows determine the installer language. To specify the language, enter the parameter INSTALLER_LANGUAGE=<language_code>. The following options are available:

Chinese (Simplified): INSTALLER_LANGUAGE=2052
French: INSTALLER_LANGUAGE=12
German: INSTALLER_LANGUAGE=7
Japanese: INSTALLER_LANGUAGE=17
Korean: INSTALLER_LANGUAGE=1
Portuguese (Portugal): INSTALLER_LANGUAGE=22
Portuguese (Brazil): INSTALLER_LANGUAGE=1046
Russian: INSTALLER_LANGUAGE=25
Spanish (Spain): INSTALLER_LANGUAGE=10
Spanish (Mexico): INSTALLER_LANGUAGE=2058
Turkish: INSTALLER_LANGUAGE=31

Durchführen einer synchronen Installation

Wenn Sie nach Abschluss der Installation weitere Konfigurationen vornehmen möchten, können Sie das Installationsprogramm synchron ausführen. Auf diese Weise können Sie weitere Befehle hinzufügen, die nach Beendigung des Installationsprogramms ausgeführt werden, z. B. können Sie eine Roboterverbindung einrichten oder Feeds konfigurieren.

Die folgenden Skripte führen die Installation durch und ermöglichen es Ihnen, weitere Befehle hinzuzufügen, die bei erfolgreicher Installation ausgeführt werden sollen.

:: Runnning the MSI synchronously
start /wait /b UiPathStudio.msi /Q

:: Assert the exit code and continue accordingly
set "_isSuccess="

if %ERRORLEVEL% EQU 0 Set "_isSuccess=1"
if %ERRORLEVEL% EQU 1641 Set "_isSuccess=1"
if %ERRORLEVEL% EQU 3010 Set "_isSuccess=1"

:: test for success and run follow-up commands
if (%_isSuccess% EQU 1) (
    echo "success"
) ELSE (
    echo "fail"
)

# Runnning the MSI synchronously
$exitCode = (Start-Process msiexec.exe -ArgumentList "/i UiPathStudio.msi /Q" -Wait -PassThru).ExitCode

# Assert the exit code and continue accordingly
if ($exitCode -in 0,1641,3010) {
    # success. run additional commands...
}
else {
    # fail.
}

Beispiele

Diese Beispiele wurden unter der Annahme erstellt, dass Sie schon in dem Verzeichnis sind, in dem sich der Installer UiPathStudio.msi befindet. Sie können dies mit dem folgenden Befehl machen, zum Beispiel: cd D:\UiPathInstaller.

  • Installieren Sie Studio, einen Roboter als Windows-Dienst und die Aktivitätenpakete - UiPathStudio.msi ADDLOCAL=DesktopFeature,Studio,Robot,RegisterService,Packages
  • Studio und einen Robot im Benutzermodus nur für den aktuellen Benutzer installieren – UiPathStudio.msi MSIINSTALLPERUSER=1 ADDLOCAL=DesktopFeature,Studio,Robot
  • Installieren Sie die gesamte Desktop-Suite im Hintergrund - UiPathStudio.msi ADDLOCAL=DesktopFeature,Studio,Robot,RegisterService,Packages,StartupLauncher,JavaBridge /Q
  • Installieren Sie die gesamte Desktop-Suite und die Chrome-Erweiterung über eine Richtlinie – UiPathStudio.msi ADDLOCAL=DesktopFeature,Studio,Robot,RegisterService,Packages,ChromeExtension CHROME_INSTALL_TYPE=POLICYONLINE /Q
  • Installieren Sie im Hintergrund Studio, den Roboter als Windows-Dienst und die Aktivitätspakete, alle im Ordner D:\UiPath - UiPathStudio.msi ADDLOCAL=DesktopFeature,Studio,Robot,RegisterService,Packages APPLICATIONFOLDER=D:\UiPath /Q
  • Installieren Sie den Roboter als Windows-Dienst im Hintergrund und verbinden Sie diesen mit dem Orchestrator -
    UiPathStudio.msi ADDLOCAL=DesktopFeature,Robot,RegisterService CONNECTIONSTRING=https://demo.uipath.com/api/robotsservice/GetConnectionData?tenantId=1 /Q
  • Installieren von Studio im Hintergrund, Installieren des Roboters als Windows-Dienst und Hinzufügen von zwei benutzerdefinierten Aktivitäts-Feeds – UiPathStudio.msi ADDLOCAL=DesktopFeature,Studio,Robot,RegisterService CUSTOM_NUGET_FEEDS="Feed Name1,https://my.custom.nuget.feed; FeedName2,D:\RPA\Activities\Packages\" /Q
  • Installieren und lizenzieren Sie Studio im Hintergrund sowie einen als Windows-Dienst registrierten Roboter und den lokalen Aktivitätsfeed - UiPathStudio.msi ADDLOCAL=DesktopFeature,Studio,Robot,RegisterService,Packages CODE=1234567890 /Q
  • Installieren eines Roboters als Windows-Dienst und Deaktivieren der offiziellen Online-Feeds – UiPathStudio.msi ADDLOCAL=DesktopFeature,Robot,RegisterService NUGET_OPTIONS=DisableOnlineFeeds
  • Deinstallieren Sie die Chrome-Erweiterung – UiPathStudio.msi REMOVE=ChromeExtension /Q
  • Einrichten der Verbindung zur automatischen Aktualisierung während der Installation des Attended-Roboters –
    UiPathStudio.msi ADDLOCAL=DesktopFeature,Robot,RegisterService SERVICE_URL="https://demo.uipath.com/myorg/mytenant"
  • Einrichten der Verbindung zur automatischen Aktualisierung während der Installation des Attended-Roboters –
    UiPathStudio.msi ADDLOCAL=DesktopFeature,Robot,ORCHESTRATOR_URL="https://demo.uipath.com/myorg/mytenant"
  • Einrichten der Verbindung zur automatischen Aktualisierung für bereits installierte Attended-Roboter –
    Update the uipath.config or updateservice.json file.
  • Einrichten der Verbindung zur automatischen Aktualisierung für bereits installierte Attended-Roboter –
    • Client-Anmeldeinformationen verwenden
      UiRobot.exe --connect --url "https://demo.uipath.com/myorg/mytenant" --clientID <clientID> --clientSecret <clientSecret>
    • Verwenden des Maschinenschlüssels –
      UiRobot.exe --connect -url "https://demo.uipath.com/myorg/mytenant" -key <machineKey>

Vor etwa einem Monat aktualisiert

Kommandozeilenparameter

Auf API-Referenzseiten sind Änderungsvorschläge beschränkt

Sie können nur Änderungen an dem Textkörperinhalt von Markdown, aber nicht an der API-Spezifikation vorschlagen.