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

uip Maestro bpmn 调试实例

“uip Maestro bpmnDebug-instance”的语法和选项,可对已上传的 Studio Web 解决方案触发支持断点的交互式调试会话。

uip maestro bpmn debug-instance 驱动低级别交互式调试会话 — 创建实例,检查其状态/变量/事件,设置断点并向前推进。它已在 bpmn 分支下注册。

这是与uip maestro bpmn debug不同的更低级别的表面: debug是一次性“上传并运行至完成”命令。debug-instance 假定解决方案已上传到 Studio Web,并为您提供对一次调试运行的手动控制 — 在断点处暂停,在运行中检查变量并向前推进 — 交互式对应项,由 debug 自己的错误指令引用当调试会话需要步骤级控制时。

大纲​

uip maestro bpmn debug-instance create --solution-id <id> --project-id <id> --entry-point <path>
                                        [--process-type <type>] [--debug-mode <mode>] [--simulation-mode <mode>] [-i, --inputs <json>]
uip maestro bpmn debug-instance status         <instance-id>
uip maestro bpmn debug-instance breakpoints    <instance-id> --inputs <json|@file>
uip maestro bpmn debug-instance cancel         <instance-id>
uip maestro bpmn debug-instance continue       <instance-id> [--inputs <json|@file>]
uip maestro bpmn debug-instance incidents      <instance-id>
uip maestro bpmn debug-instance variables      <instance-id> [--parent-element-id <id>]
uip maestro bpmn debug-instance variables-set  <instance-id> --inputs <json|@file> [--parent-element-id <id>]
uip maestro bpmn debug-instance variables-all  <instance-id>
uip maestro bpmn debug-instance create --solution-id <id> --project-id <id> --entry-point <path>
                                        [--process-type <type>] [--debug-mode <mode>] [--simulation-mode <mode>] [-i, --inputs <json>]
uip maestro bpmn debug-instance status         <instance-id>
uip maestro bpmn debug-instance breakpoints    <instance-id> --inputs <json|@file>
uip maestro bpmn debug-instance cancel         <instance-id>
uip maestro bpmn debug-instance continue       <instance-id> [--inputs <json|@file>]
uip maestro bpmn debug-instance incidents      <instance-id>
uip maestro bpmn debug-instance variables      <instance-id> [--parent-element-id <id>]
uip maestro bpmn debug-instance variables-set  <instance-id> --inputs <json|@file> [--parent-element-id <id>]
uip maestro bpmn debug-instance variables-all  <instance-id>

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

uip Maestro bpmn 调试实例创建​

使用已上传到 Studio Web 的解决方案创建调试实例,并在 Orchestrator 的个人工作区文件夹中开始调试会话。

选项​

选项必填描述
--solution-id <id>是上一次上传的解决方案或 Studio Web 中的解决方案 ID。
--project-id <id>是解决方案中的 Studio Web 项目 ID。
--entry-point <path>是入口点路径,例如/Main.bpmn#start。
--process-type <type>否流程类型。默认 processOrchestration。
--debug-mode <mode>否为 None、Default(在断点处暂停)、StepByStep(在每一步暂停)和 SingleStep(仅一个步骤)之一。默认 Default。无效的值无法快速列出接受的集。
--simulation-mode <mode>否None、All(模拟所有元素)或 Selective(模拟除选择退出元素以外的元素)之一。默认 None。无效的值无法快速列出接受的集。
-i, --inputs <json>否JSON 字符串形式的输入参数。默认 {}。

数据形状​

{
  "Code": "DebugInstanceCreated",
  "Data": {
    "instanceId": "c3d4e5f6-...",
    "runId": "d4e5f6a7-...",
    "jobKey": "b2c3d4e5-..."
  },
  "Instructions": "Use 'debug-instance status <instance-id>' to check the run. Use 'debug-instance incidents <instance-id>' or 'debug-instance variables <instance-id>' to inspect it."
}
{
  "Code": "DebugInstanceCreated",
  "Data": {
    "instanceId": "c3d4e5f6-...",
    "runId": "d4e5f6a7-...",
    "jobKey": "b2c3d4e5-..."
  },
  "Instructions": "Use 'debug-instance status <instance-id>' to check the run. Use 'debug-instance incidents <instance-id>' or 'debug-instance variables <instance-id>' to inspect it."
}

uip Maestro bpmn 调试实例状态​

获取调试实例当前的每个元素执行状态。

参数: <instance-id> (必填项) 。数据形状: Code: "DebugInstanceStatus" 。

uip Maestro bpmnDebug 实例断点​

替换在调试实例上设置的断点。

参数: <instance-id> (必填项) 。

选项: --inputs <value> — 将有效负载断点为 JSON 字符串、 @file路径或通过标准输入管道传输。如果省略,则会发送空的断点列表 ({"breakpoints": []}),并清除所有断点。

数据形状: Code: "DebugInstanceBreakpointsUpdated" 。

uip Maestro bpmn 调试实例取消​

取消调试实例。

参数: <instance-id> (必填项) 。数据形状: Code: "DebugInstanceCanceled" 。

uip Maestro bpmnDebug-实例继续​

在暂停的调试实例上继续执行。

参数: <instance-id> (必填项) 。

选项: --inputs <value> — 继续将有效负载作为 JSON 字符串、 @file路径或通过标准输入管道传输。如果省略,则发送 {"nextStep": false}(运行到下一个断点,而不是单个步骤)。

数据形状: Code: "DebugInstanceContinued" 。

uip Maestro bpmn 调试实例事件​

获取调试实例运行期间引发的事件。

参数: <instance-id> (必填项) 。数据型: Code: "DebugInstanceIncidents" , Data是一个数组(如果没有,则为空)。

uip Maestro bpmnDebug 实例变量​

获取调试实例的当前变量值。

参数: <instance-id> (必填项) 。

选项: --parent-element-id <id> — 按父元素 ID 筛选变量。

数据形状: Code: "DebugInstanceVariables" 。

uip Maestro bpmn 调试实例变量集​

在运行中修补(更新)调试实例的变量。

参数: <instance-id> (必填项) 。

选项:

选项必填描述
--inputs <value>是Patch 变量有效负载作为 JSON 字符串、@file 路径或通过标准输入管道传输。如果没有可解析的有效负载,则失败。
--parent-element-id <id>否将补丁的作用域限定为父元素 ID。

数据形状: Code: "DebugInstanceVariablesSet" 。

uip Maestro bpmn 调试-实例变量-全部​

获取调试实例的每个变量,包括子流程变量。

参数: <instance-id> (必填项) 。数据形状: Code: "DebugInstanceVariablesAll" 。

示例​

# Create a debug session, stepping through one element at a time
uip maestro bpmn debug-instance create \
  --solution-id <solution-id> --project-id <project-id> \
  --entry-point "/Main.bpmn#start" --debug-mode StepByStep

# Check status, then step forward
uip maestro bpmn debug-instance status <instance-id>
uip maestro bpmn debug-instance continue <instance-id>

# Inspect and patch a variable mid-run
uip maestro bpmn debug-instance variables <instance-id>
uip maestro bpmn debug-instance variables-set <instance-id> --inputs '{"amount": 250}'

# Clean up
uip maestro bpmn debug-instance cancel <instance-id>
# Create a debug session, stepping through one element at a time
uip maestro bpmn debug-instance create \
  --solution-id <solution-id> --project-id <project-id> \
  --entry-point "/Main.bpmn#start" --debug-mode StepByStep

# Check status, then step forward
uip maestro bpmn debug-instance status <instance-id>
uip maestro bpmn debug-instance continue <instance-id>

# Inspect and patch a variable mid-run
uip maestro bpmn debug-instance variables <instance-id>
uip maestro bpmn debug-instance variables-set <instance-id> --inputs '{"amount": 250}'

# Clean up
uip maestro bpmn debug-instance cancel <instance-id>

另请参阅​

此页面有帮助吗?

连接

需要帮助? 支持

想要了解详细内容? UiPath Academy

有问题? UiPath 论坛

保持更新