Backing up your Orchestrator configuration and NuGet packages requires copying the relevant files and folders to your designated backup location. This page provides the details needed to identify and locate those files and folders you must copy.
Orchestrator Web.config
File
Web.config
FileBackup
The steps needed to backup your Orchestrator configuration vary slightly depending on your deployment model (e.g. On-prem and IaaS (Infrastructure as a Service), or PaaS (Platform as a Service).
On-Prem and IaaS Deployments
- Open your Orchestrator installation directory. By default, this is
C:\Program Files (x86)\UiPath\Orchestrator
. - Copy the
web.config
file located there to your designated backup location.
Azure PaaS Deployments
- Select your Orchestrator App Service.
- From the Development Tools menu navigate to Advanced Tools > Go > Debug Console > CMD.
- Open the Site folder and navigate to wwwroot.
- Select
Web.config
and click Download. - Copy the downloaded file to your designated backup location.
In addition to the web.config
file, you must also copy the Application Settings and Connections Strings as follows:
- Select your Orchestrator App Service.
- From the Settings menu, select Configuration.
- From the Application Settings section, select Advanced Edit and copy the displayed value.
- From the Connection strings section, select Advanced Edit and copy the displayed value.
- Save these values to your designated backup location.
Restore
Note:
When restoring the
web.config
file, you must do so all on Orchestrator nodes in your deployment.
On-Prem and IaaS Deployments
To restore your previous Orchestrator configuration, whether to a new environment or following a failure:
- Copy the
web.config
file from your desired backup. - Open your Orchestrator installation directory. By default, this is
C:\Program Files (x86)\UiPath\Orchestrator
. - Replace the
web.config
file located there with your designated backup.
Azure PaaS Deployments
After you have retrieved your desired web.config
backup file:
- Select your Orchestrator App Service.
- From the Development Tools menu navigate to Advanced Tools > Go > Debug Console > CMD.
- Open the Site folder and navigate to wwwroot.
- Replace the
web.config
located there with your designated backup.
In addition to replacing the web.config
file, you must also restore the Application Settings and Connections Strings with their previous values, as follows:
- Select your Orchestrator App Service.
- From the Settings menu, select Configuration.
- From the Application Settings section, select Advanced Edit and replace the value there with your previously saved backup.
- From the Connection strings section, select Advanced Edit and replace the value there with your previously saved backup.
NuGet Packages
Backup
The location(s) of your NuGet package directories is indicated in the Deployment section of the web.config
file.
- Check the value of the
NuGet.Repository.Type
key. The following values are possible:- Legacy - packages are stored in the locations specified in the
NuGet.Packages.Path
andNuGet.Activities.Path
keys. - Composite - packages are stored in the locations specified in the
Storage.Type
andStorage.Location
keys.
- Legacy - packages are stored in the locations specified in the
- For Legacy repository types, copy the folders identified by the
NuGet.Packages.Path
andNuGet.Activities.Path
keys to your designated backup location. - For Composite repository types where the Storage.Type key is:
a.FileSystem
- copy the folder(s) identified in theRootPath
parameter of theStorage.Location
key to your designated backup location.
b.Azure
- a connection string is provided in theStorage.Type
key. Data integrity and availability is covered by Microsoft, however you can use their guide if you want to save the files stored there locally.
c.Amazon
- a connection string is provided in theStorage.Type
key. Data integrity and availability is covered by Amazon, however you can use their guide if you want to save the files stored there locally.
Restore
Restoring your previous NuGet package directories follows the reverse of the backup process detailed above, as follows:
- For Legacy repositories, copy your backups of the NuGet packages and activities folders to the directories identified by the
NuGet.Packages.Path
andNuGet.Activities.Path
keys indicated in the Deployment section of theweb.config
file. - For Composite repository types where the Storage.Type key is:
a.FileSystem
- copy your backup folder(s) to the directory identified in theStorage.Location
key of theRootPath
parameter, found in the Deployment section of theweb.config
file.
b.Azure
- enter the previously saved connection string in theStorage.Type
key.
c.Amazon
- enter the previously saved connection string in theStorage.Type
key.
Updated 2 years ago