通知を受け取る

UiPath Studio

UiPath Studio ガイド

コマンド ライン パラメーター

コマンド ライン引数の説明

UiPath Studio Windows インストーラー (UiPathStudio.msi) がある場合は、コマンド ラインを使用して Studio または ロボットをインストールしたり更新したりすることができます。以下の表は、使用可能なパラメーターのリストです。また、いくつかの例も紹介しています。

Orchestrator で使用できるコマンド ライン引数については、こちらをクリックしてください。

📘

重要

サイレント モードでは、コマンド プロンプトから UiPath Platform の既存のインスタンスに変更を加えることはできません。ただし、更新の実行時にインストールされるインスタンスについては変更を加えることが可能です。

セットアップ コマンドライン引数は UiPathPlatformInstaller.exe では機能しません。

これらのコマンドを実行するには、管理者権限が必要です。

Command

Description

/q

Helps 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.

ADDLOCAL

Enables 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 features enabled by default in the UI version are installed (Studio, the Robot in service mode, and the local activities feed).

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.

Robot - Installs the Robot. Add the RegisterService parameter to install the Service Mode Robot or the RegisterUserModeService to install the User Mode Robot. It cannot be used without DesktopFeature.

RegisterService - Installs the Service Mode Robot. Can only be used with the Robot and the DesktopFeature arguments.

RegisterUserModeService - Installs the User Mode Robot. Can only be used with the Robot and the DesktopFeature arguments.

UseAgentDesktop - Installs Agent Desktop. Can only be used with the Robot and the DesktopFeature arguments.

UseRobotTray - Installs the Robot Tray. Can only be used with the Robot and the DesktopFeature arguments.

Packages - Installs the activities packages. It cannot be used without the DesktopFeature and Robot arguments.

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

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 DesktopFeature and Robot arguments.

ChromeExtension - Installs the UiPath Google Chrome Extension. It cannot be used without the DesktopFeature and Robot arguments.

CitrixClient - Installs the UiPath Citrix Client Extension. It cannot be used without the DesktopFeature and Robot arguments.

APPLICATIONFOLDER

Enables you to install Studio and Robot in a custom location.

NUGET_OPTIONS

This 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_FOLDER

Enables 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 either if the Service Mode or User Mode Robot is installed.

For the Service Mode Robot, packages are concurrently installed on all users.

Please note that, for multiple User Mode Robots installed on a machine, the packages folder cannot be the same (such as C:\Packages). This is because the first User Mode Robot which download and installs a package restricts the .XAML file access only to that user, making other User Mode Robots on that machine unable to use the corresponding folder, or package because of insufficient privileges.

Please note that if you set the same package folder (such as C:\Packages) for User Mode Robots on a machine packages are not installed, because of privilege restrictions. Only Service Mode Robots share the same package folder, since it is installed per system.

If you do not provide this parameter the default folder is %userProfile%\.nuget\packages.

For installations on Windows Server machines (that enable concurrent execution - HD Robots), you must provide paths that are specific to each user. Using the same shared folder for all users in HD environments is not supported.

It is possible 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%; :fa-caret-right: In batch scripts - use %-UiPathStudio.msi PACKAGES_FOLDER=C:\Some\Path%%USERNAME%%`;
In PowerShell console or scripts - no escaping is needed.

If your user is an Active Directory domain account, it is recommended that you specify the domain name in the folder structure too, such as C:\packages^%UserDomain^%.%Username%.

CUSTOM_NUGET_FEEDS

Enables 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_EXECUTION

Optional. 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.

CODE

Licenses your Studio instance.

CONNECTIONSTRING

Automatically connects the Robot to Orchestrator using the connection string while also installing it. Please note that the following are required:
the WindowsAuth.Enabled parameter from the web.config file has to be set to true
the WindowsAuth.Domain parameter has to be set to a valid domain
the Service Mode Robot

CHROME_INSTALL_TYPE

Automatically installs the Chrome Extension via policy.

It supports the following options:

GLOBAL - The Chrome Extension is automatically installed per system, the equivalent of calling the /ChromeGlobal command using the SetupExtenstions tool.

STORE - The Chrome Extension is automatically installed per system via policy, the equivalent of calling the /ChromePolicyGlobal command using the SetupExtenstions tool.

DISABLE_SECURE_XAML

Allows you to disable security of XAML files for Service Mode Robots. 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 Service Mode Robots.
1 - Disables security for XAML files for Service Mode Robots.

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

以下の例では、UiPathStudio.msi インストーラーが置かれているディレクトリにいることを前提としています。たとえば、cd D:\UiPathInstaller などのコマンドでこれを行うことができます。

  • Studio、サービス モードの Robot、アクティビティ パッケージをインストールする - UiPathStudio.msi ADDLOCAL=DesktopFeature,Studio,Robot,RegisterService,Packages
  • Studio、ユーザー モードの Robot をインストールする - UiPathStudio.msi ADDLOCAL=DesktopFeature,Studio,Robot,RegisterUserModeService
  • デスクトップ スイート全体をサイレント モードでインストールします。 - UiPathStudio.msi ADDLOCAL=DesktopFeature,Studio,Robot,RegisterService,Packages,StartupLauncher,JavaBridge /Q
  • ポリシーを使用して、デスクトップ スイート全体と Chrome 拡張機能をサイレント モードでインストールします。 - UiPathStudio.msi ADDLOCAL=DesktopFeature,Studio,Robot,RegisterService,Packages,ChromeExtension CHROME_INSTALL_TYPE=STORE /Q
  • Studio、サービス モード ロボット、エージェント デスクトップ、およびローカル アクティビティ フィードをインストールする - UiPathStudio.msi ADDLOCAL=DesktopFeature,Studio,Robot,RegisterService,Packages,UseAgentDesktop
  • Studio、サービス モード ロボット、アクティビティ パッケージのすべてを D:\UiPath フォルダーにサイレント モードでインストールする - UiPathStudio.msi ADDLOCAL=DesktopFeature,Studio,Robot,RegisterService,Packages APPLICATIONFOLDER=D:\UiPath /Q
  • サービス モードの Robot をサイレント モードでインストールし、Orchestrator に接続する -
    UiPathStudio.msi ADDLOCAL=DesktopFeature,Robot,RegisterService CONNECTIONSTRING=https://platform.uipath.com/api/robotsservice/GetConnectionData?tenantId=1 /Q
  • Studio、サービス モード ロボットをサイレント モードでインストールし、2 つのカスタム アクティビティ フィードを追加する - UiPathStudio.msi ADDLOCAL=DesktopFeature,Studio,Robot,RegisterService CUSTOM_NUGET_FEEDS="Feed Name1, https://my.custom.nuget.feed; FeedName2, D:\RPA\Activities\Packages\" /Q
  • Studio、サービス モード ロボット、ローカル アクティビティ フィードをサイレント モードでインストールし、ライセンスを取得する - UiPathStudio.msi ADDLOCAL=DesktopFeature,Studio,Robot,RegisterService,Packages CODE=1234567890 /Q
  • サービス モードの Robot をインストールし、オフィシャル オンライン フィードを無効化する - UiPathStudio.msi ADDLOCAL=DesktopFeature,Robot,RegisterService NUGET_OPTIONS=DisableOnlineFeeds

1 年前に更新

コマンド ライン パラメーター


改善の提案は、API リファレンスのページでは制限されています

改善を提案できるのは Markdown の本文コンテンツのみであり、API 仕様に行うことはできません。