Test Suite
2022.10
False
执行任务 - Automation Suite 2022.10
横幅背景图像
徽标
Test Suite
上次更新日期 2023年12月19日

执行任务

在专为 Windows 设备设计的 UiPath CLI (UiPath.CLI.Windows) 中运行任务需要执行多个任务。

UiPath.CLI.Windows 过程与 UiPath.CLI (专为 Linux 设备设计的 UiPath CLI)过程之间的主要区别在于您可以在某些特定于您所使用的设备类型的任务中传递这些参数继续运行。

API 访问应用程序作用域

下表显示了运行任何 CLI 任务所需的 Orchestrator API 访问应用程序作用域。

应用程序作用域

描述

OR. 资产

在 Orchestrator 中具有资产读取和写入权限。

OR.BackgroundTasks

在 Orchestrator 中的后台任务读取和写入权限。

OR. 执行

在 Orchestrator 中具有执行读取和写入权限。

OR. 文件夹

在 Orchestrator 中具有文件夹读取和写入权限。

OR. 作业

在 Orchestrator 中具有作业读取和写入权限。

OR. 计算机. 读取

在 Orchestrator 中具有计算机读取权限。

或. 监控

在 Orchestrator 中具有监控读取和写入权限。

OR.Robots.Read

Orchestrator 中的机器人具有读取权限。

OR.设置.读取

在 Orchestrator 中具有设置读取权限。

OR.测试集

在 Orchestrator 中具有测试集读取和写入权限。

OR.TestSet 执行次数

在 Orchestrator 中具有测试集执行读取和写入权限。

OR.TestSet 计划

测试集计划在 Orchestrator 中具有读取和写入权限。

OR.Users.Read

在 Orchestrator 中具有用户读取权限。

运行 UiPath.CLI.Wndows

先决条件:要使用适用于 Windows 的 UiPath CLI 并执行任务,请安装 .NET 6.0.7,其中必须包含 .NET 6.0.7 Desktop Runtime,并附带 6.0.302 SDK

您可以通过调用包含相应参数的uipcli.exe来执行任务。 要执行子任务,该命令需要具有以下格式: uipcli.exe <task name> <sub-task name> 。 要运行 CLI,请执行以下操作:
  1. 打开命令提示符并导航到从 NUPKG 文件中提取的文件夹。
  2. 键入uipcli.exe ,然后选择 Enter 键。

运行 UiPath.CLI

先决条件:要跨平台使用 UiPath CLI 并执行作业任务,请安装附带 6.0.302 SDK.NET 6.0.7

您可以通过调用包含相应参数的uipcli.exe来执行任务。 要执行子任务,该命令需要具有以下格式: dotnet uipcli.dll <task name> <sub-task name> 。 要运行 CLI,请执行以下操作:
  1. 打开命令提示符并导航到从 NUPKG 文件中提取的文件夹。
  2. 输入 dotnet uipcli.dll,然后按“Enter”。

显示 CLI 版本

运行 uipcli --version 命令。

从 Orchestrator 中删除资产

先决条件

  • 在 Orchestrator 中创建资产。
  • 创建一个 CSV 文件,其中包含要删除的资产。 CSV 文件必须包含以下列三列: nametypevaluetypevalue列下的数据单元格可以留空。
  • 运行 CLI exe (适用于 Windows)或dll (适用于 Linux)文件。
  • 在下方添加 Orchestrator API 访问应用程序作用域:

    应用程序作用域

    描述

    OR. 资产

    在 Orchestrator 中具有资产读取和写入权限。

    OR.BackgroundTasks

    在 Orchestrator 中的后台任务读取和写入权限。

    OR. 执行

    在 Orchestrator 中具有执行读取和写入权限。

    OR. 文件夹

    在 Orchestrator 中具有文件夹读取和写入权限。

    OR. 作业

    在 Orchestrator 中具有作业读取和写入权限。

    OR. 计算机. 读取

    在 Orchestrator 中具有计算机读取权限。

    或. 监控

    在 Orchestrator 中具有监控读取和写入权限。

    OR.Robots.Read

    Orchestrator 中的机器人具有读取权限。

    OR.设置.读取

    在 Orchestrator 中具有设置读取权限。

    OR.测试集

    在 Orchestrator 中具有测试集读取和写入权限。

    OR.TestSet 执行次数

    在 Orchestrator 中具有测试集执行读取和写入权限。

    OR.TestSet 计划

    测试集计划在 Orchestrator 中具有读取和写入权限。

    OR.Users.Read

    在 Orchestrator 中具有用户读取权限。

有关 CSV 文件的更多信息,请查看下表中的示例:

name

类型

asset1_name

N/AN/A

asset2_name

Bool

true

asset3_name

整数

N/A

asset4_name

凭据

username:password

要从 Orchestrator 中删除资产,请执行以下操作:

  1. 使用uipcli asset运行asset任务。 您可以查看可用子任务的列表。
  2. 指定所需参数并运行delete子任务。

    请参阅下面的参数列表。

    参数

    描述

    Assets File (pos. 0)必填项

    包含要删除的资产的 CSV 文件的名称。

    Orchestrator URL (pos.1)必填项

    Orchestrator 实例的 URL。

    Orchestrator Tenant (pos.2)

    • 必需)对于 SaaP 部署。
    • 可选)适用于 PaaS 部署。

    要管理资产的 Orchestrator 实例的租户。

    -u,--username (如果使用 基本身份验证,则为必需,通过用户名和密码)

    用于向 Orchestrator 进行身份验证的用户名。 您必须将其与相应的密码配对。

    -p--password(如果您通过用户名和密码使用基本身份验证

    用于对 Orchestrator 进行身份验证的密码。您必须将其与相应的用户名配对。

    -t--token(如果使用基于令牌的身份验证,则为必填项

    用于对 Orchestrator 进行身份验证的 OAuth2 刷新令牌 。 您必须将其与 Account NameClient ID配对。

    -a--accountName(如果使用基于令牌的身份验证,则为必填项

    Orchestrator CloudRPA 帐户名称。 您必须将其与 OAuth2 刷新令牌客户端 ID配对。

    -A--accountForApp

    Orchestrator CloudRPA 帐户名称。 您必须将其与外部应用程序的 Application IDApplication SecretApplication 作用域 配对。

    -I--applicationID(如果使用外部应用程序身份验证,则为必填项

    外部应用程序 ID。 您必须将其与“ 应用程序帐户”、“应用程序密码”和“ 应用程序作用域”配对。

    -S--applicationSecret(如果使用外部应用程序身份验证,则为必填项

    外部应用程序密码。您必须将其与“应用程序帐户”、“应用程序 ID”和“应用程序作用域”配对。

    --applicationScope(如果使用外部应用程序身份验证,则为必填项

    应用程序作用域列表,以单个空格分隔。 您必须将其与外部应用程序的 应用程序帐户应用程序 ID应用程序密码 配对。

    -o--organizationUnit

    Orchestrator 文件夹(组织单元)的名称。

    要输入子文件夹,请确保同时输入父文件夹的名称和子文件夹的名称。例如,AccountingTeam\TeamJohn
    -l--language

    Orchestrator 用户界面中使用的语言。

    -y--disableTelemetry

    禁用遥测数据。

    --traceLevel

    显示事件的跟踪。

    --identityUrl (仅 PaaS 部署需要)

    身份服务器的 URL。

示例:

  • 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"

将资产部署到 Orchestrator

先决条件

  • 创建一个 CSV 文件,其中包含要部署到 Orchestrator 的资产。
    CSV 文件必须包含以下列三列: nametypevaluedescription
  • 运行 CLI exe (适用于 Windows)或dll (适用于 Linux)文件。
  • 在下方添加 Orchestrator API 访问应用程序作用域:

    应用程序作用域

    描述

    OR. 资产

    在 Orchestrator 中具有资产读取和写入权限。

    OR.BackgroundTasks

    在 Orchestrator 中的后台任务读取和写入权限。

    OR. 执行

    在 Orchestrator 中具有执行读取和写入权限。

    OR. 文件夹

    在 Orchestrator 中具有文件夹读取和写入权限。

    OR. 作业

    在 Orchestrator 中具有作业读取和写入权限。

    OR. 计算机. 读取

    在 Orchestrator 中具有计算机读取权限。

    或. 监控

    在 Orchestrator 中具有监控读取和写入权限。

    OR.Robots.Read

    Orchestrator 中的机器人具有读取权限。

    OR.设置.读取

    在 Orchestrator 中具有设置读取权限。

    OR.测试集

    在 Orchestrator 中具有测试集读取和写入权限。

    OR.TestSet 执行次数

    在 Orchestrator 中具有测试集执行读取和写入权限。

    OR.TestSet 计划

    测试集计划在 Orchestrator 中具有读取和写入权限。

    OR.Users.Read

    在 Orchestrator 中具有用户读取权限。

有关 CSV 文件的详细信息,请参阅下面的示例。

name

类型

描述

asset_1_name

text

“我有意见”

asset_1_description

asset_2_name

整数

1

asset_2_description

asset_3_name

Bool

false

asset_3_description

asset_4_name

凭据

username:password

asset_4_description

要将资产部署到 Orchestrator:

  1. 使用uipcli asset运行asset任务。 您可以查看可用子任务的列表。
  2. 指定所需参数并运行deploy子任务。

    请参阅下面的参数列表。

    参数

    描述

    Assets File (pos. 0)必填项

    包含要删除的资产的 CSV 文件的名称。

    Orchestrator URL (pos.1)必填项

    Orchestrator 实例的 URL。

    Orchestrator Tenant (pos.2)

    • 必需)对于 SaaP 部署。
    • 可选)适用于 PaaS 部署。

    要在其中管理资产的 Orchestrator 实例的租户。

    -u--username(如果您通过用户名和密码使用基本身份验证

    用于向 Orchestrator 进行身份验证的用户名。 您必须将其与相应的密码配对。

    -p--password(如果您通过用户名和密码使用基本身份验证

    用于对 Orchestrator 进行身份验证的密码。您必须将其与相应的用户名配对。

    -t--token(如果使用基于令牌的身份验证,则为必填项

    用于对 Orchestrator 进行身份验证的 OAuth2 刷新令牌 。 您必须将其与 Account NameClient ID配对。

    -a--accountName(如果使用基于令牌的身份验证,则为必填项

    Orchestrator CloudRPA 帐户名称。 您必须将其与 OAuth2 刷新令牌客户端 ID配对。

    -A--accountForApp

    Orchestrator CloudRPA 帐户名称。 您必须将其与外部应用程序的 Application IDApplication SecretApplication 作用域 配对。

    -I--applicationID(如果使用外部应用程序身份验证,则为必填项

    外部应用程序 ID。 您必须将其与“ 应用程序帐户”、“应用程序密码”和“ 应用程序作用域”配对。

    -S--applicationSecret(如果使用外部应用程序身份验证,则为必填项

    外部应用程序密码。您必须将其与“应用程序帐户”、“应用程序 ID”和“应用程序作用域”配对。

    --applicationScope(如果使用外部应用程序身份验证,则为必填项

    应用程序作用域列表,以单个空格分隔。 您必须将其与外部应用程序的 应用程序帐户应用程序 ID应用程序密码 配对。

    -o--organizationUnit

    Orchestrator 文件夹(组织单元)的名称。

    要输入子文件夹,请确保同时输入父文件夹的名称和子文件夹的名称。例如,AccountingTeam\TeamJohn
    -l--language

    Orchestrator 用户界面中使用的语言。

    -y--disableTelemetry

    禁用遥测数据。

    --traceLevel

    显示事件的跟踪。

    --identityUrl (仅 PaaS 部署需要)

    身份服务器的 URL。

示例:

  • 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"

在 Orchestrator 中运行作业

  • 在 Orchestrator 中创建流程。
  • 运行 CLI exe (适用于 Windows)或dll (适用于 Linux)文件。
  • 在下方添加 Orchestrator API 访问应用程序作用域:

    应用程序作用域

    描述

    OR. 资产

    在 Orchestrator 中具有资产读取和写入权限。

    OR.BackgroundTasks

    在 Orchestrator 中的后台任务读取和写入权限。

    OR. 执行

    在 Orchestrator 中具有执行读取和写入权限。

    OR. 文件夹

    在 Orchestrator 中具有文件夹读取和写入权限。

    OR. 作业

    在 Orchestrator 中具有作业读取和写入权限。

    OR. 计算机. 读取

    在 Orchestrator 中具有计算机读取权限。

    或. 监控

    在 Orchestrator 中具有监控读取和写入权限。

    OR.Robots.Read

    Orchestrator 中的机器人具有读取权限。

    OR.设置.读取

    在 Orchestrator 中具有设置读取权限。

    OR.测试集

    在 Orchestrator 中具有测试集读取和写入权限。

    OR.TestSet 执行次数

    在 Orchestrator 中具有测试集执行读取和写入权限。

    OR.TestSet 计划

    测试集计划在 Orchestrator 中具有读取和写入权限。

    OR.Users.Read

    在 Orchestrator 中具有用户读取权限。

  1. 使用 uipcli job 运行 job 任务。现在,您可以看到可用子任务的列表。
  2. 指定所需参数并运行run子任务。
    请参阅下面的参数列表。
    参数描述
    Process Name (pos.0)必填项要运行的流程的名称。
    Orchestrator URL (pos.1)必填项Orchestrator 实例的 URL。
    Orchestrator Tenant (pos.2)

    -(必需)对于 SaaP 部署。

    - (可选)适用于 PaaS 部署。

    要在其中运行流程的 Orchestrator 实例的租户。
    -i--input_path (仅当工作流的入口点具有输入参数时才需要与要运行的流程对应的 JSON 输入文件的完整路径。
    -u--username(如果您通过用户名和密码使用基本身份验证 用于向 Orchestrator 进行身份验证的用户名。 您必须将其与相应的密码配对。
    -p--password(如果您通过用户名和密码使用基本身份验证 用于对 Orchestrator 进行身份验证的密码。您必须将其与相应的用户名配对。
    -t--token(如果使用基于令牌的身份验证,则为必填项用于对 Orchestrator 进行身份验证的 OAuth2 刷新令牌 。 您必须将其与 Account NameClient ID配对。
    -a--accountName(如果使用基于令牌的身份验证,则为必填项Orchestrator CloudRPA 帐户名称。 您必须将其与 OAuth2 刷新令牌客户端 ID配对。
    -I--applicationID(如果使用外部应用程序身份验证,则为必填项外部应用程序 ID。您必须将其与“应用程序帐户”、“应用程序密码”和“应用程序作用域”配对。
    -S--applicationSecret(如果使用外部应用程序身份验证,则为必填项外部应用程序密码。您必须将其与“应用程序帐户”、“应用程序 ID”和“应用程序作用域”配对。
    --applicationScope(如果使用外部应用程序身份验证,则为必填项应用程序作用域列表,以单个空格分隔。您必须将其与外部应用程序的应用程序账号应用程序 ID应用程序密码配对
    -P--priority要运行作业的优先级:- 低。- 正常(默认)。- 高。
    -r--robots特定机器人名称的列表,以逗号分隔。
    -j--jobscount要运行流程的次数。 流程运行的默认次数为 1。
    -U--user用户名。此用户不可为计算机用户或 Orchestrator 用户。对于本地用户,用户名格式应为“计算机名称\\UserN用户名”。
    -M--machine要在其上运行流程的计算机的名称。
    -R--result_path要存储作业结果的 JSON 文件或文件夹的完整路径。 结果以 JSON 文件形式返回。
    -W--timeout作业执行的超时 (秒)。 默认值为 1800 秒。
    -f--fail_when_job_fails当一个作业失败时,该命令将失败,默认值为 True
    -w--wait该命令等待作业完成。 默认值为 True
    -b--job_type (仅适用于新式文件夹) 作业的运行时类型。 您可以选择:- Unattended - NonProduction
    -A--accountForAppOrchestrator CloudRPA 帐户名称。您必须将其与外部应用程序的应用程序 ID应用程序密码应用程序作用域配对。
    -o--organizationUnit Orchestrator 文件夹(组织单元)的名称。
    要输入子文件夹,请确保同时输入父文件夹的名称和子文件夹的名称。例如,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

分析项目

先决条件

  • 创建项目。
  • 运行 CLI exe (适用于 Windows)或dll (适用于 Linux)文件。
  • 在下方添加 Orchestrator API 访问应用程序作用域:

    应用程序作用域

    描述

    OR. 资产

    在 Orchestrator 中具有资产读取和写入权限。

    OR.BackgroundTasks

    在 Orchestrator 中的后台任务读取和写入权限。

    OR. 执行

    在 Orchestrator 中具有执行读取和写入权限。

    OR. 文件夹

    在 Orchestrator 中具有文件夹读取和写入权限。

    OR. 作业

    在 Orchestrator 中具有作业读取和写入权限。

    OR. 计算机. 读取

    在 Orchestrator 中具有计算机读取权限。

    或. 监控

    在 Orchestrator 中具有监控读取和写入权限。

    OR.Robots.Read

    Orchestrator 中的机器人具有读取权限。

    OR.设置.读取

    在 Orchestrator 中具有设置读取权限。

    OR.测试集

    在 Orchestrator 中具有测试集读取和写入权限。

    OR.TestSet 执行次数

    在 Orchestrator 中具有测试集执行读取和写入权限。

    OR.TestSet 计划

    测试集计划在 Orchestrator 中具有读取和写入权限。

    OR.Users.Read

    在 Orchestrator 中具有用户读取权限。

  1. 使用uipcli package运行package任务。 您可以查看可用子任务的列表。
  2. 指定所需参数并运行analyze子任务。

    请参阅下面的参数列表。

图例:(*) - 可选,建议在使用其他包订阅源时使用。

参数

描述

Project(s) Path (pos.0) (必填)
project.json文件的路径,或包含多个project.json文件的文件夹的路径。

--analyzerTraceLevel

选择分析后要输出的消息类型:

  • 关闭 = 不显示任何消息
  • 错误

    -警告

    -信息

    -详细

-stopOnRuleViolation

违反任何规则时,作业将失败。

--treatWarningsAsErrors

将警告视为错误。

--resultPath

要存储结果的 JSON 文件的完整路径。

如果不将其添加为参数,则结果将仅在标准控制台中打印。

--ignoredRules

要在分析期间忽略的规则列表,以逗号分隔。

--orchestratorUsername (*)

(如果您通过用户名和密码使用基本身份验证,则为必填项)

用于向 Orchestrator 进行身份验证的用户名。 您必须将其与相应的密码配对。

--orchestratorPassword (*)

(如果您通过用户名和密码使用基本身份验证,则为必填项)

用于对 Orchestrator 进行身份验证的密码。您必须将其与相应的用户名配对。

-orchestratorAuthToken (*)

(如果您使用基于令牌的身份验证,则为必填项

用于对 Orchestrator 进行身份验证的 OAuth2 刷新令牌 。 您必须将其与 Account NameClient ID配对。

--orchestratorAccountName (*)

(如果您使用基于令牌的身份验证,则为必填项

Orchestrator CloudRPA 帐户名称。 您必须将其与 OAuth2 刷新令牌客户端 ID配对。

--orchestratorAccountForApp (*)

Orchestrator CloudRPA 帐户名称。 您必须将其与外部应用程序的 Application IDApplication SecretApplication 作用域 配对。

--orchestratorApplicationId (*)

(如果使用外部应用程序身份验证,则为必填项

外部应用程序 ID。您必须将其与**“应用程序帐户”、“应用程序密码”和“应用程序作用域。

--orchestratorApplicationSecret (*)

(如果使用外部应用程序身份验证,则为必填项

外部应用程序密码。您必须将其与“应用程序帐户”、“应用程序 ID”和“应用程序作用域”配对。

--orchestratorApplicationScope (*)

(如果使用外部应用程序身份验证,则为必填项

应用程序作用域列表,以单个空格分隔。 您必须将其与外部应用程序的 应用程序帐户应用程序 ID应用程序密码 配对。

--orchestratorFolder (*)

目标 Orchestrator 文件夹的名称。

要输入子文件夹,请确保同时输入父文件夹的名称和子文件夹的名称。例如,AccountingTeam\TeamJohn
--orchestratorUrl (*)

Orchestrator 实例的 URL。

--orchestratorTenant (*)

要删除计算机的 Orchestrator 实例的租户。

--help

显示此命令的参数和示例。

示例:

  • 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"

删除包

先决条件

  • 将包发布到 Orchestrator。
  • 运行 CLI exe (适用于 Windows)或dll (适用于 Linux)文件。
  • 在下方添加 Orchestrator API 访问应用程序作用域:

    应用程序作用域

    描述

    OR. 资产

    在 Orchestrator 中具有资产读取和写入权限。

    OR.BackgroundTasks

    在 Orchestrator 中的后台任务读取和写入权限。

    OR. 执行

    在 Orchestrator 中具有执行读取和写入权限。

    OR. 文件夹

    在 Orchestrator 中具有文件夹读取和写入权限。

    OR. 作业

    在 Orchestrator 中具有作业读取和写入权限。

    OR. 计算机. 读取

    在 Orchestrator 中具有计算机读取权限。

    或. 监控

    在 Orchestrator 中具有监控读取和写入权限。

    OR.Robots.Read

    Orchestrator 中的机器人具有读取权限。

    OR.设置.读取

    在 Orchestrator 中具有设置读取权限。

    OR.测试集

    在 Orchestrator 中具有测试集读取和写入权限。

    OR.TestSet 执行次数

    在 Orchestrator 中具有测试集执行读取和写入权限。

    OR.TestSet 计划

    测试集计划在 Orchestrator 中具有读取和写入权限。

    OR.Users.Read

    在 Orchestrator 中具有用户读取权限。

  1. 使用uipcli package运行package任务。 您可以查看可用子任务的列表。
  2. 指定所需参数并运行delete子任务。

    请参阅下面的参数列表。

    参数

    描述

    Package name (pos. 0)必填项

    要删除的包的名称。

    Orchestrator URL (pos. 1)

    Orchestrator 实例的 URL。

    Orchestrator Tenant (pos. 2)

    • 必需)对于 SaaP 部署。
    • 可选)适用于 PaaS 部署。

    要删除计算机的 Orchestrator 实例的租户。

    -u--username(如果您通过用户名和密码使用基本身份验证

    用于向 Orchestrator 进行身份验证的用户名。 您必须将其与相应的密码配对。

    -p--password(如果您通过用户名和密码使用基本身份验证

    用于对 Orchestrator 进行身份验证的密码。您必须将其与相应的用户名配对。

    -t--token(如果使用基于令牌的身份验证,则为必填项

    用于对 Orchestrator 进行身份验证的 OAuth2 刷新令牌 。 您必须将其与 Account NameClient ID配对。

    -a--accountName(如果使用基于令牌的身份验证,则为必填项

    Orchestrator CloudRPA 帐户名称。 您必须将其与 OAuth2 刷新令牌客户端 ID配对。

    -A--accountForApp

    Orchestrator CloudRPA 帐户名称。 您必须将其与外部应用程序的 Application IDApplication SecretApplication 作用域 配对。

    -I--applicationId(如果使用外部应用程序身份验证,则为必填项

    外部应用程序 ID。 您必须将其与“ 应用程序帐户”、“应用程序密码”和“ 应用程序作用域”配对。

    -S--applicationSecret(如果使用外部应用程序身份验证,则为必填项

    外部应用程序密码。您必须将其与“应用程序帐户”、“应用程序 ID”和“应用程序作用域”配对。

    --applicationScope(如果使用外部应用程序身份验证,则为必填项

    应用程序作用域列表,以单个空格分隔。 您必须将其与外部应用程序的 应用程序帐户应用程序 ID应用程序密码 配对。

    -o--organizationUnit
    Orchestrator 文件夹(组织单元)的名称。
    要输入子文件夹,请确保同时输入父文件夹的名称和子文件夹的名称。例如,AccountingTeam\TeamJohn
    -l--language

    Orchestrator 用户界面中使用的语言。

    -y--disableTelemetry

    禁用遥测数据。

    --traceLevel

    显示事件的跟踪。

    --identityUrl (仅 PaaS 部署需要)

    身份服务器的 URL。

    --help

    显示此命令的参数和示例。

示例:

  • 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"

将包部署到 Orchestrator

先决条件

  • 创建包。
  • 运行 CLI exe (适用于 Windows)或dll (适用于 Linux)文件。
  • 在下方添加 Orchestrator API 访问应用程序作用域:

    应用程序作用域

    描述

    OR. 资产

    在 Orchestrator 中具有资产读取和写入权限。

    OR.BackgroundTasks

    在 Orchestrator 中的后台任务读取和写入权限。

    OR. 执行

    在 Orchestrator 中具有执行读取和写入权限。

    OR. 文件夹

    在 Orchestrator 中具有文件夹读取和写入权限。

    OR. 作业

    在 Orchestrator 中具有作业读取和写入权限。

    OR. 计算机. 读取

    在 Orchestrator 中具有计算机读取权限。

    或. 监控

    在 Orchestrator 中具有监控读取和写入权限。

    OR.Robots.Read

    Orchestrator 中的机器人具有读取权限。

    OR.设置.读取

    在 Orchestrator 中具有设置读取权限。

    OR.测试集

    在 Orchestrator 中具有测试集读取和写入权限。

    OR.TestSet 执行次数

    在 Orchestrator 中具有测试集执行读取和写入权限。

    OR.TestSet 计划

    测试集计划在 Orchestrator 中具有读取和写入权限。

    OR.Users.Read

    在 Orchestrator 中具有用户读取权限。

  1. 使用uipcli package运行package任务。 您可以查看可用子任务的列表。
  2. 指定所需参数并运行deploy子任务。

    请参阅下面的参数列表。

    参数

    描述

    Package(s) Path (pos. 0)必填项

    包文件的路径,或包含多个包的文件夹的路径。

    Orchestrator URL (pos. 1)必填项

    Orchestrator 实例的 URL。

    `Orchestrator 租户 (pos.2)

    • 必需)对于 SaaP 部署。
    • 可选)适用于 PaaS 部署。

    要删除计算机的 Orchestrator 实例的租户。

    -u--username(如果您通过用户名和密码使用基本身份验证

    用于向 Orchestrator 进行身份验证的用户名。 您必须将其与相应的密码配对。

    -p--password(如果您通过用户名和密码使用基本身份验证

    用于对 Orchestrator 进行身份验证的密码。您必须将其与相应的用户名配对。

    -t--token(如果使用基于令牌的身份验证,则为必填项

    用于对 Orchestrator 进行身份验证的 OAuth2 刷新令牌 。 您必须将其与 Account NameClient ID配对。

    -a--accountName(如果使用基于令牌的身份验证,则为必填项

    Orchestrator CloudRPA 帐户名称。 您必须将其与 OAuth2 刷新令牌客户端 ID配对。

    -A--accountForApp

    Orchestrator CloudRPA 帐户名称。您必须将其与外部应用程序的应用程序 ID应用程序密码应用程序作用域配对

    -I--applicationId(如果使用外部应用程序身份验证,则为必填项

    外部应用程序 ID。 您必须将其与“ 应用程序帐户”、“应用程序密码”和“ 应用程序作用域”配对。

    -S--applicationSecret(如果使用外部应用程序身份验证,则为必填项

    外部应用程序密码。您必须将其与“应用程序帐户”、“应用程序 ID”和“应用程序作用域”配对。

    --applicationScope(如果使用外部应用程序身份验证,则为必填项

    应用程序作用域列表,以单个空格分隔。 您必须将其与外部应用程序的 应用程序帐户应用程序 ID应用程序密码 配对。

    -c--createProcess
    当设置为 true时,它会在命令中传递的 Orchestrator 文件夹中创建一个流程。 其默认值为 True
    设置为 false时,它不会在 Orchestrator 文件夹中创建流程。 例如, --createProcess false.
    -e--environments (适用于传统文件夹)

    要将包部署到的环境列表,以逗号分隔。

    如果环境不属于默认文件夹(组织单位),则必须在环境名称前加上文件夹名称。 例如,如果环境为 “TestEnvironment”,文件夹名称为“ AccountingTeam”,则将环境写入“ AccountingTeam\TestEnvironment”

    -h--entryPointsPath

    定义用于创建或更新流程的特定入口点。这是始于项目根目录的入口点文件路径。

    对于传统文件夹,只能为每个环境指定一个入口点。

    -o--organizationUnit

    Orchestrator 文件夹(组织单元)的名称。

    要输入子文件夹,请确保同时输入父文件夹的名称和子文件夹的名称。例如,AccountingTeam\TeamJohn
    -l--language

    Orchestrator 用户界面中使用的语言。

    -y--disableTelemetry

    禁用遥测数据。

    --traceLevel

    显示事件的跟踪。

    --identityUrl (仅 PaaS 部署需要)

    身份服务器的 URL。

    --help

    显示此命令的参数和示例。

示例:

  • 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

将项目打包到包中

先决条件

  • 创建项目。
  • 运行 CLI exe (适用于 Windows)或dll (适用于 Linux)文件。
  • 在下方添加 Orchestrator API 访问应用程序作用域:

    应用程序作用域

    描述

    OR. 资产

    在 Orchestrator 中具有资产读取和写入权限。

    OR.BackgroundTasks

    在 Orchestrator 中的后台任务读取和写入权限。

    OR. 执行

    在 Orchestrator 中具有执行读取和写入权限。

    OR. 文件夹

    在 Orchestrator 中具有文件夹读取和写入权限。

    OR. 作业

    在 Orchestrator 中具有作业读取和写入权限。

    OR. 计算机. 读取

    在 Orchestrator 中具有计算机读取权限。

    或. 监控

    在 Orchestrator 中具有监控读取和写入权限。

    OR.Robots.Read

    Orchestrator 中的机器人具有读取权限。

    OR.设置.读取

    在 Orchestrator 中具有设置读取权限。

    OR.测试集

    在 Orchestrator 中具有测试集读取和写入权限。

    OR.TestSet 执行次数

    在 Orchestrator 中具有测试集执行读取和写入权限。

    OR.TestSet 计划

    测试集计划在 Orchestrator 中具有读取和写入权限。

    OR.Users.Read

    在 Orchestrator 中具有用户读取权限。

  1. 使用uipcli package运行package任务。 您可以查看可用子任务的列表。
  2. 指定所需参数并运行pack子任务。

    请参阅下面的参数列表。

图例:(*) - 可选,仅当您在 Orchestrator 中具有库的依赖项时才有用。

参数

描述

Project(s) Path (pos. 0) (必填)
project.json文件或包含project.json文件的文件夹的路径。
-o, or --output (Required)

要在其中打包项目的目标 Orchestrator 文件夹。

-v, or --version

设置包版本。

--autoVersion

自动生成包版本。

--outputType

强制输出为指定的类型。

--libraryOrchestratorUsername (*)

(如果您通过用户名和密码使用基本身份验证,则为必填项)

用于向 Orchestrator 进行身份验证的用户名。 您必须将其与相应的密码配对。

如果您的包引用 Orchestrator 订阅源中的库,则这是必需的

--libraryOrchestratorPassword (*)

(如果您通过用户名和密码使用基本身份验证,则为必填项)

用于对 Orchestrator 进行身份验证的密码。您必须将其与相应的用户名配对。

如果您的包引用 Orchestrator 订阅源中的库,则这是必需的

--libraryOrchestratorAuthToken (*)

(如果您使用基于令牌的身份验证,则为必填项

用于对 Orchestrator 进行身份验证的 OAuth2 刷新令牌 。 您必须将其与 Account NameClient ID配对。

如果您的包引用 Orchestrator 订阅源中的库,则这是必需的

--libraryOrchestratorAccountName (*)

(如果您使用基于令牌的身份验证,则为必填项

Orchestrator CloudRPA 帐户名称。 您必须将其与 OAuth2 刷新令牌客户端 ID配对。

如果您的包引用 Orchestrator 订阅源中的库,则这是必需的

--libraryOrchestratorAccountForApp (*)

Orchestrator CloudRPA 帐户名称。您必须将其与外部应用程序的应用程序 ID应用程序密码应用程序作用域配对

如果您的包引用 Orchestrator 订阅源中的库,则这是必需的

--libraryOrchestratorApplicationId (*)

(如果使用外部应用程序身份验证,则为必填项

外部应用程序 ID。您必须将其与“应用程序帐户”、“应用程序密码”和“应用程序作用域”配对。

如果您的包引用 Orchestrator 订阅源中的库,则这是必需的

--libraryOrchestratorApplicationSecret (*)

(如果使用外部应用程序身份验证,则为必填项

外部应用程序密码。您必须将其与“应用程序帐户”、“应用程序 ID”和“应用程序作用域”配对。

如果您的包引用 Orchestrator 订阅源中的库,则这是必需的

--libraryOrchestratorApplicationScope (*)

(如果使用外部应用程序身份验证,则为必填项

应用程序作用域列表,以单个空格分隔。 您必须将其与外部应用程序的 应用程序帐户应用程序 ID应用程序密码 配对。

如果您的包引用 Orchestrator 订阅源中的库,则这是必需的

--libraryOrchestratorFolder (*)

目标 Orchestrator 文件夹的名称。

要输入子文件夹,请确保同时输入父文件夹的名称和子文件夹的名称。例如,AccountingTeam\TeamJohn
--libraryOrchestratorUrl (*)

Orchestrator 实例的 URL。

--libraryOrchestratorTenant (*)

要删除计算机的 Orchestrator 实例的租户。

-y, or --disableTelemetry

禁用遥测数据。

--traceLevel

显示事件的跟踪。

-l, or --language

Orchestrator 用户界面中使用的语言。

--help

显示此命令的参数和示例。

示例:

  • 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

测试包/运行测试集

先决条件

  • 创建包或测试集。
  • 运行 CLI exe (适用于 Windows)或dll (适用于 Linux)文件。
  • 在下方添加 Orchestrator API 访问应用程序作用域:

    应用程序作用域

    描述

    OR. 资产

    在 Orchestrator 中具有资产读取和写入权限。

    OR.BackgroundTasks

    在 Orchestrator 中的后台任务读取和写入权限。

    OR. 执行

    在 Orchestrator 中具有执行读取和写入权限。

    OR. 文件夹

    在 Orchestrator 中具有文件夹读取和写入权限。

    OR. 作业

    在 Orchestrator 中具有作业读取和写入权限。

    OR. 计算机. 读取

    在 Orchestrator 中具有计算机读取权限。

    或. 监控

    在 Orchestrator 中具有监控读取和写入权限。

    OR.Robots.Read

    Orchestrator 中的机器人具有读取权限。

    OR.设置.读取

    在 Orchestrator 中具有设置读取权限。

    OR.测试集

    在 Orchestrator 中具有测试集读取和写入权限。

    OR.TestSet 执行次数

    在 Orchestrator 中具有测试集执行读取和写入权限。

    OR.TestSet 计划

    测试集计划在 Orchestrator 中具有读取和写入权限。

    OR.Users.Read

    在 Orchestrator 中具有用户读取权限。

  1. 使用uipcli test运行test任务。 您可以查看可用子任务的列表。
  2. 指定所需参数并运行run子任务。

    请参阅下面的参数列表。

    参数

    描述

    Orchestrator URL (pos. 0)必填项

    Orchestrator 实例的 URL。

    Orchestrator Tenant (pos. 1)

    • 必需)对于 SaaP 部署。
    • 可选)适用于 PaaS 部署。

    包或测试集所在的租户。

    -u--username(如果您通过用户名和密码使用基本身份验证

    用于向 Orchestrator 进行身份验证的用户名。 您必须将其与相应的密码配对。

    -p--password(如果您通过用户名和密码使用基本身份验证

    用于对 Orchestrator 进行身份验证的密码。您必须将其与相应的用户名配对。

    -t--token(如果使用基于令牌的身份验证,则为必填项

    用于对 Orchestrator 进行身份验证的 OAuth2 刷新令牌 。 您必须将其与 Account NameClient ID配对。

    -a--accountName(如果使用基于令牌的身份验证,则为必填项

    Orchestrator CloudRPA 帐户名称。 您必须将其与 OAuth2 刷新令牌客户端 ID配对。

    -A, --accountForApp

    Orchestrator CloudRPA 帐户名称。 您必须将其与外部应用程序的 Application IDApplication SecretApplication 作用域 配对。

    -I--applicationId(如果使用外部应用程序身份验证,则为必填项

    外部应用程序 ID。 您必须将其与“ 应用程序帐户”、“应用程序密码”和“ 应用程序作用域”配对。

    -S--applicationSecret(如果使用外部应用程序身份验证,则为必填项

    外部应用程序密码。您必须将其与“应用程序帐户”、“应用程序 ID”和“应用程序作用域”配对。

    --applicationScope(如果使用外部应用程序身份验证,则为必填项

    应用程序作用域列表,以单个空格分隔。您必须将其与外部应用程序的应用程序账号应用程序 ID应用程序密码配对

    -P--project-path

    要测试的测试包文件的路径。

    -s--testset
    要执行的测试集的显示名称。确保测试集包含最新版本的测试用例。
    如果测试集不在默认文件夹中,请确保在其前面添加相关文件夹名称。例如,AccountingTeam\TestSet

    --out

    返回结果的文件的类型。

    -r--result_path

    要存储结果的文件的目标路径。

    -e--environment (传统文件夹为必需
    要部署包的环境。 您必须将其与project path配对。
    -w--timeout

    要等待测试集执行的时间(以秒为单位)。 默认值为 7200 秒

    -i--input_path (如果入口点工作流具有要通过命令行传递的输入参数,则为必需

    json 输入文件的完整路径。

    --attachRobotLogs

    附加每个已执行测试用例的机器人日志和 JUnit 测试报告。

    -o--organizationUnit

    要在其中执行测试集的 Orchestrator 文件夹。

    -l--language

    Orchestrator 用户界面中使用的语言。

    -y--disableTelemetry

    禁用遥测数据。

    --traceLevel

    显示事件的跟踪。

    --identityURL (仅 PaaS 部署需要

    身份服务器的 URL。

    --help

    显示此命令的参数和示例。

示例:

  • test run "https://uipath-orchestrator.myorg.com" default -A myAccountForExternalApp -I myExternalAppId -S myExternalAppSecret --applicationScope "OR.Folders.Read OR.Settings.Read" -s "MyRobotTests"
  • test run "https://uipath-orchestrator.myorg.com" default -t a7da29a2c93a717110a82 -a myAccount -P "C:\UiPath\Project\project.json" -e TestingEnv -r "C:\results.json" --out uipath -l en-US
  • test run "https://uipath-orchestrator.myorg.com" default -t a7da29a2c93a717110a82 -a myAccount -P "C:\UiPath\Project\project.json" -e TestingEnv -r "C:\results.json" -i "C:\UiPath\Project\input-params.json" --out uipath -l en-US --attachRobotLogs "true"
支持和服务图标
获取您需要的帮助
UiPath Academy 图标
了解 RPA - 自动化课程
UiPath 论坛图标
UiPath Community 论坛
Uipath 白色徽标
信任与安全
© 2005-2024 UiPath. All rights reserved.