UiPathRobot.msi のコマンド ライン パラメーター

コマンド ラインから UiPathRobot.msi インストーラーを実行して Robot をインストールできます。

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

注:

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

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

使用可能なすべてのコマンド ライン パラメーターのリストを以下に示します。

• /q - 特定の UiPath 機能をサイレント モードでインストールします。ユーザー インターフェイスは表示されません。
• /l*vx <LogFile> - インストーラーのログ ファイルを指定したパスに生成します。インストール プロセスの間に問題が発生した場合は、理由を問わず、UiPath のサポート チームにファイルを送信できます。
• ADDLOCAL - インストールする機能を選択できます。このパラメーターを指定しないと、サービス モードの Robot、既定のアクティビティ パッケージ、および JavaScript アドオンの機能が既定でインストールされます。

  次のオプションがサポートされています。

  • DesktopFeature — Robot の機能をインストールすることを指定します。
  • Studio (UiPathStudio.msi の場合のみ)— Studio をインストールします。DesktopFeature パラメーターと一緒に使用する必要があります。
  • ExcelAddin (UiPathStudio.msi の場合のみ)— StudioX Excel アドインをインストールします。Studio パラメーターと一緒に使用する必要があります。
  • Robot — Robot をユーザー モードまたはサービス モードでインストールし、さらに Assistant もインストールします。DesktopFeature パラメーターと一緒に使用する必要があります。
  • RegisterService — サービス モードのインストールに必要です。ユーザー モードのインストールでは追加しないでください。
  • StartupLauncher — Windows の起動時に Robot を実行します。DesktopFeature パラメーターと一緒に使用する必要があります。
  • Packages (UiPathStudio.msi の場合のみ)— 既定のアクティビティ パッケージをインストールします。Robot パラメーターと一緒に使用する必要があります。
  • JavaBridge — Java アプリケーションとの連携と自動化を向上させる目的で UiPath Java Bridge をインストールします。このオプションを追加すると、インストール時間が長くなる可能性があります。Robot パラメーターと一緒に使用する必要があります。
  • ChromeExtension — Google Chrome 拡張機能をインストールします。Robot パラメーターと一緒に使用する必要があります。
  • FirefoxExtension — Firefox 拡張機能をインストールします。Robot パラメーターと一緒に使用する必要があります。
  • EdgeExtension — Microsoft Edge (Chromium ベース) 拡張機能をインストールします。Robot パラメーターと一緒に使用する必要があります。
  • CitrixClient — UiPath Citrix クライアント拡張機能をインストールします。Robot パラメーターと一緒に使用する必要があります。ユーザー単位のインストールでは利用できません。
  • JavaScriptAddOn — ブラウザー埋め込みアドオンをインストールします。Robot パラメーターと一緒に使用する必要があります。管理者権限では使用できません。
  • SapPlugin (UiPathStudio.msi の場合のみ)— SAP Solution Manager プラグインをインストールします。マシンに SAP Connector for Microsoft がインストールされている必要があります。クリーン インストールの場合は、SAP_SOL_MAN_HOST パラメーターを使用してインスタンスのアドレスを指定する必要もあります。Studio パラメーターと一緒に使用する必要があります。ユーザー単位のインストールでは利用できません。
  • VMwareExtension — VMware Horizon 向けの UiPath 拡張機能をインストールします。Robot パラメーターと一緒に使用する必要があります。ユーザー単位のインストールでは利用できません。
  • WindowsRdpExtension — Windows リモート デスクトップ向けの UiPath 拡張機能をインストールします。Robot パラメーターと一緒に使用する必要があります。
• MSIINSTALLPERUSER - 現在のユーザーにのみインストールできます。
  • ユーザー単位でインストールするには、MSIINSTALLPERUSER=1 を追加します。ユーザー単位のインストールでは、RegisterService、CitrixExtension、VMwareExtension、PACKAGES_FOLDER、CODE のオプションは使用できません。
  • マシン単位でインストールする場合は、このパラメーターを含めないでください。
• SAP_SOL_MAN_HOST (UiPathStudio.msi の場合のみ) - SAP Solution Manager インスタンスのホスト名または IP アドレスです。ADDLOCAL オプションに SapPlugin パラメーターが追加されているクリーン インストールに必要です。
• APPLICATIONFOLDER - Robot を指定の場所にインストールできます。
• NUGET_OPTIONS - オフライン環境向けです。このパラメーターを DisableOnlineFeeds に設定すると、ロボット用のオンラインの UiPath 公式フィードやコミュニティ フィードが無効化され、Orchestrator フィードとローカル フィードのみが使用されます。
  注: URL フィードは設定ファイルに残りますが、無視されます。

• PACKAGES_FOLDER

  • ワークフローとその依存関係のダウンロード場所を変更できます。フォルダーは、ユーザー固有のフォルダー、またはマシンのすべてのユーザーがアクセスできるフォルダーのいずれも選択できます。
  • このパラメーターを指定していない場合、既定のダウンロード場所は %userProfile%\.nuget\packages になります。

  • ユーザー単位のインストールでは利用できません。

    注: プロセスを実行する必要があるすべてのユーザーがこの新しいフォルダーに対する読み取りアクセス権を持っている必要があります。
  • セットアップ方法について詳しくは、こちらをご覧ください。
  • 同時接続実行が可能な Windows Server マシン上のインストールの場合は、各ユーザー固有のパスを指定する必要があります。詳しくはこちらをご覧ください。
  • インストール後にパッケージのダウンロード フォルダーを変更する方法について詳しくは、こちらをご覧ください。
• CUSTOM_NUGET_FEEDS - Studio および/または Robot にカスタムの NuGet アクティビティ フィードを追加できます。このコマンドは、既存のフィード リストの追加または更新のみを行います。String 型のキーと値のペアで設定する必要があります。
  • 有効な場所には、オンライン フィード、フォルダー パス、共有ネットワーク　ドライブが含まれます。
  • 指定するフィードは、そのマシンのすべてのユーザーがアクセス可能なものにしてください。

  • フィードはセミコロン (;) で区切ります。

    例:

    CUSTOM_NUGET_FEEDS="FeedName1,https://my.custom.nuget.feed; FeedName2,D:\Custom\Activities\Packages\"

• ENFORCE_SIGNED_EXECUTION - 任意です。ロボットに対して、署名されたパッケージのみを実行するよう強制できます。このパラメーターが指定されていない場合、パッケージの署名は有効化されません。 以下のオプションがあります。
  • 1 - ロボットは、UiPath が検証済みの作成者またはリポジトリによって署名されたパッケージのみを処理します。自分の証明書を信頼できるソースとして追加するには、nuget.config ファイルを変更します。
  • 0 - ロボットのデプロイに、パッケージ署名に関するルールは一切適用されません。
  詳しくは「パッケージに署名する」をご覧ください。
• CODE - Robot インスタンスにライセンスを付与します。ユーザー単位のインストールでは利用できません。
• CLIENT_ID と CLIENT_SECRET - インストール時に、クライアント資格情報を使用してロボットを Orchestrator に自動的に接続します。以下に例を示します。

  UiPathRobot.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 - グループ ポリシー (オンライン) により、Edge 拡張機能がシステムごとに自動的にインストールされます。これは、SetupExtensions ツールを使用して /Edge-Chromium-PolicyGlobal コマンドを呼び出すのと同じです。
  • 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 を定義できます。この値は uipath.config ファイルに保存されます。ユーザー モードのインストールに必要です。サービス モードのインストールでは、このパラメーターは無視されます。
• ORCHESTRATOR_URL - クリーン インストールでは、自動更新情報を取得するために使用する Orchestrator のメイン URL を指定できます。例: https://orchestrator.local/organizationName/tenantName。
• TELEMETRY_ENABLED - 使用状況データの収集を無効化できます。以下のオプションがあります。
  • 0 - Studio と Robot のテレメトリを無効化します。
  • 1 - 既定のオプションです。Studio と Robot のテレメトリを有効化します。
  テレメトリをオプトアウトする方法について詳しくは、こちらをご覧ください。
• ENABLE_PIP - マシンのロボット セッション (ピクチャ イン ピクチャ) 機能を有効化できます。以下のオプションがあります。
  • 0 - 既定のオプションです。ロボット セッション機能は無効化されます。
  • 1 - ロボット セッション機能を有効化します。
• INSTALLER_LANGUAGE - インストーラーの表示言語を選択できます。このパラメーターを指定しないと、Windows の言語設定が使用されます。以下のオプションがあります。
  • 2052 - 中国語 (簡体字)
  • 12 - フランス語
  • 7 - ドイツ語
  • 17 - 日本語
  • 1 - 韓国語
  • 22 - ポルトガル語 (ポルトガル)
  • 1046 - ポルトガル語 (ブラジル)
  • 25 - ロシア語
  • 10 - スペイン語 (スペイン)
  • 2058 - スペイン語 (メキシコ)
  • 31 - トルコ語
• ASSISTANT_OPTIONS - Assistant の Marketplace ウィジェットを有効化または無効化します。以下のオプションがあります。
  • 指定しないか EnableMarketplace - 既定のオプションです。ウィジェットを有効化します。
  • DisableMarketplace - ウィジェットを無効化します。
• ORCHESTRATOR_AUTO_SIGNIN - アカウントへの自動サインインを有効化します。ユーザー モードのインストールの場合、および Azure Active Directory で SSO を使用するよう設定されている環境の場合に使用します。ORCHESTRATOR_URL パラメーターと一緒に使用する必要があります。以下のオプションがあります。
  • 0 - 自動サインインを無効化します。
  • 1 - 自動サインインを有効化します。

コマンド ラインでパスを使用する

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

• %USERNAME% や %USERPROFILE% などの環境変数を使用する必要がある場合は、特殊文字 % は、次のようにエスケープする必要があります。
  • セットアップをコマンド プロンプトから呼び出した場合 - ^ - UiPathRobot.msi PACKAGES_FOLDER=C:\Some\Path\^%USERNAME^% を使用します。
  • バッチ スクリプトの場合 - ^ - UiPathRobot.msi PACKAGES_FOLDER=C:\Some\Path\^%USERNAME^% を使用します。
  • PowerShell コンソールまたはスクリプト - エスケーブは不要です。
  • Active Directory ドメイン アカウントを使用している場合は、フォルダー構造にもドメイン名を指定することを推奨します。例: C:\packages\^%UserDomain^%.^%Username^%
• 空白が含まれるパスを使用する必要がある場合は、次のようにパスをラップする必要があります。
  • コマンド プロンプトでは、二重引用符 (" ") で囲みます。例: UiPathRobot.msi APPLICATIONFOLDER="C:\folder name"
  • PowerShell では、一重引用符と二重引用符 ('" "') で囲みます。例: ./UiPathRobot.msi APPLICATIONFOLDER='"C:\folder name"'

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

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

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

:: Runnning the MSI synchronously
start /wait /b UiPathRobot.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"
)

例

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

• 現在のユーザーに対してのみ、ユーザー モードの Robot をインストールする - UiPathRobot.msi MSIINSTALLPERUSER=1 ADDLOCAL=DesktopFeature,Robot
• Robot のサイレント インストールを実行する - UiPathRobot.msi ADDLOCAL=DesktopFeature,Robot,RegisterService,StartupLauncher,JavaBridge /Q
• ポリシーを使用して、Robot と Chrome 拡張機能をサイレント モードでインストールする - UiPathRobot.msi ADDLOCAL=DesktopFeature,Robot,RegisterService,ChromeExtension CHROME_INSTALL_TYPE=POLICYONLINE /Q

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

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

• Robot を Windows サービスとしてサイレント モードでインストールし、2つのカスタム アクティビティ フィードを追加する - UiPathRobot.msi ADDLOCAL=DesktopFeature,Robot,RegisterService CUSTOM_NUGET_FEEDS="Feed Name1,https://my.custom.nuget.feed; FeedName2,D:\RPA\Activities\Packages\" /Q
• Robot をサイレント モードでインストールしてライセンスを付与し、Windows サービスとして登録して、ローカル アクティビティ フィードをインストールする - UiPathRobot.msi ADDLOCAL=DesktopFeature,Robot,RegisterService,CODE=1234567890 /Q
• Robot を Windows サービスとしてインストールし、オフィシャル オンライン フィードを無効化します。 - UiPathRobot.msi ADDLOCAL=DesktopFeature,Robot,RegisterService NUGET_OPTIONS=DisableOnlineFeeds
• Chrome 拡張機能をアンインストールします。 - UiPathRobot.msi REMOVE=ChromeExtension /Q

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

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

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

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