UiPath Orchestrator Guide

The Azure App Service Installation Script

Important!

Make sure you have Web Deploy 3.5.

The Azure installation script enables you to install Orchestrator on one or multiple nodes.

One Node Installation

To install Orchestrator on an Azure App Service perform the following steps:

  1. In the Azure Portal, under App Services, create a new app service with a custom name such as UiPathOrchestrator. For more information, see Microsoft's official documentation.
  2. Set the database connection string in the Application Settings of the web app, with the name "Default". For example, Server=13.13.13.13;Initial Catalog=UiPath;Persist Security Info=False;User ID=dbUser;Password=pass123; MultipleActiveResultSets=False;Encrypt=True; Connection Timeout=30;TrustServerCertificate=True.
  3. Select the app and, in the Overview tab, click Get Publish Profile. The [appservicename].PublishSettings file is downloaded.
  4. Download the UiPathOrchestrator.zip archive.
  5. Run the Publish-Orchestrator.ps1 script, in PowerShell, as follows:
Publish-Orchestrator.ps1 `
-action Deploy `
-package "path/to/package" `
-publishSettingsPath "path/to/publishSettings" `

Where:

  • package "path/to/package"- Mandatory. Indicate the full path of the UiPath.Web.zip archive;
  • publishSettingsPath "path/to/publishSettings" - Mandatory. Specify the full path of the [appServiceName].PublishSettings file.

This procedure generates two files:

  • AzurePublishParameters.json
  • AzureApplicationSettings.json.
  1. Store the AzurePublishParameters.json file to a preferred location, as you need it for future deployments.
  2. Open the AzureApplicationSettings.json file with a text editor such as Notepad++.
  3. Copy all the information present in the AzureApplicationSettings.json file to the Azure Portal, in the Application settings tab, under the App settings section.
  4. Start the Orchestrator app service. Enjoy using Orchestrator on your Azure Portal.

Clustered Installation

To install Orchestrator on multiple nodes on an Azure App Service perform the following steps:

  1. In the Azure Portal, under App Services, create a new app service with a custom name such as UiPathOrchestrator. For more information, see Microsoft's official documentation.
  2. Set the database connection string in the Application Settings of the web app, with the name "Default". For example, Server=13.13.13.13;Initial Catalog=UiPath;Persist Security Info=False;User ID=dbUser;Password=pass123; MultipleActiveResultSets=False;Encrypt=True; Connection Timeout=30;TrustServerCertificate=True.
  3. In the Scale out (App Service plan) tab, select the Scale to a specific instance count option and provide the desired Instance count.
  4. In the Overview tab, click Get Publish Profile. The [appServiceName].PublishSettings file is downloaded.
  5. Download the UiPathOrchestrator.zip archive.
  6. Run the Publish-Orchestrator.ps1 the script, in PowerShell, as follows:
Publish-Orchestrator.ps1 `
-action Deploy `
-package "path/to/package" `
-publishSettingsPath "path/to/publishSettings" `
-sessionStateMode "SQLServer" `
-useQuartzClustered `
-redisServer "RedisServer" `
-redisPassword "RedisPassword" `
-redisPort [RedisPort] `
-robotsElasticSearchUrl "RobotsElasticSearchUrl" `
-ElasticSearchUsername "Username" `
-ElasticSearchPassword "Password" `
-elasticSearchDiagnosticsUsername "Username" `
-elasticSearchDiagnosticsPassword "Password" `

Where:

  • package "path/to/package"- Mandatory. Indicate the full path of the UiPathOrchestrator.zip archive.
  • publishSettingsPath "path/to/publishSettings" - Mandatory. Specify the full path of the [appServiceName].PublishSettings file.
  • sessionStateMode "SQLServer" - Mandatory. If you want to use SQL Server, this is required exactly as written here so that the web app can retain its session in the database.

Note

If you want to use Redis, the sessionStateMode enumeration should be omitted from the script as this preserves its default mode.

  • useQuartzClustered - Mandatory. A switch that indicates that this is a clustered installation.
  • redisServer "RedisServer" - Mandatory. If you want to use Redis as your database, provide this parameter and the URL of the server as a value.
  • redisPassword "RedisPassword" - Mandatory. If you want to use Redis, provide the password for your Redis server instance.
  • redisPort [RedisPort] - Mandatory. If you want to use Redis, provide the port used by your Redis server.
  • robotsElasticSearchUrl "RobotsElasticSearchUrl" - Optional. This should be used only if you want to use Elasticsearch for logging. Provide the Elasticsearch URL as the value, such as "http://elasticserver:9200". If your Orchestrator instance requires authentication, provide the ElasticSearchUsername, ElasticSearchPassword, elasticSearchDiagnosticsUsername, and elasticSearchDiagnosticsPassword parameters.
  • ElasticSearchUsername "Username" - Optional. This parameter enables you to indicate the username for your Elasticsearch instance if its authentication is enabled.
  • ElasticSearchPassword "Password" - Optional. This parameter enables you to indicate the password for your Elasticsearch instance if its authentication is enabled.
  • elasticSearchDiagnosticsUsername "Username" - Optional. This parameter enables you to indicate the username for your Elasticsearch instance if its authentication is enabled. This parameter together with elasticSearchDiagnosticsPassword "Password" are required for internal Orchestrator logs.
  • elasticSearchDiagnosticsPassword "Password" - Optional. This parameter enables you to indicate the password for your Elasticsearch instance if its authentication is enabled. This parameter together with elasticSearchDiagnosticsUsername "Username" are required for internal Orchestrator logs.

This procedure generates two files:

  • AzurePublishParameters.json
  • AzureApplicationSettings.json.
  1. Store the AzurePublishParameters.json file to a preferred location, as you need it for future deployments.
  2. Open the AzureApplicationSettings.json file with a text editor such as Notepad++.
  3. Copy all the information present in the AzureApplicationSettings.json file to the Azure Portal, in the Application settings tab, under the App settings section.
  4. Start the Orchestrator app service. Enjoy using Orchestrator on your Azure Portal.


The Azure App Service Installation Script


Suggested Edits are limited on API Reference Pages

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