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

Studio および Robot のインストールおよび更新を行ったり、コマンド ラインから UiPathStudio.msi インストーラーまたは UiPathStudioCloud.msi インストーラーを実行して既存のインストールを変更できます。

以下のセクションに、使用できるパラメーターの説明およびいくつかの使用例を示します。

注:

• これらのコマンドを実行するには、管理者権限が必要です。
• インストーラーをコマンド ラインからサイレント モードで実行して、既存のインストールを変更することはできません。ただし、インストーラーをサイレント モードで実行して、旧バージョンから更新することはできます。
• msiexec.exe の /passive オプションを使用した無人モードのインストールの実行はサポートされていません。

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

以下の表に、使用できるすべてのコマンド ライン パラメーターのリストを示します。

クリーン インストールにはすべてのパラメーターを使用できますが、旧バージョンからの更新または既存のインストールの変更の場合は、以下のパラメーターのみサポートされます。

• ADDLOCAL を使用して機能を有効化します。
• REMOVE を使用して機能を無効化します。Robot を無効化することはできませんので注意してください。
• SERVICE_URL - RegisterService 引数を含めずに Robot をサービス モードからユーザー モードに切り替える場合に使用できます。
• NUGET_OPTIONS、ENFORCE_SIGNED_EXECUTION、DISABLE_SECURE_XAML、および TELEMETRY_ENABLED - 古いバージョンからの更新で利用できます。既存のインストールを変更する場合は利用できません。

パスを入力する際は、以下の点を考慮するようにしてください。

• %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^%
• 空白が含まれるパスを使用する必要がある場合は、次のようにパスをラップする必要があります。
  • コマンド プロンプトでは、二重引用符 (" ") で囲みます。例: UiPathStudio.msi APPLICATIONFOLDER="C:\folder name"
  • PowerShell では、一重引用符と二重引用符 ('" "') で囲みます。例: ./UiPathStudio.msi APPLICATIONFOLDER='"C:\folder name"'

コマンド	説明
/q	特定の UiPath 機能のサイレント モードでのインストールに対応していますが、ユーザー インターフェイスは表示されません。
/l*vx <LogFile>	インストーラーのログ ファイルを指定したパスに生成します。v2018.4.2 以降、Studio または Robot のライセンスをインストール時に取得した場合、このファイルにはライセンス情報も含まれます。 インストール プロセスの間に問題が発生した場合は、理由を問わず、UiPath のサポート チームにファイルを送信できます。
ADDLOCAL	インストールする機能を選択できます。ADDLOCAL を使用すると、このコマンドで指定した機能のみがインストールされます。ADDLOCAL を使用しないと、Studio、サービス モードの Robot、アクティビティ パッケージ、および JavaScript アドオンがインストールされます。 次のオプションがサポートされています。 DesktopFeature - Robot と Studio の機能をインストールすることを指定します。 Studio - Studio をインストールします。 ExcelAddin - StudioX Excel アドインをインストールします。同時に Studio の指定が必要です。 Robot - Robot をユーザー モードまたはサービス モードでインストールし、さらに Assistant もインストールします。 Robot をサービス モードでインストールするには、RegisterService オプションも追加します。これは Unattended ロボットに推奨されるオプションです。 Robot をユーザー モードでインストールするには、RegisterService オプションを追加しないでください。これは Attended ロボットおよび Development ロボットに推奨されるオプションです。 注: Robot をサービス モードからユーザー モードに変換すると、Robot が元の NuGet パッケージ フォルダーの .xaml ファイルにアクセスできなくなる場合があります。これを解決する方法について詳しくは、トラブルシューティング セクションの「移行後に NuGet パッケージにアクセスできない」をご覧ください。 Packages - アクティビティ パッケージをインストールします。同時に Robot 引数を指定する必要があります。 StartupLauncher - Windows の起動時に Robot を実行します。同時に Robot 引数を指定する必要があります。 JavaBridge - Java アプリケーションの連携と自動化を向上させるために UiPath Java Bridge をインストールします。Java Bridge をインストールする場合、インストールに通常より長い時間がかかる場合があります。同時に Robot 引数を指定する必要があります。 ChromeExtension - UiPath Google Chrome 拡張機能をインストールします。同時に Robot 引数を指定する必要があります。 FirefoxExtension - 例: UiPathStudio.msi ADDLOCAL=Studio,Robot,ChromeExtension,FirefoxExtension /Q EdgeExtension - UiPath Microsoft Edge (Chromium ベース) 拡張機能をインストールします。同時に Robot 引数を指定する必要があります。 CitrixClient - UiPath Citrix クライアント拡張機能をインストールします。同時に Robot 引数を指定する必要があります。 JavaScriptAddOn - Robot JavaScript SDK をサポートする Robot JavaScript アドオンをインストールします。 SapPlugin - SAP Solution Manager プラグインをインストールします。マシンに SAP Connector for Microsoft がインストールされている必要があります。クリーン インストールの場合は、SAP_SOL_MAN_HOST パラメーターを使用してインスタンスのアドレスを指定する必要もあります。同時に Studio の指定が必要です。 VMwareExtension - VMware Horizon 向けの UiPath 拡張機能をインストールします。同時に Robot 引数を指定する必要があります。 WindowsRdpExtension - Microsoft リモート デスクトップ向けの UiPath 拡張機能をインストールします。同時に Robot 引数を指定する必要があります。
MSIINSTALLPERUSER	このパラメーターを使用すると、Studio と Robot をユーザー単位またはマシン単位でインストールできます。 このパラメーターが含まれない場合、インストールはマシン単位で行われます。MSIINSTALLPERUSER=1 を追加すると、インストールはユーザー単位で行われます。 これらのパラメーターは、クリーン インストールを実行する場合にのみ使用できます。 ユーザー単位のインストールでは、RegisterService、CitrixExtension、VMwareExtension、SapPlugin、PACKAGES_FOLDER、CODE オプションは利用できません。
SAP_SOL_MAN_HOST	SAP Solution Manager インスタンスのホスト名または IP アドレス。ADDLOCAL オプションに SapPlugin 引数が指定されている場合のクリーン インストールに必要です。 例: UiPathStudio.msi ADDLOCAL=DesktopFeature,Studio,Robot,SapPlugin SAP_SOL_MAN_HOST=ip_address
APPLICATIONFOLDER	Studio と Robot を指定の場所にインストールできます。
NUGET_OPTIONS	オフライン環境で作業する場合には、このパラメーターが推奨されます。このパラメーターを DisableOnlineFeeds に設定すると、ロボット用のオンラインの UiPath 公式フィードやコミュニティ フィードを無効化できます。こうすることで、Orchestrator フィードとローカル フィールドのみが考慮されます。 URL フィードは設定ファイルから削除されず、単に無視されるだけです。 これは、インストールにもアップグレードにも使用可能です。 注:NUGET_OPTIONS パラメーターを使用しても、Studio のオンラインの UiPath オフィシャル フィードおよびコミュニティ フィードは無効化されません。
PACKAGES_FOLDER	Studio および/または Robot のワークフローとその依存関係のダウンロード場所を変更できます。このフォルダーは、ユーザー固有のフォルダー、またはマシンのすべてのユーザーがアクセスできるフォルダーです。このパラメーターは、サービス モードまたはユーザー モードのロボットの両方で使用できます。このパラメーターを入力しない場合、既定のフォルダーは %userProfile%\.nuget\packages になります。 注: パッケージ フォルダーを変更する場合、プロセスを実行する必要があるすべてのユーザーがこのフォルダーに対する読み取りアクセス権を持っている必要があります。 注: PACKAGES_FOLDER パラメーターを使用する場合、いくつかの制限があります。詳しくは、カスタム パッケージ フォルダーとネットワーク パスに関するこちらのページをご覧ください。 同時接続実行 (高密度ロボット) が可能な Windows Server マシン上のインストールの場合は、各ユーザー固有のパスを指定する必要があります。複数のロボットに同じパスを使用する方法について詳しくは、こちらをご覧ください。 インストール後にパッケージのダウンロード フォルダーを変更する方法について詳しくは、「アクティビティ パッケージを管理する」をご覧ください。
CUSTOM_NUGET_FEEDS	Studio や Robot 用にカスタムの NuGet アクティビティ フィードを追加できます。このコマンドは、既存のフィード リストの追加または更新のみを行います。 文字列型のキーと値のペアを設定する必要があります。有効な場所には、オンライン フィード、フォルダー パス、共有ネットワーク ドライブが含まれます。指定するフィードは、そのマシンのすべてのユーザーがアクセス可能なものにしてください。フィードはセミコロン (;) で区切ります。 例: CUSTOM_NUGET_FEEDS="FeedName1,https://my.custom.nuget.feed; FeedName2,D:\Custom\Activities\Packages\"。
ENFORCE_SIGNED_EXECUTION	任意です。ロボットに署名付きパッケージのみを実行させるルールを適用できます。インスタンスのクリーン インストール時または更新時に使用できます。デプロイ時にこのパラメーターを指定しなかった場合、パッケージの署名は有効化されません。 次のオプションがサポートされています。 1 - ロボットは、UiPath による作成者またはリポジトリの署名が付いたパッケージのみをダウンロード、インストール、または実行することができます。自分の証明書を信頼された発行元として追加する場合は、nuget.config ファイルを変更する必要があります。この方法について詳しくは、こちらのページをご覧ください。 0 - ロボットのデプロイに、パッケージ署名に関するルールは一切適用されません。 インストール後に署名済み実行を強制する方法については、「パッケージの署名」をご覧ください。
CODE	Studio インスタンスのライセンス コードを指定します。
CLIENT_SECRET および CLIENT_ID	インストール時に、クライアント資格情報を使用してロボットを Orchestrator に自動的に接続します。 例: UiPathStudio.msi ORCHESTRATOR_URL=https://demo.uipath.com/company/tenant/orchestrator_ CLIENT_ID=1234-abcd-1ab2-cd32-1111 CLIENT_SECRET=2143ndafj32k
CHROME_INSTALL_TYPE	Chrome 拡張機能のインストール方法を選択できます。このパラメーターを設定するには、管理者権限でインストーラーを実行する必要があります。省略した場合は、最も適切なインストール方法が自動的に選択されます。 次のオプションがサポートされています。 POLICYOFFLINE - グループ ポリシー (オフライン) により、Chrome 拡張機能がシステムごとに自動的にインストールされます。これは、SetupExtensions ツールを使用して /Chrome-Policy-Offline コマンドを呼び出すのと同じです。 POLICYONLINE - グループ ポリシー (オンライン) により、Chrome 拡張機能がシステムごとに自動的にインストールされます。これは、SetupExtensions ツールを使用して /ChromePolicyGlobal コマンドを呼び出すのと同じです。 MANUALPERMACHINE MANUALPERMACHINE - すべてのユーザーに対して Chrome 拡張機能がインストールされます。これは、SetupExtensions ツールを使用して /ChromeGlobal コマンドを呼び出すのと同じです。 NATIVEHOSTONLY - ネイティブ メッセージング ホスト コンポーネント (ChromeNativeMessaging.exe) のみがインストールされます。これは、SetupExtensions ツールを使用して /ChromeNativeHostGlobal コマンドを呼び出すのと同じです。 注: 後方互換性を確保するため、古いインストール方法の名前 (STORE、GLOBAL) が維持されています。
EDGE_INSTALL_TYPE	Edge 拡張機能のインストール方法を選択できます。このパラメーターを設定するには、管理者権限でインストーラーを実行する必要があります。省略した場合は、最も適切なインストール方法が自動的に選択されます。 次のオプションがサポートされています。 POLICYOFFLINE - グループ ポリシー (オフライン) により、Edge 拡張機能がシステムごとに自動的にインストールされます。これは、SetupExtensions ツールを使用して /Edge-Policy-Offline コマンドを呼び出すのと同じです。 POLICYONLINE - グループ ポリシー (オンライン) により、Edge 拡張機能がシステムごとに自動的にインストールされます。これは、SetupExtensions ツールを使用して /Edge-Chromium-PolicyGlobal コマンドを呼び出すのと同じです。 MANUALPERMACHINE - すべてのユーザーに対して Edge 拡張機能がインストールされます。これは、SetupExtensions ツールを使用して /Edge-Chromium-Global コマンドを呼び出すのと同じです。 NATIVEHOSTONLY - ネイティブ メッセージング ホスト コンポーネント (ChromeNativeMessaging.exe) のみがインストールされます。これは、SetupExtensions ツールを使用して /Edge-Chromium-NativeHostGlobal コマンドを呼び出すのと同じです。 注: 後方互換性を確保するため、古いインストール方法の名前 (STORE、GLOBAL) が維持されています。
DISABLE_SECURE_XAML	Windows サービスとしてインストールされた Robot の XAML ファイルのセキュリティを無効化できます。セキュリティ保護されていない XAML ファイルを使用すると、ユーザーはプロセス ファイルとロジックを読み取って変更できます。 次のオプションがサポートされています。 0 - 既定のオプションです。使用すると、Windows サービスとしてインストールされた Robot の XAML ファイルのセキュリティが有効化されます。 1 - Windows サービスの Robot の XAML ファイルのセキュリティが無効化されます。 注: このパラメーターは、クリーン インストールまたは更新中にのみ使用できます。
SERVICE_URL	ユーザーが対話型サインインを使用して接続する Orchestrator インスタンスの URL を定義できます。 指定した URL は、ユーザー モードの Robot についてのみ uipath.config ファイルに保存されます。サービス モードのインストールの場合、この引数は無視されます。 インストーラーを実行して旧バージョンからの更新または既存のインストールの変更を行う際、Robot をサービス モードからユーザー モードに切り替える場合 (RegisterService オプションは含めません)、このパラメーターを使用できます。
ORCHESTRATOR_URL	クリーン インストールでは、自動更新情報を取得するために使用する Orchestrator のメイン URL を指定できます (例: https://orchestrator.local/organizationName/tenantName)。
TELEMETRY_ENABLED	使用状況データの収集機能は、Studio および Robot のインストール時に無効化できます。 注: このパラメーターは、クリーン インストールまたは更新中にのみ使用できます。 テレメトリは Studio および Robot に対して既定で有効化されています。無効化するには、クリーン インストールまたは更新を実行するたびにパラメーターに次の値を使用します。 TELEMETRY_ENABLED=0 注: これにより、Studio と Robot の両方のテレメトリが無効化されます。 テレメトリを有効化する場合は、このパラメーターを含めないか、次の値と一緒に含めます。 TELEMETRY_ENABLED=1 使用状況データの収集機能と、テレメトリの設定の変更方法の詳細については、「テレメトリをオプトアウトする」をご覧ください。
ENABLE_PIP	コマンドラインから UiPath をインストールするときに、マシンのピクチャ イン ピクチャ機能を有効化することができます。 そのためには、以下のパラメーターを使用します。 ENABLE_PIP=1 例： UiPathStudio.msi ADDLOCAL=DesktopFeature,Studio,Robot,RegisterService,Packages ENABLE_PIP=1
INSTALLER_LANGUAGE	インストーラーの表示言語を選択できます。指定しない場合、Windows の言語設定によってインストーラーの言語が決定されます。言語を指定するには、INSTALLER_LANGUAGE=<language_code> パラメーターを入力します。次のオプションが利用できます。 中国語 (簡体字): INSTALLER_LANGUAGE=2052 英語: INSTALLER_LANGUAGE=9 フランス語: INSTALLER_LANGUAGE=12 ドイツ語: INSTALLER_LANGUAGE=7 日本語: INSTALLER_LANGUAGE=17 韓国語: INSTALLER_LANGUAGE=1 ポルトガル語 (ポルトガル): INSTALLER_LANGUAGE=22 ポルトガル語 (ブラジル): INSTALLER_LANGUAGE=1046 ロシア語: INSTALLER_LANGUAGE=25 スペイン語 (スペイン): INSTALLER_LANGUAGE=10 スペイン語 (メキシコ): INSTALLER_LANGUAGE=2058 トルコ語: INSTALLER_LANGUAGE=31
ORCHESTRATOR_AUTO_SIGNIN	Attended ロボットをユーザー モードでインストールする場合、Azure Active Directory で SSO を使用するよう環境設定されていると、アカウントへの自動サインインが有効化されます。このパラメーターは ORCHESTRATOR_URL と一緒に使用する必要があります。 このオプションを有効化するには、ORCHESTRATOR_AUTO_SIGNIN=1 を使用します。
ENFORCE_DEFAULT_SERVICE_URL	ユーザー モードのインストールの場合、このパラメーターは既定のサービス URL を適用します。 このオプションを有効化するには、ENFORCE_DEFAULT_SERVICE_URL=1 を使用します。 ORCHESTRATOR_URL も有効化する必要があります。

同期インストールを実行する

インストールの完了後に追加の設定を行う場合は、インストーラーを同期的に実行できます。これにより、インストーラーの完了後に実行する他のコマンドを追加できます。たとえば、インストールに続いて、ロボット接続の設定やフィードの設定ができます。

次のスクリプトでは、インストールを実行し、インストールが成功した場合に実行する他のコマンドを追加できます。

:: 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"
)

例

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

• Studio のインストールと Robot の 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 をインストールし、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
• Chrome 拡張機能をアンインストールします。 - UiPathStudio.msi REMOVE=ChromeExtension /Q

• Attended ロボットのインストール中に自動更新接続を設定します。-

  UiPathStudio.msi ADDLOCAL=DesktopFeature,Robot, SERVICE_URL="https://demo.uipath.com/myorg/mytenant"

• Unattended ロボットのインストール中に自動更新接続を設定します。-

  UiPathStudio.msi ADDLOCAL=DesktopFeature,Robot,RegisterService ORCHESTRATOR_URL="https://demo.uipath.com/myorg/mytenant/orchestrator_"