订阅

UiPath Installation and Upgrade

UiPath 安装和升级指南

命令行参数

您可以安装并更新 Studio 和 Robot，也可以通过 UiPathStudio.msi 安装程序来更改现有安装。

请参阅以下各部分，了解有关可用参数的描述和一些用法示例。

📘

注意：

  • 需要管理员权限才能执行这些命令。
  • 不支持在静默模式下通过从命令行运行安装程序来更改现有安装。但是，您可以在静默模式下运行安装程序，以从旧版本进行更新。
  • 不支持使用 msiexec.exe 的 /passive 选项运行无人值守安装。

命令行参数描述

下表列出了所有可用的命令行参数。

所有参数都可以用于全新安装，但是从旧版本更新或更改现有安装时，仅支持以下参数：

  • 使用 ADDLOCAL 启用功能。
  • 使用 REMOVE 禁用功能。请注意，无法禁用 Robot。
  • SERVICE_URL - 将 Robot 从服务模式切换到用户模式时可用，方式是不包括 RegisterService 参数。
  • NUGET_OPTIONS、ENFORCE_SIGNED_EXECUTION、DISABLE_SECURE_XAML 和 TELEMETRY_ENABLED - 从旧版本更新时可用，而在更改现有安装时不可用。
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

执行同步安装

如果要在安装完成后进行其他配置，可以同步运行安装程序。这使您能够添加要在安装程序完成后执行的其他命令，例如，您可以安装并设置机器人连接或配置订阅源。

以下脚本将执行安装，并允许您添加安装成功后要执行的其他命令。

:: 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.
}

示例

编写这些示例时，我们假设您已处于 UiPathStudio.msi 安装程序所在的目录中。您可以使用以下命令来完成此操作，例如：cd D:\UiPathInstaller。

  • 将 Studio、机器人安装为 Windows 服务和活动包 - UiPathStudio.msi ADDLOCAL=DesktopFeature,Studio,Robot,RegisterService,Packages
  • 在用户模式下仅为当前用户安装 Studio 和 Robot- UiPathStudio.msi MSIINSTALLPERUSER=1 ADDLOCAL=DesktopFeature,Studio,Robot
  • 静默安装整个桌面套件 - UiPathStudio.msi ADDLOCAL=DesktopFeature,Studio,Robot,RegisterService,Packages,StartupLauncher,JavaBridge /Q
  • 通过策略静默安装整个桌面套件和 Chrome 扩展程序 - UiPathStudio.msi ADDLOCAL=DesktopFeature,Studio,Robot,RegisterService,Packages,ChromeExtension CHROME_INSTALL_TYPE=POLICYONLINE /Q
  • 将 Studio、机器人静默安装为 Windows 服务和活动包，并且全部安装在 D:\UiPath 文件夹中 - UiPathStudio.msi ADDLOCAL=DesktopFeature,Studio,Robot,RegisterService,Packages APPLICATIONFOLDER=D:\UiPath /Q
  • 将机器人静默安装为 Windows 服务，并将其连接到 Orchestrator -
    UiPathStudio.msi ADDLOCAL=DesktopFeature,Robot,RegisterService CONNECTIONSTRING=https://demo.uipath.com/api/robotsservice/GetConnectionData?tenantId=1 /Q
  • 以静默方式安装 Studio，将机器人安装为 Windows 服务，并添加两个自定义活动订阅源 - UiPathStudio.msi ADDLOCAL=DesktopFeature,Studio,Robot,RegisterService CUSTOM_NUGET_FEEDS="Feed Name1,https://my.custom.nuget.feed; FeedName2,D:\RPA\Activities\Packages\" /Q
  • 静默安装并许可 Studio、注册为 Windows 服务的机器人和本地活动订阅源 - UiPathStudio.msi ADDLOCAL=DesktopFeature,Studio,Robot,RegisterService,Packages CODE=1234567890 /Q
  • 将机器人安装为 Windows 服务，并禁用官方在线订阅源 - UiPathStudio.msi ADDLOCAL=DesktopFeature,Robot,RegisterService NUGET_OPTIONS=DisableOnlineFeeds
  • 卸载 Chrome 扩展程序 - UiPathStudio.msi REMOVE=ChromeExtension /Q
  • 在 Attended Robot 安装期间设置自动更新连接
    UiPathStudio.msi ADDLOCAL=DesktopFeature,Robot,RegisterService SERVICE_URL="https://demo.uipath.com/myorg/mytenant"
  • 在 Unattended Robot 安装期间设置自动更新连接 -
    UiPathStudio.msi ADDLOCAL=DesktopFeature,Robot,ORCHESTRATOR_URL="https://demo.uipath.com/myorg/mytenant"
  • 为已安装的 Attended Robot 设置自动更新连接。
    更新 uipath.config 或 updateservice.json 文件。
  • 为已安装的 Unattended Robot 设置自动更新连接。
    • 使用客户端凭据 -
      UiRobot.exe --connect --url "https://demo.uipath.com/myorg/mytenant"--clientID <clientID> --clientSecret <clientSecret>
    • 使用计算机密钥
      UiRobot.exe --connect -url "https://demo.uipath.com/myorg/mytenant"-key <machineKey>

约一个月前更新

命令行参数

建议的编辑仅限用于 API 参考页面

您只能建议对 Markdown 正文内容进行编辑，而不能建议对 API 规范进行编辑。