UiPath Installation and Upgrade

The UiPath Installation and Upgrade Guide

About Updating and Migrating

It is possible to directly update your Orchestrator to v2020 in the following cases:

  • You have any 2018.4 version
  • You have any 2019.x version
    To see the latest available versions, please check the Release Notes page.

🚧

Important!

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.

Also 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.

There are a few ways to directly update:

  1. Using the Windows Installer (UiPathOrchestrator.msi) - 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. Please note that some web.config settings are not copied if the version you are upgrading from was installed using the deprecated scripts.
    Please note that the repair functionality of the Windows Installer is not supported.
  2. Using the Azure Script - a complex update of Orchestrator and its components on one or multiple nodes, in the Azure Portal.
  3. Using the UiPathPlatform installer - An executable file which enables you to update Orchestrator, Robot, and Studio. It is suitable for one-node architectures.

These artifacts are provided when you first purchase Orchestrator or they can be provided by your customer success manager or our support team.

Regardless of the way you choose to update, please note that 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.

🚧

Important!

During 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 web.config.

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.

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.

After updating your Orchestrator to v2020.4, the Profile page won't display login attempts previous to that update.

If you had previously enabled Windows authentication while having set up automatic login for Windows AD users, then after upgrading your Orchestrator to v2020.4, you can't access Identity Server's External Providers page. To do that, open a new browser in incognito mode and type https://<OrchestratorURL>/identity/configuration. Read more details here.

The UiPath Platform Installer

The UiPathPlatformInstaller.exe is an installer application which bundles all our products and enables you to update Orchestrator, Robot, and Studio. The processes are exactly the same as the ones you would go through using the Windows installers, UiPathStudio.msi and UiPathOrchestrator.msi.

However, please take into consideration that the UiPathPlatformInstaller.exe does not accept command line arguments.

Updated 4 months ago


About Updating and Migrating


Suggested Edits are limited on API Reference Pages

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