通知を受け取る

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

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

⚙ プラットフォーム構成ツール

🚧

重要

The Platform Configuration Tool works for upgrades from 2018.10, 2019.10, 2020.10, and 2021.4 to v2021.10. Post-installation checks and operations work after installing Orchestrator.

概要


UiPath プラットフォーム構成ツールは、Orchestrator の適切なインストール/アップグレードを支援する PowerShell スクリプトです。アップグレード前に実際の環境の健全性と準備状況を確認し、インストール後に実行するいくつかの操作を支援します。

ツールは下記のリンクからダウンロードでき、UiPathOrchestrator.msi インストーラーもバンドルされています。バンドルされているスクリプトは、Orchestrator のインストール ディレクトリ (既定では C:\Program Files (x86)\UiPath\Orchestrator\) の Tools フォルダーにあります。このスクリプトは Orchestrator のマシンをチェックします。マルチノード インストールの場合、このツールはいずれか 1 つのノードで実行すれば十分です。

プラットフォーム構成ツールは UiPathOrchestrator.msi インストーラーとは異なるバージョン管理方式に従っており、製品リリース サイクルに関係なく更新できます。常にツールの最新バージョンを、下記のリンクから入手することを推奨します。

前提条件

SoftwareCompatible Version
PowerShell5.1
WebAdministration ModuleN/A

スクリプト コマンドレット

このスクリプトは、特定の機能の実行を目的とした 3 つのコマンドレットから構成されています。コマンドレットで起動するコマンドと関連パラメーターを、コマンド ラインから入力して即座に実行することができます。

CmdletDescription
Test-PlatformReadiness Invoked using the -Readiness command.
Checks the sanity and readiness of your environment before an upgrade and the certificate requirements after the installation.
Update-UiPathUrl Invoked using the UpdateUiPathUrl command.
Updates the public address of Orchestrator.
Update-UiPathCertificate Invoked using the UpdateUiPathCertificate command.
Updates the Orchestrator SSL certificate or the Identity Server token-signing certificate.
AddHostAdmin Invoked using the AddHostAdmin command.
Adds a system administrator to the host tenant.

インストール前の確認


Asp.Net Core

ASP.NET Core の IIS モジュール v3.1.x 以降がインストールされ、機能していることを確認します。インストールされて適切に機能していない場合は、ASP.Net Core ホスティング バンドルのアンインストールと再インストールを促すプロンプトが表示されます。

CyberArk AIM

CyberArk AIM エージェントが C:\Program Files (x86)\CyberArk フォルダーにインストールされていることを確認します。インストールされていない場合は、インストール後に Plugins.SecureStores.CyberArk.CLIPasswordSDKExePath キーを使用して UiPath.Orchestrator.dll.config ファイルに CLIPasswordSdk.exe を追加するよう促すプロンプトが表示されます。

 この確認は、CyberArk が UiPath.Orchestrator.dll.config に定義されていない場合、実行されません。

web.config の暗号化

web.config ファイルが復号されているかどうかを確認します。暗号化されている場合は、アップグレード前に手動で復号する必要があります。アップグレード後、Orchestrator の設定のほとんどは、UiPath.Orchestrator.dll.config に移されます。
Learn how to encrypt the UiPath.Orchestrator.dll.config file.

web.config のロックされたセクション

<system.webServer> 要素にロックされたセクションが含まれているかどうかを確認します。ロックされたセクションが存在する場合は、IIS で手動でロック解除する必要があります。

SQL Server のスケールアウト

SQL Server のスケールアウトが使用されているかどうかを確認します。結果はインストール中に通知され、Redis スケールアウトが有効化されます。

資格情報ストア プラグイン

外部資格情報ストア プラグインのターゲットが、サポート対象のフレームワークであることを確認します。

NLog プラグイン

NLog プラグインのターゲットが、サポート対象のフレームワークであることを確認します。

FileSystem バケット

この確認では、アプリ設定パラメーター Buckets.FileSystem.Allowlist が v2020.4 以降のバージョンの Orchestrator に存在するかどうかが検証されます。インストール前の確認 (Orchestrator v2022.4) とインストール後の確認 (Orchestrator v2022.4) の両方が実行されます。v2020.4 より前のバージョンの Orchestrator では、この確認がスキップされます。

  • 次の確認を実行するには、構成セクションの connectionStringsappSettings を復号する必要があります。これらの構成セクションのどれか 1 つでも暗号化されている場合は、ターミナルで警告が表示され、バケットの検証の残りの手順はスキップされます。
Could not determine if any buckets with file system provider are in use. Config section 'connectionString' is encrypted, could not find the sql connection string to the UiPath database.
  • 何らかの理由でデータベースからバケットを取得できなかった場合は、ターミナルで警告が表示され、残りの検証は同様にスキップされます。
Could not determine if any buckets with file system provider are in use. Could not connect to the UiPath Database.
  • この検証は、Orchestrator データベースのバケット テーブルから取得したバケットの、ルート パスに対して実行されます。非修飾のパスがある場合は、ターミナルで警告が表示されます。被修飾のパスについての同様の確認が、構成ファイルのアプリ設定パラメーター Buckets.FileSystem.Allowlist のパスに対しても行われます。

  • 2 つのソース内のパスのいずれかが有効でない場合、または非修飾である場合は、以下に示す検証の残りの部分に対してはそのパスは考慮されません。

  • アプリ設定パラメーター Buckets.FileSystem.Allowlist が構成ファイルで設定されていない場合、ターミナルでエラーが表示され、構成ファイルに許可リストを追加するよう求められます。エラー内で提案されるパスは、ファイル システム プロバイダーを使用するバケットのルート パスです。

All storage buckets using the file system provider are not on the allowed list.
Add the following setting in the configuration file to allow all exiting buckets root paths:
      <add key="Buckets.FileSystem.Allowlist" value="C:\work\stuff\Bucket\|C:\work\stuff\Bucket1\" />
  • アプリ設定パラメーター Buckets.FileSystem.Allowlist が構成ファイルで設定されている場合、FileSystem プロバイダーを使用するバケットのルート パスに対して検証が実行されます。バケットのルート パスが許可リストで定義したパスのサブパスではない場合、ターミナルで警告が表示され、バケットのルート パスを Buckets.FileSystem.Allowlist に追加するよう求められます。
There are some storage buckets using the file system provider that are not on the allowed list. The buckets feature will not work for buckets with root paths that are not on the allowed list.
Check if any of the following paths are required to be on the allowed list and add them to the 'Buckets.FileSystem.Allowlist' key in configuration file:
|C:\work\stuff\Buckets\|C:\work\stuff\Bucket1\
  • 上記の条件に当てはまらず、バケットのすべてのルート パスが許可リストのいずれかのパスのサブパスである場合は、ターミナルに成功メッセージが表示されます。
All storage buckets using file system provider have the root path on the allow list in the configuration file.

インストール後の確認


証明書の要件

アップグレード後の Orchestrator インスタンスで証明書の要件がすべて満たされていることを確認します。

SSL 証明書の確認

  • Orchestrator サイトの hostname が証明書のサブジェクトまたはサブジェクトの代替名 (ワイルドカードを含む) と一致している
  • 信頼チェーンが有効である
  • 有効期限が切れていない

Identity Server のトークン署名証明書の確認

  • 証明書のキーのサイズが適切である (2048 ビット以上)
  • AppPool ユーザーがアクセスできる秘密キーがある
  • 有効期限が切れていない

その他の考慮事項

Check the docs on installation considerations for other areas impacted by an upgrade to v2022.4 that you need to be aware of.

スクリプトを実行する


コマンド リファレンス

Command & ParametersDescription
-ReadinessChecks the sanity and readiness of your environment before an upgrade and the certificate requirements after the installation.
Parameters:
-SiteName
-Help
-InstallationDirectory
-UpdateUiPathUrlUpdates the public address of Orchestrator.
Parameters:
-SiteName
-OrchestratorUrl
-SqlConnectionString

The SQL Server PowerShell module is required to use this command. The module is installed by default with SQL Server. If you’re working on a machine that doesn’t have the module installed, see here how to install it.
Use this command with caution as it does not have a roll-back mechanism if a step errors out during execution.
-UpdateUiPathCertificateUpdates the Orchestrator SSL certificate or the Identity Server token-signing certificate. Use it in conjunction with the -readiness command to check the validity of the new certificates.
Parameters:
-SiteName
-NewTokenSigningThumbprint
-NewSSLThumbprint
-AddHostAdminIf access to the host organization is lost (for example, if the password for the system administrator is lost or the only users with system administrator accounts leave the company), you can use this command to add or restore a system administrator.
Parameters:
-SiteName
-HostAdminUsername
-HostAdminPassword
-HostAdminEmail

スクリプトのパラメーター

ParameterDescription
-SiteNameOptional. The name of the Orchestrator website on the target machine. Defaults to "UiPath Orchestrator". -InstallationDirectory and SiteName are mutually exclusive.
-HelpOptional. Displays information about the tool options or available commands, such as the commands' syntax or the checks it performs.
-InstallationDirectoryOptional. The path of Orchestrator's installation directory. Usually C:\Program Files (x86)\UiPath\Orchestrator\. -InstallationDirectory and SiteName are mutually exclusive.
Note: Make sure the installation directory path ends with a trailing backslash (\).
-OrchestratorUrlMandatory. The new public address of Orchestrator.
-SqlConnectionStringOptional. UiPath database connection string. If left empty, the value is read from the appsettings.Production.json file.
-NewTokenSigningThumbprintOptional. The thumbprint of the new token signing certificate.
-NewSSLThumbprintOptional.The thumbprint of the new SSL certificate.
-HostAdminUsernameOnly mandatory when using the -AddHostAdmin command. Username of the host admin user to create or restore.
-HostAdminPasswordEmail of the host admin user to create or restore when using the -AddHostAdmin command. Only mandatory if using these external identity providers:
Google
Azure Active Directory
*SAML with email user mapping strategy
-HostAdminEmailPassword of the host admin user to create when using the -AddHostAdmin command. Password is only mandatory if the user is a basic authentication user. The password will need to be changed on first login.


プラットフォーム構成ツール スクリプトで作業を行うには、管理者として PowerShell スクリプトを開きます。

プラットフォーム構成ツールのアーカイブを解凍したディレクトリを確認し、現在のディレクトリをその場所に変更します。

cd C:\Program Files (x86)\UiPath\Orchestrator\Tools\UiPath.Platform.Configuration.Tool

準備状況の確認

Orchestrator のインストール前の要件は、以下の例に従って検証できます。この手順は、各ステップと追加の出力情報を -verbose レベルでログに記録します。

.\Platform.Configuration.Tool.ps1 `
  -Readiness `
  -SiteName "UiPath Orchestrator"

インストール前のチェックが正常に完了した場合の出力例。

Validating 22.4 pre-installation requirements...
Checking AspNetCore hosting module...
AspNetCore hosting module is installed.

Checking CyberArk CLIPasswordSDK.exe path...
CyberArk CLIPasswordSDK.exe was found at the default installation path 'C:\Program Files (x86)\CyberArk\ApplicationPasswordSdk\CLIPasswordSDK.exe'.

Checking Web.config sections encryption...
Web.config sections are not encrypted.

Checking IIS configuration locked sections...
Configuration sections are not locked.

Checking Orchestrator ssl certificate subject alternative names...
Orchestrator host name is valid for the ssl certificate subject alternative names.

Checking sql server scaleout use...
Sql server scaleout is not used.

Checking external credential store plugins target framework...
Credential stores plugins validation is finished.

Checking external NLog plugins target framework...
NLog plugins validation is finished.

Checking buckets with file system storage provider...
All storage buckets using file system provider have the root path on the allowed list in the configuration file.

Checking platform certificates...
Platform certificates validation is finished.

All 22.4 pre-installation checks are done.
Platform readiness validations: 10 succeeded, 0 failed and 0 warning(s).

インストール後の証明書の変更

Orchestrator の SSL 証明書および Identity Server のトークン署名証明書は、以下の例に従って更新できます。

.\Platform.Configuration.Tool.ps1 `
  -UpdateUiPathCertificate `
  -SiteName "UiPath Orchestrator" `
  -NewSSLThumbprint "a1b2c3d4" `
  -NewTokenSigningThumbprint "z6y5x4v3"

📘

注:

内部サーバー エラーを防ぐには、証明書に適切な権限一式が設定されている必要があります。詳細については、「証明書のトラブルシューティング」をご覧ください。

Orchestrator URL の変更

Orchestrator の URL は、以下の例に従って更新できます。

.\Platform.Configuration.Tool.ps1 `
  -UpdateUiPathUrl `
  -OrchestratorUrl "https://mydomainname" `
  -SiteName "UiPath Orchestrator" `
  -SqlConnectionString "Server=myServerName\myInstanceName;Database=myDataBase;User Id=myUsername;Password=myPassword;"

新しいシステム管理者を作成する

The following example creates a new system administrator on the host tenant using basic authentication. Note that if an external identity provider is set as exclusive, basic authentication is only accessible through the hostlogin URL documented in Accessing Identity Management Portal.

.\Platform.Configuration.Tool.ps1 `
  -AddHostAdmin `
  -SiteName "UiPath Orchestrator" `
  -HostAdminUsername someuser `
  -HostAdminPassword som3pwd! `
  -HostAdminEmail [email protected]

出力


出力は、色分けされます。

ColorDescription
RedBlockers
Elements are missing or are not configured and will prevent the installation.
YellowWarnings
You can install Orchestrator, but additional benefits will be absent.
GreenMessages
The environment is ready for installation.

7 日前に更新


⚙ プラットフォーム構成ツール


改善の提案は、API リファレンスのページでは制限されています

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