uip rpa 运行、调试和配置执行
“uip rpa run”、“debug”组和“execution Cancel”的语法和选项 — 用于运行和调试工作流或编码文件的当前主要界面,替换旧的“运行文件”/“停止执行”动词。
uip rpa run、uip rpa debug * 和 uip rpa execution cancel 通过 Studio 运行和调试工作流或编码文件。此页面上的所有 17 个动词都会调度到作为uip rpa run-file和uip rpa stop-execution公开为一个广泛的--command枚举的两个相同的基础工具中 — 这是相同功能当前主要、可发现的形式,每种行为一个动词而不是一个包含 19 个值的标志。run-file/stop-execution 仍然有效(它们作为已安装技能的隐藏兼容性别名),但此页面是 --help 实际显示的内容。
通过 Studio 执行,因此这些命令仅适用于 Windows 运行器(Studio 仅限 Windows)。如果 Studio 尚未运行,则系统会自动启动 — 如果您希望在专用设置步骤中支付启动成本,请先运行uip rpa start-studio 。
大纲
uip rpa run --file-path <path> [--input-arguments <json>] [--log-level <level>] [--skip-build] [--profiling] [--profiling-mode endOfRun|stream] [--remote]
uip rpa debug start --file-path <path> [same options as run] [--breakpoints <json>]
uip rpa debug start-from-here [--input-arguments <json>] [--input-variables <json>] [--log-level <level>] [--profiling] [--profiling-mode <mode>]
uip rpa debug test-activity [--input-arguments <json>] [--input-variables <json>] [--log-level <level>] [--profiling] [--profiling-mode <mode>]
uip rpa debug break [--wait-timeout-seconds <n>]
uip rpa debug continue [--wait-timeout-seconds <n>]
uip rpa debug resume [--wait-timeout-seconds <n>]
uip rpa debug continue-retry [--wait-timeout-seconds <n>]
uip rpa debug continue-ignore [--wait-timeout-seconds <n>]
uip rpa debug step-into [--wait-timeout-seconds <n>]
uip rpa debug step-over [--wait-timeout-seconds <n>]
uip rpa debug step-out [--wait-timeout-seconds <n>]
uip rpa debug state [--wait-timeout-seconds <n>]
uip rpa debug set-breakpoints --breakpoints <json>
uip rpa debug apply-file-changes --file-changes <json>
uip rpa debug toggle-breakpoint
uip rpa debug restart-from-top
uip rpa execution cancel
uip rpa run --file-path <path> [--input-arguments <json>] [--log-level <level>] [--skip-build] [--profiling] [--profiling-mode endOfRun|stream] [--remote]
uip rpa debug start --file-path <path> [same options as run] [--breakpoints <json>]
uip rpa debug start-from-here [--input-arguments <json>] [--input-variables <json>] [--log-level <level>] [--profiling] [--profiling-mode <mode>]
uip rpa debug test-activity [--input-arguments <json>] [--input-variables <json>] [--log-level <level>] [--profiling] [--profiling-mode <mode>]
uip rpa debug break [--wait-timeout-seconds <n>]
uip rpa debug continue [--wait-timeout-seconds <n>]
uip rpa debug resume [--wait-timeout-seconds <n>]
uip rpa debug continue-retry [--wait-timeout-seconds <n>]
uip rpa debug continue-ignore [--wait-timeout-seconds <n>]
uip rpa debug step-into [--wait-timeout-seconds <n>]
uip rpa debug step-over [--wait-timeout-seconds <n>]
uip rpa debug step-out [--wait-timeout-seconds <n>]
uip rpa debug state [--wait-timeout-seconds <n>]
uip rpa debug set-breakpoints --breakpoints <json>
uip rpa debug apply-file-changes --file-changes <json>
uip rpa debug toggle-breakpoint
uip rpa debug restart-from-top
uip rpa execution cancel
概念
- 两个后端之一。Studio 桌面版和无头 Helm 后端都实现这些;几个选项(
--profiling-mode stream、debug set-breakpoints、debug apply-file-changes和长时间轮询的--wait-timeout-seconds)仅限 Helm 使用,在 Studio 后端将被忽略或不可用 — 请在下方逐个动词说明。 --remote(仅在run/debug start/debug start-from-here/debug test-activity)在已配置的远程代理(Orchestrator Unattended Robot)上运行,而不是在本地运行 — 有关如何首先配置目标的信息,请参阅uip rpa remote。- 每个会话中命令都在下一个稳定状态返回。
continue/resume/continue-retry/continue-ignore/步骤动词/break/state均等待会话达到稳定状态(Paused、Suspended或Completed) ,然后返回;如果在--wait-timeout-seconds内未达到任何上限,则返回DebugState: "Running"而不是挂起。
UIP RPA 运行
通过 Studio 运行工作流或编码文件,不附加调试器。
选项
| 长 | 值 | 描述 |
|---|---|---|
--file-path <path> | 字符串 | 必需。.xaml 工作流或 .cs 编码文件的路径。 |
--input-arguments <json> | JSON 对象 | 项目级别的输入参数为纯 JSON,例如{"customerId":"ACME-1234"}。 |
--log-level <level> | Verbose|Trace|Information|Warning|Error|Critical | 输出流中的最低日志级别。默认 Trace。 |
--skip-build | 标记 | 假设项目已构建,则跳过验证/构建。用于在任何内容未更改时快速重新执行。 |
--profiling | 标记 | 收集每个活动的分析数据,作为 Profiling 字段返回。需要设置了 EnableProfiling 的 Studio 开发配置文件 — 如果不可用,运行仍会完成,并且会直接省略 Profiling。默认 false。 |
--profiling-mode <mode> | endOfRun|stream | 分析数据的交付时间。endOfRun(默认)在完成后返回摘要; stream 还会自行打开收集功能,并将每个活动条目作为 [Profiling] 行实时转发,并将详尽数据写入运行的 .uistat 文件。仅限 Helm 后端;远程运行时已忽略。 |
--remote | 标记 | 在已配置的远程代理上运行,而不是在本地运行。先使用uip rpa remote configure配置目标。默认 false。 |
示例
uip rpa run --file-path ./Main.xaml --input-arguments '{"customerId": "ACME-1234"}'
uip rpa run --file-path ./Main.xaml --input-arguments '{"customerId": "ACME-1234"}'
数据形状(--输出 json)
{ "Code": "RunResult", "Data": { "DebugState": "Completed", "Result": {} } }
{ "Code": "RunResult", "Data": { "DebugState": "Completed", "Result": {} } }
精确的Data形状是基础工具的运行结果有效负载 — 有关完整的结果合约,请参阅uip rpa run-file (两个动词返回相同的形状)。
uip rpa 调试启动
为工作流或编码文件启动调试会话。与 run 相同的选项,以及 --breakpoints。
选项
run 的所有选项,以及:
| 长 | 值 | 描述 |
|---|---|---|
--breakpoints <json> | JSON 数组 | 初始断点已设置。每个条目:workflowFile(必填,相对于项目根目录的路径)、activityIdRef(XAML 中活动的 sap2010:WorkflowViewState.IdRef — 稳定的解决方法)或 activityId(runtime ID),以及可选的 condition (VB/C# 表达式;仅在为 True 时中断)、hitCount(仅在第 N 次匹配时中断)、enabled(默认为 true)。可重复的逗号分隔 key=value 项目,每次出现一个数组条目,或通过 @breakpoints.json / --breakpoints-file 获取 JSON 文件。 |
示例
uip rpa debug start --file-path ./Main.xaml \
--breakpoints 'workflowFile=Main.xaml,activityIdRef=Assign_1'
uip rpa debug start --file-path ./Main.xaml \
--breakpoints 'workflowFile=Main.xaml,activityIdRef=Assign_1'
数据形状(--输出 json)
与 run 形状相同;点击断点的会话会报告 DebugState: "Paused" 中的活动和局部变量 DebugDetails。
uip rpa 调试“从此处开始”
从当前获得焦点的活动开始调试,并跳过在此之前的所有内容。“无”--file-path — 它将作用于打开的项目中的任何重点内容。
选项
| 长 | 值 | 描述 |
|---|---|---|
--input-arguments <json> | JSON | 项目级输入。与 run/debug start 不同,此处的值为 VB.NET 或 C# 表达式,而不是纯 JSON 文本。 |
--input-variables <json> | JSON | 用于为作用域内状态设定种子的工作流级别变量值(表达式,而非文本)。 |
--log-level <level> | 枚举值相同 run | 最低日志级别。 |
--profiling / --profiling-mode <mode> | — | 与 run 相同。 |
示例
uip rpa debug start-from-here --input-variables '{"greeting": "\"Hello World\""}'
uip rpa debug start-from-here --input-variables '{"greeting": "\"Hello World\""}'
uip rpa 调试测试活动
使用 --input-arguments/--input-variables(表达式,约定与 start-from-here 相同)隔离并执行当前聚焦的活动,以在作用域内指定状态。
选项
与 debug start-from-here 相同。
示例
uip rpa debug test-activity --input-variables '{"greeting": "\"Hello World\""}'
uip rpa debug test-activity --input-variables '{"greeting": "\"Hello World\""}'
uip rpa 调试中断
在下一个执行活动会话中的活动时暂停执行。
选项
| 长 | 值 | 描述 |
|---|---|---|
--wait-timeout-seconds <n> | 数字 | DebugState: "Running"返回下一个稳定状态之前的等待秒数上限。默认 120。仅限 Helm 后端 — Studio 后端应用自己的固定 120 秒上限,并忽略显式值。 |
uip rpaDebug 继续/继续/继续重试/继续忽略
在活动会话中继续执行。continue 从暂停中恢复; resume 已从暂停状态恢复; continue-retry 将继续并重试刚才抛出的活动; continue-ignore 将继续并吞下刚才抛出的活动中的异常。
选项
--wait-timeout-seconds与debug break 相同。
uip rpaDebug 进入/跳过/退出
标准调试器在活动会话中单步执行。在没有活动会话的情况下调用 step-out,该活动会在第一个活动之前启动一个暂停的会话。
选项
--wait-timeout-seconds与debug break 相同。
uip rpa 调试状态
报告活动的调试会话的状态 (Running/Paused/Suspended/Completed/None),没有副作用。
选项
| 长 | 值 | 描述 |
|---|---|---|
--wait-timeout-seconds <n> | 数字 | 长轮询正在运行的会话,以获取其下一个稳定状态。默认 0(即时探测器)。仅限 Helm 后端 — 在 Studio 后端,这始终是即时探测器。 |
uip rpa 调试设置断点
替换活动调试会话的整个断点集。仅 Helm 后端 — 在 Studio 后端,请改用 debug toggle-breakpoint,或将断点传递给 debug start。
选项
| 长 | 值 | 必填 | 描述 |
|---|---|---|---|
--breakpoints <json> | JSON 数组 | 是 | 与 debug start 的 --breakpoints 形状相同。替换整个集合,而不是合并。 |
uip rpa 调试应用文件更改
在调试会话中暂停时,通过热重新加载将磁盘上活动属性编辑协调到正在运行的会话中,因此无需重新启动即可拾取这些编辑。请先编辑工作流文件,然后将此命名为更改。
选项
| 长 | 值 | 必填 | 描述 |
|---|---|---|---|
--file-changes <json> | JSON 数组 | 是 | 每个已编辑属性配一个对象:workflowFile(必填)、activityIdRef 加更改后的属性名称/值。可重复的 key=value 表单或 @changes.json/--file-changes-file。 |
数据形状(--输出 json)
{ "Code": "ApplyFileChanges", "Data": { "applied": [], "rejected": [], "debugState": "Paused" } }
{ "Code": "ApplyFileChanges", "Data": { "applied": [], "rejected": [], "debugState": "Paused" } }
applied 编辑内容在会话中实时运行(例如continue-retry 重新运行故障活动并修复); rejected 编辑(即有原因)属于结构性更改,需要重新启动会话才能生效。
uip rpa 调试切换断点
在当前聚焦的活动 (.xaml) 或行 (.cs) 处切换断点。无选项。XAML 循环启用 → 禁用 → 无;编码工作流循环开启/关闭。
uip rpa 调试从顶部重新启动
从头开始重新启动活动的调试会话。无选项。
UIP RPA 执行取消
取消当前活动的执行或调试会话 — 统一适用于 run 和 debug start。无选项。
示例
uip rpa execution cancel
uip rpa execution cancel
相关内容
uip rpa run-file/uip rpa stop-execution— 这些动词替换的隐藏的旧版别名;相同的基础工具。uip rpa start-studio— 在专用的设置步骤中支付 Studio 启动费用。uip rpa remote— 为--remote配置目标。uip rpa get-errors— 运行后检查诊断。
另请参阅
- 大纲
- 概念
- UIP RPA 运行
- 选项
- 示例
- 数据形状(--输出 json)
- uip rpa 调试启动
- 选项
- 示例
- 数据形状(--输出 json)
- uip rpa 调试“从此处开始”
- 选项
- 示例
- uip rpa 调试测试活动
- 选项
- 示例
- uip rpa 调试中断
- 选项
- uip rpaDebug 继续/继续/继续重试/继续忽略
- 选项
- uip rpaDebug 进入/跳过/退出
- 选项
- uip rpa 调试状态
- 选项
- uip rpa 调试设置断点
- 选项
- uip rpa 调试应用文件更改
- 选项
- 数据形状(--输出 json)
- uip rpa 调试切换断点
- uip rpa 调试从顶部重新启动
- UIP RPA 执行取消
- 示例
- 相关内容
- 另请参阅