cicd-integrations
2024.10
true
UiPath logo, featuring letters U and I in white

CI/CD integrations user guide

Last updated May 5, 2025

Deploying a package to Orchestrator

Prerequisites:

To deploy a package to Orchestrator, take the following steps:

  1. Run the package task, using uipcli package. You can notice a list of the available sub-tasks.
  2. Specify the required parameters and run the deploy sub-task.

    The following table describes the required parameters.

    Parameter

    Description

    -c, or --createProcess

    The default value for is true.

    When set to 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.

    --processNames

    Optionally provide a .csv file with custom names for the processes to be created/updated.

    The following is a an example on how the .csv structure must look like. The column names/headers: PackageName, EntryPointName, and ProcessName are required!

    PackageNameEntryPointNameProcessName

    MyPackage

    Main.xaml

    MyProcess

    YetAnotherPackage

    CustomEntryPoint.xaml

    YetAnotherProcess

    --processName

    Optionally provide a custom name for the process to be updated/created.

    --ignoreLibraryDeployConflict

    Ignore the conflict when deploying a library package with the same version as an existing one. By default, the deployment will fail if a library with the same version already exists in the Orchestrator instance.

    -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 (Required)

    The name of the Orchestrator folder (organization unit).

    To input subfolders make sure to input both the parent folder name and the name of the subfolder. For instance, use AccountingTeam/TeamJohn.
    -l, or --language

    The language used in the Orchestrator user interface.

    -y, or --disableTelemetry

    Disable telemetry data.

    --traceLevel

    Display the trace of the events.

    --identityUrl (Required only for PaaS deployments)

    The URL of your identity server.

    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)

    • (Required) for SaaP deployments.
    • (Optional) for PaaS deployments.
    		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:

uipcli package deploy <packages_path> <orchestrator_url> <orchestrator_tenant> [-u <orchestrator_user> -p <orchestrator_pass>] [-t <auth_token> -a <account_name>] [-A <organization_name> -I <application_id> -S <application_secret> --applicationScope <application_scope>] [-o <folder_name>] [-c <false|true>] [-e <environment_list>] [-l <language>] [--ignoreLibraryDeployConflict] [--entryPointsPath <entry_points_path_list>]  [--traceLevel <None|Critical|Error|Warning|Information|Verbose>] [--identityUrl <identityUrl>]uipcli package deploy <packages_path> <orchestrator_url> <orchestrator_tenant> [-u <orchestrator_user> -p <orchestrator_pass>] [-t <auth_token> -a <account_name>] [-A <organization_name> -I <application_id> -S <application_secret> --applicationScope <application_scope>] [-o <folder_name>] [-c <false|true>] [-e <environment_list>] [-l <language>] [--ignoreLibraryDeployConflict] [--entryPointsPath <entry_points_path_list>]  [--traceLevel <None|Critical|Error|Warning|Information|Verbose>] [--identityUrl <identityUrl>]

Minimal command examples:

  • uipcli package deploy "C:\userprofile\AutomationPackages" "https://orch-23-10-paas.cloudapp.azure.com/" "TenantName" -u "orchestratorUsername" -p "********" -o "FolderName" --traceLevel Information --entryPointsPath "Main.xaml"

  • uipcli package deploy "C:\userprofile\AutomationPackage.1.0.171447983.nupkg" "https://orch-23-10-paas.cloudapp.azure.com/" "TenantName" -I "76000552-3e4f-4590-9317-cdb420001f1d" -S "********" --applicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" --identityUrl "https://orch-23-10-paas.cloudapp.azure.com/identity" -o "FolderName" --traceLevel Information --entryPointsPath "Main.xaml"n

  • uipcli package deploy "C:\userprofile\AutomationPackage.1.0.171447983.nupkg" "https://automation-suite.base.url.com/" "TenantName" -A "organizationName" -I "3f6239b9-e0e8-465e-a429-d9ffd1d9e57a" -S "********" --applicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" -o "FolderName" --traceLevel Information --entryPointsPath "Main.xaml"

  • uipcli package deploy "C:\userprofile\AutomationPackage.1.0.171447983.nupkg" "https://cloud.uipath.com/" "TenantName" -A "organizationName" -I "becc663c-8f1e-409a-a75f-c00330d80bc8" -S "********" --applicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" -o "FolderName" --traceLevel Information --processNames "C:\userprofile\processNames.csv"

  • uipcli package deploy "C:\userprofile\AutomationPackage.1.0.171447983.nupkg" "https://cloud.uipath.com/" "TenantName" -A "organizationName" -I "becc663c-8f1e-409a-a75f-c00330d80bc8" -S "********" --applicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" -o "FolderName" --traceLevel Information --entryPointsPath "Main.xaml" --processName "MyProcessName"

Was this page helpful?

Support and Services
Get The Help You Need
UiPath Academy
Learning RPA - Automation Courses
UiPath Forum
UiPath Community Forum
Uipath Logo White
Trust and Security
Terms of Use
Privacy Policy
Cookies Policy
© 2005-2025 UiPath. All rights reserved.