UiPath Installation and Upgrade

The UiPath Installation and Upgrade Guide

About Installation

The installation artifacts are provided when you first purchase Orchestrator or they can be provided by your customer success manager or our support team. If you want to try our products prior to purchasing, check out the trial versions on our website here.

Orchestrator installation can be done in the following ways:

  • through a Windows installer - a complex installation of Orchestrator and all its components, on one or multiple nodes. Please note that the repair functionality of the Windows Installer is not supported.
  • through an installation script for Azure - a complex installation of Orchestrator and its components on one or multiple nodes, in the Azure Portal.
  • through the UiPath Platform installer - an executable that helps you install Orchestrator, Robot, and Studio. The installation procedure is the same as with the Windows Installer, yet please note that this installer does not accept command line arguments. This is usually recommended for one-node architectures.

Regardless of the way you choose to install, please note that if the database you point to does not exist, it is automatically created during the installation.

UiPath collects usage and performance data to help diagnose problems and help improve Orchestrator. For more details about UiPath’s privacy practices, please review the privacy statement.

🚧

Important!

Before installing the UiPath Orchestrator, please go through all the steps provided in Prerequisites for Installation.

Logging in to Orchestrator using the Internet Explorer or Edge web browsers does not work if the name of your website contains an underscore (“_”), such as https://orchestrator_tests.com.

Also, please keep in mind that regardless of the type of installation, in order for the scheduling features to work properly, you must ensure that:

  • in clustered mode the clocks on all machines have to be synchronized within less than one second;
  • the clocks for the database and Orchestrator machines also have to be synchronized;
  • if the SQL database enters a faulted state it is recommended to restart the Orchestrator web server from IIS. If you are in an NLB environment, please restart all web servers.

About the Windows Installer

The UiPath Orchestrator Windows installer (UiPathOrchestrator.msi) can help you install Orchestrator and enables you to perform the following:

  • install on one or multiple nodes;
  • configure the IIS settings (website + app pool);
  • add firewall rules for the chosen website port;
  • configure database settings for an SQL Server database;
  • automatically sets up all NuGet feeds for packages and activities;
  • set up Identity Server for centralized authentication and access control across UiPath products;
  • set up Elasticsearch for logging;
  • enable Windows authentication.
  • enable Webhooks services

By default Orchestrator is installed in the C:\Program Files (x86)\UiPath\Orchestrator directory.

🚧

Important!

You cannot change the website and the application pool names.

About the Azure Installation Script

The Azure installation script enables you to install and configure all the same components as the Windows installer and scripts, with one or more multiple nodes. This script is differentiated from the other by the fact that it can help you install Orchestrator in the Azure Portal, with app services.

The UiPath Platform Installer

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

However, please note that the UiPathPlatformInstaller.exe does not accept command line arguments.

Modifying an Orchestrator Installation

After installing Orchestrator, you can modify the installation to add or remove optional features: Insights and/or Test Automation.

Modifying via Installer

Go to Add/Remove Programs, select UiPath Orchestrator and choose Change. You can enable/disable any of the two modules from the Features screen. You will then be taken to their corresponding configuration screens, which are the same from the installation flow.

Modifying via Command Line

To add both features, after you have installed Orchestrator without them, run from an Admin Command Prompt:

UiPathOrchestrator.msi ADDLOCAL=InsightsFeature,TestAutomationFeature DB_INSIGHTS_DATABASE_NAME=UiPathInsights DB_INSIGHTS_SERVER_NAME=.\sqlexpress DB_INSIGHTS_AUTHENTICATION_MODE=WINDOWS TA_DATABASE_NAME=UiPathTestAutomation /Q /lvx* log.txt

To remove one or both features, after installation, use the REMOVE parameter:

UiPathOrchestrator.msi REMOVE=InsightsFeature,TestAutomationFeature /Q /lvx* log.txt

Updated 2 months ago


About Installation


Suggested Edits are limited on API Reference Pages

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