Orchestrator のバックアップと復元

このページでは、Orchestrator SQL データベースの定期バックアップを作成するサンプル ソリューションについて説明します。関連する web.config および UiPath.Orchestrator.dll.config ファイルと NuGet パッケージ (該当する場合) をバックアップする方法については、こちらをご覧ください。

Orchestrator データベースのバックアップ

このバックアップを実行する方法は複数あり、必要に応じてライセンスを取得しインストールできるサードパーティのソリューションも多数存在します。ただし、ここでは、SQL Server Management Studio に用意されている統合メンテナンス プラン機能を使用するプロセスの例を紹介します。

メンテナンス プランの作成

1. SQL Server Management Studio から Orchestrator データベースの SQL Server に接続します。
   注: 管理者のアクセス権が必要です。
2. [管理] フォルダーを展開します。
   
   

   

   
   
3. [メンテナンス プラン] を右クリックして、[メンテナンス プラン ウィザード] を選択します。メンテナンス プラン ウィザードが表示されます。
   
   

   

   
   
4. [プランのプロパティを選択] ページで、次の手順を実行します。
   1. [名前] フィールドに、このメンテナンス プランのわかりやすい名前を入力します。
   2. 必要な場合は、[説明] フィールドを使用してプランの詳しい説明を提供します。
   3. [実行するアカウント名] ドロップダウンから [SQL Server エージェント サービス アカウント] を選択します。
   4. ラジオ ボタンと [スケジュール] フィールドを使用して、このメンテナンス プランに望ましい時刻と頻度を選択します。
5. [次へ] をクリックします。[メンテナンス タスクの選択] ページが表示されます。
   
   

   

   
   
6. [データベースのバックアップ (完全)] を選択して [次へ] をクリックします。[データベースのバックアップ (完全) タスクの定義] ページが表示されます。
   注: Test Manager データベースをバックアップするには、「Test Manager」セクションの「バックアップと復元」をご覧ください。

   注: この説明では、データベース全体のバックアップを作成するメンテナンス プランの詳細な設定手順のみを示しています。運用環境では、毎日実行するようにスケジュールした差分バックアップ プランも設定することをお勧めします。

   
   

   

   
   
7. [全般] タブで、次の手順を実行します。
   1. [データベース] ドロップダウンから [特定のデータベース] を選択します。
   2. [バックアップ コンポーネント] として [データベース] を選択します。ポップアップ ウィンドウで Orchestrator のデータベース (上図の例では UiPath) を選択します。
8. [バックアップ先] タブで、今後実行するすべてのバックアップの保存先を入力します。
9. [オプション] タブでは、次の項目を選択できます。
   1. バックアップ ファイルの圧縮の設定。有効化すると、バックアップの実行に要する時間が増加します。
   2. バックアップの有効期限日。
   3. バックアップの整合性の検証。有効化すると、バックアップの実行に要する時間が増加します。
10. [完了] をクリックしてメンテナンス プランを作成し、[閉じる] をクリックしてウィザードを閉じます。

メンテナンス プランの実行

作成したメンテナンス プランで定義されているバックアップは、定義されているスケジュール以外のタイミングでも実行できます。それには、次の手順を実行します。

1. SQL Server Management Studio から Orchestrator データベースの SQL Server に接続します。
   注: 管理者のアクセス権が必要です。
2. [管理] フォルダーを展開します。
3. [メンテナンス プラン] フォルダーを開きます。
4. 目的のメンテナンス プランを右クリックして [実行] を選択します。[メンテナンス プランの実行] ウィンドウが表示されます。
   
   

   

   
   
5. 正常に完了すると [成功] が表示されます。[閉じる] をクリックして終了するか、[報告] をクリックして実行レポートを表示できます。

Orchestrator データベースの復元

1. SQL Server Management Studio から目的の SQL Server に接続します。
   注: 管理者のアクセス権が必要です。
2. [データベース] フォルダーを右クリックして [データベースの復元] を選択します。
3. 復元ウィザードに従ってバックアップのソースおよび保存先を選択します。
   注: データベースをさらに前の時点まで復元することができます。データベースに新しい名前を選択することもできます。
4. [OK] をクリックして、復元手順を開始します。データベースのサイズによっては、この手順の実行に時間を要する場合があります。
5. 復元が完了すると、SQL Server Management Studio の [データベース] タブに新しいデータベースが表示されます。

バックアップ構成ファイルと NuGet パッケージ

Orchestrator の構成と NuGet パッケージをバックアップするには、関連するファイルとフォルダーを、指定したバックアップ先にコピーする必要があります。このページでは、コピーする必要があるファイルを特定し、探し出すために必要な詳細情報を提供します。

Orchestrator Web.config と UiPath.Orchestrator.dll.config ファイル

バックアップ

Orchestrator の構成をバックアップするために必要な手順は、デプロイ モデルに応じて多少異なります。このようなデプロイ モデルとして、オンプレミス、IaaS (Infrastructure as a Service)、PaaS (Platform as a Service) などがあります。

オンプレミス/IaaS デプロイ

1. Orchestrator インストール ディレクトリを開きます。既定では C:\Program Files (x86)\UiPath\Orchestrator です。
2. このディレクトリにある web.config ファイルと UiPath.Orchestrator.dll.config ファイルを指定のバックアップ先にコピーします。

Azure による PaaS デプロイ

1. Orchestrator App Service を選択します。
2. [開発ツール] メニューから [高度なツール] > [Go] > [デバッグ コンソール] > [CMD] に移動します。
3. Site フォルダーを開いて wwwroot に移動します。
4. Web.config を選択して [ダウンロード] をクリックします。
5. ダウンロードしたファイルを指定のバックアップ先にコピーします。
6. UiPath.Orchestrator.dll.config を選択して [ダウンロード] をクリックします。
7. ダウンロードしたファイルを指定のバックアップ先にコピーします。

web.config ファイルと UiPath.Orchestrator.dll.config ファイル以外に、次の手順を実行して、アプリケーション設定と接続文字列もコピーする必要があります。

1. Orchestrator App Service を選択します。
2. [設定] メニューから [構成] を選択します。
3. [アプリケーションの設定] セクションで [詳細な編集] を選択し、表示された値をコピーします。
4. [接続文字列] セクションで [詳細な編集] を選択し、表示される値をコピーします。
5. これらの値を指定のバックアップ先に保存します。

元に戻す

注: web.config ファイルと UiPath.Orchestrator.dll.config ファイルを復元する際、デプロイ内のすべての Orchestrator ノードでその復元を実行する必要があります。

オンプレミス/IaaS デプロイ

以前の Orchestrator 構成を、新しい環境へ復元する場合、または異常発生の後で復元する場合は、次の手順を実行します。

1. 目的のバックアップから web.config ファイルと UiPath.Orchestrator.dll.config ファイルをコピーします。
2. Orchestrator インストール ディレクトリを開きます。既定では C:\Program Files (x86)\UiPath\Orchestrator です。
3. このディレクトリにある web.config ファイルと UiPath.Orchestrator.dll.config ファイルを、指定のバックアップに置き換えます。

Azure による PaaS デプロイ

目的の web.config と UiPath.Orchestrator.dll.config のバックアップ ファイルを取得した後、次の手順を実行します。

1. Orchestrator App Service を選択します。
2. [開発ツール] メニューから [高度なツール] > [Go] > [デバッグ コンソール] > [CMD] に移動します。
3. Site フォルダーを開いて wwwroot に移動します。
4. このディレクトリにある web.config ファイルと UiPath.Orchestrator.dll.config ファイルを、指定のバックアップに置き換えます。

web.config ファイルと UiPath.Orchestrator.dll.config ファイルを置き換えるほかに、次の手順を実行して、アプリケーション設定と接続文字列にも以前の値を復元する必要があります。

1. Orchestrator App Service を選択します。
2. [設定] メニューから [構成] を選択します。
3. [アプリケーション設定] セクションで [詳細な編集] を選択し、そこにある値を、以前に保存したバックアップの値に置き換えます。
4. [接続文字列] セクションで [詳細な編集] を選択し、そこにある値を、以前に保存したバックアップの値に置き換えます。

NuGet パッケージ

バックアップ

NuGet パッケージ ディレクトリの場所は、UiPath.Orchestrator.dll.config ファイルの [デプロイ] セクションに示されています。

1. NuGet.Repository.Type キーの値を確認します。使用可能な値は次のとおりです。
   • Legacy - パッケージは、NuGet.Packages.Path キーと NuGet.Activities.Path キーで特定した場所に格納されます。
   • Composite - パッケージは、Storage.Type キーと Storage.Location キーで特定した場所に保存されます。
2. リポジトリの種類が Legacy の場合、NuGet.Packages.Path キーと NuGet.Activities.Path キーで特定したフォルダーを、指定のバックアップ先にコピーします。
3. リポジトリの種類が Composite の場合、Storage.Type キーの設定に応じて次の操作を行います。
   1. FileSystem - Storage.Location キーの RootPath パラメーターで特定されるフォルダーを、指定のバックアップ場所にコピーします。
   2. Azure - 接続文字列が Storage.Type キーで提供されます。データの完全性と可用性は Microsoft により保証されていますが、Azure に保存されているファイルをローカルに保存する必要がある場合は、Microsoft のガイドに従ってください。
   3. Amazon - 接続文字列が Storage.Type キーで提供されます。データの完全性と可用性は Amazon により保証されていますが、Amazon に保存されているファイルをローカルに保存する必要がある場合は、Amazon のガイドに従ってください。

元に戻す

以前の NuGet パッケージ ディレクトリを復元するには、次に示すように、前述のバックアップ プロセスを逆の順序で実行します。

1. Legacy リポジトリの場合、NuGet パッケージとアクティビティのフォルダーのバックアップを、UiPath.Orchestrator.dll.config ファイルの [デプロイ] セクションで NuGet.Packages.Path キーと NuGet.Activities.Path キーによって指定されているディレクトリにコピーします。
2. リポジトリの種類が Composite の場合、Storage.Type キーの設定に応じて次の操作を行います。
   • FileSystem - バックアップ フォルダーを RootPath パラメーターの Storage.Location キーで特定されるディレクトリにコピーします。このパラメーターは UiPath.Orchestrator.dll.config ファイルの Deployment セクションで確認できます。
   • Azure - 過去に保存した接続文字列を Storage.Type キーに入力します。
   • Amazon - 過去に保存した接続文字列を Storage.Type キーに入力します。