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.

  1. Run the Windows Installer (UiPathPlatform.msi). The UiPath Platform Setup wizard is displayed.
  2. Read and accept the terms, and click Advanced. The Product Features step is displayed.
  3. Select the Orchestrator WebSite > Will be installed on local hard drive to install it.
  1. (Optionally) Select the Robot and Studio features.
  2. Click Next. The Orchestrator IIS Settings step is displayed.
  1. Change the IIS Settings as desired:
    • Website name - the name of the website. This is set to UiPathOrchestrator2018.1 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.
  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 UiPathOrchestrator2018.1 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, User name 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 from the 2017.1 version, provide the information of the v2017.1 SQL Server database.

  • 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 - chose one of the following:
    • Windows Integrated Authentication - If you select this option, Orchestrator connects to the database using the detected IIS Application Pool's Windows account, or creates the database using the Windows credentials you are currently logged in with. For more information, see the Prerequisites chapter.
    • SQL Server Authentication - This is the default option. When you select this, the SQL Username and Password fields are displayed, that 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:
    • 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.

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.

  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 load-balanced 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 UiPath Orchestrator using the Windows Installer 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-Platform.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 Redis as the common data store and a shared NuGet local path. For example, you can use the .\Configure-PlatformNode.ps1 -mode ConfigurePrimary -websiteName UiPathOrchestrator2018.2 -nugetPackagesPath \\fileshare\NuGetPackages -redisServer redis.domain.local -redisPassword 1234 command. The database is initialized.

Important!

The following Information is returned when the script execution ends: encryptionKey, machineKeyDecryptionKey, machineKeyValidationKey, and nugetPackagesApiKey. Please keep in mind that these details are required in setting up the secondary nodes.
You can also store this info in a file, by using the -outputCommandFile and providing a file name for the output file, such as -outputCommandFile 'Install-Secondary.ps1'. For more information, please see the Configure-PlatformNode.ps1 Parameters page.

  1. On all the secondary nodes:

Important!

Silently (/Q) installing Orchestrator on secondary nodes is not supported. As a workaround, point the secondary nodes to an unexisting database (DB_CONNECTION_STRING) then provide the correct database information in the web.config file on every node, as follows:
<connectionStrings> <add name="Default" providerName="System.Data.SqlClient" connectionString="Server=.\sqlexpress;Database=UiPathDatabase;User ID=id;Password=password;" /> </connectionStrings>

3.1. Install UiPath Orchestrator on all the other machines that are to become secondary nodes using the Windows Installer with command line arguments and making sure that you include the SECONDARY_NODE=1 parameter and you point them to the same SQL Server and Elasticsearch URL (if any) provided on the first node. Orchestrator is installed by default in the C:\Program Files (x86)\UiPath\Orchestrator folder.
3.2. Open PowerShell as an administrator.
3.3. Go to the location of the Configure-Platform.ps1 script. By default, you can find it in the C:\Program Files (x86)\UiPath\Orchestrator\Tools folder.
3.4. Configure the secondary nodes using the same Redis Server and NuGet location used at step 2.4, and include the information that was returned at that step. For example, you can use the following command: .\Configure-PlatformNode.ps1 -mode ConfigureSecondary -websiteName UiPathOrchestrator2018.2 -nugetPackagesPath \\fileshare\NuGetPackages -nugetPackagesApiKey "1111-PUT-YOUR-GUID-HERE-11111" -redisServer redis.domain.local -redisPassword 1234 -encryptionKey "myPrimaryNodeEncryptionKey" -machineKeyDecryptionKey "myPrimaryNodeMachineDecryptionKey" -machineKeyValidationKey "myPrimaryNodeMachineValidationKey". The Application Pool is started and you can start using your Orchestrator instance.

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


The Windows Installer