Orchestrator installation guide

DELIVERY:

Last updated Sep 24, 2025

Resource Catalog Scripts

Publish to Resource Catalog

The following table describes all the parameters that you can use with the Publish-ResourceCatalog.ps1 script.

Parameter	Description
`-action`	Mandatory. Indicates the type of scenario you want to start. The following options are available: `Deploy` – specifies it is a clean installation. `Update` – specifies you are updating your Resource Catalog instance.
`-package`	Mandatory. Indicate the full path or relative path of the `UiPath.ResourceCatalogService-Win64.zip` archive.
`-azureAccountPassword`	Mandatory. The Azure token password for the service principal ID.
`-azureSubscriptionId`	Mandatory. The Azure subscription ID for the App Service.
`-azureAccountTenantId`	Mandatory. The Azure tenant ID.
`-resourceGroupName`	Mandatory. The name of the Azure Resource Group that contains the Resource Catalog App Service.
`-appServiceName`	Mandatory. The Resource Catalog Azure App Service name.
`-noAzureAuthentication`	Optional. Allows you to publish to the Azure App Service by relying on your own user identity, without having to create a service principal. If this parameter is used, the `UseServicePrincipal` parameter set (which includes items such as the Azure application ID, password, subscription ID, and tenant ID) are no longer necessary.
`-azureUSGovernmentLogin`	Optional. This parameter is only used for US Government deployments.

The Publish-ResourceCatalog.ps1 script is used for the initial deployment or update of Resource Catalog. The script assumes that the web app already has the DefaultConnection database connection string configured.

.\Publish-ResourceCatalog.ps1 
-action deploy 
-package ".\UiPath.ResourceCatalogService-Win64.zip" 
-azureAccountApplicationId "<azure_application_id>" 
-azureAccountPassword "<azure_account_password>" 
-azureSubscriptionId "<subscription_id>" 
-azureAccountTenantId "<azure_tenant_id>" 
-resourceGroupName "<resourcegroup_name>" 
-appServiceName "<appservice_name>".\Publish-ResourceCatalog.ps1 
-action deploy 
-package ".\UiPath.ResourceCatalogService-Win64.zip" 
-azureAccountApplicationId "<azure_application_id>" 
-azureAccountPassword "<azure_account_password>" 
-azureSubscriptionId "<subscription_id>" 
-azureAccountTenantId "<azure_tenant_id>" 
-resourceGroupName "<resourcegroup_name>" 
-appServiceName "<appservice_name>"

Migrate to Resource Catalog

The following table describes all the parameters that you can use with the MigrateTo-ResourceCatalog.ps1 script.

Parameter	Description
`-cliPackage`	Mandatory. Indicate the path to the `UiPath.ResourceCatalogService.CLI-Win64.zip` archive.
`-azureDetails`	A hash table with the following values: `azureAccountApplicationId` – Mandatory. The Azure service principal ID.. `azureAccountPassword` – Mandatory. The Azure token password for the service principal ID. `azureSubscriptionId` – Mandatory. The Azure subscription ID for the respective App Service. `azureAccountTenantId` – Mandatory. The Azure tenant ID.
`-orchDetails`	A hash table with the following values: `resourceGroupName` – Mandatory. The name of the Azure Resource Group that contains the Orchestrator App Service. `appServiceName` – Mandatory. The Orchestrator App Service name. `targetSlot` – Mandatory. The Target App Service Slot set by Azure.
`-resourceCatalogDetails`	A hash table with the following values: `resourceGroupName` – Mandatory. The name of the Azure Resource Group that contains the Resource Catalog App Service. `appServiceName` – Mandatory. The Resource Catalog App Service name. `targetSlot` – Mandatory. The Target App Service Slot set by Azure.
`-resourceCatalogUrl`	Mandatory. The public address of the Resource Catalog.
`-identityServerUrl`	Mandatory. The URL of Identity Server. Important: The URL must contain the Identity Server address + the suffix `/identity`. Example: `https://[IdentityServer]/identity`
`-noAzureAuthentication`	Optional. Allows you to publish to the Azure App Service by relying on your own user identity, without having to create a service principal. If this parameter is used, the `UseServicePrincipal` parameter set (which includes items such as the Azure application ID, password, subscription ID, and tenant ID) are no longer necessary.
`-orchestratorUrl`	Mandatory. The Orchestrator public URL.

The MigrateTo-ResourceCatalog.ps1 script is used to migrate user data from Orchestrator to Resource Catalog. It creates the database structure and add the related app settings.

The script assumes that Orchestrator and Resource Catalog are already published.

.\MigrateTo-ResourceCatalog.ps1 
-cliPackage ".\UiPath.ResourceCatalogService.CLI-Win64.zip" 
-azureDetails @{ azureSubscriptionId = "<subscription_id>"; azureAccountTenantId = "<azure_tenant_id>"; azureAccountApplicationId = "<azure_application_id>"; azureAccountPassword = "<azure_account_password>" } 
-orchDetails @{ resourceGroupName = "<resourcegroup_name>"; appServiceName = "<appservice_name>"; targetSlot = "Production" } 
-resourceCatalogDetails @{ resourceGroupName = "<resourcegroup_name>"; appServiceName = "<appservice_name>"; targetSlot = "Production"} 
-resourceCatalogUrl "https://<ResourceCatalogURL>" 
-identityServerUrl "https://<IdentityServerURL>/identity" -orchestratorUrl "https://<OrchestratorURL>".\MigrateTo-ResourceCatalog.ps1 
-cliPackage ".\UiPath.ResourceCatalogService.CLI-Win64.zip" 
-azureDetails @{ azureSubscriptionId = "<subscription_id>"; azureAccountTenantId = "<azure_tenant_id>"; azureAccountApplicationId = "<azure_application_id>"; azureAccountPassword = "<azure_account_password>" } 
-orchDetails @{ resourceGroupName = "<resourcegroup_name>"; appServiceName = "<appservice_name>"; targetSlot = "Production" } 
-resourceCatalogDetails @{ resourceGroupName = "<resourcegroup_name>"; appServiceName = "<appservice_name>"; targetSlot = "Production"} 
-resourceCatalogUrl "https://<ResourceCatalogURL>" 
-identityServerUrl "https://<IdentityServerURL>/identity" -orchestratorUrl "https://<OrchestratorURL>"