UiPath Orchestrator Guide

Updating Using the Windows Installer

The update process can be different depending on whether:

Important!

If the entire UiPath suite is installed on a single machine, and you want to update from v2018.2 or older versions to v2019 Fast Track, you are required to first do so on Orchestrator and then Studio and Robot. If you first update your Studio, your Orchestrator instance is removed. This is due to a change in the installers' Upgrade Code and is not necessary for updates from v2018.3 or higher.

If your packages (activities and/or workflows) are stored in a shared folder, please note that the UiPathOrchestrator.msi installer requires Write access to the aforementioned directory.

If you have more than 2 million logs in the SQL database, the update process times out. If your logs are kept in Elasticsearch, the update is smooth regardless of the number of logs maintained there.

In update scenarios, your storage type settings are kept. For updates from v2018.4 or previous versions, it is set to Legacy. For more information, see this page.

Previous Version Installed With Scripts

Before attempting to update from v2016.2, make sure to remove duplicate entries from the SQL database, if any. You can do so using an SQL script such as this one:

WITH CTE AS
(
   SELECT Id,
       RN = ROW_NUMBER() OVER (PARTITION BY AssetId, [RobotId] ORDER BY [Id] DESC)
   FROM [dbo].[AssetValues]
)
DELETE FROM CTE WHERE RN > 1;

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 v2019 Fast Track is installed.
  6. Open the v2019 Fast Track Web.config file, and copy any settings that you have customized in the previous install if any.
  7. By default the NuGet.Repository.Type parameter is set to Composite, with the FileSystem Storage.Type.
    a. If you want to keep this feature, you are required to upload all your packages again, as explained here. Please take into account the size limit set in your IIS.
    b. If you want to use your previous settings:
    • set the NuGet.Repository.Type parameter to Legacy;
    • copy the previously used values for the NuGet.Packages.Path and NuGet.Activities.Path parameters.
  8. Save and close the web.config file.
  9. 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 v2019 Fast Track 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.
  10. 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.
  11. 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!

Although you provide the admin passwords at host and default tenant level, they are not taken into account. Use your previous passwords to log in.

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 v2018.1 or have installed Orchestrator in a custom location.

  1. Back up your automation packages, web.config file, and database.
  2. Run the v2019 Fast Track UiPathOrchestrator.msi installer. Orchestrator v2019 Fast Track is installed with the UiPathOrchestrator name, the database is updated, and all your data is migrated.
  3. 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.
  4. 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. Orchestrator v2019 Fast Track is installed with the UiPathOrchestrator name, the database is updated, and all your data is migrated.

Note:

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

Additionally, if your previous multi-node installation was done with scripts, although you provide the admin passwords at host and default tenant level, they are not taken into account. Use your previous passwords to log in.

  1. Execute the Configure-PlatformNode.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 v2019 Fast Track 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.


Updating Using the Windows Installer


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.