- リリース ノート
- 基本情報
- UiPath Assistant
- インストールとアップグレード
- ロボットの種類
- Robot のコンポーネント
- ライセンス
- Robot を Orchestrator に接続する
- プロセスとアクティビティ
- ログ
- Robot JavaScript SDK
- 特定のシナリオ
- トラブルシューティング
UiPathRobot.msi のコマンド ライン パラメーター
UiPathRobot.msi インストーラーを実行して Robot をインストールできます。
以下のセクションに、使用できるパラメーターの説明およびいくつかの使用例を示します。
- これらのコマンドを実行するには、管理者権限が必要です。
- msiexec.exe の
/passiveオプションを使用した無人モードのインストールの実行はサポートされていません。
以下の表に、使用できるすべてのコマンド ライン パラメーターのリストを示します。
パスを入力する際は、以下の点を考慮するようにしてください。
%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"'
- コマンド プロンプトでは、二重引用符 (
|
コマンド |
説明 |
|---|---|
|
|
特定の UiPath® 機能のサイレント モードでのインストールに対応していますが、ユーザー インターフェイスは表示されません。 |
|
|
インストーラーのログ ファイルを指定したパスに生成します。v2018.4.2 以降、Studio または Robot のライセンスをインストール時に取得した場合、このファイルにはライセンス情報も含まれます。 インストール プロセスの間に問題が発生した場合は、理由を問わず、UiPath のサポート チームにファイルを送信できます。 |
|
|
インストールする機能を選択できます。
ADDLOCAL を使用すると、このコマンドで指定した機能のみがインストールされます。ADDLOCAL を使用しないと、サービス モードの Robot、アクティビティ パッケージ、および JavaScript アドオンがインストールされます。
次のオプションがサポートされています。 DesktopFeature - Robot の機能をインストールすることを指定します。
Robot - Robot をユーザー モードまたはサービス モードでインストールし、さらに Assistant もインストールします。同時に DesktopFeature の指定が必要です。
注: Robot をサービス モードからユーザー モードに変換すると、Robot が元の NuGet パッケージ フォルダーの
.xaml ファイルにアクセスできなくなる場合があります。これを解決する方法について詳しくは、トラブルシューティング セクションの「移行後に NuGet パッケージにアクセスできない」をご覧ください。
StartupLauncher - Windows の起動時に Robot を実行します。同時に Robot 引数を指定する必要があります。
JavaBridge - Java アプリケーションに関して連携と自動化を向上させる目的で UiPath® Java Bridge をインストールします。Java Bridge をインストールする場合、インストールに通常より長い時間がかかる場合があります。同時に Robot 引数を指定する必要があります。
ChromeExtension - UiPath® Google Chrome 拡張機能をインストールします。同時に Robot 引数を指定する必要があります。
FirefoxExtension - 例: UiPathRobot.msi ADDLOCAL=Robot,ChromeExtension,FirefoxExtension /QEdgeExtension - UiPath Microsoft Edge (Chromium ベース) 拡張機能をインストールします。同時に Robot 引数を指定する必要があります。
CitrixClient - UiPath® Citrix クライアント拡張機能をインストールします。同時に Robot 引数を指定する必要があります。
JavaScriptAddOn - Robot のブラウザー埋め込みアドオンをインストールします。
VMwareExtension- VMware Horizon 向けの UiPath® 拡張機能をインストールします。同時に Robot 引数を指定する必要があります。
WindowsRdpExtension ^ Microsoft リモート デスクトップ向けの UiPath® 拡張機能をインストールします。同時に Robot 引数を指定する必要があります。
|
|
|
現在のユーザーにのみインストールできます。ユーザー単位でインストールするには、
MSIINSTALLPERUSER=1 を追加します。マシン単位でインストールする場合は、このパラメーターを含めないでください。
ユーザー単位のインストールでは、RegisterService、CitrixExtension、VMwareExtension、PACKAGES_FOLDER、CODE のオプションは使用できません。 |
|
|
Robot を指定の場所にインストールできます。 |
|
|
オフライン環境で作業する場合には、このパラメーターが推奨されます。このパラメーターを
DisableOnlineFeeds に設定すると、ロボット用のオンラインの UiPath® 公式フィードやコミュニティ フィードを無効化できます。こうすることで、Orchestrator フィードとローカル フィールドのみが考慮されます。
URL フィードは設定ファイルから削除されず、単に無視されるだけです。 これは、インストールにもアップグレードにも使用可能です。 |
|
|
Studio および/または Robot のワークフローとその依存関係のダウンロード場所を変更できます。このフォルダーは、ユーザー固有のフォルダー、またはマシンのすべてのユーザーがアクセスできるフォルダーです。このパラメーターは、サービス モードまたはユーザー モードのロボットの両方で使用できます。このパラメーターを入力しない場合、既定のフォルダーは
%userProfile%\.nuget\packages になります。
注: パッケージ フォルダーを変更する場合、プロセスを実行する必要があるすべてのユーザーがこのフォルダーに対する読み取りアクセス権を持っている必要があります。
インストール後にパッケージのダウンロード フォルダーを変更する方法について詳しくは、「アクティビティ パッケージを管理する」をご覧ください。 |
|
|
Studio や Robot 用にカスタムの NuGet アクティビティ フィードを追加できます。このコマンドは、既存のフィード リストの追加または更新のみを行います。 文字列型のキーと値のペアを設定する必要があります。有効な場所には、オンライン フィード、フォルダー パス、共有ネットワーク ドライブが含まれます。指定するフィードは、そのマシンのすべてのユーザーがアクセス可能なものにしてください。フィードはセミコロン (;) で区切ります。 例:
CUSTOM_NUGET_FEEDS="FeedName1,https://my.custom.nuget.feed; FeedName2,D:\Custom\Activities\Packages\"。
|
|
|
任意です。ロボットに署名付きパッケージのみを実行させるルールを適用できます。インスタンスのクリーン インストール時または更新時に使用できます。デプロイ時にこのパラメーターを指定しなかった場合、パッケージの署名は有効化されません。 次のオプションがサポートされています。
インストール後に署名済み実行を強制する方法については、「パッケージの署名」をご覧ください。 |
|
|
Robot インスタンスにライセンスを付与します。 |
CLIENT_SECRET および CLIENT_ID |
インストール時に、クライアント資格情報を使用してロボットを Orchestrator に自動的に接続します。 例:
UiPathRobot.msi ORCHESTRATOR_URL=https://demo.uipath.com/company/tenant/orchestrator_ CLIENT_ID=1234-abcd-1ab2-cd32-1111 CLIENT_SECRET=2143ndafj32k |
|
|
Chrome 拡張機能のインストール方法を選択できます。このパラメーターを設定するには、管理者権限でインストーラーを実行する必要があります。省略した場合は、最も適切なインストール方法が自動的に選択されます。 次のオプションがサポートされています。
注: 後方互換性を確保するため、古いインストール方法の名前 (
STORE、GLOBAL) が維持されています。
|
|
|
Edge 拡張機能のインストール方法を選択できます。このパラメーターを設定するには、管理者権限でインストーラーを実行する必要があります。省略した場合は、最も適切なインストール方法が自動的に選択されます。 次のオプションがサポートされています。
注: 後方互換性を確保するため、古いインストール方法の名前 (
STORE、GLOBAL) が維持されています。
|
|
|
Windows サービスとしてインストールされた Robot の
XAML ファイルのセキュリティを無効化できます。セキュリティ保護されていない XAML ファイルを使用すると、ユーザーはプロセス ファイルとロジックを読み取って変更できます。
次のオプションがサポートされています。
注: このパラメーターは、クリーン インストールまたは更新中にのみ使用できます。
|
|
|
ユーザーが対話型サインインを使用して接続する Orchestrator インスタンスの URL を定義できます。 指定した URL は、ユーザー モードの Robot についてのみ
uipath.config ファイルに保存されます。サービス モードのインストールの場合、この引数は無視されます。
インストーラーを実行して旧バージョンからの更新または既存のインストールの変更を行う際、Robot をサービス モードからユーザー モードに切り替える場合 (
RegisterService オプションは含めません)、このパラメーターを使用できます。
|
|
|
クリーン インストールでは、自動更新情報を取得するために使用する Orchestrator のメイン URL を指定できます (例:
https://orchestrator.local/organizationName/tenantName)。
|
|
|
使用状況データの収集機能は、Robot のインストール時に無効化できます。 テレメトリは Studio および Robot に対して既定で有効化されています。無効化するには、クリーン インストールまたは更新を実行するたびにパラメーターに次の値を使用します。
テレメトリを有効化する場合は、このパラメーターを含めないか、次の値と一緒に含めます。
使用状況データの収集機能と、テレメトリの設定の変更方法の詳細については、「テレメトリをオプトアウトする」をご覧ください。 |
|
|
コマンドラインから UiPath® 製品をインストールするときに、マシンのピクチャ イン ピクチャ機能を有効化できます。 そのためには、以下のパラメーターを使用します。
例：
|
|
|
インストーラーの表示言語を選択できます。指定しない場合、Windows の言語設定によってインストーラーの言語が決定されます。言語を指定するには、
INSTALLER_LANGUAGE=<language_code> パラメーターを入力します。次のオプションが利用できます。
|
ASSISTANT_OPTIONS | Assistant の Marketplace ウィジェットを有効化するか無効化するかを指定できます。
|
ORCHESTRATOR_AUTO_SIGNIN | Attended ロボットをユーザー モードでインストールする場合、Azure Active Directory で SSO を使用するよう環境設定されていると、アカウントへの自動サインインが有効化されます。このパラメーターは ORCHESTRATOR_URL と一緒に使用する必要があります。
このオプションを有効化するには、
ORCHESTRATOR_AUTO_SIGNIN=1 を使用します。 |
インストールの完了後に追加の設定を行う場合は、インストーラーを同期的に実行できます。これにより、インストーラーの完了後に実行する他のコマンドを追加できます。たとえば、インストールに続いて、ロボット接続の設定やフィードの設定ができます。
次のスクリプトでは、インストールを実行し、インストールが成功した場合に実行する他のコマンドを追加できます。
:: 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"
):: 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_"
