UiPath Solution Deploy

Application: Solution

Type: Post-Build task

UiPath Solution: Deploy is available in standard jobs and pipelines, and lets you deploy an existing UiPath solution package to an Orchestrator folder.

Note:

Solutions are currently supported only in Automation Cloud. Support for Automation Suite is planned for a future release. On-premises (MSI) Orchestrator does not support Solutions.

Note:

This task is compatible only with UiPath.CLI.Windows or UiPath.CLI.Linux at least version 25.10 or higher.

Configuration

Job parameter	Description
Package name	The name of the package that will be deployed.
Package version	The version of the package that will be deployed.
Deployment Name	The name of the deployment.
Deployment Parent Folder	Parent folder for deployment. There are three options for this: When left empty, the deployment will be under the tenant folder. When specified, the deployment will be under the specified folder. When set to "example_user's workspace", the deployment will be under personal workspace for specified user.
Deployment Folder Name	The name of the folder that will contain deployment.
Config path	Optional path to config file, if omitted default one stored on the server will be used.
Orchestrator address	The address of the Orchestrator instance where you'll deploy the solution to.
Orchestrator tenant	Specify the Orchestrator tenant.
Authentication	For authentication towards Automation Cloud Orchestrator, you need to create credentials in Jenkins upfront. Solutions support External App authentication only. See Managing external applications for details on creating an External App and obtaining the required credentials.
Trace level	Setting used to enable trace logging to one of the following levels: None Critical Error Warning Information Verbose. (The default is set to None ). Useful for debugging purposes.

Pipeline example

pipeline {  agent any  environment {      MAJOR = '1'      MINOR = '0'  }  stages {    stage ('Deploy Solution') {      steps {        script {            orchestratorCredentials = ExternalApp(                applicationId: 'External application identifier',                applicationScope: 'AutomationSolutions Solutions.Deployments Solutions.Packages',                applicationSecret: 'External application secret',                accountForApp: 'Organization identifier'            )            UiPathSolutionDeploy(                packageName: 'Name of the package',                packageVersion: 'Version of the package',                deploymentParentFolder: 'Deployment parent folder',                deploymentName: 'Deployment name',                deploymentFolderName: 'Deployment folder name',                configPath: 'example/path',                orchestratorAddress: 'OrchestratorUrl',                orchestratorTenant: 'Tenant name',                credentials: orchestratorCredentials,                traceLevel: 'Information',            )        }      }    }  }}