Orchestrator Installation Guide

DELIVERY:

Last updated Oct 31, 2024

Backup and Restore

This page provides an overview, with links to detailed instruction, of the process and procedure for backing-up and restoring your Orchestrator deployment and all its settings and features.

Backup

Back up your Orchestrator database.
Back up the Orchestrator Web.config, UiPath.Orchestrator.dll.config, Identity's appSettings.Production.json and Webhooks' appSettings.Production.json files to save your configuration settings. Depending on the existing version of Orchestrator, some of these files might not be present in the installation folder.
Back up all NuGet package directories.
If also using UiPath Insights:
1. Back up your Insights database using the same procedure as that for the Orchestrator database.
2. Back up Insights Dashboards.

Restore

If migrating to a new environment, Install Orchestrator and UiPath Insights, if previously used.
Restore the desired Orchestrator database backup.
Restore all the configuration files saved during the backup phase.
Restore all Nuget package directories.
If UiPath Insights was previously used, also:
1. Restore your Insights database using the same procedure as that for the Orchestrator database.
2. Restore your Insights Dashboards.

Insights Backup and Restore

For Orchestrator deployments with the Insights feature enabled, regular backups of your Insights database should be performed inline with the backups of your Orchestrator database.

In addition, you must also back up your configured dashboards.

Dashboard Backup

From Windows Services Manager, stop the following services:
- Sisense.Repository.
- Sisense.Discovery.
Copy the contents of the %ProgramData%\Sisense\PrismWeb\Repository\DB directory to the location where your database backups are maintained. Be sure to maintain the same file structure.
Copy the contents of the %ProgramData%\Sisense\Infra\Discovery directory to the location where your database backups are maintained. Be sure to maintain the same file structure.
Return to Windows Services Manager and restart the stopped services:
- Sisense.Repository.
- Sisense.Discovery.

Restore Dashboards

Important: Before proceeding with restoring Insights or its attendant dashboards, your Orchestrator database must be restored to a matching backup version and the original Insights certificate needs to be installed (i.e. if this is a new machine, or if you deleted it).

Restore the Insights database.
Re-install Insights.
From Windows Services Manager, stop the following services:
- Sisense.Repository.
- Sisense.Discovery.
Replace the contents of the %ProgramData%\Sisense\PrismWeb\Repository\DB directory with the previously created backups.
Replace the contents of the %ProgramData%\Sisense\Infra\Discovery directory with the previously created backups.
Return to Windows Services Manager and restart the stopped services:
- Sisense.Repository.
- Sisense.Discovery.
Re-enable each previously Insights-enabled tenant using the UiPath.InsightsAdminTool:
Navigate to the \Orchestrator\Tools directory.

For example: cd C:\Program Files (x86)\UiPath\Orchestrator\Tools.
Run the tool using the list command to obtain the previously enabled tenants.

For example: c:\Program Files (x86)\UiPath\Orchestrator\Tools>UiPath.InsightsAdminTool.exe list -u admin -p ******
For each listed tenant, run the tool using the enable command.

For example: c:\Program Files (x86)\UiPath\Orchestrator\Tools>UiPath.InsightsAdminTool.exe enable -u admin -p ****** -t Default.
Restart the Insights machine.

Restore Configuration

Important: This procedure is only necessary if, after an upgrade, a full uninstall and reinstall had to be performed.

In case of an upgrade failure that requires a full uninstall/reinstall, the previous encryption configuration must be set in order to use the database backup.

Extract the backup .zip file produced by the Insights installer during upgrade.
Locate baseConfiguration.json file in the extracted folder.
From the baseConfiguration.json file, locate the following keys:
```
{
 "encryption.IV": "value",
 "encryption.aesKey": "value",
 "encryption.licenseKey": "value"
}{
 "encryption.IV": "value",
 "encryption.aesKey": "value",
 "encryption.licenseKey": "value"
}
```
From your Insights machine, navigate to http://localhost:3030.
Click on the UiPath logo in the upper-left corner 5 times in a row.
Navigate to the Base configuration page.
In the Encryption section, replace all fields with the ones found in the baseConfiguration.json file.
Click Save Base.

Restore Server Identity

For new Insights installations the server's identity can be reset. This needs to be addressed in order for the restored metadata/configuration to function properly.

This is done via the InsightsBackupTool.

A sample execution command:

{
  "codes": [
    {
      "code": ".\InsightsBackupTool.exe restore -l log.txt",
      "language": "powershell"
    }
  ]
}{
  "codes": [
    {
      "code": ".\InsightsBackupTool.exe restore -l log.txt",
      "language": "powershell"
    }
  ]
}

On this page

Backup
Restore
Insights Backup and Restore
Dashboard Backup
Restore Dashboards

Was this page helpful?

PREVIOUSUpdating Using the Azure Script

NEXTOrchestrator Backup and Restore

Support and Services

Get The Help You Need

UiPath Academy

Learning RPA - Automation Courses

UiPath Forum

UiPath Community Forum

Trust and Security

Cookies Policy