- Overview
- UiPath CLI
- Azure DevOps extension
- Jenkins plugin
CI/CD integrations user guide
Deploying a package to Orchestrator
Prerequisites:
- Create a package.
- Run the CLI
exe(for Windows) ordll(for Linux) file. - Add the required Orchestrator API access application scopes.
To deploy a package to Orchestrator, take the following steps:
- Run the
packagetask, usinguipcli package. You can see a list of the available sub-tasks. - Specify the required parameters and run the
deploysub-task. See the list of parameters below.
| Parameter | Description |
|---|---|
-c , or --createProcess | The default value for is true , it creates a process in the Orchestrator folder that is passed in the command. When set to false , it doesn't create a process in the Orchestrator folder. For example, --createProcess false . |
-e , or --environments (for Classic folders) | A list of environments where you want to deploy the package to, separated by commas. If the environment doesn't belong to the default folder (organization unit), you must prefix the environment name with the folder name. For example, if the environment is TestEnvironment , and the folder name is AccountingTeam , then write the environment as AccountingTeam\TestEnvironment . |
-h , or --entryPointsPath | Defines the specific entry points to create, or update the process. This is the file path of the entry point, starting from the root of the project. For classic folders, only a single entry point can be specified for each environment. |
-u , or --username ( Required if you use Basic Authentication , through a username and a password) | The username used for authenticating to Orchestrator. You must pair it with the corresponding password. |
-p , or --password ( Required if you use Basic Authentication , through a username and a password) | The password used for authenticating to Orchestrator. You must pair it with the corresponding username. |
-t , or --token ( Required if you use token-based authentication ) | The OAuth2 refresh token used for authenticating to Orchestrator. You must pair it with the Account Name and Client ID . |
-a , or --accountName ( Required if you use token-based authentication ) | The Orchestrator CloudRPA account name. You must pair it with the OAuth2 refresh token and Client ID . |
-A , or --accountForApp | The Orchestrator CloudRPA account name (organization name). You must pair it with the Application ID , Application Secret , and Application scope for external application |
-I , or --applicationId ( Required if you use external application authentication ) | The external Application ID. You must pair it with the Application Account , Application Secret , and Application scope . |
-S , or --applicationSecret ( Required if you use external application authentication ) | The external Application Secret. You must pair it with the Application Account , Application ID , and Application scope . |
--applicationScope ( Required if you use external application authentication ) | The list of application scopes, separated by single spaces. You must pair it with the Application Account , Application ID , and Application Secret for external application. |
-o , or --organizationUnit | The name of the Orchestrator folder (organization unit). AccountingTeam/TeamJohn . |
-l , or --language | The language used in the Orchestrator user interface. |
-y , or --disableTelemetry | Disable telemetry data. |
|
| Display the trace of the events. |
--identityUrl ( Required for PaaS or MSI deployments) | The URL of your identity server. |
|
| Displays the parameters and examples for this command. |
|
| Display version information. |
Package(s) Path (pos. 0) ( Required ) | The path to a package file, or the path to a folder containing multiple packages. |
Orchestrator URL (pos. 1) ( Required ) | The URL of the Orchestrator instance. |
| Orchestrator Tenant (pos. 2)
| The tenant of the Orchestrator instance where you want to delete a machine. |
The uipcli creates a process with a default entry point if you do not specify one. If the entry point is specified, a process with that entry point is created and _{entryPoint} is appended to the process name. Additionally, all processes associated with the package.Id are updated to the latest version, regardless of whether the process was created manually or from a pipeline.
Usage:
package deploy <packages_path> <orchestrator_url> <orchestrator_tenant> [-u <orchestrator_user> -p <orchestrator_pass>] [-t <auth_token> -a <account_name>] [-A <account_for_app> -I <application_id> -S <application_secret> --applicationScope] [-o <folder_organization_unit>] [-c <create_process>] [-e <environment_list>] [-l <language>]package deploy <packages_path> <orchestrator_url> <orchestrator_tenant> [-u <orchestrator_user> -p <orchestrator_pass>] [-t <auth_token> -a <account_name>] [-A <account_for_app> -I <application_id> -S <application_secret> --applicationScope] [-o <folder_organization_unit>] [-c <create_process>] [-e <environment_list>] [-l <language>]Examples:
package deploy "C:\UiPath\Project 1" "https://uipath-orchestrator.myorg.com" default -u admin -p 123456package deploy "C:\UiPath\Project\Package.1.0.6820.22047.nupkg" "https://uipath-orchestrator.myorg.com" default -u admin -p 123456 -o OurOrganizationpackage deploy "C:\UiPath\Project\TestsPackage.1.0.6820.22047.nupkg" "https://uipath-orchestrator.myorg.com" default -u admin -p 123456 -e SAPEnvironment,ExcelAutomationEnvironment -l en-USpackage deploy "C:\UiPath\Project\Package.1.0.6820.22047.nupkg" "https://uipath-orchestrator.myorg.com" default -t a7da29a2c93a717110a82 -a myAccountpackage deploy "C:\UiPath\Project\TestsPackage.1.0.6820.22047.nupkg" "https://uipath-orchestrator.myorg.com" default -A myAccountForExternalApp -I myExternalAppId -S myExternalAppSecret --applicationScope "OR.Folders.Read OR.Settings.Read"package deploy "C:\UiPath\Project\TestsPackage.1.0.6820.22047.nupkg" "https://uipath-orchestrator.myorg.com" default -u admin -p 123456 -e SAPEnvironment,ExcelAutomationEnvironment -l en-US -h EntryPoint1,EntryPoint2
