UiPath Platform Installer - コマンドラインからインストールする

uipath-platform-installer

latest

false

UiPath Platform Installer ユーザーガイド

ユーザーガイド
- はじめに
- デスクトップクライアントをインストールする
- コマンドラインからインストールする
- macOS にインストールする (プレビュー)
- クラシック MSI から移行する
- 更新を延期する

重要 :

このコンテンツの一部は機械翻訳によって処理されており、完全な翻訳を保証するものではありません。新しいコンテンツの翻訳は、およそ 1 ～ 2 週間で公開されます。 (1)

コマンドラインからインストールする

サポートされている UiPathPlatform.msi のパラメーターと設定ファイルを使用して、コマンドラインから対話モードまたはサイレントモードで UiPath デスクトップクライアントをインストールします。

UiPath Platform Installer (UiPathPlatform.msi) を使用して、UiPath デスクトップクライアントをコマンドラインからインストールできます。サポートされている MSI パラメーターを使って、完全な対話型モードまたは完全なサイレントモードのいずれでも実行できます。サイレントモードは、無人デプロイを目的としています。対話型インストールについては、「デスクトップクライアントをインストールする」をご覧ください。

構文

msiexec /i UiPathPlatform.msi [PARAMETER=value ...] [/qn]
msiexec /i UiPathPlatform.msi [PARAMETER=value ...] [/qn]

パラメーターは、パッケージパスの後に PARAMETER=value のペアとして渡されます。スペースを含む値は二重引用符で囲んでください。

インストールモード

モード	条件分岐 (switch)	説明
完全な対話型	(省略)	完全な UI でインストールウィザードを実行します。ユーザーには、進行状況とプロンプトが表示されます。
完全なサイレント	`/qn`	ユーザーインターフェイスやダイアログを一切表示せずに実行されます。無人デプロイに必要です。

注:

無人インストールには /qn を使用してください。部分 UI モード (/qb、/qr) は無人シナリオではサポートされていません。インストーラーによってブロックするダイアログが表示される可能性があるためです。

サポートされているパラメーター

パラメーター	値	既定 (Default)	説明
`FORCE_PERUSER`	`1`	—	現在のユーザーが管理者であっても、ユーザー単位のインストールを強制します。
`CHANNEL`	`sts`	`sts` `UiPathPlatformSTS.msi`の場合、`community` `UiPathPlatform.msi` の場合	プラットフォームがたどる更新チャネル。いずれかのインストーラーで Enterprise STS チャネルをインストールするには、 `CHANNEL=sts` を渡します。
`PLATFORM_CONFIGURATION_FILE`	絶対ファイルパス	—	インストール時に適用される製品構成ファイルへのパスです。
`UPDATER_CONFIGURATION_FILE`	絶対ファイルパス	—	インストール時に適用されるアップデーター固有の構成ファイルへのパスです。
`TELEMETRY_ENABLED`	`1` = 有効、`0` = 無効	enabled	テレメトリデータを送信するかどうかを制御します。
`INSTALLER_LANGUAGE`	`de`、`en`、`es`、`es-MX`、`fr`、`ja`、`ko`、`pt-BR`、`pt`、`ro`、`ru`、`tr`、`zh-CN`、`zh-TW`	システム言語	インストールウィザードの UI 言語です。サイレントモードでは影響しません。

インストール範囲

インストーラーの既定値はユーザー単位のインストールです。次のいずれかに当てはまる場合は、マシン単位のインストールに切り替わります。

msiexec は管理者特権 (管理者) コマンドプロンプトから、または Microsoft Intune や Configuration Manager などの展開ツールから SYSTEM として管理者特権で実行されます。これはサイレントインストールにも当てはまります。
管理者はインストールを対話モードで実行し、ユーザーアカウント制御を使用して管理者権限を昇格させることができます。

管理者特権ではないプロンプトから開始されたサイレントインストールは、管理者であっても管理者ごとのインストールにとどまります。これは昇格を求めるプロンプトを表示できないためです。

注:

UiPath では、マシン単位のインストールを推奨しています。これにより、デスクトップクライアントをすべてのユーザーが利用できるようにし、一元管理できます。

管理者であってもユーザー単位のインストールを強制するには、FORCE_PERUSER=1 を渡します。
マシン単位のサイレントインストールの場合は、管理者特権で msiexec を実行するか、 SYSTEMとしてデプロイします。

例

対話型インストール

既定のチャネル、フルウィザード:

msiexec /i UiPathPlatform.msi
msiexec /i UiPathPlatform.msi

特定のチャネルと構成ファイル:

msiexec /i UiPathPlatform.msi CHANNEL=sts PLATFORM_CONFIGURATION_FILE="C:\Config\platformConfig.json"
msiexec /i UiPathPlatform.msi CHANNEL=sts PLATFORM_CONFIGURATION_FILE="C:\Config\platformConfig.json"

管理者にユーザー単位のインストールを強制:

msiexec /i UiPathPlatform.msi FORCE_PERUSER=1
msiexec /i UiPathPlatform.msi FORCE_PERUSER=1

サイレントインストール

ユーザー単位、既定のチャネル:

msiexec /i UiPathPlatform.msi /qn
msiexec /i UiPathPlatform.msi /qn

特定のチャネル、構成ファイルを指定し、テレメトリを無効化したサイレントインストール:

msiexec /i UiPathPlatform.msi CHANNEL=sts PLATFORM_CONFIGURATION_FILE="C:\Config\platformConfig.json" TELEMETRY_ENABLED=0 /qn
msiexec /i UiPathPlatform.msi CHANNEL=sts PLATFORM_CONFIGURATION_FILE="C:\Config\platformConfig.json" TELEMETRY_ENABLED=0 /qn

Intune や Configuration Manager ( SYSTEMとして実行) などのデプロイツールからのマシンごとのサイレントインストールと、詳細なインストールログ:

msiexec /i UiPathPlatformSTS.msi PLATFORM_CONFIGURATION_FILE="C:\Config\platformConfig.json" /qn /l*v "C:\Windows\Temp\UiPathPlatform-install.log"
msiexec /i UiPathPlatformSTS.msi PLATFORM_CONFIGURATION_FILE="C:\Config\platformConfig.json" /qn /l*v "C:\Windows\Temp\UiPathPlatform-install.log"

企業プロキシ (アップデーター構成ファイルを介して提供されるプロキシ) の背後でクリーンインストールを実行:

msiexec /i UiPathPlatform.msi UPDATER_CONFIGURATION_FILE="C:\Config\updaterConfig.json" /qn
msiexec /i UiPathPlatform.msi UPDATER_CONFIGURATION_FILE="C:\Config\updaterConfig.json" /qn

設定ファイル

platformConfig.json (`PLATFORM_CONFIGURATION_FILE`)

インストールするデスクトップクライアントと製品固有のパラメーターを選択します。

このファイルには、製品ごとに 1 つのエントリを含む Packages リストが含まれています。

フィールド	説明
`PackageName`	「利用可能な製品」に記載されているとおりの製品名です。この名前では大文字と小文字が区別されます。名前が製品と一致しないエントリは無視されます。
`InstallRequested`	`true` 製品をインストールするファイルに存在しない製品、または `false`に設定されている製品はインストールされません。
`Parameters`	文字列のキーと値のペアとしての製品固有の設定`{}`製品に設定が必要ない場合に使用します。詳しくは、「製品パラメーター」をご覧ください。

利用可能な製品

`PackageName`	インストール	Also list (必須)	オプションのコンパニオン
`Studio`	Studio (オプションの Studio レガシパッケージとアクティビティパッケージを含む)	`Robot`, `Runtimes`	`Assistant`, `BrowserExtensions`
`Robot`	Robot (オプションのライブストリーミングパッケージを含む)	`Runtimes`	`BrowserExtensions`
`Assistant`	Assistant	`Robot` (したがって `Runtimes`)	—
`BrowserExtensions`	ブラウザーおよびリモートデスクトップ拡張機能	—	—
`Runtimes`	他のデスクトップクライアントが依存するランタイム`Robot`で必要であるため、`Studio` と `Assistant`で必要です。	—	—

重要:

必要な製品は自動的に追加されません。要求された製品に必要な製品も "InstallRequested": trueに設定されていない場合、インストールは失敗し、ロールバックされて終了コード 1603になります。詳しくは、「トラブルシューティング」をご覧ください。

Studio、Robot、または Assistant をインストールするすべての構成には、"InstallRequested": trueでRuntimesも含まれている必要があります。

必要な製品は現在の Enterprise STS リリースを反映しており、リリース間で変更される可能性があります。

例: Robot と Assistant

Robot、Assistant、およびそれらのランタイムをインストールし、Robot を Orchestrator に接続して、ポリシーを使用して Chrome 拡張機能と Edge 拡張機能をデプロイします。

{
  "Packages": [
    {
      "PackageName": "Robot",
      "InstallRequested": true,
      "Parameters": {
        "SERVICE_URL": "https://cloud.uipath.com/org/tenant/orchestrator_"
      }
    },
    {
      "PackageName": "Runtimes",
      "InstallRequested": true,
      "Parameters": {}
    },
    {
      "PackageName": "Assistant",
      "InstallRequested": true,
      "Parameters": {}
    },
    {
      "PackageName": "BrowserExtensions",
      "InstallRequested": true,
      "Parameters": {
        "INSTALL_CHROME_EXTENSION": "True",
        "INSTALL_EDGE_EXTENSION": "True",
        "CHROME_INSTALL_TYPE": "PolicyOnline",
        "EDGE_INSTALL_TYPE": "PolicyOnline"
      }
    }
  ]
}
{
  "Packages": [
    {
      "PackageName": "Robot",
      "InstallRequested": true,
      "Parameters": {
        "SERVICE_URL": "https://cloud.uipath.com/org/tenant/orchestrator_"
      }
    },
    {
      "PackageName": "Runtimes",
      "InstallRequested": true,
      "Parameters": {}
    },
    {
      "PackageName": "Assistant",
      "InstallRequested": true,
      "Parameters": {}
    },
    {
      "PackageName": "BrowserExtensions",
      "InstallRequested": true,
      "Parameters": {
        "INSTALL_CHROME_EXTENSION": "True",
        "INSTALL_EDGE_EXTENSION": "True",
        "CHROME_INSTALL_TYPE": "PolicyOnline",
        "EDGE_INSTALL_TYPE": "PolicyOnline"
      }
    }
  ]
}

例: Studio

アクティビティパッケージと共に Studio を、必要な Robot とランタイム、さらに Assistant と Edge 拡張機能をインストールします。

{
  "Packages": [
    {
      "PackageName": "Studio",
      "InstallRequested": true,
      "Parameters": {
        "INSTALL_ACTIVITIES": "True"
      }
    },
    {
      "PackageName": "Robot",
      "InstallRequested": true,
      "Parameters": {
        "INSTALL_ROBOTJS": "True",
        "SERVICE_URL": "https://cloud.uipath.com/org/tenant/orchestrator_"
      }
    },
    {
      "PackageName": "Runtimes",
      "InstallRequested": true,
      "Parameters": {}
    },
    {
      "PackageName": "Assistant",
      "InstallRequested": true,
      "Parameters": {}
    },
    {
      "PackageName": "BrowserExtensions",
      "InstallRequested": true,
      "Parameters": {
        "INSTALL_EDGE_EXTENSION": "True"
      }
    }
  ]
}
{
  "Packages": [
    {
      "PackageName": "Studio",
      "InstallRequested": true,
      "Parameters": {
        "INSTALL_ACTIVITIES": "True"
      }
    },
    {
      "PackageName": "Robot",
      "InstallRequested": true,
      "Parameters": {
        "INSTALL_ROBOTJS": "True",
        "SERVICE_URL": "https://cloud.uipath.com/org/tenant/orchestrator_"
      }
    },
    {
      "PackageName": "Runtimes",
      "InstallRequested": true,
      "Parameters": {}
    },
    {
      "PackageName": "Assistant",
      "InstallRequested": true,
      "Parameters": {}
    },
    {
      "PackageName": "BrowserExtensions",
      "InstallRequested": true,
      "Parameters": {
        "INSTALL_EDGE_EXTENSION": "True"
      }
    }
  ]
}

製品パラメータ

パラメーター名では大文字と小文字が区別されます。Boolean パラメーターは、 True または False (任意の文字の場合) を受け入れます。その他の値 ( 1 や 0など) は無視されて警告が表示され、既定値が使用されます。認識できないパラメーター名は無視されます。特に指定がない限り、Boolean パラメーターは既定で False に設定されます。

ほとんどのパラメーターは、同じ名前のクラシック MSI コマンドラインパラメーターと一致します。Studio パッケージと Robot パッケージが分離されていたため、Robot と Orchestrator の接続設定は Studioではなく Robotに属します。

Studio

パラメーター	値	説明
`INSTALL_ACTIVITIES`	`True`, `False`	アクティビティパッケージをインストールします。
`INSTALL_STUDIO_LEGACY`	`True`, `False`	Studio レガシをインストールします。
`INSTALL_EXCEL_ADDIN`	`True`, `False`	Excel アドインをインストールします。Microsoft Excel および Visual Studio Tools for Office ランタイム 10.0.50325 以降が必要です。
`INSTALL_SAP_SOLMAN`	`True`, `False`	SAP Solution Manager の連携をインストールします。マシンに SAP Connector for Microsoft と `SAP_SOLMAN_HOST`が必要です。
`SAP_SOLMAN_HOST`	ホスト名または IP アドレス	SAP Solution Manager のホスト。マシンで解決する必要があります。

Robot

パラメーター	値	説明
`SERVICE_URL`	絶対 URL	ロボットが接続する Orchestrator URL。
`REGISTER_ROBOT_SERVICE`	`True`, `False`	Robot を Windows サービス (無人) として登録します。
`DISABLE_SECURE_XAML`	`True`, `False`	Windows サービスとして登録されたロボットの場合、は XAML ファイルの保護を無効化し、ユーザーがプロセスファイルを読み取って変更できるようにします。`False` により、XAML ファイルがセキュリティで保護されます。
`INSTALL_ROBOTJS`	`True`, `False`	Robot JavaScript アドオンをインストールします。ユーザー単位のインストールおよび有人インストールの場合は、常にインストールされます。
`INSTALL_LIVE_STREAMING`	`True`, `False`	ライブストリーミングパッケージをインストールします。
`ORCHESTRATOR_AUTO_SIGNIN`	`True`, `False`	Microsoft Entra ID によるシングルサインオンを使用する環境にユーザー単位でインストールされた Attended ロボットの場合、ユーザーは自動的にサインインします。`SERVICE_URL`が必要です。`REGISTER_ROBOT_SERVICE=True`またはクライアントの資格情報と組み合わせることはできません。
`ENFORCE_DEFAULT_SERVICE_URL`	`True`, `False`	ユーザー単位のインストールの場合は、を既定の Orchestrator URL として `SERVICE_URL` 適用します。`SERVICE_URL`が必要です。
`ORCHESTRATOR_CLIENT_ID`, `ORCHESTRATOR_CLIENT_SECRET`	文字列	Unattended ロボットのクライアント資格情報です。両方を、 `SERVICE_URL` と `REGISTER_ROBOT_SERVICE=True`と一緒に設定します。
`LICENSE_KEY`	文字列	ロボットのライセンスキー。
`NUGET_OPTIONS`	`EnableOnlineFeeds`, `DisableOnlineFeeds`	`DisableOnlineFeeds` オフライン環境の場合、ロボットの UiPath 公式フィードとコミュニティオンラインフィードをオフにします。既定値は `EnableOnlineFeeds`です。
`CUSTOM_NUGET_FEEDS`	`name,url;name2,url2`	カスタムアクティビティフィードを追加または更新します。フィードには、URL、フォルダーパス、またはネットワーク共有を使用できます。
`ENFORCE_SIGNED_EXECUTION`	`True`, `False`	Robot に対し、UiPath が署名したパッケージをダウンロード、インストール、および実行する程度を制限します。追加の証明書は、インストール後に `nuget.config` に追加することで信頼できます。
`PACKAGES_FOLDER`	フォルダーパス	ワークフローとその依存関係のダウンロード場所。既定値は `%userProfile%\.nuget\packages`です。
`INSTALL_WEBVIEW`	`True`, `False`	インストール時に Microsoft からダウンロードした Microsoft Edge WebView2 ランタイムをインストールします (インターネットへのアクセスが必要)。ダウンロードに失敗した場合、ランタイムはスキップされ、インストールは続行されます。

Assistant

パラメーター	値	説明
`ASSISTANT_OPTIONS`	`DisableMarketplace`, `EnableMarketplace`	Marketplace ウィジェットの非表示と表示を切り替えます。省略すると、マシンの現在の設定が保持されます。

ブラウザー拡張機能

パラメーター	値	説明
`CHROME_INSTALL_TYPE`, `EDGE_INSTALL_TYPE`	`PolicyOnline`、`PolicyOffline`、`ManualPerMachine`、`ManualPerUser`、`NativeHostOnly`、`None`	Chrome または Edge 拡張機能のデプロイ方法値では大文字と小文字が区別されません。
`INSTALL_CHROME_EXTENSIONINSTALL_EDGE_EXTENSION`、`INSTALL_FIREFOX_EXTENSION`	`True`, `False`	目的のブラウザー用の拡張機能をインストールします。
`INSTALL_JAVA_EXTENSION`, `INSTALL_SILVERLIGHT_EXTENSION`	`True`, `False`	Java または Silverlight 拡張機能をインストールします。
`INSTALL_CITRIX_CLIENT_EXTENSION`、`INSTALL_RDP_CLIENT_EXTENSION`、`INSTALL_VMWARE_CLIENT_EXTENSION`、`INSTALL_AWS_WORKSPACES_CLIENT_EXTENSION`	`True`, `False`	そのリモートデスクトップクライアントの拡張機能をインストールします。

レガシインストールの種類の値である GLOBAL ( ManualPerMachineに相当) と STORE ( PolicyOnlineに相当) は引き続き使用できます。それ以外の値はとして扱われ None。

INSTALL_*_EXTENSION パラメーターを省略すると、拡張機能は現在のステートを維持します。つまり、クリーンインストールではインストールされず、インストールを変更またはアップグレードしても、インストール済みの拡張機能はインストールされたままになります。

ランタイム

Runtimes はパラメーターを受け取りません。"Parameters": {}を使用します。

警告:

構成ファイルはプレーンテキストとして読み取られます。ORCHESTRATOR_CLIENT_SECRET や LICENSE_KEYなどのシークレットが含まれている場合は、ファイルへのアクセスを制限し、インストールの完了後に、インストーラーが %TEMP%\UiPathConnected\に書き込むコピーとともに削除します。

updaterConfig.json (`UPDATER_CONFIGURATION_FILE`)

アップデーターを設定します。ここでプロキシ設定が指定されます。マシン単位のインストールでは、プロキシはシステム全体で使用するために保持されます。

最小プロキシ構成:

{
  "Proxy": {
    "ProxyAddress": "http://proxy.corp:8080",
    "BypassLocalAddresses": true
  }
}
{
  "Proxy": {
    "ProxyAddress": "http://proxy.corp:8080",
    "BypassLocalAddresses": true
  }
}

認証とバイパスリストを使用するプロキシ:

{
  "Proxy": {
    "ProxyAddress": "http://proxy.corp:8080",
    "BypassList": "localhost;*.corp.local",
    "BypassLocalAddresses": true,
    "UserName": "proxyuser",
    "Password": "proxypassword",
    "Domain": "CORP"
  }
}
{
  "Proxy": {
    "ProxyAddress": "http://proxy.corp:8080",
    "BypassList": "localhost;*.corp.local",
    "BypassLocalAddresses": true,
    "UserName": "proxyuser",
    "Password": "proxypassword",
    "Domain": "CORP"
  }
}

または、固定アドレスの代わりにプロキシ自動構成 (PAC) スクリプトを使用することもできます。

{
  "Proxy": {
    "ScriptAddress": "http://proxy.corp/proxy.pac"
  }
}
{
  "Proxy": {
    "ScriptAddress": "http://proxy.corp/proxy.pac"
  }
}

注:

ProxyAddress と ScriptAddress は相互に排他的です。UserName を設定する場合は、Password も設定する必要があります。

トラブルシューティング

失敗したインストールを調査するには、msiexec コマンドに /l*v "<log path>" を追加して、詳細なインストールログをキャプチャします。

インストールは終了コード 1603 で失敗し、ロールバックされます

詳細なログに Command executed with exit code: 80が含まれている場合、デスクトップクライアント自体のインストールは失敗しています。原因は、インストーラーのログにあります。

インストール範囲	インストーラーのログ
マシンごと	`%SystemRoot%\SystemTemp\UiPath.Connected.Installer.CLI.<yyyy-MM-dd>.log` ( `SystemTemp` フォルダーのない Windows バージョンでは、 `%SystemRoot%\Temp`)
ユーザーごと	`%TEMP%\UiPath.Connected.Installer.CLI.<yyyy-MM-dd>.log`

一般的な原因は、必要な製品を含まない製品を要求する構成ファイルです。インストーラーのログには次のような行が含まれます。

Missing required dependencies. The following products must also be installed: Runtimes (required by Robot)
Missing required dependencies. The following products must also be installed: Runtimes (required by Robot)

これを修正するには、以下の手順を実行します。

「利用可能な製品」に示すように、表示されている製品を "InstallRequested": trueを使用して構成ファイルに追加します。
インストールを再度実行します。

このページは役に立ちましたか?

前へデスクトップクライアントをインストールする

次へmacOS にインストールする (プレビュー)

構文​

インストール モード​

サポートされているパラメーター​

インストール範囲​

例​

対話型インストール​

サイレントインストール​

設定ファイル​

platformConfig.json (PLATFORM_CONFIGURATION_FILE)​

利用可能な製品​

例: Robot と Assistant​

例: Studio​

製品パラメータ​

updaterConfig.json (UPDATER_CONFIGURATION_FILE)​

トラブルシューティング​

インストールは終了コード 1603 で失敗し、ロールバックされます​