UIP Maestro bpmn

用于使用“uip Maestro bpmn”工具创作、打包、调试和操作 UiPath Maestro BPMN 流程编排项目的命令。

uip maestro bpmn用于编写、打包、调试和运营UiPath Maestro项目 — 具有长时间运行的人机回圈语义的 BPMN 2.0 业务流程编排。Maestro 是三个同级编排界面之一：BPMN（此页面）、流 ( uip maestro flow ) 和案例管理 ( uip maestro case )。选择 BPMN 以实现标准 BPMN 语义（用户任务、边界事件、计时器、子流程），选择“流”（用于智能体或连接器步骤的节点边缘图），并选择“案例管理”（用于长时间运行的人工驱动单元）建模为阶段/任务/SLA 的工作流，而非线性流程。

该工具作为 @uipath/maestro-tool 插件提供。此页面上的每个命令均已在 bpmn 分支下注册 — 实际调用始终为 uip maestro bpmn <verb>，而非空的 uip maestro <verb>。请参阅工具（插件） ，了解插件模型。

创作流程

Maestro 项目是一个目录，其中包含project.uiproj 、 .bpmn文件和支持元数据文件（ operate.json 、 entry-points.json 、 bindings_v2.json 、 package-descriptor.json ）。

# 1. Scaffold
uip maestro bpmn init invoice-orchestration

# 2. Edit the .bpmn in Studio Web or your IDE
#    (BPMN is validated at init time via bpmn-moddle)

# 3. Smoke-test via Studio Web
uip maestro bpmn debug ./invoice-orchestration

# 4. Validate the .bpmn file before packing
uip maestro bpmn validate ./invoice-orchestration/invoice-orchestration.bpmn

# 5. Pack for deployment
uip maestro bpmn pack ./invoice-orchestration ./dist --version 1.0.0

# ...or pack + publish straight to Orchestrator in one step
uip maestro bpmn process publish ./invoice-orchestration --folder-key <key>

创作命令

命令	用途
uip maestro bpmn init	添加一个新的 Maestro 项目（BPMN 入门版）
uip maestro bpmn debug	上传到 Studio Web 并运行调试会话
uip maestro bpmn validate	在不打包的情况下验证项目的 BPMN 和元数据
uip maestro bpmn format	自动格式化并整理 .bpmn 文件
uip maestro bpmn refresh	从当前项目重新生成生成的项目文件 .bpmn
uip maestro bpmn update-metadata	（已弃用 — 使用refresh ）更新生成的元数据文件
uip maestro bpmn pack	生成可部署的 .nupkg
uip maestro bpmn process publish	一步完成打包并发布到 Orchestrator

运行时

在运行时，已发布的 Maestro 包会在 Orchestrator 上成为类型为ProcessOrchestration的流程。启动其中一个会创建实例；每次执行尝试都是一个作业；故障显示为事件。

命令	用途
uip maestro bpmn process	列出并运行已部署的 Maestro 流程（list、get、run、publish）
uip maestro bpmn processes	跨文件夹、每个流程的事件和诊断的流程摘要（list、incidents、diagnose、error-codes）
uip maestro bpmn instance	检查和转向正在运行的实例（list、get、pause、resume、cancel、retry、migrate、goto、variables、message send、element cancel/ retry、...）
uip maestro bpmn debug-instance	以交互方式调试正在运行的特定实例
uip maestro bpmn incident	阅读事件摘要和详细信息
uip maestro bpmn job	流式传输追踪 ( traces ) 并检查作业状态

通过 Orchestrator 工具操作 Orchestrator 级别的作业和流程 — 请参阅Orchestrator 作业和Orchestrator 流程。

注册表 (BPMN)

Maestro 还附带一个 BPMN 注册表uip maestro bpmn registry ，用于浏览.bpmn中可用的扩展程序类型、连接器和流程。虽然目前尚未在侧边栏中调用，但现在即可调用：

uip maestro bpmn registry pull   [-f, --force]
uip maestro bpmn registry list   [-l, --limit <n>]
uip maestro bpmn registry search <keyword>
uip maestro bpmn registry get    <extensionType> [--connection-id <id>] [--object-name <name>] [--operation <name>]

数据形状： RegistryPullSuccess （计数： ExtensionTypeCount 、 ConnectorCount 、 ProcessCount ）、 RegistryListSuccess / RegistrySearchSuccess （ Data.ExtensionTypes[] 、 Data.Connectors[] 、 Data.Processes[] ）、 RegistryGetSuccess （ Data.ExtensionType （当同时提供了--connection-id和--object-name时，为可选Data.ISEnrichment ）。

约定

• 每个uip maestro bpmn子命令都遵循全局选项（ --output 、 --output-filter 、 --log-level 、 --log-file ）。
• 默认输出为JSON 。
• 退出代码遵循标准合同。
• 大多数运行时命令首先需要uip login — 请参阅身份验证。

另请参阅

• uip maestro flow — 图形形状的同级工作流
• uip maestro case — 案例管理同级
• 工具（插件）
• 身份验证
• 全局选项、退出代码