test-suite

2022.10

false

Test Suite User Guide

DELIVERY:

Automation Cloud Automation Cloud Public Sector Automation Suite Standalone

Last updated Jul 15, 2024

Executing Tasks

Running tasks inside the UiPath CLI designed for Windows devices (UiPath.CLI.Windows) requires several tasks.

The main differences between procedures for the UiPath.CLI.Windows and procedures for the UiPath.CLI (UiPath CLI designed for Linux devices), consist in additional arguments that you could pass with some tasks that are specific to the type of device that you are running on.

Important:

When using UiPath CLI, you must ensure that the project is closed in Studio. Doing otherwise causes a conflict leading to the following error message in CLI:

The action could not be performed because the project is already opened in another Studio instance. Please close it and try
                     again.

API Access application scopes

The following table shows the required Orchestrator API Access Application Scopes for running any CLI task.

Application Scope	Description
OR.Assets	Assets read and write access in Orchestrator.
OR.BackgroundTasks	BackgroundTasks read and write access in Orchestrator.
OR.Execution	Execution read and write access in Orchestrator.
OR.Folders	Folders read and write access in Orchestrator.
OR.Jobs	Jobs read and write access in Orchestrator.
OR.Machines.Read	Machines read access in Orchestrator.
OR.Monitoring	Monitoring read and write access in Orchestrator.
OR.Robots.Read	Robots read access in Orchestrator.
OR.Settings.Read	Settings read access in Orchestrator.
OR.TestSets	TestSets read and write access in Orchestrator.
OR.TestSetExecutions	TestSetExecutions read and write access in Orchestrator.
OR.TestSetSchedules	TestSetSchedules read and write access in Orchestrator.
OR.Users.Read	Users read access in Orchestrator.

Running UiPath.CLI.Windows

Prerequisites: To use the UiPath CLI for Windows and execute tasks, install .NET 6.0.7, that must include .NET 6.0.7 Desktop Runtime, that come with the 6.0.302 SDK.

You can execute tasks by callinguipcli.exe including the corresponding parameters. To execute sub-tasks, the command needs to have the following format: uipcli.exe <task name> <sub-task name>. To run the CLI:

Open a command prompt and navigate to the folder extracted from the NUPKG file.
Type uipcli.exe and select the Enter key.

Running UiPath.CLI

Prerequisites: To use the UiPath CLI for Cross-platform, and execute job tasks, install .NET 6.0.7, that comes with the 6.0.302 SDK.

You can execute tasks by callinguipcli.exe including the corresponding parameters. To execute sub-tasks, the command needs to have the following format: dotnet uipcli.dll <task name> <sub-task name>. To run the CLI:

Open a command prompt and navigate to the folder extracted from the NUPKG file.
Type dotnet uipcli.dll, and select the Enter key.

Displaying the CLI Version

Run the uipcli --version command.

Deleting Assets From Orchestrator

Prerequisites:

Create assets in Orchestrator.
Create a CSV file, that contains the assets that you want to delete. The CSV file must have the following three columns: name, type, and value. The data cells under the type, and value columns can remain empty.
Run the CLI exe (for Windows) or dll (for Linux) file.

Add the Orchestrator API Access Application Scopes below:

Application Scope	Description
OR.Assets	Assets read and write access in Orchestrator.
OR.BackgroundTasks	BackgroundTasks read and write access in Orchestrator.
OR.Execution	Execution read and write access in Orchestrator.
OR.Folders	Folders read and write access in Orchestrator.
OR.Jobs	Jobs read and write access in Orchestrator.
OR.Machines.Read	Machines read access in Orchestrator.
OR.Monitoring	Monitoring read and write access in Orchestrator.
OR.Robots.Read	Robots read access in Orchestrator.
OR.Settings.Read	Settings read access in Orchestrator.
OR.TestSets	TestSets read and write access in Orchestrator.
OR.TestSetExecutions	TestSetExecutions read and write access in Orchestrator.
OR.TestSetSchedules	TestSetSchedules read and write access in Orchestrator.
OR.Users.Read	Users read access in Orchestrator.

For more information about the CSV file, check the examples in the table below:

name	type	value
asset1_name	`N/A`	`N/A`
asset2_name	bool	`true`
asset3_name	integer	`N/A`
asset4_name	credential	username:password

To delete assets from Orchestrator:

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

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

See the list of parameters below.

Parameter	Description
`Assets File (pos. 0)` (Required)	The name of the CSV file that contains the assets you want to delete.
`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 manage your assets.
`-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.

Examples:

asset delete assets_file.csv "https://uipath-orchestrator.myorg.com" default -u admin -p 123456 -l en-US
asset delete assets_file.csv "https://uipath-orchestrator.myorg.com" default -u admin -p 123456 -o OurOrganization
asset delete assets_file.csv "https://uipath-orchestrator.myorg.com" default -t a7da29a2c93a717110a82 -a myAccount
asset delete assets_file.csv "https://uipath-orchestrator.myorg.com" default -A accountForExternalApp -I myExternalAppId -S myExternalAppSecret --applicationScope "OR.Folders.Read OR.Settings.Read"

Deploying Assets to Orchestrator

Prerequisites:

Create a CSV file that contains the assets that you want to deploy to Orchestrator.
The CSV file must have the following three columns: name, type, value, and description.
Run the CLI exe (for Windows) or dll (for Linux) file.

Add the Orchestrator API Access Application Scopes below:

Application Scope	Description
OR.Assets	Assets read and write access in Orchestrator.
OR.BackgroundTasks	BackgroundTasks read and write access in Orchestrator.
OR.Execution	Execution read and write access in Orchestrator.
OR.Folders	Folders read and write access in Orchestrator.
OR.Jobs	Jobs read and write access in Orchestrator.
OR.Machines.Read	Machines read access in Orchestrator.
OR.Monitoring	Monitoring read and write access in Orchestrator.
OR.Robots.Read	Robots read access in Orchestrator.
OR.Settings.Read	Settings read access in Orchestrator.
OR.TestSets	TestSets read and write access in Orchestrator.
OR.TestSetExecutions	TestSetExecutions read and write access in Orchestrator.
OR.TestSetSchedules	TestSetSchedules read and write access in Orchestrator.
OR.Users.Read	Users read access in Orchestrator.

For more information about the CSV file, check the example below.

name	type	value	description
asset_1_name	text	"i have a comment"	asset_1_description
asset_2_name	integer	`1`	asset_2_description
asset_3_name	bool	`false`	asset_3_description
asset_4_name	credential	username:password	asset_4_description

To deploy assets to Orchestrator:

Run the asset task, using uipcli asset. 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
`Assets File (pos. 0)` (Required)	The name of the CSV file that contains the assets you want to delete.
`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 manage your assets.
`-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.

Examples:

asset deploy assets_file.csv "https://uipath-orchestrator.myorg.com" default -u admin -p 123456 -l en-US.
asset deploy assets_file.csv "https://uipath-orchestrator.myorg.com" default -u admin -p 123456 -o OurOrganization.
asset deploy assets_file.csv "https://uipath-orchestrator.myorg.com" default -t a7da29a2c93a717110a82 -a myAccount.
asset delete assets_file.csv "https://uipath-orchestrator.myorg.com" default -A accountForExternalApp -I myExternalAppId -S myExternalAppSecret --applicationScope "OR.Folders.Read OR.Settings.Read".

Running a job inside Orchestrator

Create a process in Orchestrator.
Run the CLI exe (for Windows) or dll (for Linux) file.

Add the Orchestrator API Access Application Scopes below:

Application Scope	Description
OR.Assets	Assets read and write access in Orchestrator.
OR.BackgroundTasks	BackgroundTasks read and write access in Orchestrator.
OR.Execution	Execution read and write access in Orchestrator.
OR.Folders	Folders read and write access in Orchestrator.
OR.Jobs	Jobs read and write access in Orchestrator.
OR.Machines.Read	Machines read access in Orchestrator.
OR.Monitoring	Monitoring read and write access in Orchestrator.
OR.Robots.Read	Robots read access in Orchestrator.
OR.Settings.Read	Settings read access in Orchestrator.
OR.TestSets	TestSets read and write access in Orchestrator.
OR.TestSetExecutions	TestSetExecutions read and write access in Orchestrator.
OR.TestSetSchedules	TestSetSchedules read and write access in Orchestrator.
OR.Users.Read	Users read access in Orchestrator.

Run the job task, using uipcli job. Now you can see a list of the available the sub-tasks.

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

See the list of parameters below.

Parameter	Description
`Process Name (pos.0)` (Required)	The name of the process that you want to run.
`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 run processes.
`-i`, or `--input_path` (Required only if the entry point of the workflow has input parameters)	The full path to the JSON input file corresponding to the process that you want to run. JSON file format example: `{ "StringArgument_In": "MyConfigurationValue", "IntArgument_In": 1, "DictionaryArgument_In": { "Key1": "Value1", "Key2": "Value2" } }`{ "StringArgument_In": "MyConfigurationValue", "IntArgument_In": 1, "DictionaryArgument_In": { "Key1": "Value1", "Key2": "Value2" } }
`-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.
`-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.
`-P`, or `--priority`	The priority that you want to run the job with:- Low.- Normal (default).- High.
`-r`, or `--robots`	A list of specific robot names, separated by commas.
`-j`, or `--jobscount`	The number of times that you want to run the process. The default number of times that the process runs is one.
`-U`, or `--user`	The name of the user. This should be a machine user, not an Orchestrator user. For local users, the format is MachineName\UserName.
`-M`, or `--machine`	The name of the machine that you want to run the process on.
`-R`, or `--result_path`	The full path to a JSON file, or to a folder, where you want to store the results of the job. The results return as JSON files.
`-W`, or `--timeout`	The timeout for job executions (seconds). The default is 1800 seconds.
`-f`, or `--fail_when_job_fails`	The command fails when one job fails, The default for this is True.
`-w`, or `--wait`	The command waits for the job to finish. The default for this is True.
`-b`, or `--job_type` (for modern folders only)	The type of runtime for the job. You can choose:- `Unattended`- `NonProduction`.
`-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.
`-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`.

job run ProcessName "https://uipath-orchestrator.myorg.com" default -u admin -p 123456 -P High -o MyFolder
job run ProcessName "https://uipath-orchestrator.myorg.com" default -t a7da29a2c93a717110a82 -a myAccount -P High -j 3 -w false
job run ProcessName "https://uipath-orchestrator.myorg.com" default -t a7da29a2c93a717110a82 -a myAccount -r robotName -R C:\Temp\status.json

Analyzing a Project

Prerequisites:

Create a project.
Run the CLI exe (for Windows) or dll (for Linux) file.

Add the Orchestrator API Access Application Scopes below:

Application Scope	Description
OR.Assets	Assets read and write access in Orchestrator.
OR.BackgroundTasks	BackgroundTasks read and write access in Orchestrator.
OR.Execution	Execution read and write access in Orchestrator.
OR.Folders	Folders read and write access in Orchestrator.
OR.Jobs	Jobs read and write access in Orchestrator.
OR.Machines.Read	Machines read access in Orchestrator.
OR.Monitoring	Monitoring read and write access in Orchestrator.
OR.Robots.Read	Robots read access in Orchestrator.
OR.Settings.Read	Settings read access in Orchestrator.
OR.TestSets	TestSets read and write access in Orchestrator.
OR.TestSetExecutions	TestSetExecutions read and write access in Orchestrator.
OR.TestSetSchedules	TestSetSchedules read and write access in Orchestrator.
OR.Users.Read	Users read access in Orchestrator.

Run the package task, using uipcli package. You can see a list of the available sub-tasks.
Specify the required parameters and run the analyze sub-task.

See the list of parameters below.

Note:

Project validation is not performed by the Pack or Analyze tasks of UiPath CLI.

Legend: (*) - Optional, recommended when using additional package feeds.

Parameter	Description
`Project(s) Path (pos.0)` (Required)	The path to the `project.json` file, or the path to the folder that contains multiple `project.json` files.
`--analyzerTraceLevel`	Choose what types of messages to output after analyzing: Off = don't show any message Error -Warning -Info -Verbose.
`-stopOnRuleViolation`	The job fails when any rule is violated.
`--treatWarningsAsErrors`	Treat warnings as errors.
`--resultPath`	The full path to a JSON file where you want to store the results. If you don't add this as an argument, then the results will print only in the standard console.
`--ignoredRules`	A list of rules that you want to ignore during the analysis, separated by commas.
`--orchestratorUsername` () (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.
`--orchestratorPassword` () (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.
`-orchestratorAuthToken` () (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.
`--orchestratorAccountName` () (Required* if you use token-based authentication)	The Orchestrator CloudRPA account name. You must pair it with the OAuth2 refresh token and Client ID.
`--orchestratorAccountForApp` (*)	The Orchestrator CloudRPA account name(organization name). You must pair it with the Application ID, Application Secret, and Application scope for external application.
`--orchestratorApplicationId` () (Required* if you use external application authentication)	The external Application ID. You must pair it with the Application Account, Application Secret, and Application scope**.
`--orchestratorApplicationSecret` () (Required* if you use external application authentication)	The external Application Secret. You must pair it with the Application Account, Application ID, and Application scope.
`--orchestratorApplicationScope` () (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.
`--orchestratorFolder` (*)	The name of the target Orchestrator folder. To input subfolders make sure to input both the parent folder name and the name of the subfolder. For instance, use `AccountingTeam\TeamJohn`.
`--orchestratorUrl` (*)	The URL of the Orchestrator instance.
`--orchestratorTenant` (*)	The tenant of the Orchestrator instance where you want to delete a machine.
`--help`	Displays the parameters and examples for this command.

Examples:

package analyze "C:\UiPath\Project\project.json" --analyzerTraceLevel "Error" --stopOnRuleViolation --treatWarningsAsErrors --resultPath "C:\UiPath\Project\output.json"
package analyze "C:\UiPath\Project\project.json" --analyzerTraceLevel "Error" --stopOnRuleViolation --treatWarningsAsErrors --resultPath "C:\UiPath\Project\output.json" --ignoredRules "ST-NMG-009,ST-DBP-020,UI-USG-011,ST-DBP-020"
package analyze "C:\UiPath\Project\project.json" --analyzerTraceLevel "Error" --stopOnRuleViolation --treatWarningsAsErrors --resultPath "C:\UiPath\Project\output.json" --ignoredRules "ST-NMG-009,ST-DBP-020,UI-USG-011,ST-DBP-020" --orchestratorUrl "https://orchestratorurl.com" --orchestratorTenant "default" --orchestratorUsername "username" --orchestratorPassword "\_ye5zG9(x" --orchestratorAuthToken "AuthToken" --orchestratorAccountName "AccountName" --orchestratorFolder "OrchestratorFolder"

Deleting a Package

Prerequisites:

Publish a package to Orchestrator.
Run the CLI exe (for Windows) or dll (for Linux) file.

Add the Orchestrator API Access Application Scopes below:

Application Scope	Description
OR.Assets	Assets read and write access in Orchestrator.
OR.BackgroundTasks	BackgroundTasks read and write access in Orchestrator.
OR.Execution	Execution read and write access in Orchestrator.
OR.Folders	Folders read and write access in Orchestrator.
OR.Jobs	Jobs read and write access in Orchestrator.
OR.Machines.Read	Machines read access in Orchestrator.
OR.Monitoring	Monitoring read and write access in Orchestrator.
OR.Robots.Read	Robots read access in Orchestrator.
OR.Settings.Read	Settings read access in Orchestrator.
OR.TestSets	TestSets read and write access in Orchestrator.
OR.TestSetExecutions	TestSetExecutions read and write access in Orchestrator.
OR.TestSetSchedules	TestSetSchedules read and write access in Orchestrator.
OR.Users.Read	Users read access in Orchestrator.

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

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

See the list of parameters below.

Parameter	Description
`Package name (pos. 0)` (Required)	The name of the package that you want to delete.
`Orchestrator URL (pos. 1)`	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.
`-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.

Examples:

package delete PackageName "https://uipath-orchestrator.myorg.com" default -u admin -p 123456 -l en-US.
package delete PackageName "https://uipath-orchestrator.myorg.com" default -t refreshToken -a accountName.
package delete PackageName "https://uipath-orchestrator.myorg.com" default -A accountForExternalApp -I myExternalAppId -S myExternalAppSecret --applicationScope "OR.Folders.Read OR.Settings.Read".

Deploying a Package to Orchestrator

Prerequisites:

Create a package.
Run the CLI exe (for Windows) or dll (for Linux) file.

Add the Orchestrator API Access Application Scopes below:

Application Scope	Description
OR.Assets	Assets read and write access in Orchestrator.
OR.BackgroundTasks	BackgroundTasks read and write access in Orchestrator.
OR.Execution	Execution read and write access in Orchestrator.
OR.Folders	Folders read and write access in Orchestrator.
OR.Jobs	Jobs read and write access in Orchestrator.
OR.Machines.Read	Machines read access in Orchestrator.
OR.Monitoring	Monitoring read and write access in Orchestrator.
OR.Robots.Read	Robots read access in Orchestrator.
OR.Settings.Read	Settings read access in Orchestrator.
OR.TestSets	TestSets read and write access in Orchestrator.
OR.TestSetExecutions	TestSetExecutions read and write access in Orchestrator.
OR.TestSetSchedules	TestSetSchedules read and write access in Orchestrator.
OR.Users.Read	Users read access in Orchestrator.

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
`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.
`-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.
`-c`, or `--createProcess`	When set to `true`, it creates a process in the Orchestrator folder that is passed in the command. The default value for this is True. 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.
`-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.

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.

Examples:

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\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.

Packing Projects Into a Package

Prerequisites:

Create projects.
Run the CLI exe (for Windows) or dll (for Linux) file.

Add the Orchestrator API Access Application Scopes below:

Application Scope	Description
OR.Assets	Assets read and write access in Orchestrator.
OR.BackgroundTasks	BackgroundTasks read and write access in Orchestrator.
OR.Execution	Execution read and write access in Orchestrator.
OR.Folders	Folders read and write access in Orchestrator.
OR.Jobs	Jobs read and write access in Orchestrator.
OR.Machines.Read	Machines read access in Orchestrator.
OR.Monitoring	Monitoring read and write access in Orchestrator.
OR.Robots.Read	Robots read access in Orchestrator.
OR.Settings.Read	Settings read access in Orchestrator.
OR.TestSets	TestSets read and write access in Orchestrator.
OR.TestSetExecutions	TestSetExecutions read and write access in Orchestrator.
OR.TestSetSchedules	TestSetSchedules read and write access in Orchestrator.
OR.Users.Read	Users read access in Orchestrator.

Run the package task, using uipcli package. You can see a list of the available sub-tasks.
Specify the required parameters and run the pack sub-task.

See the list of parameters below.

Note:

Project validation is not performed by the Pack or Analyze tasks of UiPath CLI.

Legend: (*) - Optional, useful only when you have dependencies from a library in Orchestrator.

Parameter	Description
`Project(s) Path (pos. 0)` (Required)	The path to a `project.json` file, or to a folder that contains `project.json` files.
`-o`, or `--output` (Required)	The destination Orchestrator folder, where you want to package the projects.
`-v`, or `--version`	Set the package version.
`--autoVersion`	Auto-generates a package version.
`--outputType`	Forces the output to be a specific type.
`--libraryOrchestratorUsername` () (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. This is required if your package references libraries from Orchestrator feed
`--libraryOrchestratorPassword` () (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. This is required if your package references libraries from Orchestrator feed
`--libraryOrchestratorAuthToken` () (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. This is required if your package references libraries from Orchestrator feed
`--libraryOrchestratorAccountName` () (Required* if you use token-based authentication)	The Orchestrator CloudRPA account name. You must pair it with the OAuth2 refresh token and Client ID. This is required if your package references libraries from Orchestrator feed
`--libraryOrchestratorAccountForApp` (*)	The Orchestrator CloudRPA account name(organization name). You must pair it with the Application ID,Application Secret, and Application scope for external application This is required if your package references libraries from Orchestrator feed.
`--libraryOrchestratorApplicationId` () (Required* if you use external application authentication)	The external Application ID. You must pair it with the Application Account, Application Secret, and Application scope. This is required if your package references libraries from Orchestrator feed.
`--libraryOrchestratorApplicationSecret` () (Required* if you use external application authentication)	The external Application Secret. You must pair it with the Application Account, Application ID, and Application scope. This is required if your package references libraries from Orchestrator feed.
`--libraryOrchestratorApplicationScope` () (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. This is required if your package references libraries from Orchestrator feed.
`--libraryOrchestratorFolder` (*)	The name of the target Orchestrator folder. To input subfolders make sure to input both the parent folder name and the name of the subfolder. For instance, use `AccountingTeam\TeamJohn`.
`--libraryOrchestratorUrl` (*)	The URL of the Orchestrator instance.
`--libraryOrchestratorTenant` (*)	The tenant of the Orchestrator instance where you want to delete a machine.
`-y`, or `--disableTelemetry`	Disable telemetry data.
`--traceLevel`	Display the trace of the events.
`-l`, or `--language`	The language used in the Orchestrator user interface.
`--help`	Displays the parameters and examples for this command.

Examples:

package pack "C:\UiPath\Project\project.json" -o "C:\UiPath\Package" -v 1.0.6820.22047.
package pack "C:\UiPath\Project\project.json" -o "C:\UiPath\Package" --autoVersion.
package pack "C:\UiPath\Project\project.json" -o "C:\UiPath\Package" --outputType Tests -l en-US.

Testing a Package/Running a Test Set

Prerequisites:

Create a package, or Test Set.
Run the CLI exe (for Windows) or dll (for Linux) file.

Add the Orchestrator API Access Application Scopes below:

Application Scope	Description
OR.Assets	Assets read and write access in Orchestrator.
OR.BackgroundTasks	BackgroundTasks read and write access in Orchestrator.
OR.Execution	Execution read and write access in Orchestrator.
OR.Folders	Folders read and write access in Orchestrator.
OR.Jobs	Jobs read and write access in Orchestrator.
OR.Machines.Read	Machines read access in Orchestrator.
OR.Monitoring	Monitoring read and write access in Orchestrator.
OR.Robots.Read	Robots read access in Orchestrator.
OR.Settings.Read	Settings read access in Orchestrator.
OR.TestSets	TestSets read and write access in Orchestrator.
OR.TestSetExecutions	TestSetExecutions read and write access in Orchestrator.
OR.TestSetSchedules	TestSetSchedules read and write access in Orchestrator.
OR.Users.Read	Users read access in Orchestrator.

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

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

See the list of parameters below.

Parameter	Description
`Orchestrator URL (pos. 0)` (Required)	The URL of the Orchestrator instance.
`Orchestrator Tenant (pos. 1)` (Required) for SaaP deployments. (Optional) for PaaS deployments.	The tenant inside which the package, or Test Set are.
`-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`, `--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
`-P`, or `--project-path`	The path to the Testing package file that you want to test.
`-s`, or `--testset`	The name shown for the Test Set you wish to execute. Ensure that the Test Set includes the most recent version of the Test Cases. If the Test Set isn't in the default folder, make sure to include the relevant folder name before it. For instance, use `AccountingTeam\TestSet`.
`--out`	The type of the result file <junit\|uipath>.
`-r`, or `--result_path`	The destination path of the file where you want to store the results.
`-e`, or `--environment` (Required for classic folders)	The environment where you want to deploy the package. You must pair it with the `project path`.
`-w`, or `--timeout`	The time (in seconds) that you want to wait for the Test Set to execute. The default value is 7200 seconds.
`-i`, or `--input_path` (Required if the entry-point workflow has input parameters that you want to pass through the command line)	The full path to a JSON input file.
`--attachRobotLogs`	Attaches Robot Logs for each executed Test Case, and a JUnit Test Report.
`-o`, or `--organizationUnit`	The Orchestrator folder where you want to execute the Test Sets.
`-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 for PaaS deployments only)	The URL of your identity server.
`--help`	Displays the parameters and examples for this command.

Examples:

uipcli test run "https://orch-23-10-paas.cloudapp.azure.com/" "TenantName" -u "orchestratorUsername" -p "********" -o "FolderName" --traceLevel Information -P "C:\userprofile\AutomationProjectWithTestCases\project.json"
uipcli test run "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 -P "C:\userprofile\AutomationProjectWithTestCases\project.json"
uipcli test run "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 -P "C:\userprofile\AutomationProjectWithTestCases\project.json"
uipcli test run "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 -P "C:\userprofile\AutomationProjectWithTestCases\project.json
uipcli test run "https://orch-23-10-paas.cloudapp.azure.com/" "TenantName" -u "orchestratorUsername" -p "********" -o "FolderName" --traceLevel Information -P "C:\userprofile\AutomationProjectWithTestCases\project.json" --out junit
uipcli test run "https://orch-23-10-paas.cloudapp.azure.com/" "TenantName" -u "orchestratorUsername" -p "********" -o "FolderName" --traceLevel Information -P "C:\userprofile\AutomationProjectWithTestCases\project.json" --out uipath

On this page

API Access application scopes
Running UiPath.CLI.Windows
Running UiPath.CLI
Displaying the CLI Version
Deleting Assets From Orchestrator
Deploying Assets to Orchestrator
Running a job inside Orchestrator
Analyzing a Project
Deleting a Package
Deploying a Package to Orchestrator
Packing Projects Into a Package
Testing a Package/Running a Test Set

Was this page helpful?

PREVIOUSCLI Tasks

NEXTAzure DevOps Extension

Support and Services

Get The Help You Need

UiPath Academy

Learning RPA - Automation Courses

UiPath Forum

UiPath Community Forum

Trust and Security

Cookies Policy