uip maestro bpmn

Commands for authoring, packing, debugging, and operating UiPath Maestro BPMN process-orchestration projects using the `uip maestro bpmn` tool.

uip maestro bpmn authors, packs, debugs, and operates UiPath Maestro projects — BPMN 2.0 business-process orchestrations with long-running, human-in-the-loop semantics. Maestro is one of three sibling orchestration surfaces: BPMN (this page), Flow (uip maestro flow), and Case Management (uip maestro case). Pick BPMN for standard BPMN semantics (user tasks, boundary events, timers, sub-processes), Flow for a node-and-edge graph of agentic or connector-heavy steps, and Case Management for a long-running, human-driven unit of work modeled as stages/tasks/SLAs rather than a linear process.

The tool is shipped as the @uipath/maestro-tool plugin. Every command on this page is registered under the bpmn branch — the real invocation is always uip maestro bpmn <verb>, never a bare uip maestro <verb>. See Tools (plugins) for the plugin model.

创作流程

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	Validate a project's BPMN and metadata without packing
uip maestro bpmn format	Auto-format and tidy a .bpmn file
uip maestro bpmn refresh	Regenerate generated project files from the current .bpmn
uip maestro bpmn update-metadata	(Deprecated — use refresh) Update generated metadata files
uip maestro bpmn pack	生成可部署的 .nupkg
uip maestro bpmn process publish	Pack and publish to Orchestrator in one step

运行时

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

命令	用途
uip maestro bpmn process	List and run deployed Maestro processes (list, get, run, publish)
uip maestro bpmn processes	Process summaries across folders, per-process incidents, and diagnostics (list, incidents, diagnose, error-codes)
uip maestro bpmn instance	Inspect and steer running instances (list, get, pause, resume, cancel, retry, migrate, goto, variables, message send, element cancel/retry, …)
uip maestro bpmn debug-instance	Debug a specific running instance interactively
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 — Case Management sibling
• 工具（插件）
• 身份验证
• 全局选项、退出代码