uip Maestro 流程和 uip Maestro 流程

“uip Maestro 流程流程”和“uip Maestro 流程流程”的语法和选项，涵盖按文件夹和租户范围内发布的流程操作。

将 Flow 包发布到 Orchestrator 后，它就成为一个流程。本页介绍两个相关的命令组：

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

大纲

# Singular — per-folder, operational
uip maestro flow process list -f <folder-key> [--filter <odata>] [--login-validity <minutes>]
uip maestro flow process get  <process-key> <feed-id> -f <folder-key> [--login-validity <minutes>]
uip maestro flow process run  <process-key> <folder-key>
                       [-i, --inputs <json>]
                       [--release-key <key>] [--feed-id <id>] [--robot-ids <ids>]
                       [--attachment <name=path>]...
                       [--wait [--timeout <seconds>] [--poll-interval <seconds>]]
                       [--validate] [--login-validity <minutes>]
uip maestro flow process settings get       <process-key> -f <folder-key>
uip maestro flow process settings set       <process-key> -f <folder-key> [--inputs <json|@file>]
uip maestro flow process variable-tags get  <process-key> -f <folder-key>
uip maestro flow process variable-tags set  <process-key> -f <folder-key> [--variable <name>]... [--all] [--searchable <bool>] [--tags <csv>] [--add-tags <csv>] [--remove-tags <csv>] [--inputs <json|@file>]

# Plural — tenant-wide summary and incident surface
uip maestro flow processes list
uip maestro flow processes incidents    <process-key> --folder-key <key>
uip maestro flow processes diagnose     <process-key> --folder-key <key>
uip maestro flow processes error-codes  <process-key> --folder-key <key>

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

---

uip Maestro 流程流程列表

列出特定文件夹中的可用 Flow 流程（版本）。

选项

选项	必填	描述
-f, --folder-key <key>	是	文件夹密钥 (GUID)。
--filter <odata>	否	在服务器端应用的其他 OData 筛选器。
--login-validity <minutes>	否	令牌刷新阈值（默认为10 ）。

数据形状 ( --output json )

{
  "Code": "FlowProjectList",
  "Data": [
    {
      "name":       "InvoiceFlow",
      "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 流流程获取

获取 Flow 流程的入口点架构（输入/输出 JSON 架构）。使用此结果为process run构建有效的--inputs有效负载。

参数

• <process-key> （必填） — 流程密钥，例如MyFlow.flow.Flow:1.0.0或<package-id>:<version> 。
• <feed-id> （必填） — 订阅源 ID（来自list输出）。

选项

• -f, --folder-key <key> （必填项）
• --login-validity

数据形状

{
  "Code": "FlowProjectGet",
  "Data": [
    {
      "Path":         "/content/main.flow",
      "DisplayName":  "Main",
      "Type":         "Flow",
      "InputSchema":  "{\"type\":\"object\",\"properties\":{}}",
      "OutputSchema": "{\"type\":\"object\",\"properties\":{}}"
    }
  ]
}

InputSchema和OutputSchema为重新字符串化的 JSON；将它们解析为 JSON 架构，以驱动输入构建。

---

uip Maestro 流程流程运行

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

参数

• <process-key> （必填项） — 流程密钥（例如MyFlow.flow.Flow:1.0.0 ）。
• <folder-key> （必填） — 文件夹密钥 (GUID)。

选项

选项	描述
-i, --inputs <json>	以 JSON 字符串或@path/to/file.json表示的输入。如果省略此参数且通过管道传输标准输入，则标准输入将解析为输入。
--release-key <key>	发行密钥 (GUID) — 来自process list 。
--feed-id <id>	包查找的订阅源 ID（可选）。
--robot-ids <ids>	以逗号分隔的机器人 ID（整数）。无效值快速失败。
--attachment <name=path>	将本地文件上传到 Orchestrator，并将其绑定为文件类型输入变量。可重复，例如--attachment file1=./resume.pdf。如果 --inputs 中也存在相同的变量名称，则覆盖该变量名称。
--wait	阻止，直到作业达到最终状态，而不是立即返回，Pending。
--timeout <seconds>	等待的最大秒数。0 = 未超时。需要 --wait。
--poll-interval <seconds>	等待时状态检查之间的秒数。需要 --wait。
--validate	运行前，根据流程架构验证输入。仅执行基本检查 — 存在必填字段且基本类型匹配。此阶段不强制执行复杂约束（枚举、模式、引用）。
--login-validity <minutes>	令牌刷新阈值（默认为10 ）。

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

示例

# Run with inline JSON
uip maestro flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-0000-0000-0000-000000000001" \
  --release-key "e5f6a7b8-…" --inputs '{"amount":100}'

# Run with inputs from a file
uip maestro flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-…" --inputs @inputs.json

# Run with inputs piped from stdin
echo '{"amount":100}' | uip maestro flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-…"

# Validate before running
uip maestro flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-…" \
  --inputs '{"amount":100}' --validate

数据形状

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

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

---

uip Maestro 流程流程设置

获取或更新流程的运行时设置。

获取 uip Maestro 流程设置

参数

• <process-key> （必填） — 流程定义键。

选项

• -f, --folder-key <key> （必填项）

数据形状

Code: "ProcessSettingsGet"，Data 是流程设置对象。

UIP Maestro 流程流程设置已完成

参数

• <process-key> （必填项）

选项

选项	描述
-f, --folder-key <key>	（必填）文件夹密钥 (GUID)。
--inputs <value>	将有效负载设置为 JSON 字符串、@file 路径或通过标准输入管道传输。

数据形状

Code: "ProcessSettingsSet"。

uip Maestro 流流程变量标签

获取或更新流程输出变量的可搜索性标签——这些变量可用于筛选实例。

uip Maestro 流程流程变量标签获取

参数

• <process-key> （必填项）

选项

• -f, --folder-key <key> （必填项）

数据形状

Code: "ProcessVariableTagsGet"，其中 Data 是流程的 variableTags 映射（如果未设置则使用 {}）。

uip Maestro 流程流程变量标签集

两种互斥的输入样式：传递带有完整 JSON 负载的--inputs ，或使用友好的--variable / --all / --searchable / --tags / --add-tags / --remove-tags标志 — 两者结合将失败，并显示其返回类型。

参数

• <process-key> （必填项）

选项

选项	描述
-f, --folder-key <key>	（必填）文件夹密钥 (GUID)。
--variable <name>	要标记的变量（输出）的名称。可重复，用于在一次调用中标记多个标记。
--element-id <id>	拥有变量的元素 — 当相同名称出现在多个元素上时，该元素会消除歧义。仅与单个 --variable 一起使用时有效。
--all	将更改应用到每个可标记变量。
--searchable <bool>	将变量标记为可搜索以进行实例筛选 (true/false)。
--tags <csv>	高级：完全替换变量的当前标签。空值会将其清除。
--add-tags <csv>	向变量的当前标签添加标签。
--remove-tags <csv>	从变量的当前标签中删除标签。
--inputs <value>	以 JSON 字符串、@file 路径或通过标准输入管道传输的完整变量标签有效负载，这是上述标志的替代方案。

数据形状

Code: "ProcessVariableTagsSet"。

---

uip Maestro 流程流程列表

租户范围内的 Flow 流程摘要 ( /processes/summary?processType=Flow )。没有参数，也没有全局变量以外的选项。

数据形状

{
  "Code": "ProcessList",
  "Data": [
    {
      "processKey":     "…",
      "name":           "…",
      "folderKey":      "…",
      "latestVersion":  "…"
    }
  ]
}

备注：

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

---

uip Maestro 流程事件

获取特定流程流程定义的所有事件（非单个实例）。

参数

• <process-key> （必填） — 流程定义键。

选项

• --folder-key <key> （必填） — 用于确定查找范围的文件夹密钥。

数据形状

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

请参阅uip maestro flow incident ，了解每个事件的形状。

uip Maestro 流程诊断

在一次调用中将流程摘要、故障和错误代码关联起来——这是一种快速分类命令。

参数

• <process-key> （必填） — 流程定义键。

选项

• --folder-key <key> （必填项）

数据形状

{
  "Code": "ProcessDiagnostics",
  "Data": {
    "ProcessKey": "…",
    "FolderKey": "…",
    "Summary": { /* this process's entry from processes/summary, or null if not found */ },
    "FaultedCount": 0,
    "RunningCount": 0,
    "Incidents": [ /* array of incidents */ ],
    "IncidentCount": 0,
    "ErrorCodes": [ /* array of error code strings */ ],
    "ErrorCodeCount": 0
  }
}

uip Maestro 流程流程错误代码

获取在流程故障中出现的唯一一组错误代码。

参数

• <process-key> （必填项）

选项

• --folder-key <key> （必填项）

数据形状

{
  "Code": "ProcessIncidentErrorCodes",
  "Data": ["Process.UnhandledException"]
}

另请参阅

• uip maestro flow instance — 检查和引导正在运行的执行
• uip maestro flow job — 单个作业的追踪记录和状态
• uip maestro flow incident — 事件摘要和详细信息
• Orchestrator 作业、 Orchestrator 流程
• 流概述