uip Maestro bpmn 注册表
使用“uip Maestro bpmn registry”浏览 Maestro BPMN 注册表的扩展程序类型、Integration Service 连接器和 Orchestrator 流程。
uip maestro bpmn registry用于浏览和搜索Maestro BPMN 注册表,即 Maestro 可以根据其进行创作的 BPMN 扩展程序类型、Integration Service 连接器和 Orchestrator 发现的流程的目录。智能体(人类或其他智能体)使用它来发现存在的扩展程序类型,查找其形状,并在生成 BPMN 之前使用实时 Integration Service 元数据丰富连接器类型。
如果没有登录,则仅内置 (OOTB) 扩展程序类型可用。登录后查看从 Integration Service 和 Orchestrator 发现的连接器和流程。
大纲
uip maestro bpmn registry <verb> [options]
uip maestro bpmn registry <verb> [options]
典型工作流:
uip login(可选 — OOTB 类型离线工作)。uip maestro bpmn registry pull— 将注册表同步到本地缓存。uip maestro bpmn registry search <keyword>— 查找条目。uip maestro bpmn registry get <extensionType>— 查看完整规范。
动词
| 动词 | 用途 |
|---|---|
pull | 获取并缓存注册表(静态 BPMN + 发现的资源)。 |
list | 列出缓存的扩展程序类型和已发现的资源。 |
search | 按关键字在扩展程序类型、连接器和流程中查找条目。 |
get | 获取单个扩展程序类型的完整规范;使用 IS 元数据可选择丰富。 |
uip Maestro bpmn 注册表拉取
获取并缓存注册表。默认情况下,返回最新缓存结果;传递--force以重新同步。
选项
| 短 | 长 | 值 | 默认 | 描述 |
|---|---|---|---|---|
-f | --force | 标记 | 关闭 | 忽略缓存,然后重新获取。 |
示例
uip maestro bpmn registry pull
uip maestro bpmn registry pull --force
uip maestro bpmn registry pull
uip maestro bpmn registry pull --force
数据形状(--输出 json)
{
"Code": "RegistryPullSuccess",
"Data": {
"ExtensionTypeCount": 48,
"ConnectorCount": 12,
"ProcessCount": 5,
"ProcessCountsByType": {
"Process": 3,
"ProcessOrchestration": 1,
"Agent": 1,
"Flow": 0,
"Api": 0,
"Function": 0,
"CaseManagement": 0,
"BusinessRules": 0
},
"FromCache": false,
"AgeMinutes": 0,
"CacheWritten": true,
"Message": "Synced fresh registry"
}
}
{
"Code": "RegistryPullSuccess",
"Data": {
"ExtensionTypeCount": 48,
"ConnectorCount": 12,
"ProcessCount": 5,
"ProcessCountsByType": {
"Process": 3,
"ProcessOrchestration": 1,
"Agent": 1,
"Flow": 0,
"Api": 0,
"Function": 0,
"CaseManagement": 0,
"BusinessRules": 0
},
"FromCache": false,
"AgeMinutes": 0,
"CacheWritten": true,
"Message": "Synced fresh registry"
}
}
ProcessCountsByType 按已发现的流程类型对 ProcessCount 进行细分。
使用缓存时, FromCache为true , AgeMinutes报告缓存期限, Message为Using cached registry (age: <n>m) 。
uip Maestro bpmn 注册表列表
列出缓存的扩展程序类型和已发现的资源。默认上限为30 ;为所有用户传递--limit -1 。
选项
| 短 | 长 | 值 | 默认 | 描述 |
|---|---|---|---|---|
-l | --limit | 数字 | 30 | 要返回的扩展程序类型数量; -1适用于全部)。 |
示例
uip maestro bpmn registry list
uip maestro bpmn registry list --limit 100
uip maestro bpmn registry list --limit -1
uip maestro bpmn registry list
uip maestro bpmn registry list --limit 100
uip maestro bpmn registry list --limit -1
数据形状(--输出 json)
{
"Code": "RegistryListSuccess",
"Data": {
"ExtensionTypes": [
{
"ExtensionType": "Orchestrator.StartJob",
"Label": "Start Job",
"BpmnElement": "bpmn:ServiceTask",
"ExtensionTag": "uipath:startJob",
"InputPattern": "...",
"BindingPattern": "...",
"RequiresDiscovery": "No"
}
],
"Connectors": [
{
"Key": "slack",
"Name": "Slack",
"Connections": 2,
"Activities": 14,
"Triggers": 3
}
],
"Processes": [
{
"Name": "InvoiceProcessing",
"ProcessKey": "c3d4e5f6-0000-0000-0000-000000000001",
"Type": "Maestro",
"Folder": "Shared"
}
],
"ProcessesByType": {
"Process": 3,
"ProcessOrchestration": 1,
"Agent": 1,
"Flow": 0,
"Api": 0,
"Function": 0,
"CaseManagement": 0,
"BusinessRules": 0
}
}
}
{
"Code": "RegistryListSuccess",
"Data": {
"ExtensionTypes": [
{
"ExtensionType": "Orchestrator.StartJob",
"Label": "Start Job",
"BpmnElement": "bpmn:ServiceTask",
"ExtensionTag": "uipath:startJob",
"InputPattern": "...",
"BindingPattern": "...",
"RequiresDiscovery": "No"
}
],
"Connectors": [
{
"Key": "slack",
"Name": "Slack",
"Connections": 2,
"Activities": 14,
"Triggers": 3
}
],
"Processes": [
{
"Name": "InvoiceProcessing",
"ProcessKey": "c3d4e5f6-0000-0000-0000-000000000001",
"Type": "Maestro",
"Folder": "Shared"
}
],
"ProcessesByType": {
"Process": 3,
"ProcessOrchestration": 1,
"Agent": 1,
"Flow": 0,
"Api": 0,
"Function": 0,
"CaseManagement": 0,
"BusinessRules": 0
}
}
}
如果结果被截断,则会在日志中写入Showing first <n> of <total> extension types说明。
uip Maestro bpmn 注册表搜索
按关键字在扩展程序类型 ID、标签、连接器名称和流程名称中搜索注册表。关键字匹配不区分大小写。
参数
| 名称 | 必填 | 用途 |
|---|---|---|
<keyword> | 是 | 搜索词。 |
示例
uip maestro bpmn registry search connector
uip maestro bpmn registry search queue
uip maestro bpmn registry search slack
uip maestro bpmn registry search agent
uip maestro bpmn registry search connector
uip maestro bpmn registry search queue
uip maestro bpmn registry search slack
uip maestro bpmn registry search agent
数据形状(--输出 json)
{
"Code": "RegistrySearchSuccess",
"Data": {
"ExtensionTypes": [
{
"ExtensionType": "Intsvc.ActivityExecution",
"Label": "Execute Activity",
"BpmnElement": "bpmn:ServiceTask",
"ExtensionTag": "uipath:activityExecution",
"InputPattern": "...",
"BindingPattern": "...",
"RequiresDiscovery": "Yes"
}
],
"Connectors": [
{ "Key": "slack", "Name": "Slack", "Connections": 2, "Activities": 14, "Triggers": 3 }
],
"Processes": [
{ "Name": "SlackNotifier", "ProcessKey": "c3d4e5f6-0000-0000-0000-000000000002", "Type": "Maestro" }
],
"ProcessesByType": {
"Process": 1,
"ProcessOrchestration": 0,
"Agent": 0,
"Flow": 0,
"Api": 0,
"Function": 0,
"CaseManagement": 0,
"BusinessRules": 0
}
}
}
{
"Code": "RegistrySearchSuccess",
"Data": {
"ExtensionTypes": [
{
"ExtensionType": "Intsvc.ActivityExecution",
"Label": "Execute Activity",
"BpmnElement": "bpmn:ServiceTask",
"ExtensionTag": "uipath:activityExecution",
"InputPattern": "...",
"BindingPattern": "...",
"RequiresDiscovery": "Yes"
}
],
"Connectors": [
{ "Key": "slack", "Name": "Slack", "Connections": 2, "Activities": 14, "Triggers": 3 }
],
"Processes": [
{ "Name": "SlackNotifier", "ProcessKey": "c3d4e5f6-0000-0000-0000-000000000002", "Type": "Maestro" }
],
"ProcessesByType": {
"Process": 1,
"ProcessOrchestration": 0,
"Agent": 0,
"Flow": 0,
"Api": 0,
"Function": 0,
"CaseManagement": 0,
"BusinessRules": 0
}
}
}
uip Maestro bpmn 注册表获取
获取单个扩展程序类型的完整规范。对于连接器类型(Intsvc.ActivityExecution、Intsvc.WaitForEvent、Intsvc.EventTrigger…),请同时传递 --connection-id 和 --object-name,以使用实时 Integration Service 字段元数据来丰富响应;添加 --operation 以选择要返回的操作字段。
参数
| 名称 | 必填 | 用途 |
|---|---|---|
<extensionType> | 是 | 扩展程序类型标识符(例如Orchestrator.StartJob )。 |
选项
| 短 | 长 | 值 | 默认 | 描述 |
|---|---|---|---|---|
| — | --connection-id | ID | — | Integration Service 丰富的连接 ID。需要--object-name 。 |
| — | --object-name | name | — | 用于富集 Integration Service 的对象名称。需要--connection-id 。 |
| — | --operation <name> | name | — | 要返回其请求/响应字段的操作(例如Create、INCIDENT_CREATED)。对于活动类型,默认为对象的唯一操作(当有多个操作时,响应会列出可用的操作)。对于事件类型,它是必需的— 一个对象可以公开多个事件操作,因此无法推断出来。 |
验证
--connection-id和--object-name必须一起提供 — 仅提供一个会失败,并显示IS enrichment needs --connection-id and --object-name together (add --operation for event types). Missing: <the missing flag>.--connection-id/--object-name仅适用于Intsvc.*类型 — 将它们用于非Intsvc的扩展类型会失败,将Intsvc.ActivityExecution/Intsvc.EventTrigger指定为有效示例。- 对于事件标记扩展程序类型 (),省略
extensionTag: "uipath:event"--operationEvent enrichment requires --operation将失败,并指向uip is activities list <connector> --triggers以发现有效的操作名称。
示例
uip maestro bpmn registry get Orchestrator.StartJob
# Connector activity type enriched with live IS metadata
uip maestro bpmn registry get Intsvc.ActivityExecution \
--connection-id abc123 --object-name contacts
# Connector activity type with a specific operation
uip maestro bpmn registry get Intsvc.ActivityExecution \
--connection-id abc123 --object-name contacts --operation Create
# Event type — --operation is required
uip maestro bpmn registry get Intsvc.EventTrigger \
--connection-id abc123 --object-name contacts --operation INCIDENT_CREATED
# Just the field names
uip maestro bpmn registry get Orchestrator.StartJob \
--output-filter 'Data.ExtensionType'
uip maestro bpmn registry get Orchestrator.StartJob
# Connector activity type enriched with live IS metadata
uip maestro bpmn registry get Intsvc.ActivityExecution \
--connection-id abc123 --object-name contacts
# Connector activity type with a specific operation
uip maestro bpmn registry get Intsvc.ActivityExecution \
--connection-id abc123 --object-name contacts --operation Create
# Event type — --operation is required
uip maestro bpmn registry get Intsvc.EventTrigger \
--connection-id abc123 --object-name contacts --operation INCIDENT_CREATED
# Just the field names
uip maestro bpmn registry get Orchestrator.StartJob \
--output-filter 'Data.ExtensionType'
数据形状(--输出 json)
基础响应:
{
"Code": "RegistryGetSuccess",
"Data": {
"ExtensionType": {
"extensionType": "Orchestrator.StartJob",
"label": "Start Job",
"bpmnElement": "bpmn:ServiceTask",
"extensionTag": "uipath:startJob"
}
}
}
{
"Code": "RegistryGetSuccess",
"Data": {
"ExtensionType": {
"extensionType": "Orchestrator.StartJob",
"label": "Start Job",
"bpmnElement": "bpmn:ServiceTask",
"extensionTag": "uipath:startJob"
}
}
}
当提供 --connection-id 和 --object-name(对于事件类型,则为 --operation)并且 Integration Service 调用成功时,响应还包含 ISEnrichment 字段,而该字段包含实时元数据有效负载。如果丰富调用失败(包括 Integration Service 未为给定对象/操作返回任何字段元数据),则会记录警告并省略 ISEnrichment;仍会返回基本规范。
相关命令
uip maestro bpmn pack— 打包 Maestro 项目;注册表会通知您可以使用哪些扩展程序类型。uip maestro bpmn process— 发现注册表编目的面向 Orchestrator 的流程。uip login— 在pull之前登录以查看连接器和流程。