cicd-integrations
2023.4
false
  • Overview
    • About CI/CD pipelines
  • UiPath CLI
  • Azure DevOps extension
  • Jenkins plugin
UiPath logo, featuring letters U and I in white

CI/CD integrations user guide

Last updated Apr 28, 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:

  1. Run the job task, using uipcli job. Now you can see a list of the available the sub-tasks.
  2. Specify the required parameters and run the run sub-task.
    See the list of parameters below.
    ParameterDescription
    -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 --priorityThe priority that you want to run the job with:- Low.- Normal (default).- High.
    -r, or --robotsA list of specific robot names, separated by commas.
    -j, or --jobscountThe number of times that you want to run the process. The default number of times that the process runs is one.
    -U, or --userThe name of the user. This should be a machine user, not an Orchestrator user. For local users, the format is MachineName\UserName.
    -M, or --machineThe name of the machine that you want to run the process on.
    -R, or --result_pathThe 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 --timeoutThe timeout for job executions (seconds). The default is 1800 seconds.
    -f, or --fail_when_job_failsThe command fails when one job fails, The default for this is True.
    -w, or --waitThe 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 --accountForAppThe 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 --organizationUnitThe 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.

    --help

    Displays the parameters and examples for this command.

    --version

    Display version information.

    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:

job run <process_name> <orchestrator_url> <orchestrator_tenant> [-i <input_path>] [-j <jobscount>] [-R <result_path>] [-P <priority>] [-r <robots>] [-f <do_not_fail_when_job_fails>] [-W <timeout>] [-w <do_not_wait>] [-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>] [-l <language>]job run <process_name> <orchestrator_url> <orchestrator_tenant> [-i <input_path>] [-j <jobscount>] [-R <result_path>] [-P <priority>] [-r <robots>] [-f <do_not_fail_when_job_fails>] [-W <timeout>] [-w <do_not_wait>] [-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>] [-l <language>]

Examples:

  • job run ProcessName "https://uipath-orchestrator.myorg.com" default -u admin -p 123456

  • job run ProcessName "https://uipath-orchestrator.myorg.com" default -u admin -p 123456 -P Low

  • job run ProcessName "https://uipath-orchestrator.myorg.com" default -u admin -p 123456 -P Normal -o MyFolder

  • 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 -f false -W 0

  • 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 -P Low -r robotName -R C:\Temp

  • job run ProcessName "https://uipath-orchestrator.myorg.com" default -t a7da29a2c93a717110a82 -a myAccount -r robotName -R C:\Temp\status.json

  • job run ProcessName "https://uipath-orchestrator.myorg.com" default -A accountForExternalApp -I myExternalAppId -S myExternalAppSecret --applicationScope "OR.Folders.Read OR.Settings.Read" -r robotName -R C:\Temp\status.json

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
Trust and Security
Terms of Use
Privacy Policy
Cookies Policy
© 2005-2025 UiPath. All rights reserved.