UiPath Orchestrator Guide

Updating Using the Windows Installer

The update process can be different depending on whether you installed the previous version using the Windows installer, or the scripts, or you have installed Orchestrator in a multi-node environment.

Important!

If the entire UiPath suite is installed on a single machine, and you want to update from an older version to v2018.3, you are required to first do so on Orchestrator and then Studio and Robot. If you first update your Studio to v2018.3, your Orchestrator instance is removed. This is due to a change in the installers' Product Code and is not going to be necessary for other subsequent updates.

Previous Version Installed With Scripts

To update Orchestrator from a version that was previously installed using the scripts, perform the following actions:

  1. On the machine on which the old version of Orchestrator is installed, open IIS.
  2. Navigate to the Orchestrator website and, in the Actions section, click Stop. The Orchestrator website is stopped.
  1. Back up your automation packages, web.config file, and database.
  2. Open the Web.config file.
  3. Copy the value of the EncryptionKey parameter.
  4. Run the UiPathOrchestrator.msi Windows installer from the command line by also providing the encryption key from the previous installation, such as UiPathOrchestrator.msi APP_ENCRYPTION_KEY=encryption_key_from_old_installation. The installation wizard starts.
  5. Fill in the information as explained here, by providing the same SQL database from the previous installation. Orchestrator v2018.3 is installed with the UiPath Orchestrator name.
  6. Open the v2018.3 Web.config file, and copy any settings that you have customized in the previous install if any.
  7. Save and close the web.config file.
  8. If your workflows were kept on the disk, copy the NuGet packages and their directory structure from the previous version and copy it to the v2018.3 location.
    • If you are updating from 2016.2 - Move them in the Default tenant (C:\Program Files (x86)\UiPath\Orchestrator\NuGetPackages\Tenants\Default). This step is necessary as the option to segregate data among tenants was not available in that version, and you have to decide how to sort out your packages.
  9. If you are using Redis for cache management, flush all Redis cache keys, using the FLUSHALL or FLUSHDBcommand. More info on them is available here or here.
  10. Restart the UiPath Robot service on all Robot machines you have connected to Orchestrator if you are updating from a version prior to v2018.2 (that did not have the new licensing model). If you are updating from v2016.2, please note that you also need to add the username and passwords for all your Robots before restarting the service.

Previous Version Installed With Windows Installer

To update Orchestrator from a version that was previously installed using the Windows installer, perform the following actions:

Important!

If the previous Orchestrator installation path and the current one is different, please note that you need to stop IIS before running the UiPathOrchestrator.msi and copy the web.config settings as explained in the proceedure above. For example, you might need to do this if you are updating from a version prior to 2018.1 or have installed Orchestrator in a custom location.

  1. Back up your automation packages, web.config file, and database.
  2. Run the v2018.3 UiPathOrchestrator.msi installer.
  3. Fill in the information as explained here. Orchestrator v2018.3 is installed with the UiPathOrchestrator name, the database is updated, and all your data is migrated.
  4. If you are using Redis for cache management, flush all Redis cache keys, using the FLUSHALL or FLUSHDBcommand. More info on them is available here or here.
  5. Restart the UiPath Robot service on all Robot machines you have connected to Orchestrator if you are updating from a version prior to v2018.2 (that did not have the new licensing model). If you are updating from v2016.2, please note that you also need to add the username and passwords for all your Robots before restarting the service.

Multi-node Environment

If you have a load-balanced environment for Orchestrator, the following steps need to be taken to update all your nodes:

  1. Back up your automation packages, web.config file, and database.
  2. On all nodes, run the UiPathOrchestrator.msi Windows Installer and fill in the information as explained here, using the same SQL Sever and Elasticsearch (if any). Orchestrator v2018.3 is installed with the UiPathOrchestrator2018.3 name.

Note:

If your previous multi-node installation was done with scripts, please also follow the 4-10 steps described above.

  1. Execute the Configure-Platform.ps1 script on the primary node and then all the secondary nodes as explained here.
  2. If you are using Redis for cache management, flush all Redis cache keys, using the FLUSHALL or FLUSHDBcommand. More info on them is available here or here.
  3. Restart the UiPath Robot service on all Robot machines you have connected to Orchestrator if you are updating from a version prior to v2018.2 (that did not have the new licensing model). If you are updating from v2016.2, please note that you also need to add the username and passwords for all your Robots before restarting the service.

Important!

If you want to use the Concurrent Runtime license type, please note that when updating to v2018.3 from an older version, if you have High-Density Robots set up, the number of runtimes per machine is automatically set to 1, and not the total number of Robots on that machine.