Test Suite User Guide

DELIVERY:

Automation Cloud Automation Cloud Public Sector Automation Suite Standalone

Last updated Dec 18, 2024

Deploying a Package to Orchestrator

Prerequisites:

Create a package.
Run the CLI exe (for Windows) or dll (for Linux) file.
Add the required Orchestrator API access application scopes.

Run the package task, using uipcli package. You can see a list of the available sub-tasks.

Specify the required parameters and run the deploy sub-task.

See the list of parameters below.

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.`
`-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). 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.
`--help`	Displays the parameters and examples for this command.
`--version`	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) (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:

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 123456
package deploy "C:\UiPath\Project\Package.1.0.6820.22047.nupkg" "https://uipath-orchestrator.myorg.com" default -u admin -p 123456 -o OurOrganization
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
package deploy "C:\UiPath\Project\Package.1.0.6820.22047.nupkg" "https://uipath-orchestrator.myorg.com" default -t a7da29a2c93a717110a82 -a myAccount
package 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

Adding an External Application

To register an external application so that it can access your UiPath resources using OAuth:

Log in to the tenant as an Administrator.
Go to Tenant > Manage access > Assign roles and click Manage Accounts & Groups.

The tenant-level opens.
Along the left, select External Applications.

The External Applications page opens, listing all the existing external applications registered for the current tenant:
Above the table, on the right, click Add Application.
Fill in the Application Name field.
Select an option for Application Type.

If you select Confidential application, you receive an app secret at the end, so make sure your application can store it securely. If it can't, select Non-confidential application.
Under Resources, click Add Scopes.

The Edit Resource panel opens on the right, where you can select the resources to which the application should have access.
From the Resource drop-down list, select the UiPath API that the application can use.

Note: You can only add scope for one resource at a time. If you want to allow access to multiple resources, repeat this process to add scope for each resource.
On the User Scope(s) tab, select the check boxes for the logical API permissions that you want to grant, as needed.

Granting permissions under user scope means that the external application can access those resources within a user context and a user with the appropriate permissions must be logged in.
If this is a confidential application, you can switch to the Application Scope(s) tab to also grant application-level permissions for the selected resource, as needed.

With permissions under application scope, the external application has access to application-wide data for the selected scopes without the need for user interaction.

Non-confidential applications cannot access application scope.
Click Save.

The panel closes and the selected resource and scopes are added to the Resources table in the form.
If the external application can accept it, you can add a URL in the Redirect URL field and the authorization response is sent there. The application can then use it to access UiPath resources.
Click Add to create the registration.

A confirmation message opens. For confidential applications, the confirmation message includes the app secret that the registered external application can use to request authorization. Make sure you save it in a secure location because you cannot see it again.