Overview

The update process can be different depending on whether:

• the previous version was set up with the Windows installer;
• your Orchestrator instance is in a multi-node environment.

🚧

Important!

Before upgrading, please visit the Hardware Reqirements, Software Reqirements and prerequisites pages, for the version you are upgrading to, as they may have changed. You need to ensure you meet all requirements prior to upgrade.

If upgrading from a version older than v2020.10, we recommend that you restart all your robots in order for them to apply the new settings.

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.

Starting with v2020.4, there are more requirements for the SSL certificate of Orchestrator. Make sure you meet all prerequisites. For how to change your existing certificate, see Using a Certificate for the HTTPS Protocol.

Double-check the selected installation path. Moving an installation from one location to another post-install is not supported.

It is recommended to preserve the previous Orchestrator Application Pool identity type for Identity Server and Webhooks as well. Otherwise, issues may occur while accessing the SQL server.

If you are considering installing Insights, make sure that you select the db_owner role as this is required when you configure the Insights SQL Server configuration.

If you upgrade from a version older than 2021.10 that has the Windows Authentication option selected, make sure to run the installer as an AD user.

If you upgrade from a version older than 2021.10 and your database connection string contains custom parameters (e.g. MultiSubnetFailover), you should perform a silent upgrade (using /Q option). This way, the new connection string(s) present in the new version can be properly initialized with the custom parameters specific to your scenario.

Previous Version Installed with Windows Installer

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

1. Back up your automation packages, web.config and UiPath.Orchestrator.dll.config files, and database.
2. Run the UiPathOrchestrator.msi installer. Orchestrator is installed with the UiPathOrchestrator name, the database is updated, and all your data is migrated. You can also update the Identity Server and Update Server settings at this stage.
3. If you are using HAA for cache management, flush all HAA cache keys, using the following command: redis-cli -h <hostname> -p <portnumber> -a <password> flushall. Note that HAA uses port 10000 by default. For example:

redis-cli -h redis-12345.c24.us-east-mz-1.ec2.cloud.redislabs.com -p 10000 -a xyz flushall

Multi-Node Environment

In a multi-node environment, upgrading is done differently on primary and secondary nodes. The below steps need to be taken to update all your nodes.

📘

Note:

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.

Backup Files

Back up your automation packages, web.config and UiPath.Orchestrator.dll.config files, and database.

Primary Node Installation

For Attended Installation: Run from the Admin Command Prompt the following command:

UiPathOrchestrator.msi OUTPUT_PARAMETERS_FILE=c:\temp\upgradeParams.json /lvx* ugprade.log

For Unattended Installation: Run from the Admin Command Prompt the following command:

UiPathOrchestrator.msi PUBLIC_URL=https://hostname.local APPPOOL_USER_NAME=serviceAccount APPPOOL_PASSWORD=pass OUTPUT_PARAMETERS_FILE=c:\temp\upgradeParams.json /lvx* ugprade.log /Q

Follow through with the installation as described here.

🚧

Important

Do not forget to back up the upgradeParams.json configuration file generated by the installation. This is to be used on subsequent, secondary node installations.

Secondary Nodes Installation

It is recommended to run the unattended install, using the upgradeParams.json configuration file produced on the primary node. Run from the Admin Command Prompt the following command:

UiPathOrchestrator.msi SECONDARY_NODE=1 PARAMETERS_FILE=c:\temp\upgradeParams.json /lvx* ugprade.log /Q

Flush Keys

If you are using HAA for cache management, flush all HAA cache keys, using the following command: redis-cli -h <hostname> -p <portnumber> -a <password> flushall. Note that HAA uses port 10000 by default. For example:

redis-cli -h redis-12345.c24.us-east-mz-1.ec2.cloud.redislabs.com -p 10000 -a xyz flushall

🚧

Important!

If you want to use the Concurrent Runtime license type, please note that when updating from a version older than v2020.4, 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.