You can directly update Orchestrator to 2022.4 if you currently use any of the following versions:
If you use version 2018.4 you need to upgrade to 2019.x or 2020.x or 2021.x and then jump to 2022.4.
If you use a version lower than 2018.4, you need to upgrade to v2018.4 or v2019.x or 2020.x, and then jump to 2022.4.
We recommend using 2019.10 as an intermediate version.
To see the latest available versions, please check the Release Notes page.
Before proceeding with an Orchestrator upgrade/installation, carefully review the following task list:
Review the system requirements
Learn about changes introduced by the new deployment
A new Orchestrator deployment brings about changes that you should be aware of. Some of the items must be taken care of before an upgrade/installation. Some are notes on the biggest changes and recommendations on how to get the best of the new version.
Run the Platform Configuration Tool
The Platform Configuration Tool is a PowerShell script used to assist you in the successful installation/upgrade of Orchestrator. It helps you check the sanity and readiness of your environment before an upgrade, and assists you in performing several operations post-installation.
Upgrades of your Orchestrator must be made with the application stopped. Performing any updates while the application is running can result in errors and is not supported.
Installation artifacts are provided when you first purchase Orchestrator or they can be provided by your customer success manager or our support team. There are a few ways to directly update:
UiPathOrchestrator.msi performs an in-place update that copies all your settings and creates a backup folder for the old version. It is suitable for both one node and multi-node architecture. Some
web.config settings are not copied if the version you are upgrading from was installed using the deprecated scripts. The repair functionality of the Windows Installer is not supported.
If the Orchestrator you want to update was installed using the now deprecated
UiPathPlatformInstaller.exe, use the Windows installer to update to this version.
A complex update of Orchestrator and its components on one or multiple nodes, in the Azure Portal.
Learn how to update using the Azure script.
During an Orchestrator update, the installer cannot read an encrypted
SecureAppSettings section within
web.config . In order to read the
EncryptionKey from Orchestrator's
web.config and then migrate it into Identity Server's
appsettings.Production.json, the key must be plain text. You need to manually decrypt the section before updating Orchestrator. After the Orchestrator update process was finalized, remember to re-encrypt the
SecureAppSettings section in
Note the new certificate requirements. If your existing certificate doesn't meet them, here is how to get a valid certificate and how to replace it in the existing Orchestrator instance, before upgrading.
For security reasons, for the certificate used to sign the access tokens generated by the Identity Server, make sure to use a public key on 2048 bits. The certificate's location has to be set within
appsettings.Production.json's Signing Credential section.
Regardless of how you choose to update, if the database you point to does not exist, it is automatically created while running the update. If you point to an existing database, it is updated during the same process. The Orchestrator SQL database is automatically set to be case-insensitive (“OrchDB” = “orchdb”) at installation.
While performing the update, if you have any external providers enabled in
web.config, you are prompted about the manual changes you need to perform on your preexistent external providers. Read here about the manual changes you need to perform.
When upgrading to the latest Orchestrator version, all your local accounts are automatically migrated from Orchestrator to Identity Server and converted to the required format.
This change does not impact your robots.
If you were ever on version 2018.4 and have never completed this conversion for users imported from Active Directory (or did not convert all imported users), those directory accounts that were not converted must interactively log in to Orchestrator at least once to finalize the conversion. Signing in to the Identity Management portal, or signing in from UiPath Studio or UiPath Assistant does not complete the conversion of the account.
Once the conversion is complete, you can no longer use basic authentication to log in with the respective users.
While upgrading to the latest Orchestrator version, we strongly recommend to use the same Application Pool identity type for Identity Server and Webhooks as the one used for Orchestrator during the original installation.
For example, if you set the Application Pool identity type as a custom account during the Orchestrator v2020.10 installation, while upgrading to v2021.10, select the same Application Pool identity type (i.e., custom account) for both Identity Server and Webhooks applications. Otherwise, the access to the SQL server may be blocked.
Some antivirus software can prevent Data Migration scripts from functioning correctly during an upgrade.
After updating your Orchestrator from 2019.10 or older, the Profile page won't display login attempts previous to that update.
After you upgrade or migrate Orchestrator, we recommend that you update your license information from the Licenses page using either online or offline activation. For instructions, see Activating Your License.
If you are upgrading or migrating from a version that is older than 2019.10, you must update your license information, otherwise you do not benefit from the grace period at license expiration, which can cause service disruption.
Legacy is no longer a supported NuGet repository type. Packages previously residing in a
Legacy repository are migrated to a
Composite repository. For composite repositories, package location is configured using the
Storage.Location parameters in
UiPath.Orchestrator.dll.config. After the upgrade, all
Legacy-related app settings become deprecated and no longer have an effect:
The new package location depends on how you configured the
NuGet.Activities.Path parameters in
web.config for the previous Orchestrator version.
If you stored the packages in the default locations (
~/NuGetPackages/Activities), the new package location becomes
Pre 2020.10 Key Defaults - web.config
2020.10+ Key Defaults - UiPath.Orchestrator.dll.config
If you stored the packages in a custom location, during the installation you are asked for a new storage location. For silent installs, the
STORAGE_LOCATION parameters become mandatory, unless you specifically add them in
Storage.Location) prior to the upgrade.
The matrix below describes when the
STORAGE_LOCATION parameters are requested or ignored during an upgrade. The matrix takes into consideration the version you are upgrading from, as well as the package location customization in both the previous version and in 2020.10 and later.
For example, based on this feature combination, the matrix shows that the two parameters are requested (flagged with a check mark) in Silent Mode for an upgrade from version 2019.4+ if the package was stored in a custom location, but its new storage location is a default one.
Previous Legacy Location
New Composite Location
Parameters Requested in the Storage Window
Parameters Requested in Silent Mode
Parameters Ignored from CMD
If, for any reason, package migration fails, you are presented with the following options:
- Retry - Package migration is restarted. Packages that have already been migrated are skipped.
- Abort - The installation is restarted. During the migration step, packages that have already been migrated are not skipped and are migrated again. For this reason, you may find duplicate files in different containers. This only happens when migrating from versions older than 2019.4.
- Continue - The migration is being carried on with.
Updated 4 months ago