UiPath Orchestrator Guide

Updating Using the Azure Script

  1. Open the AzurePublishParameters.json and AzureApplicationSettings.json files generated on your previous deployment using a text editor such as Notepad++.
  2. Download the latest available UiPathOrchestrator.zip archive.
  3. Unblock the UiPathOrchestrator.zip file using the PowerShell command Unblock-File. For example, Unblock-File .\UiPathOrchestrator.zip.
  4. Unarchive the UiPathOrchestrator.zip.
  5. Run the Publish-Orchestrator.ps1 script in PowerShell using the values found in the AzurePublishParameters.json and AzureApplicationSettings.json files, as follows:
Publish-Orchestrator.ps1 `
-action Update `
-package "path/to/package" `
-activitiesPackagePath \"path/to/UiPathActivities.zip\" `
-encryptionKey "encryptionKey from AzurePublishParameters.json" `
-packagesApiKey "packagesApiKey from AzureApplicationSettings.json" `
-activitiesApiKey "activitiesApiKey from AzureApplicationSettings.json" `
-publishSettingsPath "path/to/publishSettings" `
-nugetRepositoryType "RepositoryType" `
-storageType "StorageType" `
-storageLocation "StorageLocation" `
-sessionStateMode "sesionStateMode from AzurePublishParameters.json" `
-sessionStateSqlConnectionString "sessionStateSqlConnectionString from AzurePublishParameters.json" `
-machineKeyDecryption "machineKeyDecryption from AzurePublishParameters.json" `
-machineKeyDecryptionKey "machineKeyDecryptionKey from AzurePublishParameters.json" `
-machineKeyValidation "machineKeyValidation from AzurePublishParameters.json" `
-machineKeyValidationKey "machineKeyValidationKey from AzurePublishParameters.json" `

Note:

If you are using Redis in your multi-node installation, please include the following parameters:
-redisServer "#{RedisServer}"
-redisPassword "#{RedisPassword}"
-redisPort #{RedisPort}

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;
  • -activitiesPackagePath - Optional. Specify the full path of the UiPathActivities.zip archive, which is included by default, starting with v2018.4.4, in UiPathOrchestrator.zip. This enables you to install the local activity feed in Azure at install-time. Please note that this parameter only works if the nugetRepositoryType is set to Legacy.
  • nugetRepositoryType "RepositoryType" - Mandatory. This parameter specifies where execution media and packages are saved. It can be populated as follows:
    • Composite - Package metadata is saved to the SQL database for faster search and filtering. Execution media and packages are saved to the location specified through the storageType and storageLocation parameters. This is the default value in update scenarios.
    • Legacy - Uses FileSystem for package sync and execution media storage. Platform users must enter this value in update scenarios to maintain access to preexisting packages.
  • storageType "StorageType" - Defines the target where the packages should be saved. It can be populated with the following targets:
    • FileSystem - such as storageType "FileSystem". This is the default value in update scenarios.
    • Azure - such as storageType "Azure".
    • Amazon - such as storageType "Amazon".
    • Minio - such as storageType "Minio".
  • storageLocation "StorageLocation" - Defines the actual location where execution media and packages are to be saved. Particularities:
    • FileSystem - provide an absolute path in the RootPath=.\Storage format, such as storageLocation "RootPath=C:\FolderName\AnotherFolderName". In the provided folder, three other sub-directiories are created: ExecutionMedia, Packages, and Libraries. Files are saved according to their type in dedicated folders, at the specified location. This is the default value in update scenarios.
    • Azure - provide a connection string, such as storageLocation "DefaultEndpointsProtocol=https;AccountName=usr;AccountKey=...;EndpointSuffix=core.windows.net".
    • Amazon - provide a connection string, such as storageLocation" "EndpointRegion=eu-west-3;accessKey=AKIAZGUEIGXUJ3BBI4MW;secretKey=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;useHttp=false".
    • Minio - provide a connection string, such as storageLocation" "host=localhost:9001;accessKey=YVKYFJ0ZY246KDKP0634;secretKey=bdBEk2ubhIFsTNPuQ80PjKL+oqZBj67HoSWBFnw1".

Important!

If you are using a local path for NuGet packages and/or activities ("~/NuGetPackages", "~/NuGetPackages/Activities") and you decide to change that location using the NuGet.Packages.Path or NuGet.Activities.Path parameters, please make sure to include the following to the publish script:
-foldersToSkip @("\\path\\to\\packages", "\\path\\to\\activities").

It is important to add two backslashes to the paths in this parameter, as it is an array which contains regular expressions and backslashes have to be escaped.

This procedure generates two files:

  • AzurePublishParameters.json
  • AzureApplicationSettings.json.

Important!

If your web app is running inside an Azure Stack\Azure Pack\ASE, you have to add Orchestrator's IP to the SQL Server's firewall settings. This is required so that the web app can have access to the database.

  1. Store the AzurePublishParameters.json and AzureApplicationSettings.json files to a preferred location, as you need them for future deployments.
  2. If you are using Redis for cache management, flush all Redis cache keys, using the FLUSHALL or FLUSHDBcommand. More info on them is available here or here.
  3. Start the Orchestrator app service. Enjoy using Orchestrator on your Azure Portal.
  4. Restart the UiPath Robot service on all Robot machines you have connected to Orchestrator. If you are updating from v2016.2, please note that you also need to add the username and passwords for all your Robots before restarting the service.

Important!

If you want to use the Concurrent Runtime license type, please note that when updating from an older version, if you have High-Density Robots set up, the number of runtimes per machine is automatically set to 1, and not the total number of Robots on that machine.


Updating Using the Azure Script


Suggested Edits are limited on API Reference Pages

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