用于使用“uip Maestro”工具创作、打包、调试和操作 UiPath Maestro BPMN 流程编排项目的命令。
uip maestro用于编写、打包、调试和运营UiPath Maestro项目 — 具有长时间运行的人机回圈语义的 BPMN 2.0 业务流程编排。Maestro 是 UiPath 编排界面中的流 ( uip flow ) 的同级;当您需要标准 BPMN 语义(用户任务、边界事件、计时器、子流程)时,请选择 Maestro;当您需要智能体或连接器密集型步骤的节点边图时,请选择“流”。
该工具作为@uipath/maestro-tool插件提供。Maestro 命令在uip maestro下注册(对于 BPMN 特定的次表面, uip maestro bpmn )下注册。请参阅工具(插件) ,了解插件模型。
创作流程
Maestro 项目是一个目录,其中包含project.uiproj 、 .bpmn文件和支持元数据文件( operate.json 、 entry-points.json 、 bindings_v2.json 、 package-descriptor.json )。
# 1. Scaffold
uip maestro 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 debug ./invoice-orchestration
# 4. Pack for deployment
uip maestro pack ./invoice-orchestration ./dist --version 1.0.0
# 1. Scaffold
uip maestro 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 debug ./invoice-orchestration
# 4. Pack for deployment
uip maestro pack ./invoice-orchestration ./dist --version 1.0.0
创作命令
| 命令 | 用途 |
|---|---|
uip maestro init | 添加一个新的 Maestro 项目(BPMN 入门版) |
uip maestro debug | 上传到 Studio Web 并运行调试会话 |
uip maestro pack | 生成可部署的 .nupkg |
运行时
在运行时,已发布的 Maestro 包会在 Orchestrator 上成为类型为ProcessOrchestration的流程。启动其中一个会创建实例;每次执行尝试都是一个作业;故障显示为事件。
| 命令 | 用途 |
|---|---|
uip maestro process | 列出并运行已部署的 Maestro 流程( list 、 get 、 run ) |
uip maestro processes | 跨文件夹的流程摘要,以及每个流程的事件 |
uip maestro instances | 检查和引导正在运行的实例( list 、 get 、 pause 、 resume 、 cancel 、 retry 、 migrate 、 goto 、 variables ……) |
uip maestro incidents | 阅读事件摘要和详细信息 |
uip maestro 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>]
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>]
数据形状: RegistryPullSuccess (计数: ExtensionTypeCount 、 ConnectorCount 、 ProcessCount )、 RegistryListSuccess / RegistrySearchSuccess ( Data.ExtensionTypes[] 、 Data.Connectors[] 、 Data.Processes[] )、 RegistryGetSuccess ( Data.ExtensionType (当同时提供了--connection-id和--object-name时,为可选Data.ISEnrichment )。
约定
- 每个
uip maestro子命令都遵循全局选项(--output、--output-filter、--log-level、--log-file)。 - 默认输出为JSON 。
- 退出代码遵循标准合同。
- 大多数运行时命令首先需要
uip login— 请参阅身份验证。