UiPath Documentation
uipath-cli
latest
false
重要 :
请注意,此内容已使用机器翻译进行了本地化。 新发布内容的本地化可能需要 1-2 周的时间才能完成。

UiPath CLI 用户指南

uip Maestro 流程和 uip Maestro 流程

Maestro 包发布到 Orchestrator 后,它将成为类型为ProcessOrchestration流程。本页介绍两个相关的命令组:

  • uip maestro process — 对单个流程定义的按文件夹操作(在文件夹中列出,获取其架构,然后运行)。
  • uip maestro processes (复数) — 租户范围内的摘要和每个流程的事件查找。

大纲

# Singular — per-folder, operational
uip maestro process list -f <folder-key> [-t <tenant>] [--filter <odata>] [--login-validity <minutes>]
uip maestro process get  <process-key> <feed-id> -f <folder-key> [-t <tenant>] [--login-validity <minutes>]
uip maestro process run  <process-key> <folder-key>
                          [-i, --inputs <json>] [-t, --tenant <name>]
                          [--release-key <key>] [--feed-id <id>] [--robot-ids <ids>]
                          [--validate] [--login-validity <minutes>]

# Plural — tenant-wide summary and incident surface
uip maestro processes list
uip maestro processes incidents <process-key> [--folder-key <key>]
# Singular — per-folder, operational
uip maestro process list -f <folder-key> [-t <tenant>] [--filter <odata>] [--login-validity <minutes>]
uip maestro process get  <process-key> <feed-id> -f <folder-key> [-t <tenant>] [--login-validity <minutes>]
uip maestro process run  <process-key> <folder-key>
                          [-i, --inputs <json>] [-t, --tenant <name>]
                          [--release-key <key>] [--feed-id <id>] [--robot-ids <ids>]
                          [--validate] [--login-validity <minutes>]

# Plural — tenant-wide summary and incident surface
uip maestro processes list
uip maestro processes incidents <process-key> [--folder-key <key>]

所有子命令都需要uip login并遵循全局选项。退出代码遵循标准合同


uip Maestro 流程列表

列出特定文件夹中可用的 Maestro 流程(版本)。

选项

选项必填描述
-f, --folder-key <key>文件夹密钥 (GUID)。
-t, --tenant <name>租户名称。默认为经过身份验证的租户。
--filter <odata>在服务器端应用的其他 OData 筛选器。
--login-validity <minutes>令牌刷新阈值(默认为10 )。

Data shape (--output json)

{
  "Code": "MaestroProcessList",
  "Data": [
    {
      "name":       "InvoiceOrchestration",
      "processKey": "a1b2c3d4-0000-0000-0000-000000000001:1.0.0",
      "releaseKey": "e5f6a7b8-0000-0000-0000-000000000001",
      "folderKey":  "c3d4e5f6-0000-0000-0000-000000000001",
      "feedId":     "default",
      "folderId":   42,
      "active":     "Yes",
      "latest":     "Yes"
    }
  ]
}
{
  "Code": "MaestroProcessList",
  "Data": [
    {
      "name":       "InvoiceOrchestration",
      "processKey": "a1b2c3d4-0000-0000-0000-000000000001:1.0.0",
      "releaseKey": "e5f6a7b8-0000-0000-0000-000000000001",
      "folderKey":  "c3d4e5f6-0000-0000-0000-000000000001",
      "feedId":     "default",
      "folderId":   42,
      "active":     "Yes",
      "latest":     "Yes"
    }
  ]
}

uip Maestro 流程获取

获取 Maestro 流程的入口点架构(输入/输出 JSON 架构)。

参数

  • <process-key> (必填) — 流程密钥。
  • <feed-id> (必填) — 订阅源 ID(来自list )。

选项

  • -f, --folder-key <key> (必填项)
  • -t, --tenant
  • --login-validity

数据形状

{
  "Code": "MaestroProcessGet",
  "Data": [
    {
      "Path":         "/content/main.bpmn#Event_start",
      "DisplayName":  "Manual trigger",
      "Type":         "processorchestration",
      "InputSchema":  "{\"type\":\"object\",\"properties\":{}}",
      "OutputSchema": "{\"type\":\"object\",\"properties\":{}}"
    }
  ]
}
{
  "Code": "MaestroProcessGet",
  "Data": [
    {
      "Path":         "/content/main.bpmn#Event_start",
      "DisplayName":  "Manual trigger",
      "Type":         "processorchestration",
      "InputSchema":  "{\"type\":\"object\",\"properties\":{}}",
      "OutputSchema": "{\"type\":\"object\",\"properties\":{}}"
    }
  ]
}

InputSchemaOutputSchema是重新字符串化的 JSON 架构字符串。


uip Maestro 流程运行

为已发布的流程启动 Maestro 作业。

参数

  • <process-key> (必填) — 流程密钥。
  • <folder-key> (必填) — 文件夹密钥 (GUID)。

选项

选项描述
-i, --inputs <json>以 JSON 字符串或@path/to/file.json表示的输入。如果省略且通过管道传输 标准输入,则解析标准输入。
-t, --tenant <name>租户名称(默认为经过身份验证的租户)。
--release-key <key>发行密钥 (GUID) — 来自process list
--feed-id <id>包查找的订阅源 ID(可选)。
--robot-ids <ids>以逗号分隔的机器人 ID(整数)。无效值快速失败。
--validate运行前,根据流程架构验证输入。仅基本检查 — 必填字段+原始类型。
--login-validity <minutes>令牌刷新阈值(默认为10 )。

输入优先级--inputs <json> / --inputs @file.json > 标准输入 > 空对象{}

示例

# Inline JSON
uip maestro process run "InvoiceOrchestration:1.0.0" "<folder-key>" \
  --inputs '{"amount":100}'

# From a file
uip maestro process run "InvoiceOrchestration:1.0.0" "<folder-key>" --inputs @inputs.json

# Piped stdin
echo '{"amount":100}' | uip maestro process run "InvoiceOrchestration:1.0.0" "<folder-key>"

# Validate before running
uip maestro process run "InvoiceOrchestration:1.0.0" "<folder-key>" \
  --inputs '{"amount":100}' --validate
# Inline JSON
uip maestro process run "InvoiceOrchestration:1.0.0" "<folder-key>" \
  --inputs '{"amount":100}'

# From a file
uip maestro process run "InvoiceOrchestration:1.0.0" "<folder-key>" --inputs @inputs.json

# Piped stdin
echo '{"amount":100}' | uip maestro process run "InvoiceOrchestration:1.0.0" "<folder-key>"

# Validate before running
uip maestro process run "InvoiceOrchestration:1.0.0" "<folder-key>" \
  --inputs '{"amount":100}' --validate

数据形状

{
  "Code": "MaestroJobStarted",
  "Data": {
    "jobKey":  "b2c3d4e5-0000-0000-0000-000000000001",
    "state":   "Pending",
    "traceId": "d4e5f6a7-0000-0000-0000-000000000001"
  }
}
{
  "Code": "MaestroJobStarted",
  "Data": {
    "jobKey":  "b2c3d4e5-0000-0000-0000-000000000001",
    "state":   "Pending",
    "traceId": "d4e5f6a7-0000-0000-0000-000000000001"
  }
}

下一步: uip maestro job traces <jobKey>进行流执行或uip maestro job status <jobKey>进行轮询。


uip Maestro 进程列表

租户范围内的 Maestro 流程摘要(此层未应用任何processType筛选器 — 复数命令在工具之间共享,并且不适用于ProcessOrchestration服务器端)。

参数

无。

数据形状

{
  "Code": "ProcessList",
  "Data": [ /* array of Maestro process summaries */ ]
}
{
  "Code": "ProcessList",
  "Data": [ /* array of Maestro process summaries */ ]
}
备注:

每个流程摘要的确切字段集由 Maestro runtime 指定,并且可能会不断变化;使用--output json对包含数据的租户运行一次命令,以查看您将使用的字段。如果您解析特定字段,请在 CI 中固定@uipath/cli


uip Maestro 处理事件

获取特定 Maestro 流程定义的所有事件。

参数

  • <process-key> (必填) — 流程定义键。

选项

  • --folder-key <key> (可选) — 用于限定查找范围的文件夹密钥。

数据形状

{
  "Code": "ProcessIncidents",
  "Data": [ /* array of process incidents */ ]
}
{
  "Code": "ProcessIncidents",
  "Data": [ /* array of process incidents */ ]
}

另请参阅

此页面有帮助吗?

连接

需要帮助? 支持

想要了解详细内容? UiPath Academy

有问题? UiPath 论坛

保持更新