- 基本情報
- 要件
- ベスト プラクティス
- インストール
- 更新
- Identity Server
- 起動エラーのトラブルシューティング
Windows インストーラー
UiPathOrchestrator.msi Windows インストーラーを使用して、シングルノード環境またはマルチノード環境に Orchestrator をインストールします。
UiPathOrchestrator.msi インストーラーを使用すると、必要に応じて Orchestrator をシングルノードまたはマルチノードでインストールできます。以下のセクションでは、シングルノードとマルチノードの両方の環境でインストールを正常に実行する方法について説明します。
含まれるサービス
Orchestrator のインストールに含まれるサービスは以下のとおりです。
- Orchestrator
- Identity Server
- Webhook
- リソース カタログ サービス
シングル ノードでのインストール
シングル ノードのインストールでは、共有する必要がないためセッションはメモリに保持されます。
- Windows インストーラー (
UiPathOrchestrator.msi) を実行します。UiPath Orchestrator セットアップ ウィザードが表示されます。 - [ ライセンス契約の条項に同意 します。] チェックボックスをオンにして契約の条項に同意し、[ インストール] を選択します。[製品機能の選択] ウィンドウが表示されます。
図 1. 製品機能
- Test Automation 機能を有効化すると、既定の名前 (
UiPathTestAutomation) でデータベースが作成されます。別の名前を選択する場合は、コマンド ラインTA_DATABASE_NAME=<MyCustomDB>で名前を渡します。 - Test Automation データベースは、Orchestrator データベースから分離することも、Orchestrator データベースの一部にすることもできます。
- Orchestrator とともに UiPath Insights および/または Test Automation 機能をインストールする場合に選択します。[ 次へ] を選択します。[ Orchestrator IIS 設定] のステップが表示されます。
図 2. Orchestrator IIS 設定
- IIS 設定に必要な変更を行います:
- Web サイト名 - Web サイトの名前です。既定では、
UiPath Orchestratorに設定されており、編集することはできません。 - Web サイト ポート - コンピューターと Orchestrator との間の通信を有効化するために使用するポートです。これは既定で
443に設定され、HTTPS を使用できます。別のポートを使用する場合は、以下で詳しく説明するように、Identity Server のパラメーターPUBLIC_URLにポートを追加してください。 - [このポートに対するファイアウォール ルールを追加 ] - 選択した場合は、このポートのファイアウォール ルールが自動的に追加され、お使いの端末のセキュリティが確保されます。
- SSL 証明書 - Orchestrator との接続のセキュリティ保護に使用する SSL 証明書のサブジェクトまたは拇印です。既定では、フル コンピューター名が入力されています。
- ポートの使用可否を検証 - このチェックボックスをオンにすると、指定された Web サイト ポートが使用可能かどうかを確認します。
- Web サイト名 - Web サイトの名前です。既定では、
- [ 次へ] を選択します。[ アプリケーション プール設定] のステップが表示されます。
図 3. Orchestrator アプリケーション プール設定
- 必要に応じて編集可能なオプションを設定します。
- 名前 - アプリケーション プールの名前です。これは既定で
UiPath Orchestratorに設定され、編集することはできません。 - ID - UiPath Orchestrator の Web サイトを実行する ID を選択することができます。次のオプションを使用できます。
- アプリケーション プールの ID - アプリケーション プールの既定の ID で Orchestrator Web サイトを実行します。
- カスタム アカウント - 指定された Windows ID または Domain ID で Orchestrator を実行します。このオプションを選択すると、[ユーザー名] フィールドと [パスワード] フィールドが表示されます。これらのフィールドで、実行する ID を指定できます。
- 名前 - アプリケーション プールの名前です。これは既定で
アプリケーション プール ID の詳細については、 Microsoft の公式ドキュメントをご覧ください。
- [次へ ] をクリックします。[Orchestrator データベース設定] の手順が表示されます。
図 4. Orchestrator データベース設定
- 次のように、お使いの SQL Server に関する情報をフィールドに入力します。
- SQL Server ホスト - SQL Server マシンの名前です。既定では、localhost (
.) に設定されています。これが既定のインスタンスではない場合は、MyMachine\MyInstanceの形式で既定のインスタンスを記述してください。また、MyMachine\MyInstance,800などのようにコンマを使用してここでカスタムポート番号を指定することもできます。 - データベース名 - データベースの名前です。既定では、
UiPathに設定されています。特殊文字 (空白スペース、\、/、*、:、;、?、"、<、>、|) はサポートされていません。長さは最大 123 文字です。 - 認証モード -UiPath Orchestrator の Web サイトの認証モードを選択できます。次のオプションを使用できます。
- Windows 統合認証 - これが既定のオプションです。このオプションを選択すると、Orchestrator は検出された IIS アプリケーション プールの Windows アカウントを用いてデータベースに接続し、ユーザーが現在のログインに使用した Windows の資格情報を使用してデータベースを作成します。
- SQL Server 認証 - このオプションを選択すると、[SQL ユーザー名] フィールドと [パスワード] フィールドが表示されます。これらのフィールドには SQL サーバーのユーザー名とパスワードを入力する必要があります。詳細については前提条件についてのセクションをご覧ください。
注:
パスワードはセミコロン (
;3 ) の使用をサポートしていません。
- [次へ] をクリックします。インストーラーにより SQL 接続が検証されます。SQL 接続が有効でない場合、ダイアログ ボックスが表示されます。SQL 接続が有効な場合は、[Identity Server の設定] のステップが表示されます。
注:
Identity Server は Orchestrator とともに提供される、UiPath 製品の認証とアクセス制御を集中管理するためのサービスです。
- SQL Server ホスト - SQL Server マシンの名前です。既定では、localhost (
図 5. Identity Server の設定
大規模なデプロイの場合は、Identity Server 用に別のデータベースを使用することをお勧めします。
- 次のように、Identity Server に関する情報をフィールドに入力します。
- データベース名 - データベースの名前です。既定では Orchestrator データベースの名前ですが、変更できます。これらの特殊文字 (空白スペース、
\、/、*、:、?、"、<、>、|) はサポートされていません。長さは最大 123 文字です。 - Orchestrator パブリック URL - Identity Server が接続する Orchestrator の URL です。マルチノードのシナリオでは、これはユーザーが Orchestrator のインストールを呼び出すときに使用する、ロード バランサーの URL です (例: https://orchestrator.mydomain.local)。
- データベース名 - データベースの名前です。既定では Orchestrator データベースの名前ですが、変更できます。これらの特殊文字 (空白スペース、
既定では、Orchestrator のパブリック URL は https://<host name> に設定されています。これは、既定の Web サイト ポート (443) を使用する場合にのみ適用されることに注意してください。カスタム ポートを使用する場合、Orchestrator のパブリック URL は https://<host name>:<custom port> です。たとえば、Web サイト ポートが 444 に設定されている場合、Orchestrator のパブリック URL は https://<host name>:444 です。
- 署名証明書 - Orchestrator と Identity Server 間の認証に使用するアクセス トークンの署名に使用する、証明書のサブジェクトまたは拇印です。
- [次へ] を選択します。 [更新サーバーのデータベース設定] の手順が表示されます。
図 6. 更新サーバーのデータベース設定
- 次のように、更新サーバー データベースに関する情報をフィールドに入力します。
- SQL Server ホスト - SQL Server マシンの名前です。既定では、localhost (
.) に設定されています。localhost が既定のインスタンスではない場合は、必ずMyMachine\MyInstanceの形式で既定のインスタンスを記述してください。また、ここでMyMachine\MyInstance,800のようにコンマを使用してカスタム ポート番号を指定することもできます。 - データベース名 - 更新サーバーが使用するデータベースの名前です。既定ではこれは Orchestrator データベースの名前ですが、変更できます。次の特殊文字はサポートされていません: 空白スペース、
\、/、*、:、?、"、<、>、|)。また、長さは最大 123 文字です。 - 認証モード - 更新サーバーの認証モードを選択できます。次のオプションを使用できます。
- Windows 統合認証 - これが既定のオプションです。このオプションを選択すると、Orchestrator は検出された IIS アプリケーション プールの Windows アカウントを用いてデータベースに接続し、ユーザーが現在のログインに使用した Windows の資格情報を使用してデータベースを作成します。
- SQL Server 認証 - このオプションを選択すると、[SQL ユーザー名] フィールドと [パスワード] フィールドが表示され、SQL Server のユーザー名とパスワードを入力する必要があります。詳細については、「 前提条件」の章をご覧ください。
注:
パスワードはセミコロン (
;3 ) の使用をサポートしていません。
- [次へ] をクリックします。[Elasticsearch ログ設定] のステップが表示されます。
- SQL Server ホスト - SQL Server マシンの名前です。既定では、localhost (
図 7. Orchestrator Elasticsearch ログ設定
- (任意) Elasticsearch インスタンスに関する情報をフィールドに次のように入力します。
- [URL] - 情報ログを記録する Elasticsearch URL。
- 認証要求 - Elasticsearch インスタンスに認証が必要かどうかを指定できます。選択された場合は、[ユーザー名] と [パスワード] の入力が必要です。
- ユーザー名 - Elasticsearch ユーザー名。
- パスワード - ElasticSearch のパスワードです。
注:
Elasticsearch を使用してログを記録しない場合は、[URL] フィールドを空のままとしてください。
- [次へ] をクリックします。[Orchestrator 認証設定] の手順が表示されます。
図 8. Orchestrator 認証設定
-
次のようにフィールドに入力します。
- ホストのパスワード - ホスト管理者のカスタム パスワードを設定します。パスワードは、8 ~ 33 文字にする必要があり、1 文字以上の英文字の小文字と 1 文字以上の数字を含める必要があります。
- パスワードを確認 - ホスト管理者のパスワードを確認します。
- 初回ログイン時にリセット - ホスト管理者の初回ログイン時にパスワードを強制的にリセットさせます。これは、ワンタイム パスワードとも呼ばれます。
- 既定のテナント パスワード - 既定のテナント管理者のカスタム パスワードを設定します。パスワードは、8~ 33 文字にする必要があり、1 文字以上の英文字の小文字と 1 文字以上の数字を含める必要があります。
- パスワードを確認 - 既定のテナント管理者のパスワードを確認します。
- 初回ログイン時にリセット - 既定のテナント管理者が初回ログイン時にパスワードを強制的にリセットさせます。これは、ワンタイム パスワードとも呼ばれます。
-
[次へ] を選択します。 Insights 機能を選択した場合は Insights の手順が表示されます。
注:Insights SQL Server の構成時には、
db_ownerロールを必ず選択してください。このロールは、データベース所有者のロールを追加するときに必要です。図 9.洞察 力 -
次のように、Insights インスタンスに関する情報をフィールドに入力します。
- [QL Server ホスト - Insights の SQL Server マシンの名前です。既定では、localhost (
.) に設定されています。これが既定のインスタンスではない場合は、MyMachine\MyInstanceの形式で既定のインスタンスを記述してください。また、MyMachine\MyInstance,800などのようにコンマを使用して、カスタム ポート番号をここで指定できます。 - データベース名 - データベースの名前です。既定では、
UiPathに設定されています。特殊文字 (空白スペース、\、/、*、:、;、?、"、<、>、|) はサポートされていません。長さは最大 123 文字です。 - 認証モード -UiPath Orchestrator の Web サイトの認証モードを選択できます。次のオプションを使用できます。
- Windows 統合認証 - これが既定のオプションです。このオプションを選択すると、Orchestrator は検出された IIS アプリケーション プールの Windows アカウントを用いてデータベースに接続し、ユーザーが現在のログインに使用した Windows の資格情報を使用してデータベースを作成します。
- SQL Server 認証 - このオプションを選択すると、[ユーザー名] フィールドと [パスワード] フィールドが表示されます。これらのフィールドには、SQL サーバーのユーザー名とパスワードを入力する必要があります。
- [次へ] をクリックします。Test Automation 機能を選択した場合は Test Automation の手順が表示されます。
- [QL Server ホスト - Insights の SQL Server マシンの名前です。既定では、localhost (
図 10. Test Automation のデータベース設定
- Test Automation インスタンスに関する情報を、次のようにフィールドに入力します。
- SQL Server ホスト - TA SQL Server マシンの名前です。既定では、localhost (
.) に設定されています。これが既定のインスタンスではない場合は、MyMachine\MyInstanceの形式で既定のインスタンスを記述してください。また、MyMachine\MyInstance,800のようにコンマを使用することで、ここでカスタム ポート番号を指定できます。 - データベース名 - データベースの名前です。特殊文字 (空白スペース、
\、/、*、:、;、?、"、<、>、|) はサポートされていません。長さは最大 123 文字です。 - 認証モード -UiPath Orchestrator の Web サイトの認証モードを選択できます。次のオプションを使用できます。
- Windows 統合認証 - これが既定のオプションです。このオプションを選択すると、Orchestrator は検出された IIS アプリケーション プールの Windows アカウントを用いてデータベースに接続し、ユーザーが現在のログインに使用した Windows の資格情報を使用してデータベースを作成します。
- SQL Server 認証 - このオプションを選択すると、[ユーザー名] フィールドと [パスワード] フィールドが表示されます。これらのフィールドには、SQL サーバーのユーザー名とパスワードを入力する必要があります。
注:
パスワードはセミコロン (
;3 ) の使用をサポートしていません。
- [次へ] をクリックします。
- SQL Server ホスト - TA SQL Server マシンの名前です。既定では、localhost (
- 目的の [ストレージの種類] と [ストレージの場所] を入力します。詳細についてはこちらをご覧ください。
- [ 次へ] を選択します。[ UiPath のインストールの準備完了 ] のステップが表示されます。
- [ インストール] を選択します。インストール プロセスが開始されます。Orchestrator は
C:\Program Files (x86)\UiPath\Orchestratorにインストールされます。重要:選択したインストール パスをダブルチェックします。インストール後に、ある場所から別の場所にインストールを移動することはできません。
- IIS マネージャーに移動します。
- Orchestrator サーバーを選択します。これにより、機能ビューが更新されます。
- 機能の委任をダブル選択 します。[機能の委任] ビューが表示されます。
- [ 認証] - [Windows ] を右クリックし、[ 読み取り/書き込み] を選択します。
- Web サイトを起動します。Orchestrator を使用できます。
注:
ホスト管理者としてログインするには、ライセンス購入時に UiPath から提供される認証情報 (不明な場合はお問い合わせください) を使用して、
hostを [テナント名] フィールドに書き込みます。 詳細についてはこちらをご覧ください。
マルチノードでのインストール
Orchestrator のマルチノード デプロイは、通信に REdis Serialization Protocol (RESP) を使用するため、このプロトコルを実装するあらゆるソリューションによる設定が可能です。 UiPath では、マルチノード Orchestrator での高可用性デプロイは、UiPath High Availability Add-on が使用されている場合にのみサポートされます。
マルチノード インストールの場合、CERTIFICATE_SUBJECT および IS_CERTIFICATE_SUBJECT パラメーターは必須です。Identity Server に異なる証明書が使用されている場合、Orchestrator と Identity Server の連携は機能しません。使用するパラメーター ファイルの値は、すべてのノードで共通の値である必要があります。共通の値にするためには次のような方法があります。
- ワイルドカードの証明書の使用 (
subject=*.domain.local) または - パブリック ロード バランサーと、すべてのノード (任意) の DNS 名が含まれるサブジェクトの別名 (SAN) 証明書の使用。これはセカンダリ ノードのインストールを行う前に、証明書を作成するタイミング、またはパラメーター ファイルの値を編集するタイミングのいずれかで使用します。 証明書はサブジェクトまたは拇印で入力できます。
プライマリ ノードで管理者権限でコマンド プロンプトを開き、次のコマンド ラインにより Orchestrator をインストールします。UiPathOrchestrator.msi OUTPUT_PARAMETERS_FILE=install.json REDIS_HOST=redis.corp.local REDIS_PASSWORD=secretPass STORAGE_TYPE=FileSystem STORAGE_LOCATION="RootPath=\\fileserver\Share" PUBLIC_URL=<Orchestrator_LoadBalancer_URL> CERTIFICATE_SUBJECT=*.domain.local IS_CERTIFICATE_SUBJECT=*.domain.local
使用できるパラメーターの詳細については、こちらをご覧ください。
マルチノードの Orchestrator で Test Automation を有効化するには、プライマリ ノードのインストール時にコマンド ラインに Test Automation のパラメーターを追加します。Test Automation のパラメーターのリストについては、「Test Automation のパラメーター」をご覧ください。
たとえば、Orchestrator のプライマリ ノードのインストールに使用するコマンド ラインを のように変更して、Test Automation を有効化できます。 UiPathOrchestrator.msi OUTPUT_PARAMETERS_FILE=install.json REDIS_HOST=redis.corp.local REDIS_PASSWORD=secretPass STORAGE_TYPE=FileSystem STORAGE_LOCATION="RootPath=\\fileserver\Share" PUBLIC_URL=<Orchestrator_LoadBalancer_URL> CERTIFICATE_SUBJECT=*.domain.local IS_CERTIFICATE_SUBJECT=*.domain.local ADDLOCAL="OrchestratorFeature,IdentityFeature,TestAutomationFeature" TA_DATABASE_NAME="" TA_DB_SERVER_NAME="<serverName>" TA_DB_AUTHENTICATION_MODE=SQL TA_DB_USER_NAME="<SQLAccountUserName>" TA_DB_PASSWORD="<SQLAccountPassword>"
既定のポート (6379) を使用しない場合は、REDIS_PORT パラメーターを使用して、インストール済みの RESP(REdis Serialization Protocol)ソリューションのポートを指定することもできます。High Availability Add-on では、ポート ID が使用されます 10000。
デプロイに Insights を含む場合は、Orchestrator のセカンダリ ノードをインストールする前に Insights のインストールを完了してください。
- すべてのセカンダリ ノードで、
UiPathOrchestrator.msiを使用し、コマンド ライン引数を指定して、Orchestrator をインストールします。この時、SECONDARY_NODEパラメーターを true に設定し、プライマリ ノードのインストール時に生成されたパラメーター ファイルを指定してください。また、パッシブ インストールでは進行状況バーとエラー ポップアップが表示されるため、/passiveパラメーターを使用することをお勧めします。Unattended インストールの場合のみ、/Qパラメーターを指定して、サイレント モードを選択します。
例: UiPathOrchestrator.msi SECONDARY_NODE=1 PARAMETERS_FILE=install.json /Q。
アプリケーション プールが起動され、Orchestrator インスタンスを使用できるようになります。 プライマリ ノードをインストールすると、データベースが初期化されます。セカンダリ ノードをセットアップする時点ではデータベースの初期化手順は不要になっています。
Test Automation がプライマリ ノードで有効化されている場合、構成は PARAMETERS_FILE に出力されます。この PARAMETERS_FILE JSON ファイルはその後、セカンダリ ノードのインストール時に入力として使用されます。
マルチノードの Orchestrator にノードを追加する
上記の方法では、最初のデプロイ時にプライマリ ノードとセカンダリ ノードをインストールし構成することを想定していますが、既存のノードからパラメーター ファイルを生成して、追加ノードのインストールに使用することもできます。
これには、Orchestrator インストール ディレクトリの Tools サブフォルダーにある Generate-ParametersFile.ps1 スクリプトを使用します。
- Orchestrator インストール ディレクトリの
Toolsサブフォルダーを開き、Generate-ParametersFile.ps1を実行します。注:認証に
appPoolIdentityを使用しない限り、appPoolカスタム ユーザー パスワードを渡す必要があります。 - JSON ファイルは、既存の Orchestrator の構成ファイルと環境に基づいて生成されます。
- このファイルを使用して、セカンダリ ノードのインストールを完了します (上記の 「マルチノードでのインストール」の手順 2)。
パッケージの格納に関する考慮事項
アクティビティ、ワークフロー、ライブラリなどの、すべてのパッケージのメタデータ (定義) は、検索とフィルターを高速化するために SQL データベースに保存されます。
これに加え、FileSystem または選択した Blob ストレージ (Azure、Amazon S3、または Minio) に実際のファイルと実行メディアを保存することもできます。この機能では、特に複雑なマルチノードの Orchestrator 環境では、より高性能なファイル同期を行えます。
パッケージの格納にどのストレージを使用するかを問わず、1 回のアップロード当たりの最大ファイル サイズは 28.6MB (IIS で定められた制限値) であることに留意してください。Amazon、Minio、FileSystem、Azure でこれを変更する方法については、 このページをご覧ください。