Yida Integration

yida-integration — 宜搭集成&自动化（逻辑流）技能

命令选择

严格禁止 (NEVER DO)

• 不要在未加载本技能内容的情况下编写逻辑流定义，节点格式复杂且易出错
• 不要编造 formUuid 或 fieldId，必须从已有记录或 yida-get-schema 获取
• 不要用此技能配置审批流程，应使用 yida-process-rule
• 不得把 integration update 的 fail-closed 结果降级为 integration create --process-code --replace

严格要求 (MUST DO)

• 创建/发布前必须确认：执行集成自动化创建或发布操作前，必须向用户展示逻辑流配置摘要（触发条件、节点列表、通知对象），获得用户明确同意后再执行
• 创建前先确认触发表单的 formUuid 和相关字段 ID
• 创建成功后记录逻辑流 ID 到 .cache/<项目名>-schema.json
• --spec JSON 文件必须先用结构化文件写入工具创建到 <projectRoot>/.cache/openyida/<项目名或任务名>/integration/；不要用 shell heredoc、cat/echo/printf/tee 或重定向写文件，也不要写仓库根目录或系统临时目录
• 连接器 action schema 只能来自 CLI 的平台只读发现或固定已证 preset；不得使用 --connector-inputs 自行声明未知字段类型，未知连接器、动作或输入字段必须停止且保持零写入
• 连接器嵌套输入使用完整路径赋值，如 Body.userid、Path.unionId；只有 schema 中唯一的叶子名可以使用短名称
• 需要宜搭 systemToken 的连接器动作使用 --connector-system-token-app <appType>，或在 spec 中声明 secretBindings。CLI 校验官方目标后从当前登录态读取凭据并只注入服务端流程 payload；普通 assignment 不接收该值
• integration create --publish 的成功只证明控制面保存、启用和配置回读；输出 runtimeVerified=false 时必须真实触发并独立读回业务结果，不能宣称连接器动作已经执行成功
• 参考官方示例时不要只看默认页面 schema：集成自动化示例的默认页通常只是触发表单或说明页，逻辑流本体需要通过集成自动化接口/命令查询或创建
• 分析已有应用时先执行不带筛选的 integration list --json 获取全部已知触发类型；不得只看表单事件就声称已完成自动化盘点

适用场景

异常处理

Agent 错误处理策略

当 Agent 执行本技能遇到错误时，必须遵循以下默认行为：

本技能用于在宜搭平台创建「集成&自动化」（逻辑流），支持场景：表单事件触发 → 多节点组合处理 → 钉钉工作通知 / 数据操作。

官方示例中心体现的集成范式是“表单收集数据，逻辑流处理副作用”。因此，跨表新增/更新、通知、创建待办、调用钉钉能力等提交后动作，默认用本技能；不要把这些副作用塞进表单字段 JS 或自定义页面按钮，除非用户明确要求一次性人工触发工具页。

功能概述

• 监听指定表单的新增 / 更新 / 删除 / 评论事件
• 可选：从另一张表单获取单条数据，支持按触发表单字段值过滤
• 可选：向指定表单新增数据，支持字段赋值（含公式）
• 可选：更新指定表单数据（按节点查询结果或条件过滤）
• 可选：条件分支，根据上游节点数据有无 / 字段值走不同分支
• 通知内容和标题支持引用表单字段变量（#{fieldId-ComponentType}# 格式）
• 支持保存为草稿（未开启状态）或直接发布（开启状态）

命令格式

openyida integration create <appType> <formUuid> <flowName> [选项]
openyida integration update <appType> <formUuid> <processCode> --spec <desired-spec.json> [--publish]
openyida integration list <appType> [--flow-types 1,2,3,5,6] [--form-uuid <uuid>] [--status y|n] [--json]
openyida integration enable <appType> <formUuid> <processCode>
openyida integration disable <appType> <formUuid> <processCode>
openyida integration check <appType...> [--json] [--output result.xlsx] [--no-progress]

参数说明

选项说明

示例

# 整图替换已有自动化
openyida integration create APP_XXX FORM-XXX "替换已有自动化" \
  --process-code LPROC-XXX \
  --replace \
  --spec .cache/openyida/<项目名或任务名>/integration/desired-spec.json

# 最简用法：表单新增时通知指定用户，仅保存草稿
openyida integration create APP_XXX FORM-XXX "新增记录通知" \
  --receivers user123 \
  --title "有新记录提交" \
  --content "表单有新记录提交，请及时处理。"

# 引用表单字段变量，保存并发布
openyida integration create APP_XXX FORM-XXX "记录变更通知" \
  --receivers user123,user456 \
  --title "记录变更：#{textField_abc-TextField}#" \
  --content "内容：#{textField_abc-TextField}#" \
  --events insert,update,delete,comment \
  --publish

# 带获取单条数据节点：触发时从 B 表单获取匹配记录，再发送通知
# --data-condition 格式：B表单字段ID:B表单字段名:A表单字段ID[:组件类型[:opCode[:valueType]]]
# 可多次传入 --data-condition 添加多个过滤条件
openyida integration create APP_XXX FORM-A-XXX "跨表通知" \
  --receivers user123 \
  --title "关联记录变更：#{textField_a1-TextField}#" \
  --content "B表单数据已更新，请查看。" \
  --events insert,update \
  --data-form-uuid FORM-B-XXX \
  --data-condition "textField_b1:B表单姓名字段:textField_a1:TextField" \
  --publish

# 获取自身：触发后重新读取当前记录，避免流水号、定时值或触发 payload 不是最新值
openyida integration create APP_XXX FORM-A-XXX "获取自身后通知" \
  --title "记录已提交" \
  --content "已按表单实例ID重新读取当前记录。" \
  --events insert,update \
  --get-self \
  --publish

# 带新增数据节点：触发时将 A 表单数据同步到 B 表单，并发送通知
# --add-data-assignment 格式：目标字段ID:valueType:value
# valueType 可选：processVar（引用触发表单字段）、literal（固定值）、column（公式）
# 可多次传入 --add-data-assignment 添加多个字段赋值
openyida integration create APP_XXX FORM-A-XXX "表单A新增后同步到表单B并通知" \
  --receivers user123 \
  --title "数据已同步" \
  --content "表单A新增了一条记录，已自动同步到表单B。" \
  --add-data-form-uuid FORM-B-XXX \
  --add-data-assignment "textField_b1:processVar:textField_a1" \
  --add-data-assignment "numberField_b2:literal:0" \
  --add-data-assignment "textareaField_b3:column:CONCATENATE(#{textField_a1},#{textField_a2})" \
  --publish

# A 流程审批完成后，发起 B 流程审批（B 是流程表单时使用）
openyida integration create APP_XXX FORM-A-XXX "A审批完成后发起B流程" \
  --events processFinish \
  --approval-actions agree \
  --get-self \
  --initiate-approval-form-uuid FORM-PROCESS-B-XXX \
  --initiate-approval-initiator-user "01376266634908:张三" \
  --initiate-approval-assignment "textField_b1:processVar:textField_a1" \
  --initiate-approval-assignment "textareaField_b2:literal:自动发起" \
  --publish

# 调用 HTTP 自定义连接器动作，并保留设计器右侧面板所需的连接器元信息
openyida integration create APP_XXX FORM-A-XXX "调用 HTTP 连接器" \
  --connector-id Http_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx \
  --action-id publish_month_qs \
  --connection-id 28336 \
  --connector-display-name "BI 后端" \
  --connector-assignment "month:processVar:textField_month" \
  --publish

# 调用需要 systemToken 的宜搭 OpenAPI；凭据由 CLI 内部读取，不写入命令参数
openyida integration create APP_XXX FORM-A-XXX "服务端调用宜搭 OpenAPI" \
  --connector-id Http_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx \
  --action-id query_yida_data \
  --connector-system-token-app APP_TARGET \
  --connector-assignment "formUuid:literal:FORM_TARGET" \
  --publish

结构化编排 --spec

复杂自动化优先使用 --spec，不要手写 saveProcess payload。spec 的节点可以用 id 作为别名，后续用 ${别名}.fieldId 引用上游节点输出，OpenYida 会在保存前替换成真实 node_xxx。

{
  "events": ["insert"],
  "nodes": [
    { "id": "self", "type": "getSelf", "formType": "receipt" },
    {
      "id": "branch",
      "type": "route",
      "branches": [
        {
          "id": "hasSelf",
          "name": "已获取自身",
          "conditions": [
            {
              "fieldId": "${self}.form_inst_id",
              "fieldName": "表单实例ID",
              "opCode": "ExistValue",
              "componentType": "TextField"
            }
          ],
          "nodes": [
            {
              "id": "updateSelf",
              "type": "dataUpdate",
              "source": "self",
              "assignments": [
                {
                  "column": "textareaField_result",
                  "valueType": "literal",
                  "value": "已处理"
                }
              ]
            }
          ]
        },
        {
          "id": "fallback",
          "name": "其他情况",
          "default": true,
          "nodes": [
            {
              "id": "notice",
              "type": "sendMessage",
              "title": "未获取到记录",
              "content": "获取自身节点无匹配结果，请检查过滤条件。"
            }
          ]
        }
      ]
    }
  ]
}

openyida integration create APP_XXX FORM-XXX "获取自身后分支更新" \
  --spec .cache/openyida/<项目名或任务名>/integration/get-self-update.json \
  --publish

--spec 文件先用 create_file / Write / file edit tool 创建。上方路径默认从 OpenYida project 工作目录执行；从 workspace 根执行命令时路径加 project/ 前缀。

initiateApproval 必须把目标流程表单、发起人和至少一个字段赋值完整写进 spec；不要再混传同名 CLI 结构参数。select_user.value 是员工身份 JSON 字符串，必须含非空 id 和固定 type: "employee"；使用当前登录用户时写 current_user，CLI 会在远端写入前解析为员工身份。

需要 systemToken 的 connector 节点用安全绑定声明目标应用。assignments 不写 systemToken：

{
  "type": "connector",
  "connectorId": "Http_xxx",
  "actionId": "query_yida_data",
  "secretBindings": [
    { "target": "body.systemToken", "provider": "yidaSystemToken", "appType": "APP_TARGET" }
  ],
  "assignments": [
    { "column": "formUuid", "valueType": "literal", "value": "FORM_TARGET" }
  ]
}

{
  "type": "initiateApproval",
  "formUuid": "FORM-PROCESS-XXX",
  "initiator": { "type": "current_user" },
  "assignments": [
    { "column": "textField_title", "valueType": "literal", "value": "自动发起审批" }
  ]
}

从上游节点的子表取一行或新增一行，只用于 --spec 新建草稿，不要用来改现网自动化，也不要调用 integration update。

• dataRetrieve：originalType: "sub_table"，source 必须是拓扑上游的 getSelf 或 dataRetrieve 别名，subSourceId 为子表 fieldId；不要再填目标表 formUuid
• dataCreate：insertType: "sub_table"，source 为同一类上游节点，subFormUuid 为子表 fieldId；赋值字段必须落在该子表下。parentFormUuid 可选；来源是 getSelf 时回退到触发表单 UUID，否则从上游节点的 formUuid 推断

{
  "id": "lookupRow",
  "type": "dataRetrieve",
  "originalType": "sub_table",
  "source": "school",
  "subSourceId": "tableField_history",
  "subSourceLabel": "经销商履历",
  "conditions": [
    {
      "bFieldId": "textField_dealer_code",
      "bFieldName": "经销商编号",
      "aFieldId": "textField_selected_dealer_code",
      "componentType": "TextField",
      "opCode": "Equal",
      "valueType": "processVar"
    }
  ]
}

{
  "id": "appendRow",
  "type": "dataCreate",
  "insertType": "sub_table",
  "source": "school",
  "subFormUuid": "tableField_history",
  "assignments": [
    { "column": "textField_dealer_code", "valueType": "processVar", "value": "textField_selected_dealer_code" }
  ]
}

字段变量引用格式

在通知标题和内容中，可以使用 #{fieldId-ComponentType}# 格式引用触发表单的字段值：

#{textField_mmq4ldti-TextField}#
#{numberField_abc123-NumberField}#
#{selectField_xyz-SelectField}#

• fieldId：字段 ID（可通过 yida-get-schema 技能查询）
• ComponentType：字段组件类型（如 TextField、NumberField、SelectField 等）

在结构化 spec 的公式赋值中，valueType: "column" 的 value 使用 ${alias}.fieldId 引用上游节点；如果同时提供设计器展示用的 __source，使用 #{alias//fieldId}。CLI 会把这两种别名引用都替换成真实节点 ID；不要只写 value 后假设设计器一定能恢复“值设置”展示。

输出结果

命令执行成功后，向 stdout 输出 JSON：

{
  "success": true,
  "published": false,
  "processCode": "LPROC-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "flowName": "新增记录通知",
  "appType": "APP_XXX",
  "formUuid": "FORM-XXX",
  "formEventTypes": ["insert"]
}

加 --publish 后，只有按 formUuid + processCode 精确完成全量列表与状态回读、并确认 getProcess 返回非空详情时，published 才为 true；输出包含诚实口径 verificationLevel=PLATFORM_LIST_EXACT_DETAIL_PRESENT 和回读摘要。详情未携带已证 identity 字段时只证明存在，不能宣称 detail exact；写响应成功但回读无法证明时命令失败，published=null、verificationLevel=UNVERIFIED。

控制面查询与启停

• integration list 默认枚举 1/2/3/5/6 五类触发类型，并为结果附带 flowType；会复用 integration check 的安全 paginator，拉完应用分组分页，并在分组 hasMore=true 时继续拉取表单下剩余逻辑流，不把单页或单一触发类型冒充完整列表。
• 当前 create 写入仍只支持表单事件触发。读到定时、应用事件或手动/卡片触发时，必须保留原 flowType 和事件语义并报告精确 capability gap；不得退化为表单新增通知后声称等价创建。
• integration enable/disable 写入后必须按 formUuid + processCode 精确匹配唯一列表项、校验期望 status=y/n，并完成 getProcess 详情存在性回读。
• 回读成功返回 verificationLevel=PLATFORM_LIST_EXACT_DETAIL_PRESENT；精确匹配为 0/多条、状态不一致、详情为空、详情请求失败，或详情顶层 processCode/formUuid 与目标冲突，都必须非零失败。
• 详情回读当前只证明目标设计定义存在，不证明完整 runtime graph；不得据此解锁 integration update。

异常日志检查

openyida integration check APP_XXX --json
openyida integration check APP_XXX APP_YYY --output project/output/自动化异常.xlsx
openyida integration diagnose --text "连接器异常：接口参数异常"
openyida integration diagnose --file project/tickets/automation-error.txt --json

• 会分页查询指定应用下的全部集成自动化，默认覆盖 1/2/3/5/6 五类触发类型。
• 对每条自动化调用运行日志接口，并按 status=2 筛选“执行异常”。
• integration check 会在 JSON/Excel/文本输出中附带诊断建议；注意“未发现异常日志”不等于业务一定正确，获取数据无匹配或条件未命中可能仍显示成功。
• integration diagnose 可离线诊断工单文本、OCR 后的截图文本或日志片段，不需要登录态。
• 批量查询时只显示单行进度，不逐条输出 HTTP 200。
• JSON 结果包含 totalFlows、abnormalFlows[].processCode、自动化名称、触发表单和异常日志列表。
• 传入 --output <file.xlsx> 时导出 Excel，一个应用一个 sheet；无异常的应用会写入“未发现执行异常日志”，检查失败的应用会写入失败原因。

集成自动化闭坑规则

• 获取自身：优先使用 --get-self；流程表单运行态使用查询侧 pid（流程实例ID）、设计器使用 proc_inst_id，普通表单两侧使用 form_inst_id（表单实例ID），均等于触发事件字段 __masterdata_form_inst_id。不要用 formInstId = formInstId、不要用“包含”或非唯一字段做自身匹配。
• 流水号：新增/编辑触发时，触发 payload 中的流水号可能为空或不是最新值；需要先获取自身，再引用获取节点里的流水号。
• 定时自动化：定时触发值可能是历史数据；需要最新值时先获取自身或获取目标数据。
• 直接更新：匹配字段只能消费当前触发表字段，不能随意匹配前置节点字段；文本字段不要匹配单选/多选字段。直接更新不会触发被更新表单上的集成自动化。
• 条件分支：空值判断优先用公式 ISEMPTY()，不要只依赖“没有值”选项。
• 异常重试：重试通常会从头执行，已执行过的新增/更新节点可能再次写入或覆盖数据；重试前先确认幂等性。

调用流程

1. 读取 token session 获取登录态（不存在则提示执行 openyida login）
2. 有连接器节点时，先通过平台只读详情精确发现 action 的 inputs/outputs，或命中固定已证 preset；无法证明时零写入失败
3. 生成各节点 ID（node_xxx 格式，随机生成），并在首个写入前完成双 JSON 构建
4. 创建新自动化时调用 createLogicflow.json 获取真实 processCode；整图替换时使用已校验的 processCode 和 --replace
5. 调用 saveProcess 接口（isOnline=false）保存为草稿
6. 若指定 --publish，再次调用 saveProcess 接口（isOnline=true）
7. 按 formUuid + processCode 执行全量列表与最终状态精确回读，并校验详情存在性及可用的 identity 投影；无法证明则失败

⚠️ 必须先调用 createLogicflow.json 新建绑定关系，再调用 saveProcess 写入内容。直接调用 saveProcess 无法创建新逻辑流，只能覆盖更新已有逻辑流。

安全二次编辑

使用 integration update 获取 capability 结果。结果为 PLATFORM_PROBE_REQUIRED 时，保持 remoteWrites=0，输出本地 probe artifact 和 blocker，并向用户报告当前状态。只有只读探针同时证明完整 runtime graph、完整 view graph、资源 ownership 与 before fingerprint 后，才允许另行评审 update；列表/详情存在性回读不足以解锁更新，不得降级为整图替换或通用 JSON Patch。

Runtime E2E 证据边界

域内 runner 为 scripts/e2e-real/integration/runtime-runner.js，已为 dataCreate、dataRetrieve、dataUpdate、route、sendMessage、connector、initiateApproval 固定独立读回合同和 mutation 失败条件。真实平台 adapter 必须实现 owned fixture prepare、trigger、独立 readback、cleanup 四步；prepare 是只读 preflight，必须声明 remoteWrites=0 并提供结构化 ownershipEvidence、资源 fingerprint 与 correlation proof。只有 ownership 通过后才允许 trigger/cleanup；主流程与 cleanup 双失败时必须同时报告机器错误与 residual。compiler、builder 单测或写响应不能代替 runtime 证据。

逻辑流节点结构

复杂节点 JSON 不再内联在主技能中，避免每次触发都占用大量上下文。需要手写或排查节点结构时，只读取对应参考文档：

• 节点类型速查、trigger / sendMessage / dataCreate / dataRetrieve / dataUpdate / route + condition 完整结构： references/integration-node-schemas.md
• 常见创建示例： references/examples.md

快速链路：

trigger -> sendMessage -> finish
trigger -> dataRetrieve -> sendMessage -> finish
trigger -> sendMessage -> dataCreate -> finish
trigger -> dataRetrieve -> route -> condition -> dataUpdate/dataCreate -> finish

读取规则：

• 仅使用 CLI 选项创建标准通知、查询、新增数据链路时，不需要展开节点 JSON 参考。
• 需要自定义复杂分支、更新数据、排查 saveProcess payload 时，再读取 integration-node-schemas.md。
• 需要给用户展示示例命令时，优先读取 examples.md。

变量引用与字段赋值

📖 字段赋值 valueType 规律和变量引用格式对照详见 references/integration-node-schemas.md。

接口说明

📖 saveProcess、listLogicflows、switchLogicflow 接口的完整参数和返回值结构详见 references/integration-node-schemas.md。

前置依赖

• Node.js
• 项目根目录存在有效 token session（通过 openyida login 获取）

文件结构

lib/
└── integration/
    └── integration-create.js    # integration create 子命令实现

触发条件

正向触发：

• "配置集成自动化"、"数据联动"、"自动触发"
• "表单提交后自动发消息"、"自动新增数据"
• "配置逻辑流"、"自动化规则"

注意事项

• --receivers 填写的是宜搭/钉钉用户 ID（userId），不是姓名
• 触发事件使用 API 内部名称：insert（新增）、update（更新）、delete（删除）、comment（评论），也支持别名 create
• processCode 格式为 LPROC- 加 38 位大写字母数字，不传则自动随机生成
• 保存（草稿）和发布使用同一个接口 saveProcess，通过 isOnline 参数区分
• 错误码处理：接口返回 token 过期或登录失效时，CLI 会优先使用 refresh_token 刷新后重试；refresh 失败时提示重新执行 openyida login
• 本技能不读写 memory：集成逻辑流配置通过 CLI 命令写入宜搭平台，processCode 等信息输出到 stdout，不依赖跨会话的 memory 状态