- Open the
AzureApplicationSettings.jsonfiles generated on your previous deployment using a text editor such as Notepad++.
- Download the latest available
- Unblock the
UiPathOrchestrator.zipfile using the PowerShell command
Unblock-File. For example,
- Run the
Publish-Orchestrator.ps1script in PowerShell using the values found in the
AzureApplicationSettings.jsonfiles, 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 "Off" ` -machineKeyDecryption "machineKeyDecryption from AzurePublishParameters.json" ` -machineKeyDecryptionKey "machineKeyDecryptionKey from AzurePublishParameters.json" ` -machineKeyValidation "machineKeyValidation from AzurePublishParameters.json" ` -machineKeyValidationKey "machineKeyValidationKey from AzurePublishParameters.json" `
If you are using Redis in your multi-node installation, please include the following parameters:
package "path/to/package"- Mandatory. Indicate the full path of the
publishSettingsPath "path/to/publishSettings"- Mandatory. Specify the full path of the
-activitiesPackagePath- Optional. Specify the full path of the
UiPathActivities.ziparchive, 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
nugetRepositoryTypeis set to
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
storageLocationparameters. This is the default value in update scenarios.
Legacy- Uses FileSystem for package sync. Packages and activities are saved in the locations specified in the
NuGet.Activities.Pathparameters, respectively. Execution media is saved to the location specified through the
storageLocationparameters. Platform users must enter this value in update scenarios to maintain access to preexisting packages.
storageType "StorageType"- Defines the target where execution media and packages are to 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
Amazon- such as
Minio- such as
storageLocation "StorageLocation"- Defines the actual location where execution media and packages are to be saved. Particularities:
- FileSystem - provide an absolute path in the
RootPath=.\Storageformat, such as
- Azure - provide a connection string, such as
- Amazon - provide a connection string, such as
- Minio - provide a connection string, such as
More information on these deployment types is available here.
- FileSystem - provide an absolute path in the
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.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:
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.
- Store the
AzureApplicationSettings.jsonfiles to a preferred location, as you need them for future deployments.
- If you are using Redis for cache management, flush all Redis cache keys, using the
FLUSHDBcommand. More info on them is available here or here.
- Start the Orchestrator app service. Enjoy using Orchestrator on your Azure Portal.
- 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.
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.