uip Maestro 案例流程和流程作业

“uip Maestro Case process”、“processes”、“job”、“instance”和“cident”的语法和选项 — 运行和检查案例管理流程及其执行情况。

uip maestro case 的 runtime 命令：process 运行案例流程并管理其设置/变量标签，job 检查一次执行尝试，instance 检查/引导最终生成的流程实例，processes 提供跨流程摘要视图，incident 读取事件。有关整个case子系统共享的概念，请参阅案例概述。

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

instance 、 incident和processes与等效的BPMN和流命令（ @uipath/maestro-sdk的共享命令模块）共享其实现 — 相同的缺陷和相同的修复方法已在此处参数化（针对案例）（ toolLabel: "Case" processType: "CaseManagement" ）。一个真正的行为差异： instance的--folder-key在此( folderKeyRequired: false ) 是可选的，而在 BPMN/Flow 等效项中为必需。

大纲

uip maestro case process list --folder-key <key> [--filter <odata>] [--login-validity <minutes>]
uip maestro case process get <process-key> <feed-id> --folder-key <key> [--login-validity <minutes>]
uip maestro case process run <process-key> <folder-key> [--inputs <json|@file>] [--release-key <key>] [--feed-id <id>] [--robot-ids <ids>] [--validate] [--login-validity <minutes>]
uip maestro case process settings get <process-key> --folder-key <key>
uip maestro case process settings set <process-key> --folder-key <key> --inputs <json|@file>
uip maestro case process variable-tags get <process-key> --folder-key <key>
uip maestro case process variable-tags set <process-key> --folder-key <key> [--variable <name>]... [--element-id <id>] [--all] [--searchable <true|false>] [--tags <csv>] [--add-tags <csv>] [--remove-tags <csv>] [--inputs <json|@file>]

uip maestro case processes list [--folder-key <key>] [--limit <n>] [--offset <n>] [--status <status>]
uip maestro case processes incidents <process-key> --folder-key <key>
uip maestro case processes diagnose <process-key> --folder-key <key>
uip maestro case processes error-codes <process-key> --folder-key <key>

uip maestro case job traces <job-key> [--folder-key <key>] [--poll-interval <ms>] [--traces-service <name>] [--pretty] [--login-validity <minutes>]
uip maestro case job status <job-key> [--folder-key <key>] [--detailed] [--login-validity <minutes>]

uip maestro case instance list --folder-key <key> [-l <limit>] [--next-page <cursor>] [--process-key <k>] [--package-id <id>] [--error-code <code>] [--status <status>]... [--from-date <iso-8601>] [--to-date <iso-8601>]
uip maestro case instance get <instance-id> [--folder-key <key>]
uip maestro case instance pause|resume|cancel|retry <instance-id> [--folder-key <key>] [--comment <text>]
uip maestro case instance migrate <instance-id> <new-version> [--folder-key <key>] [--comment <text>]
uip maestro case instance incidents|asset|cursors|element-executions|variables|variables-all|global-variables <instance-id> [--folder-key <key>]
uip maestro case instance variables-set <instance-id> [--folder-key <key>] --inputs <json|@file>
uip maestro case instance goto <instance-id> <transitions> [--folder-key <key>]
uip maestro case instance element cancel|retry <instance-id> <element-id> [--folder-key <key>] [--comment <text>]
uip maestro case instance message send [--folder-key <key>] [--inputs <json|@file>]

uip maestro case incident summary [--folder-key <key>] [-l <limit>] [--offset <n>] [--process-key <k>] [--status <status>] [--severity <severity>]
uip maestro case incident get <incident-id> --folder-key <key>

uip Maestro 案例流程

管理案例流程：列出已发布到文件夹的内容，检查入口点的输入/输出架构，并运行其中。

备注：

process run将<folder-key>作为位置参数，而不是标志 — 与此页面上的所有其他动词（ list / get / settings / variable-tags ）不同，这些动词都使用--folder-key / -f了。这种不对称性真实存在，而非拼写错误 — 如果复制粘贴示例似乎失败，请根据您自己的 CLI 版本的 --help 进行验证。

uip Maestro 案例流程列表

列出已发布到文件夹的案例流程。

选项

选项	必填	描述
-f, --folder-key <key>	是	文件夹密钥 (GUID)。
--filter <odata>	否	其他 OData 筛选器。
--login-validity <minutes>	否	在令牌过期前触发刷新的最短分钟数。默认 10。

数据形状

{
  "Code": "CaseProcessList",
  "Data": [
    {
      "name": "InvoiceReview",
      "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 案例流程获取

获取流程的入口点架构 — process run 预期的输入/输出形状。

参数

名称	必填	用途
<process-key>	是	流程密钥。
<feed-id>	是	订阅源 ID，来自 process list 的 feedId 字段。

选项

选项	必填	描述
-f, --folder-key <key>	是	文件夹密钥 (GUID)。
--login-validity <minutes>	否	默认 10。

数据形状

{
  "Code": "CaseProcessGet",
  "Data": [
    {
      "Path": "/content/caseplan.json.bpmn#Trigger_1",
      "DisplayName": "Start",
      "Type": "CaseManagement",
      "InputSchema": "{\"type\":\"object\",\"properties\":{}}",
      "OutputSchema": "{\"type\":\"object\",\"properties\":{}}"
    }
  ]
}

Data 是一个数组 — 流程公开的每个入口点一个条目，而不是单个对象。如果流程的入口点为零，则失败并显示明确错误。

uip Maestro 案例流程运行

启动案例流程实例。

参数

名称	必填	用途
<process-key>	是	流程密钥。
<folder-key>	是	文件夹密钥 (GUID) —此处是位置密钥，不是标志。

选项

选项	必填	描述
-i, --inputs <json>	否	以 JSON 字符串或 @file.json 形式输入参数。省略以从 标准输入 读取；对于空输入 ({})，两者都省略。
--release-key <key>	否	发行密钥(GUID)，来自 process list。
--feed-id <id>	否	用于包查找的订阅源 ID。
--robot-ids <ids>	否	以逗号分隔的数字机器人 ID。如果任何条目不是数字，则快速失败。
--validate	否	提交前，对流程的输入架构运行基本的客户端验证（必填字段 + 原始类型）。失败时打印✅/❌并退出1，而不开始作业。
--login-validity <minutes>	否	默认 10。

示例

uip maestro case process run a1b2c3d4-0000-0000-0000-000000000001 c3d4e5f6-0000-0000-0000-000000000001 \
  --inputs '{"amount":100}'

数据形状

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

成功消息会将您指向 uip maestro case job traces <jobKey> 以查看执行情况。

uip Maestro 案例流程设置

读取或替换流程的原始设置对象（variable-tags 读取/写入一个字段的同一对象）。

动词	参数	选项	注意
get	<process-key>	-f, --folder-key <key> 必填	Code: "ProcessSettingsGet"。
set	<process-key>	-f, --folder-key <key> 为必填项， --inputs <json|@file>	读取-修改-写入：GET 当前设置，将您的有效负载作为新对象 PUT。Code: "ProcessSettingsSet"。

uip Maestro 案例流程变量标签

标记流程的输出变量（例如，将一个变量标记为可搜索，以进行实例列表筛选）。两种独立模式 — 选择其中一种，而不是同时选择两种:

• 友好模式： --variable <name> （可重复）+ --element-id / --all前往目标，加上--searchable <true|false>或更低级别的--tags / --add-tags / --remove-tags进行变异。
• 原始模式：具有完整的variableTags有效负载的--inputs <json|@file> 。

动词	参数	选项	注意
get	<process-key>	-f, --folder-key <key> 必填	仅返回 variableTags 对象。Code: "ProcessVariableTagsGet"。
set	<process-key>	-f, --folder-key <key> 必需，加上上面的友好/原始标志	将 --inputs 与任何友好标志混合使用均是错误的。--element-id 只适用于一个 --variable。--searchable 无法与 --tags/--add-tags/--remove-tags 结合使用。Code: "ProcessVariableTagsSet"。

示例

# Mark the "amount" output searchable
uip maestro case process variable-tags set a1b2c3d4-… --folder-key <key> --variable amount --searchable true

uip Maestro 案例流程

跨流程摘要视图 — 列出每个流程的聚合计数，或按键向下钻取某个流程的计数。与BPMN processes和流等效组件共享实现，并在processType: "CaseManagement"中进行筛选。

动词	参数	选项	注意
list	—	--folder-key <key>、-l/--limit <n>、--offset <n>、--status <status>	Code: "ProcessList"。
incidents	<process-key>	--folder-key <key> 必填	Code: "ProcessIncidents"。
diagnose	<process-key>	--folder-key <key> 必填	在一次调用中将摘要、故障和错误代码关联起来。Code: "ProcessDiagnostics"包含FaultedCount /RunningCount IncidentCount/ErrorCodeCount 汇总。
error-codes	<process-key>	--folder-key <key> 必填	Code: "ProcessIncidentErrorCodes"。

uip Maestro 案例作业

检查案例流程的一次执行尝试（一个作业）。

uip Maestro 案例作业追踪

正在运行或最近完成的作业的流执行追踪事件。

选项

选项	默认	描述
--folder-key <key>	—	可选 — 限定追踪请求的作用域。
--poll-interval <ms>	2000	轮询间隔。
--traces-service <name>	llmopstenant_	Traces 服务名称。
--pretty	关闭	人类可读的追踪行，而非原始 JSON。
--login-validity <minutes>	10	令牌刷新阈值。

直接追踪流到输出 — 无最终 Data 有效负载。退出代码为 0 表示成功，否则为 1。

uip Maestro 案例作业状态

获取作业的状态。

选项

选项	必填	默认	描述
--folder-key <key>	否	经过身份验证的文件夹	文件夹密钥（GUID，来自 process list）。此处为可选项— 省略此参数，以让后端解析您的默认文件夹。
--detailed	否	关闭	完整回复，而非策划摘要。
--login-validity <minutes>	否	10	令牌刷新阈值。

数据形状（默认摘要）

{
  "Code": "CaseJobStatus",
  "Data": {
    "key": "b2c3d4e5-0000-0000-0000-000000000001",
    "state": "Successful",
    "runtimeType": "…",
    "processType": "CaseManagement",
    "startTime": "2025-04-15T10:30:00Z",
    "endTime": "2025-04-15T10:32:11Z",
    "creationTime": "…",
    "inputArguments": "…",
    "outputArguments": "…",
    "info": "…",
    "releaseName": "InvoiceReviewProcess",
    "processKey": "a1b2c3d4-0000-0000-0000-000000000001",
    "robotName": "…",
    "hostMachineName": "…"
  }
}

uip Maestro 案例实例

检查并引导单个流程实例——案例流程的一次执行。与BPMN instance和流instance共享实现；请参阅任一页面以获取完整的动词参考（ list 、 get 、 pause 、 resume 、 cancel 、 retry 、 migrate 、 variables 、 variables-set variables-all 、 global-variables 、 incidents 、 asset 、 cursors 、 goto 、 element-executions 、 element cancel / retry 、 message send ） — 每个选项名称、默认值和数据形状相同。

一个真正的区别： -f, --folder-key在案例的每个instance命令（共享命令配置中的folderKeyRequired: false ）中是可选的，而 BPMN 和流需要它。将其省略，以限制经过身份验证的默认文件夹。

UIP Maestro 案例事件

跨流程读取事件或按 ID 读取事件。与BPMN incident /流的等效实现相同 — 请参阅任一页面，以获取完整的 6 标志summary选项表格和get的单个必需--folder-key 。

示例

# Publish check, then run
uip maestro case process list --folder-key <key>
uip maestro case process get a1b2c3d4-… default --folder-key <key>
uip maestro case process run a1b2c3d4-… <key> --inputs '{"amount":100}'

# Watch it through to completion
JOB_KEY=$(uip maestro case process run a1b2c3d4-… <key> --inputs '{}' --output-filter "Data.jobKey" --output plain)
uip maestro case job traces "$JOB_KEY" --pretty
uip maestro case job status "$JOB_KEY" --detailed

# Diagnose a failing process in one call
uip maestro case processes diagnose a1b2c3d4-… --folder-key <key>

另请参阅

• Case overview
• uip maestro bpmn instance / uip maestro flow instance — 完整的共享实例引用
• uip maestro bpmn incident — 完整的共享事件引用
• Orchestrator 作业