uip Maestro 案例注册表

使用“uip Maestro 案例注册表”浏览和搜索包含活动、触发器、连接器和其他自动化资源的 Maestro Case 管理注册表。

uip maestro case registry用于浏览和搜索案例管理注册表，即本地缓存的自动化资源目录（流程、智能体、API、流程、连接器活动/触发器、Action 应用程序，以及正在进行的解决方案自身的资源），或者是案例定义可以将任务连接到。每个会话拉取一次注册表，然后在创作案例时按标识符搜索或获取资源。

有关整个uip maestro case子系统以及注册表资源如何馈入任务创作，请参阅概述。

大纲

uip maestro case registry pull [-f, --force] [-s, --solution-id <solutionId>]
uip maestro case registry search [keyword] [-t, --type <type>] [-f, --filter <filter>] [--local]
uip maestro case registry list [--local]
uip maestro case registry get <identifier> [-t, --type <type>] [--connection-id <id>] [--local]
uip maestro case registry get-connector -t, --type <type> --activity-type-id <id>
uip maestro case registry get-connection -t, --type <type> --activity-type-id <id>

典型工作流：

1. uip maestro case registry pull — 获取并缓存完整的资源注册表（每个会话运行一次）。
2. uip maestro case registry search <keyword> — 查找资源。
3. uip maestro case registry get <identifier> — 检查其完整架构。
4. uip maestro case registry get <identifier> --output-filter "Node.inputDefinition.fields" — 仅提取输入字段。

概念

• 资源类型— 注册表为 17 种资源类型建立索引： agent 、 process 、 api 、 processOrchestration 、 caseManagement 、 flow 、 action-apps 、 solution ，以及 9 个typecache-*连接器索引文件按目录来源拆分（ typecache-activities 、 typecache-triggers 、 typecache-packages以及各自的-external-automation-* / -external-agent-*变体）。由于基础目录不相交，请将它们作为单独的缓存文件保留，合并它们会使每个拉取类型的条目都会覆盖以前的类型条目。
• --local模式— search 、 list和get接受--local ，仅搜索解决方案同级项目资源，而不是租户范围内的缓存。需要当前目录或其两个父目录之一中的 .uipx 文件； get --local 的标识符是同级的资源密钥或其 .uipx 项目 ID。
• solution资源 —solution 仅当给定 时，系统才会缓存pull --solution-id <id>资源类型； 在未拉取 的情况下搜索/获取--type solution 会返回明确的提示，要求其先运行pull --solution-id 。
• 丰富连接器— get会在可能的情况下自动使用实时连接器元数据（通过条目的uiPathActivityTypeId查找）来丰富typecache-activities / typecache-triggers匹配项；传递--connection-id以获取特定于连接的自定义字段元数据。如果查找失败，系统将静默跳过此丰富操作（并非错误）。
• get-connector / get-connection — 仅针对本地类型缓存索引（不是常规资源缓存）进行低级别查找： get-connector根据--activity-type-id解析一个连接器活动/触发器条目及其连接器配置； get-connection执行相同的查找操作，然后从 Integration Service 获取连接器的可用连接。

uip Maestro 案例注册表拉取

获取并缓存所有资源类型。并行运行所有类型并报告每种类型的故障，包括任何失败的故障。

选项

短	长	值	描述
-f	--force	标记	忽略缓存，并重新获取每种资源类型。
-s	--solution-id <solutionId>	字符串	同时提取和缓存给定解决方案自己的资源（solution 资源类型）。

示例

uip maestro case registry pull

数据形状（--输出 json）

{
  "Result": "Success",
  "Code": "PullResourcesSuccess",
  "Data": {
    "TotalNodesCount": 128,
    "FromCache": false,
    "ResourceTypes": [
      {
        "Type": "typecache-activities",
        "NodesCount": 80,
        "FromCache": false,
        "AgeMinutes": null,
        "CacheWritten": true,
        "Info": null
      }
    ],
    "Errors": null
  }
}

当一种或多种资源类型拉取失败时，Result 为 "PartialSuccess, N failed"（非 "Success"） — Errors 列出每个失败类型及其错误消息；成功拉取的类型仍会缓存并反映在 ResourceTypes 中。

uip Maestro 案例注册表搜索

按关键字和/或字段筛选器搜索缓存的资源。至少需要 [keyword] 或 --filter。

参数

名称	必填	用途
[keyword]	否*	要搜索的自由文本关键字。

* 必须提供 [keyword] 和 --filter 之一或两者同时给出 — 在任何查找之前省略两者都会失败。

选项

短	长	值	描述
-t	--type <type>	枚举	将搜索限制为一种资源类型。可搜索的类型之一 — 请参阅概念，了解 17 种类型的完整列表（所有RESOURCE_TYPES值在此处均有效）。
-f	--filter <filter>	字符串	字段筛选器：field=value 或 field:operator=value，逗号分隔多个（例如name:contains=Apple,category=Pipelines）的存储库。字段：name、title、description、category 和 connectorKey。运算符：equals、contains、in、startsWith 和 endsWith。
—	--local	标记	仅搜索解决方案内的同级资源。请参阅概念。

示例

uip maestro case registry search invoice

uip maestro case registry search --filter "name:contains=Apple,category=Pipelines"

数据形状（--输出 json）

{
  "Result": "Success",
  "Code": "ResourceSearchSuccess",
  "Data": {
    "Keyword": "invoice",
    "Filters": null,
    "Type": null,
    "Local": false,
    "ResultCount": 1,
    "Resources": [
      {
        "resourceType": "typecache-activities",
        "resource": {
          "name": "InvoiceParser",
          "uiPathActivityTypeId": "a1b2c3d4-0000-0000-0000-000000000001"
        }
      }
    ],
    "FailedTypes": null,
    "Hint": null
  }
}

Hint特别是当--type solution 返回零个结果且 未通过时，系统会填充（而不是省略）--local — 它会将您指向registry pull --solution-id <id> 。FailedTypes 列出搜索期间出错的所有资源类型（对于成功的类型，仍会返回部分结果）。

uip Maestro 案例注册表列表

列出每个缓存的资源，按类型分组。未到达网络 — 反映上次缓存的 pull 任何内容；先运行 pull（或再次运行）以刷新。

选项

长	值	描述
--local	标记	仅列出解决方案内的同级资源，而不是租户范围内的缓存。请参阅概念。

示例

uip maestro case registry list

数据形状（--输出 json）

{
  "Result": "Success",
  "Code": "ResourceListSuccess",
  "Data": {
    "ResourcesCount": 128,
    "Local": false,
    "ResourceTypes": [
      { "Type": "typecache-activities", "Count": 80 },
      { "Type": "typecache-triggers", "Count": 48 }
    ],
    "resources": []
  }
}

--local 解析解决方案并直接扫描其资源树（不涉及缓存）；缺少的解决方案（未找到 .uipx）将报告为干净错误，而不是空列表。

uip Maestro 案例注册表获取

按标识符获取一个或多个完整资源记录。

参数

名称	必填	用途
<identifier>	是	资源的entityKey （流程类类型）或id （操作应用程序） — 通过概念面板查看每种类型的 ID 字段。请改用 --local、同级项目的资源密钥或 .uipx 项目 ID。

选项

短	长	值	描述
-t	--type <type>	枚举	将查找内容限制为一种资源类型（设置与 search --type 相同）。
—	--connection-id <id>	字符串	特定于连接器的 Integration Service 字段元数据（自定义字段）的连接 ID。仅适用于 typecache-* 个活动/触发器匹配。
—	--local	标记	根据解决方案内的同级资源解析，而非租户缓存。请参阅概念。

示例

uip maestro case registry get a1b2c3d4-0000-0000-0000-000000000001

数据形状（--输出 json）

{
  "Result": "Success",
  "Code": "ResourceGetSuccess",
  "Data": {
    "MatchCount": 1,
    "Local": false,
    "Resources": [
      {
        "ResourceType": "typecache-activities",
        "Resource": {
          "uiPathActivityTypeId": "a1b2c3d4-0000-0000-0000-000000000001",
          "name": "InvoiceParser"
        }
      }
    ]
  }
}

零匹配表示失败（少于 Code 的错误响应），而非空的成功 — 错误的 Instructions 因模式而异：--local 缺失建议通过 registry list --local 重新检查同级的资源密钥或项目 ID； --type solution 缺失建议先运行 pull --solution-id；其他仅报告“未找到资源”。

uip Maestro 案例注册表获取连接器

直接从本地类型缓存索引中查找单个连接器活动/触发器条目（及其连接器配置），绕过常规资源搜索。

选项

短	长	值	必填	描述
-t	--type <type>	枚举	是	要在其中查找的类型缓存索引：typecache-activities、typecache-triggers、typecache-external-automation-activities、typecache-external-automation-triggers、typecache-external-agent-activities 或 typecache-external-agent-triggers。
—	--activity-type-id <id>	字符串	是	要查找的 uiPathActivityTypeId。

示例

uip maestro case registry get-connector --type typecache-activities --activity-type-id a1b2c3d4-0000-0000-0000-000000000001

数据形状（--输出 json）

{
  "Result": "Success",
  "Code": "ConnectorGetSuccess",
  "Data": {
    "Entry": {
      "uiPathActivityTypeId": "a1b2c3d4-0000-0000-0000-000000000001",
      "name": "InvoiceParser"
    },
    "Config": { "connectorKey": "uipath-connector-a" }
  }
}

uip Maestro 案例注册表获取连接

查找连接器活动/触发器（与 get-connector 相同的查找方式），然后获取其可用的 Integration Service 连接。

选项

短	长	值	必填	描述
-t	--type <type>	枚举	是	类型缓存索引选项与 get-connector 相同。
—	--activity-type-id <id>	字符串	是	要查找的 uiPathActivityTypeId。

示例

uip maestro case registry get-connection --type typecache-activities --activity-type-id a1b2c3d4-0000-0000-0000-000000000001

数据形状（--输出 json）

{
  "Result": "Success",
  "Code": "ConnectionGetSuccess",
  "Data": {
    "Entry": { "uiPathActivityTypeId": "a1b2c3d4-0000-0000-0000-000000000001" },
    "Config": { "connectorKey": "uipath-connector-a" },
    "Connections": [
      { "id": "b2c3d4e5-0000-0000-0000-000000000001", "name": "Default" }
    ]
  }
}

将任务输入绑定到变量

通过直接编辑案例管理 JSON 架构文件，将任务的输入连接到文本值/表达式或另一个任务的输出。字段引用：以点分隔的 <field-path> 中的任务输入（<input-name>[.<key1>[.<key2>...]] — 无点直接设置 input.value；每个点段遍历一个属性级别，例如body.body.body（对于连接器活动的嵌套请求正文））接受文字字符串或带有允许前缀（=vars.、=bindings.、=js:、=metadata.、=datafabric.、=orchestrator.JobAttachments、=response、=result、=Error、=jsonString:）或在采购其他任务的输出时生成的 =vars.<id> 表达式。直接编辑 caseplan.json 的任务输入以设置其中任何一项，然后运行 uip maestro case validate <file>。

相关内容

• uip Maestro 案例— 案例管理子系统的概述及其余部分。

另请参阅

• Maestro 工具概述
• 全局选项
• 退出代码