UiPath Orchestrator Guide

The Windows Installer

Single Node Installation

Important!

Before performing this procedure, ensure that you went through the Prerequisites chapter, and have made all the necessary preparations.

The UiPathPlatformInstaller.exe can also be used to install Orchestrator, but it cannot accept command line arguments.

In single-node installations, the session is kept in the memory, as you do not need to share it.

  1. Run the Windows Installer (UiPathOrchestrator.msi). The UiPath Orchestrator Setup wizard is displayed.
  2. Read and accept the terms, and click Install. If URL Rewrite is installed on the machine you are running the installer, the Orchestrator IIS Settings step is displayed. If URL Rewrite is not installed, you are prompted to do so.
  1. Change the IIS Settings as desired:
    • Website name - the name of the website. This is set to UiPathOrchestrator and cannot be edited.
    • Host name - used to identify the device on which Orchestrator is installed. By default, this is set to the full computer name.
    • Website Port - the port you want to use to enable the communication between the computer and Orchestrator. By default, this is 443, to enable you to use HTTPS.
    • Add firewall rules for this port - when selected, automatically adds firewall rules for this port, to ensure your machine's security.
    • SSL certificate - the name of the SSL certificate you want to use to secure connections with Orchestrator. By default, this is filled in with the full computer name.
    • Verify port availability - if selected, checks if the specified website port is available.
  2. Click Next. The Application Pool Settings step is displayed.
  1. Configure the following options as desired:
    • AppPool name - the application pool name. This is set to UiPathOrchestrator by default and cannot be edited.
    • Identity for AppPool - enables you to chose between running the UiPath Orchestrator website under an application pool identity or a specified Windows identity.
      • Application Pool Identity - runs the Orchestrator website under the identity of an application pool.
      • Custom account - runs the Orchestrator website under a specified Windows identity. Selecting this option displays two fields, Username and Password, which enable you to specify the Windows identity under which to run.

For more information on the differences between the two, please see Microsoft's official documentation - https://technet.microsoft.com/en-us/library/cc771170(v=ws.10).aspx.

  1. Click Next. The Orchestrator Database Settings step is displayed.
  1. Fill in the fields with information about your SQL Server, as follows:

Note:

If you want to migrate your data provide the information of the SQL Server database previously used.

  • SQL Server Host - the name of the SQL Server machine. By default, this is set to localhost (.). If it is not the default instance, please also mention it in the MyMachine\MyInstance format. You can also specify a custom port number here using a comma, such as MyMachine\MyInstance,800.
  • Database Name - the name of the database. By default, it is UiPath. Please note that the following special characters are not supported: an empty space, \, /, *, :, ?, ", <, >, |, and the maximum length is 123 characters.
  • Authentication mode - choose one of the following:
    • Windows Integrated Authentication - This is the default option. If you select it, Orchestrator connects to the database using the detected IIS Application Pool's Windows account and creates the database using the Windows credentials you are currently logged in with. For more information, see the Prerequisites chapter.
    • SQL Server Authentication - If you select this option, the SQL Username and Password fields are displayed, which have to be filled in with the SQL Server username and password. For more information, see the Prerequisites chapter.
  1. Click Next. The SQL connection is verified by the installer. If the SQL connection was not valid, a dialog box is displayed. If the SQL connection was valid, the next step is displayed. The Elasticsearch Log Settings step is displayed.
  1. (Optional) Fill in the fields with information about your Elasticsearch instance, as follows:
    • URL - The Elasticsearch URL to which you want to log information.
    • Requires authentication - Enables you to indicate if your Elasticsearch instance requires authentication. If selected, the Username and Password.
      • Username - The Elasticsearch username.
      • Password - The Elasticsearch password.

Note:

If you do not want to use Elasticsearch for logging, please leave the URL field empty.

  1. Click Next. The Orchestrator Authentication Settings step is displayed.
  1. Fill in the fields as follows:
    • Host password - Set a custom password for the host administrator. Please note that passwords have to be least 8 characters long, and must have at least one lowercase character and at least one digit.
    • Confirm password - Confirm the host administrator password.
    • Reset at first login - Enables you to enforce a password reset on the first login for the host administrator. This is also called a one-time password.
    • Default tenant password - Set a custom password for the default tenant administrator. Please note that passwords have to be least 8 characters long, and must have at least one lowercase character and at least one digit.
    • Confirm password - Confirm the default tenant administrator password.
    • Reset ar first login - Enables you to enforce a password reset on the first login for the default tenant administrator. This is also called a one-time password.
    • Enable Windows Authentication - If selected, enables Windows Authentication in Orchestrator and displays the Active Directory domain field.
      • Active Directory domain - the Active Directory domain you want to use in Orchestrator and from which users are going to be imported from.
  2. Click Next. The Ready to install UiPath step is displayed.
  3. Click Install. The installation process starts. Note that Orchestrator is installed at the following location: C:\Program Files (x86)\UiPath\Orchestrator.
  4. Navigate to IIS Manager.
  5. Select the server. The Features View is updated accordingly.
  6. Double-click Feature Delegation. The Feature Delegation view is displayed.
  7. Right-click the Authentication - Windows and click Read/Write.
  8. Start the website. You can now use Orchestrator.

Note:

To log in as the host administrator, use the credentials provided by our teams when purchasing a license and write host in the Tenant Name field. Details here.

Multi-node Installation

The multi-node installation also requires you to execute a script called Configure-PlatformNode.ps1, that can be found, by default, in the C:\Program Files (x86)\UiPath\Orchestrator\Tools\Configure-PlatformNode.ps1 folder.

Please note that, by default, when installing Orchestrator in a cluster with the Configure-PlatformNode.ps1 script, the session state is automatically set to the same Redis instance used for caching, the one provided at steps 2.4 and 3.4 in the below procedure.

  1. Mandatory - Install and configure a Redis Server that is to be used for caching and shared by the Orchestrator nodes. Please note that setting up the Orchestrator in a clustered environment without a Redis Server is not supported. A Redis cluster is required to ensure High Availability in production environments.
  2. On the primary node:
    2.1. Install Orchestrator as explained above on the machine that is to become the first node. Orchestrator is installed by default in the C:\Program Files (x86)\UiPath\Orchestrator folder.
    2.2. Open PowerShell as an administrator.
    2.3. Go to the location of the Configure-PlatformNode.ps1 script. By default, you can find it in the C:\Program Files (x86)\UiPath\Orchestrator\Tools folder.
    2.4. Configure the primary load-balanced Orchestrator node using the Configure-PlatformNode.ps1 script, Redis as the common data store, and the storage type of your choosing. For example, you can use:
    .\Configure-PlatformNode.ps1 -mode ConfigurePrimary -websiteName "UiPath Orchestrator" -storageType FileSystem -storageLocation "RootPath=\\Share\Storage" -redisServer redis.domain.local -redisPassword 1234
    Specify the -redisPort parameter if you want to overwrite the default Redis port.
    2.5. Copy the Web.config and MigrationHistory.txt files to a location which can be accessed by the secondary nodes, so that you can use them to keep the same settings across all nodes.
  3. On all the secondary nodes, install Orchestrator using UiPathOrchestrator.msi with command line arguments, making sure you provide:
    • the SECONDARY_NODE=1 parameter;
    • the CONFIGURATION_FOLDER=D:\MyConfigFolder set to the directory location in which you saved the Web.config and MigrationHistory.txt files, at step 2.5.
      For example: UiPathOrchestrator.msi SECONDARY_NODE=1 CONFIGURATION_FOLDER=D:\MyConfigFolder. The Application Pool is started and you can start using your Orchestrator instance.

The database is initialized when you install the primary node. When setting up the secondary nodes, the database initialization step is no longer needed.

Packages Storage Considerations

The metadata (definition) of all packages - activities, workflows, libraries - is kept in the SQL database. This enables you to search and apply filters to related Orchestrator pages faster.

In addition to this, it is possible to keep the actual files and execution media on the FileSystem or a blob storage of your choosing - Azure, Amazon S3, or Minio. This feature allows for a more performant file synchronization, especially in complex multi-node Orchestrator environments.

To enable this feature you are required to configure the NuGet.Repository.Type parameter in the web.config file, as explained here.

Take into consideration that, regardless of the storage you use to keep your packages, the maximum file size per upload is 28.6MB - a limitation given by IIS. To see how to change this for Amazon, Minio, and FileSystem, please visit this page.

Note:

By default, in new installations, the repository type is set to Composite and the storage type to FileSystem. 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.



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.