CI/CD integrations user guide

Last updated May 23, 2025

Running a job inside Orchestrator

Prerequisites:

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

To run a job inside Orchestrator, take the following steps:

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

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

The following table describes the required parameters.

Parameter	Description
`-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" } }
`-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`.
`-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`, `--language`	The Orchestrator language.
`-y`, `--disableTelemetry`	Disable telemetry data.
`--traceLevel`	Display the trace of the events.
`--identityUrl` (Required only for PaaS deployments)	The URL of your identity server.
`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.

Usage:

uipcli job run <process_name> <orchestrator_url> <orchestrator_tenant> [-i <input_path>] [-j <jobscount>] [-R <result_path>] [-P <Low|Normal|High>] [-r <robots>] [-f <false|true>] [-W <timeout>] [-w <false|true>] [-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>] [-l <language>] [--user <machine_user> --machine <machine_host_name>] [--job_type <Unattended|NonProduction>] [--traceLevel <None|Critical|Error|Warning|Information|Verbose>] [--identityUrl <identityUrl>]uipcli job run <process_name> <orchestrator_url> <orchestrator_tenant> [-i <input_path>] [-j <jobscount>] [-R <result_path>] [-P <Low|Normal|High>] [-r <robots>] [-f <false|true>] [-W <timeout>] [-w <false|true>] [-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>] [-l <language>] [--user <machine_user> --machine <machine_host_name>] [--job_type <Unattended|NonProduction>] [--traceLevel <None|Critical|Error|Warning|Information|Verbose>] [--identityUrl <identityUrl>]

Minimal command examples:

uipcli job run ProcessName "https://orch-23-10-paas.cloudapp.azure.com/" "TenantName" -u "orchestratorUsername" -p "********" -o "FolderName" --traceLevel "Information"
uipcli job run ProcessName "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"
uipcli job run ProcessName "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"
uipcli job run ProcessName "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"

Was this page helpful?

PREVIOUSDeploying a package to Orchestrator

NEXTTesting a package or running a test set

Support and Services

Get The Help You Need

UiPath Academy

Learning RPA - Automation Courses

UiPath Forum

UiPath Community Forum

Trust and Security

Cookies Policy