CI/CD integrations user guide

Last updated Apr 28, 2025

UiPath Run Job

The UiPath Run Job post-build step starts a process that was already deployed on an Orchestrator instance. In Orchestrator version 2020.10, you can find the processes that are run by this task in the Processes tab. In versions of Orchestrator 2021.10, and higher, you can find the processes that are run by this task in Automations, under Processes.

Configuration

Job parameter	Description
Process (Required)	Process name. You can take the process name from the Orchestrator UI. If the process is deployed in a Modern folder then this argument should be the Name of the process in the Processes tab. If the process is deployed in a Classic folder, then the argument must be formed by the Name of the process and the Environment (for example: `NAME: ProcessA ENVIRONMENT: Production ProcessName: ProcessA_Production`).
Parameters	The full path to a JSON input file. This is used when the Process requires input. 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" } }
Priority	The job run priority.
Strategy	Specify the job run strategy, dynamically allocated job(s) or robot-specific job(s). Choose one of the following options: Allocate dynamically Specific robots
Job Type (available for Modern folders only)	Choose the license model of the runtime under which the job is to be executed.
Orchestrator address	The address of the Orchestrator instance where you'll run the process.
Orchestrator tenant	Specify the Orchestrator tenant.
Orchestrator folder	Specify the folder where the specified process was deployed. To input subfolders make sure to input both the parent folder name and the name of the subfolder. For instance, use `AccountingTeam\TeamJohn`.
Authentication	For authentication towards Orchestrator, you need to create credentials in Jenkins upfront. There are four options to authenticate: (1) Authenticate to an on-premise Orchestrator using username and password. (2) Authenticate to a cloud Orchestrator using a refresh token (API key). (3) Authenticate to a cloud Orchestrator using external app authentication. (4) Authenticate to a on-premise Orchestrator using .
Job results output path	Specify the output path of the job results (for example, `testResults.json`). The results are outputted in JSON format. If not specified, the results are outputted to the artifact staging directory as `UiPathResults.json`. The output is in JSON format.
Timeout	Specify the job run(s) timeout in seconds.
Fail when job fails	The task fails when at least one job fails. The default value is True.
Wait for job completion	Wait for job run(s) completion. The default value is True.
Trace logging level	Setting used to enable trace logging to one of the following levels: None Critical Error Warning Information Verbose. (The default is set to None). Useful for debugging purposes.
No. of jobs	The number of job runs. The default value is 1.
User (available for Modern folders only)	The name of the user. This should be a machine user, not an Orchestrator user. For local users, the format should be MachineName\UserName.
Machine (available for Modern folders only)	The name of the machine.
Robot names	Comma-separated list of specific robot names.

Pipeline example

pipeline {
  agent any
  environment {
      MAJOR = '1'
      MINOR = '0'
  }
  stages {
    stage ('Build') {
        UiPathRunJob(
          credentials: UserPass('825c83c9-9a14-44eb-883a-af54f8078af0'),
          failWhenJobFails: true,
          folderName: 'A_Classic',
          orchestratorAddress: 'https://testorchestrator.some-domain.com',
          orchestratorTenant: 'Default',
          parametersFilePath: '',
          priority: 'Low',
          processName: 'ProcessA_EnvB',
          resultFilePath: 'output.json',
          strategy: Dynamically(jobsCount: 1, machine: 'TestMachine', user: 'TestUser'), timeout: 3600, waitForJobCompletion: true, traceLoggingLevel: 'None'
        )
        UiPathRunJob(
          credentials: UserPass('825c83c9-9a14-44eb-883a-af54f8078af0'),
          failWhenJobFails: true,
          folderName: 'A_Classic',
          orchestratorAddress: 'https://testorchestrator.some-domain.com',
          orchestratorTenant: 'Default',
          parametersFilePath: '',
          priority: 'Low',
          processName: 'ProcessA_EnvB',
          resultFilePath: 'output.json',
          strategy: Robot('robot1,robot2'),
          timeout: 1800,
          waitForJobCompletion: false,
          traceLoggingLevel: 'None'
        )
    }
  }
}pipeline {
  agent any
  environment {
      MAJOR = '1'
      MINOR = '0'
  }
  stages {
    stage ('Build') {
        UiPathRunJob(
          credentials: UserPass('825c83c9-9a14-44eb-883a-af54f8078af0'),
          failWhenJobFails: true,
          folderName: 'A_Classic',
          orchestratorAddress: 'https://testorchestrator.some-domain.com',
          orchestratorTenant: 'Default',
          parametersFilePath: '',
          priority: 'Low',
          processName: 'ProcessA_EnvB',
          resultFilePath: 'output.json',
          strategy: Dynamically(jobsCount: 1, machine: 'TestMachine', user: 'TestUser'), timeout: 3600, waitForJobCompletion: true, traceLoggingLevel: 'None'
        )
        UiPathRunJob(
          credentials: UserPass('825c83c9-9a14-44eb-883a-af54f8078af0'),
          failWhenJobFails: true,
          folderName: 'A_Classic',
          orchestratorAddress: 'https://testorchestrator.some-domain.com',
          orchestratorTenant: 'Default',
          parametersFilePath: '',
          priority: 'Low',
          processName: 'ProcessA_EnvB',
          resultFilePath: 'output.json',
          strategy: Robot('robot1,robot2'),
          timeout: 1800,
          waitForJobCompletion: false,
          traceLoggingLevel: 'None'
        )
    }
  }
}

JSON input file

To configure the Run Job task, input a JSON file that contains the parameters required for running the process in Orchestrator. Orchestrator validates only primitive values. Below is an overview of the required formats for input parameters that can be passed to Orchestrator:

Parameter	Required format	Example
String	Enclose the value in quotation marks.	`'string value'`
Int32	Provide the value as you would for any integer.	`11`
Boolean	Provide the value as either `true` or `false`.	`true`
Double	Provide a floating point value.	`3.5`
DateTime	Provide a valid JSON representation.	`"2012-04-23T18:25:43.511Z"`
Array	Provide values as valid JSON.	`[1,1,2,3,5,8]` or `["firstString", "secondString"]`

Example JSON schema

Below is an example JSON schema showing how to input the required parameters in a JSON file. Ensure that the arguments passed in the JSON file exist in the Studio project used for publishing the process to Orchestrator.

{
    'in_JenkinsBaseUrl': 'http://localhost:8080/jenkins/',
    'in_JenkinsBuildName': '02_UiPathApplicationDemo'
}{
    'in_JenkinsBaseUrl': 'http://localhost:8080/jenkins/',
    'in_JenkinsBuildName': '02_UiPathApplicationDemo'
}

On this page

Configuration
Pipeline example
JSON input file
Example JSON schema

Was this page helpful?

PREVIOUSAdding UiPath tasks to pipeline agent pool

NEXTUiPath Manage Assets

Support and Services

Get The Help You Need

UiPath Academy

Learning RPA - Automation Courses

UiPath Forum

UiPath Community Forum

Trust and Security

Cookies Policy