- 基本情報
- 要件
- ベスト プラクティス
- インストール
- 更新
- Identity Server
- High Availability Add-on
- 起動エラーのトラブルシューティング
Orchestrator インストール ガイド
更新と移行について
古いバージョンの Orchestrator を新しいバージョンにアップグレードできるかどうかを確認するには、『UiPath 概要ガイド』の「Orchestrator のアップグレード パス」のマトリクスをご覧ください。
利用可能な最新バージョンを確認するには、『UiPath リリース ノート』をご覧ください。
Orchestrator のアップグレード/インストールに進む前に、次のタスク リストを入念に確認してください。
|
説明 |
詳細 |
|---|---|
|
|
インストールするバージョンの前提条件とハードウェアやソフトウェアの要件が満たされていることを確認します。 |
|
|
新しい Orchestrator のデプロイによりどのような変更が加えられるかを知っておく必要があります。アップグレード/インストール前に確認し、対処しておくべきことがあります。以下に、最大の変更点と、新バージョンのメリットを最大限に引き出すための推奨事項をいくつか示します。 |
|
|
UiPath プラットフォーム構成ツールは、Orchestrator を適切にインストール/アップグレードできるようにするための PowerShell スクリプトです。アップグレード前に実際の環境の健全性と準備状況を確認し、インストール後に実行するいくつかの操作を支援します。
|
|
|
Orchestrator のアップグレードは、アプリケーションが停止状態で行う必要があります。アプリケーションの実行中に更新を実行すると、エラーが発生する可能性があり、これはサポートされていません。 |
インストール アーティファクトは、Orchestrator の初回購入時に提供されるか、カスタマー サクセス マネージャーまたは UiPath のサポート チームで用意いたします。次のとおり、直接更新する方法はいくつかあります。
UiPathOrchestrator.msi は、既存の設定をすべてコピーして古いバージョンのバックアップ フォルダーを作成するインプレース更新を実行します。シングル ノードとマルチノード アーキテクチャの両方に適しています。アップグレード元のバージョンが非推奨スクリプトを使用してインストールされていた場合は、web.config 設定の一部がコピーされません。Windows インストーラーの修復機能はサポートされません。
UiPathPlatformInstaller.exe を使用してインストールされた Orchestrator を更新する場合は、Windows インストーラーを使用してこのバージョンに更新します。
Azure Portal で、シングル ノードまたはマルチノードでの Orchestrator およびそのコンポーネントの複雑な更新を実行します。
web.config 内の SecureAppSettings セクションが暗号化されていると、インストーラーはそのセクションを読み込めません。Orchestrator の web.config の EncryptionKey を読み込み、それを Identity Server の appsettings.Production.json に移行するには、キーがプレーン テキストである必要があります。Orchestrator の更新前にこのセクションを手動で復号する必要があります。なお、Orchestrator の更新処理の完了後は web.config の SecureAppSettings セクションを忘れずに再暗号化してください。
選択した更新方法に関係なく、指定したデータベースが存在しない場合は、更新の実行中に自動的に作成されます。既存のデータベースを指定した場合は、同じプロセスでそのデータベースも更新されます。インストール時に、Orchestrator SQL データベースは、大文字と小文字を区別しないように自動設定されます (「OrchDB」=「orchdb」)。
最新バージョンの Orchestrator にアップグレードすると、すべてのローカル アカウントが Orchestrator から Identity Server に自動的に移行され、必要な形式に変換されます。
この変更は、ロボットには影響を与えません。
変換が完了すると、各ユーザーは基本認証ではログインできなくなります。
Orchestrator の最新バージョンにアップグレードする際、Identity Server と Webhook のアプリケーション プール ID の種類は、元のインストールで Orchestrator が使用していたものと同じ種類を使用することを強くお勧めします。
たとえば、Orchestrator v2020.10 のインストールでアプリケーション プール ID の種類をカスタム アカウントとして設定していた場合は、v2021.10 へのアップグレード時にも Identity Server と Webhook アプリケーションの両方で、同じ種類のアプリケーション プール ID (つまりカスタム アカウント) を選択します。同じ種類の ID を選択しないと、SQL サーバーへのアクセスがブロックされる場合があります。
AZURE_AUTHORITY_HOST を対応する値に設定する必要があります (つまり、 "AZURE_AUTHORITY_HOST": "https://login.microsoftonline.us/")。 値の詳細については、「 Microsoft Entra authentication & national clouds - Microsoft ID platform」 をご覧ください。
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 以前から更新する場合、[プロファイル] ページには更新前のログイン試行の記録が表示されません。
Orchestrator をアップグレードまたは移行した後は、[ライセンス] ページからオンラインまたはオフラインのアクティベーションを行って、ライセンス情報を更新することをお勧めします。更新の手順については、「ライセンスをアクティベーションする」をご覧ください。
Legacy がサポート対象外になりました。以前に Legacy リポジトリに保存されていたパッケージは、Composite リポジトリに移行されます。Composite リポジトリの場合、パッケージの保存場所は、UiPath.Orchestrator.dll.config のパラメーター Storage.Type と Storage.Location によって設定されます。アップグレード後、Legacy 関連のアプリ設定はすべて非推奨となり、無効になります。
NuGet.Packages.PathNuGet.Activities.PathNuget.EnableRedisNodeCoordinationNuget.EnableNugetServerLoggingNuGet.EnableFileSystemMonitoringNuGet.Repository.Type
web.config で、パラメーター NuGet.Packages.Path および NuGet.Activities.Path がどのように設定されていたかによって異なります。
~/NuGetPackages と ~/NuGetPackages/Activities) に保存していた場合、新しいパッケージの保存場所は RootPath=.\Storage になります。
|
2020.10 より前のキーの既定値 - web.config |
2020.10+ のキーの既定値 - UiPath.Orchestrator.dll.config |
|---|---|
|
|
|
STORAGE_TYPE と STORAGE_LOCATION の両方のパラメーターを指定する必要があります。ただし、アップグレード前に、web.config の Storage.Type と Storage.Location に具体的な値を追加しておいた場合は、その必要はありません。
STORAGE_TYPE と STORAGE_LOCATION が要求または無視されるかを示したものです。この表では、それらのパラメーターが要求または無視されるかどうかを、アップグレード元のバージョンごとに、そして元のバージョンと v2020.10 以降でのパッケージの保存場所 (既定の場所、またはそれ以外の場所) ごとに示しています。
この表では、このような機能の組み合わせに基づいて、たとえば、2019.4 以降のバージョンからのアップグレードで、パッケージがカスタムの場所に保存されているが、新しいストレージの場所が既定の場所である場合に、サイレント モードで 2 つのパラメーター (チェックマークで示されています) が要求されることを示しています。
|
アップグレード元 |
以前の Legacy ロケーション |
新しい Composite ロケーション |
ストレージ ウィンドウでのパラメーター要求 |
サイレント モードでのパラメーター要求 |
CMD からの無視されるパラメーター |
|---|---|---|---|---|---|
|
2019.4 以降 |
既定 (Default) |
既定 (Default) |
| ||
|
2019.4 以降 |
既定 (Default) |
カスタム |
| ||
|
2019.4 以降 |
カスタム |
既定 (Default) |
|
| |
|
2019.4 以降 |
カスタム |
カスタム |
|
何らかの理由でパッケージ移行に失敗した場合、次のオプションが表示されます。
- 再試行 - パッケージの移行が再実行されます。移行済みのパッケージはスキップされます。
- 中止 - インストールが再実行されます。移行のステップでは、移行済みのパッケージもスキップされずに再度移行されます。そのため、異なるコンテナー内にファイルが重複する可能性があります。こうした状況は、2019.4 よりも古いバージョンから移行する場合にのみ発生します。
- 続行 - 移行が続行されます。
2019.10 からのアップグレード
2019.10 からのアップグレードの一環として移行を行うと、パッケージ名が変更され、Orchestrator で利用できなくなる場合があります。この問題が発生した場合は、影響を受けたパッケージを手動でアップロードすることをお勧めします。
