Orchestrator Backup and Restore

This page provides a sample solution for creating scheduled backups of your Orchestrator SQL database. See here how to back up the related web.config and UiPath.Orchestrator.dll.config files and NuGet packages, if applicable.

Backing Up the Orchestrator Database

There are multiple options for performing this backup, including many third-party solutions that you can license and install if desired; however, this example guides you through the process using the integrated Maintenance Plans functionality already present in SQL Server Management Studio.

Creating the Maintenance Plan

1. From SQL Server Management Studio, connect to the SQL Server of your Orchestrator database.
   Note: Administrator access is required.
2. Expand the Management folder.
   
   

   

   
   
3. Right-click Maintenance Plans and select Maintenance Plan Wizard. The Maintenance Plan Wizard is displayed.
   
   

   

   
   
4. On the Select Plan Properties page:
   1. In the Name field, enter a descriptive name for this maintenance plan.
   2. Use the Description field to provide a detailed description of the plan, if desired.
   3. From the Run as drop-down, select SQL Server Agent service account.
   4. Use the radio buttons and Schedule field to select the desired time and frequency for this maintenance plan.
5. Click Next. The Select Maintenance Tasks page is displayed.
   
   

   

   
   
6. Select Back Up Database (Full) and click Next. The Define Back Up Database (Full) Task page is displayed.
   Note: To back up the Test Manager database, see Test Manager Backup and Restore.

   Note: This guide only details the setup of a maintenance plan for the creation of a full database backup. In your production environment, it is also recommended to set up a Differential backup plan scheduled to run daily.

   
   

   

   
   
7. From the General tab:
   1. Use the Database(s) drop-down to select Specific databases.
   2. Select Database as the Backup component. In the popup window, select your Orchestrator database (UiPath in the example above).
8. From the Destination tab, enter the location where all future backups are saved.
9. The Options tab enables you to select:
   1. Compression for the backup files. If enabled, the time needed to perform the backup increases.
   2. Backup Expiration Date.
   3. Backup Integrity Verification. If enabled, the time needed to perform the backup increases.
10. Click Finish to create the maintenance plan and Close to close the wizard.

Executing the Maintenance Plan

The backup as defined in your created maintenance plan can also be executed outside of the defined schedule as follows:

1. From SQL Server Management Studio, connect to the SQL Server of your Orchestrator database.
   Note: Administrator access is required.
2. Expand the Management folder.
3. Expand the Maintenance Plans folder.
4. Right-click the desired maintenance plan and select Execute. The Execute Maintenance Plan window is displayed.
   
   

   

   
   
5. Once completed Success is displayed. You can click Close to exit or select Report to view the execution report.

Restoring the Orchestrator Database

1. From SQL Server Management Studio, connect to the desired SQL Server.
   Note: Administrator access is required.
2. Right-click the Databases folder and select Restore Database.
3. Follow the restoration wizard to select the source of the backup and the destination where it is restored.
   Note: It is possible to restore a database to an earlier point in time. You can also select a new name for your database.
4. Click OK to begin the restore procedure. Note that this may take some time depending the on size of the database.
5. Once completed, the new database appears in the Databases tab of SQL Server Management Studio.