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

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

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

注:

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

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

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

コマンド	説明
/q	特定の UiPath 機能のサイレント モードでのインストールに対応していますが、ユーザー インターフェイスは表示されません。
/l*vx <LogFile>	インストーラーのログ ファイルを指定したパスに生成します。v2018.4.2 以降、Studio または Robot のライセンスをインストール時に取得した場合、このファイルにはライセンス情報も含まれます。 インストール プロセスの間に問題が発生した場合は、理由を問わず、UiPath のサポート チームにファイルを送信できます。
ADDLOCAL	インストールする機能を選択できます。ADDLOCAL を使用すると、このコマンドで指定した機能のみがインストールされます。ADDLOCAL を使用しないと、Studio、サービス モードの Robot、アクティビティ パッケージ、および JavaScript アドオンがインストールされます。 次のオプションがサポートされています。 DesktopFeature - Robot と Studio の機能をインストールすることを指定します。 Studio - Studio をインストールします。同時に DesktopFeature の指定が必要です。 ExcelAddin - StudioX Excel アドインをインストールします。Studio なしでは使用できません。 Robot - Robot をユーザー モードでまたはサービス モードでインストールします。同時に DesktopFeature の指定が必要です。 Robot をサービス モードでインストールするには、RegisterService オプションも追加します。これは Unattended ロボットに推奨されるオプションです。 Robot をユーザー モードでインストールするには、RegisterService オプションを追加しないでください。これは Attended ロボットおよび Development ロボットに推奨されるオプションです。 UseLegacyTray - UiPath Assistant の代わりに従来のロボット トレイをインストールします。 To switch to Assistant after install, run REMOVE=UseLegacyTray. Packages - アクティビティ パッケージをインストールします。同時に DesktopFeature 引数と Robot 引数の指定が必要です。 StartupLauncher - Windows の起動時に Robot を実行します。同時に DesktopFeature 引数と Robot 引数の指定が必要です。 JavaBridge - Java アプリケーションに関して統合と自動化を向上させる目的で UiPath Java Bridge をインストールします。Java Bridge をインストールする場合、インストール時間が通常より長くなる場合があります。DesktopFeature 引数および Robot 引数を指定せずに使用することはできません。 ChromeExtension - UiPath Google Chrome 拡張機能をインストールします。DesktopFeature コマンドおよび Robot 引数がない場合は使用できません。 EdgeExtension - UiPath Microsoft Edge (Chromium ベース) 拡張機能をインストールします。同時に Robot 引数を指定する必要があります。 CitrixClient - UiPath Citrix クライアント拡張をインストールします。DesktopFeature コマンドおよび Robot 引数がない場合は使用できません。 JavaScriptAddOn - Robot JavaScript SDK をサポートする Robot JavaScript アドオンをインストールします。
APPLICATIONFOLDER	Studio と Robot を指定の場所にインストールできます。
NUGET_OPTIONS	オフライン環境で作業する場合には、このパラメーターが推奨されます。このパラメーターを DisableOnlineFeeds に設定すると、ロボット用のオンラインの UiPath 公式フィードやコミュニティ フィードを無効化できます。こうすることで、Orchestrator フィードとローカル フィールドのみが考慮されます。 URL フィードは設定ファイルから削除されず、単に無視されるだけです。 これは、インストールにもアップグレードにも使用可能です。
PACKAGES_FOLDER	Studio および/または Robot のワークフローとその依存関係のダウンロード先となる場所を変更できます。このフォルダーは、ユーザー固有のフォルダー、またはマシンのすべてのユーザーがアクセスできるフォルダーです。このパラメーターは、Robot がサービスとしてインストールされている場合でも、ユーザー モードでインストールされている場合でも使用できます。 サービス モードの Robot の場合、パッケージはすべてのユーザーに同時にインストールされます。 マシンにユーザー モードの Robot が複数インストールされている場合、パッケージ フォルダー (C:\Packages など) が異なる場合があることに注意してください。これは、パッケージを最初にダウンロードしてインストールするユーザー モード Robot が、.XAML ファイルへのアクセスをそのユーザーに限定するため、そのマシン上の他のユーザー モード Robot には権限がなく、対応するフォルダーまたはパッケージを使用できなくなるからです。 このパラメーターを入力しない場合、既定のフォルダーは %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. Read more about using the same path for multiple robots %USERNAME% や %USERPROFILE% などの環境変数を使用できます。特殊文字 % は、次のようにエスケープする必要があります。 セットアップをコマンド プロンプトから呼び出した場合 - UiPathStudio.msi PACKAGES_FOLDER=C:\Some\Path\^%USERNAME^% を使用します。 バッチ スクリプト - % - UiPathStudio.msi PACKAGES_FOLDER=C:\Some\Path\^%USERNAME^% を使用します。 PowerShell コンソールまたはスクリプト - エスケーブは不要です。 ユーザーが Active Directory ドメイン アカウントである場合は、フォルダー構造にもドメイン名 (C:\packages\^%UserDomain^%.^%Username^% など) を指定することを推奨します。 For information on how to change the download folder for packages after installation, see Managing Activities Packages.
CUSTOM_NUGET_FEEDS	Studio や Robot 用にカスタムの NuGet アクティビティ フィードを追加できます。このコマンドは、既存のフィード リストの追加または更新のみを行います。 文字列型のキーと値のペアを設定する必要があります。有効な場所には、オンライン フィード、フォルダー パス、共有ネットワーク ドライブが含まれます。指定するフィードは、そのマシンのすべてのユーザーがアクセス可能なものにしてください。フィードはセミコロン (;) で区切ります。 例: CUSTOM_NUGET_FEEDS="FeedName1,https://my.custom.nuget.feed; FeedName2,D:\Custom\Activities\Packages\"。
ENFORCE_SIGNED_EXECUTION	任意です。ロボットに署名付きパッケージのみを実行させるルールを適用できます。インスタンスのクリーン インストール時または更新時に使用できます。デプロイ時にこのパラメーターを指定しなかった場合、パッケージの署名は有効化されません。 次のオプションがサポートされています。 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 - ロボットのデプロイに、パッケージ署名に関するルールは一切適用されません。 For information on how to enforce signed execution after installation, see Signing Packages .
CODE	Studio インスタンスのライセンス コードを指定します。
CONNECTIONSTRING	Automatically connects the Robot to Orchestrator on-premises using the connection string while also installing it. Please note that the following are required: UiPath.Orchestrator.dll.config ファイルの WindowsAuth.Enabled パラメーターが true に設定されていること WindowsAuth.Domain パラメーターに有効なドメインを設定する必要があります。 the Service Mode Robot a Standard Machine configuration has to be in place. Automatic enrollment with standard machines using the connectionstring can only be used with Orchestrator v2020.10.
CHROME_INSTALL_TYPE	ポリシーによって Chrome 拡張機能を自動的にインストールします。 次のオプションがサポートされています。 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	Windows サービスとしてインストールされた Robot の XAML ファイルのセキュリティを無効化できます。セキュリティ保護されていない XAML ファイルを使用すると、ユーザーはプロセス ファイルとロジックを読み取って変更できます。 次のオプションがサポートされています。 0 - 既定のオプションです。使用すると、Windows サービスとしてインストールされた Robot の XAML ファイルのセキュリティが有効化されます。 1 - Windows サービスの Robot の XAML ファイルのセキュリティが無効化されます。 This parameter can only be used during a clean install or upgrade.
SERVICE_URL	ユーザーが対話型サインインを使用して接続する場合の、Orchestrator インスタンスの URL を定義できます。 指定した URL は、ユーザー モードの Robot についてのみ uipath.config ファイルに保存されます。サービス モードのインストールの場合、この引数は無視されます。 インストーラーを実行して旧バージョンからの更新または既存のインストールの変更を行う際、Robot をサービス モードからユーザー モードに切り替える場合 (RegisterService オプションは含めません)、このパラメーターを使用できます。
TELEMETRY_ENABLED	使用状況データの収集機能は、Studio および Robot のインストール時に無効化できます。 テレメトリは Studio および Robot に対して既定で有効化されています。無効化するには、インストール時のパラメーターに次の値を使用します。 TELEMETRY_ENABLED=0 これにより、Studio と Robot の両方のテレメトリが無効化されます。 テレメトリを再び有効化するには、以下の値を使用します。 TELEMETRY_ENABLED=1 For more information about usage data collection and how to change telemetry settings, see the Opting Out of Telemetry document.
ENABLE_PIP	コマンドラインから UiPath をインストールするときに、マシンのピクチャ イン ピクチャ機能を有効化することができます。 そのためには、以下のパラメーターを使用します。 ENABLE_PIP=1 例： UiPathStudio.msi ADDLOCAL=DesktopFeature,Studio,Robot,RegisterService,Packages ENABLE_PIP=1

例

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

• Studio のインストールと Robot の Windows サービスとしてのインストールを実行し、アクティビティ パッケージをインストールします。 - UiPathStudio.msi ADDLOCAL=DesktopFeature,Studio,Robot,RegisterService,Packages

• Studio と Robot をユーザー モードでインストールします。 - UiPathStudio.msi 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=STORE /Q

• サイレント モードで、Studio をインストールし、Robot を Windows サービスとしてインストールし、アクティビティ パッケージをインストールする (すべてを D:\UiPath フォルダーにインストール) - UiPathStudio.msi ADDLOCAL=DesktopFeature,Studio,Robot,RegisterService,Packages APPLICATIONFOLDER=D:\UiPath /Q

• サイレント モードで Robot を Windows サービスとしてインストールし、Orchestrator に接続する -

  UiPathStudio.msi ADDLOCAL=DesktopFeature,Robot,RegisterService CONNECTIONSTRING=https://demo.uipath.com/api/robotsservice/GetConnectionData?tenantId=1 /Q

• Studio のインストールと Robot の Windows サービスとしてのインストールと、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 、Windows サービスとして登録された Robot、ローカル アクティビティ フィードのインストールとライセンスの取得をサイレント モードで実行します。 - UiPathStudio.msi ADDLOCAL=DesktopFeature,Studio,Robot,RegisterService,Packages CODE=1234567890 /Q

• Robot を Windows サービスとしてインストールし、オフィシャル オンライン フィードを無効化します。 - UiPathStudio.msi ADDLOCAL=DesktopFeature,Robot,RegisterService NUGET_OPTIONS=DisableOnlineFeeds