- 基本情報
- 要件
- ベスト プラクティス
- インストール
- 更新
- Identity Server
- High Availability Add-on
更新と移行について
概要
この情報は、アップグレード元のバージョンではなく、アップグレード先のバージョンに関するものですのでご注意ください。そのため、作業を続行する前に必ず正しい詳細情報をお読みください。
次に該当する場合には、Orchestrator を v2020 に直接更新できます。
- 2018.4 バージョンを使用している場合
- 2019.x バージョンを使用している場合
- 2020.x バージョンのいずれかを使用している場合
利用可能な最新バージョンを確認するには、『UiPath リリース ノート』をご覧ください。
インストール前のチェックリスト
Orchestrator のアップグレード/インストールに進む前に、次のタスク リストを入念に確認してください。
| 説明 | 詳細 |
|---|---|
|
|
インストールするバージョンの前提条件とハードウェアやソフトウェアの要件が満たされていることを確認します。 |
|
|
新しい Orchestrator のデプロイによりどのような変更が加えられるかを知っておく必要があります。アップグレード/インストール前に確認し、対処しておくべきことがあります。以下に、最大の変更点と、新バージョンのメリットを最大限に引き出すための推奨事項をいくつか示します。 |
|
|
UiPath プラットフォーム構成ツールは、Orchestrator を適切にインストール/アップグレードできるようにするための PowerShell スクリプトです。アップグレード前に実際の環境の健全性と準備状況を確認し、インストール後に実行するいくつかの操作を支援します。 |
|
|
Orchestrator のアップグレードは、アプリケーションが停止状態で行う必要があります。アプリケーションの実行中に更新を実行すると、エラーが発生する可能性があり、これはサポートされていません。 |
Orchestrator の直接更新
インストール アーティファクトは、Orchestrator の初回購入時に提供されるか、カスタマー サクセス マネージャーまたは UiPath のサポート チームで用意いたします。次のとおり、直接更新する方法はいくつかあります。
Windows インストーラーを使用
UiPathOrchestrator.msi は、既存の設定をすべてコピーして古いバージョンのバックアップ フォルダーを作成するインプレース更新を実行します。シングル ノードとマルチノード アーキテクチャの両方に適しています。アップグレード元のバージョンが非推奨スクリプトを使用してインストールされていた場合は、web.config 設定の一部がコピーされません。Windows インストーラーの修復機能はサポートされません。
Azure スクリプトを使用
Azure Portal で、シングル ノードまたはマルチノードでの Orchestrator およびそのコンポーネントの複雑な更新を実行します。
UiPathPlatform インストーラーを使用
Orchestrator、Robot、Studio の更新が可能な実行可能ファイルです。シングル ノード アーキテクチャに適しています。プロセスは、Windows インストーラーの UiPathStudio.msi や UiPathOrchestrator.msi を使用した場合と同じです。
ただし、UiPathStudio.msi や UiPathOrchestrator.msi とは異なり、UiPathPlatformInstaller.exe はコマンド ライン引数を受け付けません。
更新の考慮事項
暗号化
During an Orchestrator update, the installer cannot read an encrypted SecureAppSettings section within web.config . In order to read the EncryptionKey from Orchestrator's web.config and then migrate it into Identity Server's appsettings.Production.json, the key must be plain text. You need to manually decrypt the section before updating Orchestrator. After the Orchestrator update process was finalized, remember to re-encrypt the SecureAppSettings section in web.config.
証明書
Note the new certificate requirements. If your existing certificate doesn't meet them, here is how to get a valid certificate and how to replace it in the existing Orchestrator instance, before upgrading.
For security reasons, for the certificate used to sign the access tokens generated by the Identity Server, make sure to use a public key on 2048 bits. The certificate's location has to be set within appsettings.Production.json's Signing Credential section.
データベース
選択した更新方法に関係なく、指定したデータベースが存在しない場合は、更新の実行中に自動的に作成されます。既存のデータベースを指定した場合は、同じプロセスでそのデータベースも更新されます。インストール時に、Orchestrator SQL データベースは、大文字と小文字を区別しないように自動設定されます (「OrchDB」=「orchdb」)。
外部プロバイダー
更新中に、web.config でいずれかの外部プロバイダーが有効化されていると、既存の外部プロバイダーに対して必要な手動の設定変更を行うよう促すプロンプトが表示されます。
既知の問題
v2023.10+ へのアップグレード中にデータベース タイムアウト エラーが発生する
Orchestrator に 100,000 を超えるグループがあると、v2023.10+ へのアップグレード中にタイムアウト エラーが発生する場合があります。
この問題を解決するには、以下のスクリプトをデータベースで直接実行してから、アップグレードをリトライします。
-- 1. Delete group subscriptions
DECLARE @rowCount BIGINT = 1
DECLARE @batchSize BIGINT = 4000
DECLARE @pivotDate DATETIME = GETUTCDATE()
WHILE (@rowCount > 0)
BEGIN
DECLARE @subscriptionsToDeleteIds TABLE(
[Id] UNIQUEIDENTIFIER NOT NULL
)
INSERT INTO @subscriptionsToDeleteIds
SELECT TOP(@batchSize) [ns].[Id]
FROM [dbo].[NotificationSubscriptions] [ns]
JOIN [dbo].[Users] [u] ON [u].[Id] = [ns].[UserId]
WHERE [u].[Type] = 3 AND -- Group
[u].[CreationTime] <= @pivotDate AND
[u].[IsDeleted] = 0
DELETE FROM [dbo].[NotificationSubscriptions]
WHERE [Id] IN (
SELECT [Id] FROM @subscriptionsToDeleteIds
)
OPTION (MAXDOP 1)
SET @rowCount = @@ROWCOUNT
WAITFOR DELAY '00:00:00.1'
END
-- 2. Create index on UserNotifications
IF NOT EXISTS(SELECT * FROM sys.indexes WHERE OBJECT_ID = OBJECT_ID(N'[dbo].[UserNotifications]') AND NAME = N'IX_UserId_CreationTime')
CREATE NONCLUSTERED INDEX [IX_UserId_CreationTime] ON [dbo].[UserNotifications]
(
[UserId] ASC,
[CreationTime] ASC
) INCLUDE ([TenantNotificationId]) WITH (ONLINE = ON);
-- 1. Delete group subscriptions
DECLARE @rowCount BIGINT = 1
DECLARE @batchSize BIGINT = 4000
DECLARE @pivotDate DATETIME = GETUTCDATE()
WHILE (@rowCount > 0)
BEGIN
DECLARE @subscriptionsToDeleteIds TABLE(
[Id] UNIQUEIDENTIFIER NOT NULL
)
INSERT INTO @subscriptionsToDeleteIds
SELECT TOP(@batchSize) [ns].[Id]
FROM [dbo].[NotificationSubscriptions] [ns]
JOIN [dbo].[Users] [u] ON [u].[Id] = [ns].[UserId]
WHERE [u].[Type] = 3 AND -- Group
[u].[CreationTime] <= @pivotDate AND
[u].[IsDeleted] = 0
DELETE FROM [dbo].[NotificationSubscriptions]
WHERE [Id] IN (
SELECT [Id] FROM @subscriptionsToDeleteIds
)
OPTION (MAXDOP 1)
SET @rowCount = @@ROWCOUNT
WAITFOR DELAY '00:00:00.1'
END
-- 2. Create index on UserNotifications
IF NOT EXISTS(SELECT * FROM sys.indexes WHERE OBJECT_ID = OBJECT_ID(N'[dbo].[UserNotifications]') AND NAME = N'IX_UserId_CreationTime')
CREATE NONCLUSTERED INDEX [IX_UserId_CreationTime] ON [dbo].[UserNotifications]
(
[UserId] ASC,
[CreationTime] ASC
) INCLUDE ([TenantNotificationId]) WITH (ONLINE = ON);
ウイルス対策ソフトウェアの問題
一部のウイルス対策ソフトウェアを使用すると、アップグレード中にデータ移行のスクリプトが正常に機能しなくなることがあります。
ログイン試行の問題
Orchestrator を v2019.10 以前から更新する場合、[プロファイル] ページには更新前のログイン試行の記録が表示されません。
インストール後にライセンスを更新する
After you upgrade or migrate Orchestrator, we recommend that you update your license information from the Licenses page using either online or offline activation.
2019.10 より古いバージョンからアップグレードまたは移行する場合は、そうしないと、ライセンスの有効期限が切れた時点で猶予期間が適用されず、サービスが中断される可能性があります。
パッケージの移行
In v2020.10+, Legacy is no longer a supported NuGet repository type. Packages previously residing in a Legacy repository are migrated to a Composite repository. For composite repositories, package location is configured using the Storage.Type and Storage.Location parameters in UiPath.Orchestrator.dll.config. After the upgrade, all Legacy-related app settings become deprecated and no longer have an effect:
NuGet.Packages.PathNuGet.Activities.PathNuget.EnableRedisNodeCoordinationNuget.EnableNugetServerLoggingNuGet.EnableFileSystemMonitoringNuGet.Repository.Type
新しいパッケージの保存場所は、以前のバージョンの Orchestrator で web.config で、パラメーター NuGet.Packages.Path および NuGet.Activities.Path がどのように設定されていたかによって異なります。
既定の場所
パッケージを既定の場所 (~/NuGetPackages と ~/NuGetPackages/Activities) に保存していた場合、新しいパッケージの保存場所は RootPath=.\Storage になります。
| 2020.10 より前のキーの既定値 - web.config | 2020.10 のキーの既定値 - UiPath.Orchestrator.dll.config |
|---|---|
<add key="NuGet.Packages.Path" value="~/NuGetPackages" /><add key="NuGet.Packages.Path" value="~/NuGetPackages/Activities" /> | <add key="Storage.Type" value="FileSystem" /><add key="Storage.Location" value="RootPath=.\Storage" /> |
指定の場所
パッケージを既定以外の場所に保存していた場合は、インストール中に新しい保存場所を尋ねられます。サイレント インストールの場合、STORAGE_TYPE と STORAGE_LOCATION の両方のパラメーターを指定する必要があります。ただし、アップグレード前に、web.config の Storage.Type と Storage.Location に具体的な値を追加しておいた場合は、その必要はありません。
パッケージ移行に関する表
下の表は、アップグレード時のどのような場合にパラメーター STORAGE_TYPE と STORAGE_LOCATION が要求または無視されるかを示したものです。この表では、それらのパラメーターが要求または無視されるかどうかを、アップグレード元のバージョンごとに、そして元のバージョンと v2020.10 以降でのパッケージの保存場所 (既定の場所、またはそれ以外の場所) ごとに示しています。
この表では、このような機能の組み合わせに基づいて、たとえば、次のような場合にサイレント モードで 2 つのパラメーター (チェックマークで示されています) が要求されることを示しています。
-
バージョン 2018.4 からのアップグレードで、パッケージがカスタムの場所に保存されている場合
-
バージョン 2019.4 以降からのアップグレードで、パッケージがカスタムの場所に保存されているが、新しいストレージの場所が既定の場所である場合
アップグレード元 以前の Legacy ロケーション 新しい Composite ロケーション ストレージ ウィンドウでのパラメーター要求 サイレント モードでのパラメーター要求 CMD からの無視されるパラメーター 2018.4
既定 (Default)

2018.4
カスタム


2019.4 以降
既定 (Default)
既定 (Default)

2019.4 以降
既定 (Default)
カスタム

2019.4 以降
カスタム
既定 (Default)


2019.4 以降
カスタム
カスタム

移行エラー
何らかの理由でパッケージ移行に失敗した場合、次のオプションが表示されます。
- 再試行 - パッケージの移行が再実行されます。移行済みのパッケージはスキップされます。
- 中止 - インストールが再実行されます。移行のステップでは、移行済みのパッケージもスキップされずに再度移行されます。そのため、異なるコンテナー内にファイルが重複する可能性があります。こうした状況は、2019.4 よりも古いバージョンから移行する場合にのみ発生します。
- 続行 - 移行が続行されます。
2019.10 からのアップグレード
2019.10 からのアップグレードの一環として移行を行うと、パッケージ名が変更され、Orchestrator で利用できなくなる場合があります。この問題が発生した場合は、影響を受けたパッケージを手動でアップロードすることをお勧めします。