UiPath 製品のインストールとアップグレード

UiPath 製品のインストールとアップグレード ガイド

Windows インストーラー

🚧

重要!

このインストールを実行する前に、「前提条件」の章を読み、必要な準備をすべて完了してください。

単一ノードでのインストール

単一ノードのインストールでは、共有する必要がないためセッションはメモリに保持されます。

  1. Windows インストーラー (UiPathOrchestrator.msi) を実行します。UiPath Orchestrator セットアップ ウィザードが表示されます。
  2. [ライセンス契約の条項に同意する] チェック ボックスを選択して契約条項に同意し、[インストール] をクリックします。[製品機能] 選択ウィンドウが表示されます。

🚧

重要!

Test Automation 機能を有効化すると、既定の名前 UiPathTestAutomation を持つデータベースが作成されます。別の名前を選択する場合にはコマンド ライン TA_DATABASE_NAME=<MyCustomDB> 経由で名前を渡します。

  1. Orchestrator とともに Insights および/または Test Automation 機能をインストールする場合に選択します。[次へ] をクリックします。[Orchestrator IIS 設定] のステップが表示されます。
  1. IIS 設定に必要な変更を行います:
    • [ウェブサイト名 (Website name)] - ウェブサイトの名前です。既定では、UiPath Orchestrator に設定されており、編集することはできません。
    • [ホスト名 (Host name)] - Orchestrator のインストール先であるデバイスの特定に使用します。既定では、フルコンピューター名に設定されています。
    • Website Port - コンピューターと Orchestrator 間の接続に使用するポートです。これは既定で 443 に設定され、HTTPS が使用できます。
    • [このポートに対するファイアウォール ルールを追加 ] - 選択した場合は、このポートのファイアウォール ルールが自動的に追加され、お使いの端末のセキュリティが確保されます。
    • SSL certificate - the Subject or Thumbprint of the SSL certificate you want to use to secure connections with Orchestrator. By default, this is filled in with the full computer name.
    • [ポートの使用可否を検証 (Verify port availability)] - このチェックボックスを選択すると、指定されたウェブサイトポートが使用可能かどうかを確認します。
  2. [次へ (Next)] をクリックします。[アプリケーションプール設定 (Application Pool Settings)] の手順が表示されます。
  1. 必要に応じて編集可能なオプションを設定します。
    • 名前 - アプリケーションプールの名前です。これは既定で UiPath Orchestrator に設定され、編集することはできません。
    • ID - UiPath Orchestrator のウェブサイトを実行する ID を選択することができます。次のオプションを使用できます。
      • アプリケーション プールの ID - アプリケーションプールの既定の ID で Orchestrator ウェブサイトを実行します。
      • カスタムアカウント - 指定された Windows ID または Domain ID で Orchestrator を実行します。このオプションを選択すると、[ユーザー名 (User name)] フィールドと [パスワード (Password)] フィールドが表示されます。これらのフィールドで、実行する ID を指定できます。

アプリケーションプール ID の詳細については、 Microsoft の公式ドキュメントを参照してください。

  1. [次へ (Next)] をクリックします。[Orchestrator データベース設定 (Orchestrator Database Settings)] 手順が表示されます。
  1. 次のように、お使いの SQL Server に関する情報をフィールドに入力します。

📘

注:

データを移行するには、以前使用していた SQL Server データベースの情報を入力します。

  • [SQL Server ホスト (SQL Server Host)] - SQL Server マシンの名前です。既定では、localhost (.) に設定されています。これが既定のインスタンスではない場合は、MyMachine\MyInstance というフォーマットでそのことを記述してください。また、MyMachine\MyInstance,800 などのようにカンマを使用してここでカスタムポート番号を指定することもできます。
  • Database Name - the name of the database. By default, it is set to UiPath. Please note that the following special characters are not supported: an empty space,\, /, *, :, ;, ?, ", <, >, |, and the maximum length is 123 characters.
  • 認証モード -UiPath Orchestrator のウェブサイトの認証モードを選択できます。次のオプションを使用できます。
    • [Windows 統合認証 (Windows Integrated Authentication)] - これが既定のオプションです。このオプションを選択すると、Orchestrator は検出された IIS アプリケーションプールの Windows アカウントを用いてデータベースに接続し、ユーザーが現在のログインに使用した Windows の資格情報を使用してデータベースを作成します。詳細については、「前提条件」を参照してください。
    • SQL Server Authentication - If you select this option, the SQL Username and Password fields are displayed, which have to be filled in with the SQL Server username and password. For more information, see the Prerequisites chapter. Note: The password does not support the use of semicolons (;).
  1. [次へ] をクリックします。インストーラーにより SQL 接続が検証されます。SQL 接続が有効でない場合、ダイアログ ボックスが表示されます。SQL 接続が有効な場合は、[Identity Server の設定] のステップが表示されます。

📘

注:

Identity Server は Orchestrator とともに提供される、UiPath 製品の認証とアクセス制御を集中管理するためのサービスです。

🚧

重要!

大規模なデプロイの場合は、Identity Server 用に別のデータベースを使用することをお勧めします。

:warning: ウィザードの Orchestrator IIS 設定の手順のホスト名と、Identity Server 設定の手順の Orchestrator パブリック URL には同じ URL を入力してください。そうしないと、Orchestrator にアクセスする際にエラー Too many redirects が発生します。

  1. 次のように、Identity Server に関する情報をフィールドに入力します。
  • Database Name - the name of the database. By default, this is the name of the Orchestrator database, but can be changed. Please note that the following special characters are not supported: an empty space,\, /, *, :, ;, ?, ", <, >, |, and the maximum length is 123 characters.
  • Orchestrator Public URL - the URL of the Orchestrator to which the Identity Server connects. By default, it is set to https://<host name>. In a multi-node scenario, this would be the URL of the load balancer by which the user calls the Orchestrator installation (e.g. https://orchestrator.mydomain.local).
  • Signing Certificate - the Subject or Thumbprint of the certificate used to sign access tokens used for authentication between Orchestrator and Identity Server.
  1. [次へ] をクリックします。[Elasticsearch ログ設定] のステップが表示されます。
  1. (任意) Elasticsearch インスタンスに関する情報をフィールドに次のように入力します。
  • [URL] - 情報ログを記録する Elasticsearch URL。
  • 認証要求 - Elasticsearch インスタンスに認証が必要かどうかを指定できます。選択された場合は、[ユーザー名] と [パスワード] の入力が必要です。
    • [ユーザー名 (Username)] - Elasticsearch ユーザー名。
    • [パスワード (Password)] - ElasticSearch のパスワードです。

📘

注:

Elasticsearch を使用してログを記録しない場合は、[URL] フィールドを空のままとしてください。

  1. [次へ (Next)] をクリックします。[Orchestrator 認証設定 (Orchestrator Authentication Settings)] 手順が表示されます。
  1. 次のようにフィールドに入力します。
    • ホストのパスワード (Host password) - ホスト管理者のカスタムパスワードを設定します。パスワードは、8 文字以上にする必要があり、1 文字以上の英文字の小文字と 1 文字以上の数字を含める必要があります。
    • パスワードの確認入力 (Confirm password) - ホスト管理者のパスワードを確認します。
    • 初回ログイン時にリセット (Reset at first login) - ホスト管理者の初回ログイン時にパスワードを強制的にリセットさせます。これは、ワンタイムパスワードとも呼ばれます。
    • 既定のテナントパスワード (Default tenant password) - 既定のテナント管理者のカスタムパスワードを設定します。パスワードは、8 文字以上にする必要があり、1 文字以上の英文字の小文字と 1 文字以上の数字を含める必要があります。
    • パスワードの確認入力 (Confirm password) - 既定のテナント管理者のパスワードを確認します。
    • 初回ログイン時にリセット (Reset at first login) - 既定のテナント管理者が初回ログイン時にパスワードを強制的にリセットさせます。これは、ワンタイムパスワードとも呼ばれます。
    • [Windows 認証を有効にする (Enable Windows Authentication)] - 選択されている場合は、Windows 認証が Orchestrator 内で有効になり、[Active Directory ドメイン (Active Directory domain)] フィールドが表示されます。
      • Active Directory ドメイン - Orchestrator で使用する Active Directory ドメイン。ユーザーはここから追加されます。
  2. [次へ] をクリックします。Insights 機能を選択した場合は Insights の手順が表示されます。
  1. 次のように、Insights インスタンスに関する情報をフィールドに入力します。
  • [QL Server ホスト - Insights の SQL Server マシンの名前です。既定では、localhost (.) に設定されています。これが既定のインスタンスではない場合は、MyMachine\MyInstance の形式でそれを記述してください。また、MyMachine\MyInstance,800 などのようにカンマを使用して、カスタム ポート番号をここで指定できます。
  • Database Name - the name of the database. By default, it is set to UiPath. Please note that the following special characters are not supported: an empty space,\, /, *, :, ;, ?, ", <, >, |, and the maximum length is 123 characters.
  • 認証モード -UiPath Orchestrator のウェブサイトの認証モードを選択できます。次のオプションを使用できます。
    • Windows 統合認証 - これが既定のオプションです。このオプションを選択すると、Orchestrator は検出された IIS アプリケーション プールの Windows アカウントを用いてデータベースに接続し、ユーザーが現在のログインに使用した Windows の資格情報を使用してデータベースを作成します。
    • SQL Server Authentication - If you select this option, the SQL Username and Password fields are displayed, which have to be filled in with the SQL Server username and password. Note: The password does not support the user of semicolons (;).
  1. Click Next. If the Test Automation feature was selected, the Test Automation step is displayed.
  1. Fill in the fields with information about your Test Automation instance, as follows:
  • SQL Server host - the name of the TA SQL Server machine. By default, this is set to localhost (.). If it is not the default instance, please also mention it in the MyMachine\MyInstance format. You can also specify a custom port number here using a comma, such as MyMachine\MyInstance,800.
  • Database Name - the name of the database. Please note that the following special characters are not supported: an empty space,\, /, *, :, ;, ?, ", <, >, |, and the maximum length is 123 characters.
  • 認証モード -UiPath Orchestrator のウェブサイトの認証モードを選択できます。次のオプションを使用できます。
    • Windows 統合認証 - これが既定のオプションです。このオプションを選択すると、Orchestrator は検出された IIS アプリケーション プールの Windows アカウントを用いてデータベースに接続し、ユーザーが現在のログインに使用した Windows の資格情報を使用してデータベースを作成します。
    • SQL Server Authentication - If you select this option, the SQL Username and Password fields are displayed, which have to be filled in with the SQL Server username and password. Note: The password does not support the use of semicolons (;).
  1. [次へ (Next)] をクリックします。[UiPath をインストールする準備ができました (Ready to install UiPath)] の手順が表示されます。
  2. [インストール (Install)] をクリックします。インストールプロセスが開始されます。Orchestrator は、C:\Program Files (x86)\UiPath\Orchestratorにインストールされます。
  3. IIS マネージャーに移動します。
  4. Orchestrator サーバーを選択します。これにより、機能ビューが更新されます。
  5. [機能の委任 (Feature Delegation)] をダブルクリックします。[機能の委任 (Feature Delegation)] ビューが表示されます。
  6. 認証 - Windows を右クリックし、読み取り/書き込みをクリックします。
  7. ウェブサイトを起動します。Orchestrator を使用できます。

📘

注:

ホスト管理者としてログインするには、ライセンス購入時に弊社のチームから提供される認証情報を使用して、host を [テナント名 (Tenant Name)] フィールドに書き込みます。詳細についてはこちらをご覧ください。

マルチノードでのインストール

🚧

重要!

Orchestrator のマルチノード デプロイは、通信に REdis Serialization Protocol (RESP) を使用するため、このプロトコルを実装するあらゆるソリューションによる設定が可能です。

UiPath では、マルチノード Orchestrator での高可用性デプロイは、UiPath High Availability Add-on が使用されている場合にのみサポートされます。

🚧

重要!

:warning: For multi-node installations the CERTIFICATE_SUBJECT and IS_CERTIFICATE_SUBJECT parameters are mandatory. Orchestrator-Identity Server integration does not work if different certifications are used for Identity. Its value in the parameters file used must be a common one across all nodes. This can be accomplished by using:

  • ワイルドカードの証明書の使用 (subject=*.domain.local) または
  • すべてのノードとロード バランサーの DNS 名が含まれるサブジェクトの別名 (SAN) 証明書の使用。これはセカンダリ ノードのインストールを行う前の、証明書を作成する際、またはパラメーター ファイルの値を編集する際のいずれかのタイミングで使用します。

Certificates can be entered by subject or thumbprint.

MSI インストール

  1. プライマリ ノードで管理者権限でコマンド プロンプトを開き、次のコマンド ラインにより Orchestrator をインストールします。UiPathOrchestrator.msi OUTPUT_PARAMETERS_FILE=myconfig.json REDIS_HOST=redis.corp.local REDIS_PASSWORD=secretPass STORAGE_TYPE=FileSystem STORAGE_LOCATION="RootPath=\\fileserver\Share" QUARTZ_CLUSTERED=1 PUBLIC_URL=<Orchestrator_LoadBalancer_URL> CERTIFICATE_SUBJECT=*.domain.local IS_CERTIFICATE_SUBJECT=*.domain.local

使用できるパラメーターの詳細については、こちらを参照してください。

📘

注:

既定のポート (10000) を使用しない場合は、REDIS_PORT パラメーターを使用して、インストール済みの REdis Serialization Protocol (RESP) ソリューションのポートを指定することもできます。

🚧

重要!

デプロイに Insights を含む場合は、Orchestrator のセカンダリ ノードをインストールする前に Insights のインストールを完了してください。

  1. セカンダリ ノードで UiPathOrchestrator.msi にコマンドライン引数を指定して Orchestrator をインストールします。この時、SECONDARY_NODE パラメーターを 1 に設定し、プライマリ ノードのインストール時に生成されたパラメーター ファイルを指定してください。また、サイレント インストールの場合は、必要なパラメーターが設定済みであるため、/Q を指定します。

例: UiPathOrchestrator.msi SECONDARY_NODE=1 PARAMETERS_FILE=myconfig.json /Q

アプリケーションプールが起動され、Orchestrator インスタンスを使用できるようになります。
プライマリ ノードをインストールすると、データベースが初期化されます。セカンダリ ノードを設定する際はデータベースの初期化手順は必要ありません。

UiPathPlatformInstaller.exe インストール

次のように、UiPathPlatformInstaller.exe インストーラーを使用してマルチノード Orchestrator インスタンスをインストールすることもできます。

  1. [マルチノード インスタンスをインストール] 、次に [プライマリ ノードをインストール] を選択し、プロンプトに従って Orchestrator のインストールを完了します。
  2. インストールが完了すると、生成されたパラメーターファイルへのローカルパスが提供されます。このパスを保存するか、必要に応じて構成ファイルをコピーして、セカンダリノードのインストールで使用します。

🚧

重要!

デプロイに Insights を含む場合は、Orchestrator のセカンダリ ノードをインストールする前に Insights のインストールを完了してください。

  1. セカンダリ ノードでインストーラーを起動し、[マルチノード インスタンスをインストール]、次に [セカンダリ ノードをインストール] オプションを選択します。
  2. プライマリノードのインストールから生成された構成ファイルへのパスを入力します。
  3. インストールが完了すると、アプリケーション プールが起動され、Orchestrator インスタンスを使用できるようになります。

マルチノードの Orchestrator にノードを追加する

上記の方法では、最初のデプロイ時にプライマリ ノードとセカンダリ ノードをインストールし構成することを想定していますが、既存のノードからパラメーター ファイルを生成して、追加ノードのインストールに使用することもできます。

これは、Orchestrator のインストール ディレクトリにある Generate-ParametersFile.ps1 スクリプトを使用して行います。

  1. Orchestrator のインストール ディレクトリを開いて Generate-ParametersFile.ps1 を実行します。
    : 認証に appPoolIdentity を使用しない限り、appPool カスタム ユーザーのパスワードを渡す必要があります。
  2. JSON ファイルは、既存の Orchestrator の構成ファイルと環境に基づいて生成されます。
  3. このファイルを使用して、セカンダリ ノードのインストールを完了します (上記の MSI および UiPathPlatformInstaller.exe インストールの手順 2)。

パッケージの格納に関する考慮事項

アクティビティ、ワークフロー、ライブラリなどの、すべてのパッケージのメタデータ (定義) は、検索とフィルターを高速化するために SQL データベースに保存されます。

これに加え、FileSystem または選択した Blob ストレージ (Azure、Amazon S3、または Minio) に実際のファイルと実行メディアを保存することもできます。この機能では、特に複雑なマルチノードの Orchestrator 環境では、より高性能なファイル同期を行えます。

この機能を有効にするには、web.config ファイルの NuGet.Repository.Type パラメーターを設定する必要があります (手順についてはこちらを参照)。

パッケージの格納にどのストレージを使用するかを問わず、1 回のアップロード当たりの最大ファイルサイズは 28.6MB (IIS で定められた制限値) であることに留意してください。Amazon、Minio、FileSystem でこれを変更する方法については、このページを参照してください。Azure でこれを行う方法については、このページを参照してください。

📘

注:

新しいインストールの場合、既定ではリポジトリファイルは Composite に設定され、ストレージタイプは FileSystem に設定されます。更新の場合は、ストレージタイプ設定はそのまま維持されます。v2018.4 またはそれ以前のバージョンの場合には、これは Legacy に設定されています。詳細については、このページを参照してください。

約 1 か月前に更新


Windows インストーラー


改善の提案は、API 参照ページでは制限されています

改善を提案できるのは Markdown の本文コンテンツのみであり、API 仕様に行うことはできません。