CI/CD 集成用户指南

上次更新日期 2025年4月28日

UiPath 运行作业

“UiPath 运行作业”构建后步骤将启动已在 Orchestrator 实例上部署的流程。在 Orchestrator 2020.10 版本中，您可以在“流程”选项卡中找到此任务运行的流程。在 Orchestrator 2021.10 及更高版本中，您可以在“流程”下的“自动化”中找到此任务运行的流程。

配置

作业参数	描述
流程（必填）	流程名称。您可以从 Orchestrator 用户界面获取流程名称。如果流程部署在新式文件夹中，则此参数应为“流程”选项卡中的流程名称。如果流程部署在传统文件夹中，则参数必须由流程的名称和环境组成（例如： `NAME: ProcessA ENVIRONMENT: Production ProcessName: ProcessA_Production` ）。
参数	JSON 输入文件的完整路径。当流程需要输入时使用。 JSON 文件格式示例： `{ "StringArgument_In": "MyConfigurationValue", "IntArgument_In": 1, "DictionaryArgument_In": { "Key1": "Value1", "Key2": "Value2" } }`{ "StringArgument_In": "MyConfigurationValue", "IntArgument_In": 1, "DictionaryArgument_In": { "Key1": "Value1", "Key2": "Value2" } }
优先级	运行作业优先级。
策略	指定作业运行策略、已动态分配的作业，或者机器人指定的作业。选择以下选项之一：动态分配特定机器人
作业类型（仅适用于新式文件夹）	选择要用于执行作业的运行时的许可模式。
Orchestrator 地址	您将在其中运行流程的 Orchestrator 实例的地址。
Orchestrator 租户	指定 Orchestrator 租户。
Orchestrator 文件夹	指定部署指定流程的文件夹。要输入子文件夹，请确保同时输入父文件夹的名称和子文件夹的名称。例如，`AccountingTeam\TeamJohn`。
身份验证	要对 Orchestrator 进行身份验证，您需要预先在 Jenkins 中创建凭据。有四个用于身份验证的选项： (1) 使用用户名和密码对本地部署 Orchestrator 进行身份验证。 ( 2 ) 使用刷新令牌（API 密钥）对 Cloud Orchestrator 进行身份验证。 (3) 使用外部应用程序身份验证向 Cloud Orchestrator 进行身份验证。 ( 4 ) 使用对本地部署 Orchestrator 进行身份验证。
作业结果输出路径	指定作业结果的输出路径（例如`testResults.json` ）。结果以 JSON 格式输出。若未获指定，结果将以 `UiPathResults.json` 形式输出到工件阶段目录中。输出结果为 JSON 格式。
超时	指定作业运行的超时时间 (以秒为单位)。
作业失败即失败	至少有一个作业失败时，任务失败。默认值为 TRUE。
等待作业完成	等待作业运行完成。默认值为 TRUE。
追踪日志记录级别	用于启用跟踪日志记录的设置为以下级别之一：无重要事项错误 Warning 信息详细。（默认设置为“ 无”）。可用于调试目的。
作业数	作业运行数。默认值为 1。
用户（仅适用于新式文件夹）	用户名。此用户不可为计算机用户或 Orchestrator 用户。对于本地用户，格式应为 MachineName\UserName。
计算机（仅适用于新式文件夹）	计算机名称。
机器人名称	指定机器人名称的逗号分隔列表。

管道示例

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 输入文件

要配置“运行作业”任务，请输入一个 JSON 文件，其中包含在 Orchestrator 中运行流程所需的参数。 Orchestrator 仅验证原始值。下面概述了可传递给 Orchestrator 的输入参数的必需格式：

参数	所需格式	示例
字符串	用引号将值括起来。	`'string value'`
Int32	像提供任何整数一样提供值。	`11`
布尔值	提供 `true` 或 `false`形式的值。	`true`
Double	提供浮点值。	`3.5`
Datetime	提供有效的 JSON 表示。	`"2012-04-23T18:25:43.511Z"`
数组	以有效 JSON 的形式提供值。	`[1,1,2,3,5,8]` 或`["firstString", "secondString"]`

JSON 架构示例

以下是 JSON 架构示例，显示了如何在 JSON 文件中输入所需参数。确保用于将流程发布到 Orchestrator 的 Studio 项目中存在 JSON 文件中传递的参数。

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