事件发布、等待与审批
适用版本:1.0.0。任务 → 新增/编辑 → 插件 EVENT。
入口与准备
使用 ADMIN 创建、配置和保存任务;ADMIN 或 OPERATOR 可以执行已发布定义,详细日志和输入输出变量由 ADMIN 查看。资源必须启用并可被执行节点访问。任务公共超时、重试和版本规则见任务,角色动作见权限矩阵。
字段说明
“默认值”指 1.0.0 新建表单的初始值;空表示尚未填写,不表示必填项可以省略。显示条件决定当前分支中是否出现字段。“条件必填”只在对应分支启用时要求填写。
动作
| 字段 | 是否必填 | 默认值 | 显示条件 | 作用范围 |
|---|---|---|---|---|
| 事件动作 | 选择 | PUBLISH | 始终 | 当前任务版本 |
- 事件动作:选择发布、等待事件、等待审批或文件探测。
文件探测
| 字段 | 是否必填 | 默认值 | 显示条件 | 作用范围 |
|---|---|---|---|---|
| 文件资源 | 条件必填 | 空 | PROBE_FILE | 当前任务版本 |
| 探测目录 | 条件必填 | / | PROBE_FILE | 当前任务版本 |
| 文件匹配 | 有默认值 | * | PROBE_FILE | 当前任务版本 |
| 递归目录 | 有默认值 | false | PROBE_FILE | 当前任务版本 |
| 区分大小写 | 有默认值 | true | PROBE_FILE | 当前任务版本 |
| 最小文件年龄(秒) | 有默认值 | 30 | PROBE_FILE | 当前任务版本 |
| 新增事件上限 | 有默认值 | 100 | PROBE_FILE | 当前任务版本 |
| 最大扫描深度 | 有默认值 | 16 | PROBE_FILE | 当前任务版本 |
| 扫描条目上限 | 有默认值 | 100000 | PROBE_FILE | 当前任务版本 |
| 扫描超时(秒) | 有默认值 | 60 | PROBE_FILE | 当前任务版本 |
- 文件资源:提供待探测目录的文件资源。
- 探测目录:在文件资源允许的路径范围内选择探测目录。
- 文件匹配:筛选需要生成事件的文件。
- 递归目录:开启后扫描子目录,仍受深度和条目上限限制。
- 区分大小写:控制文件匹配时是否区分大小写。
- 最小文件年龄(秒):文件达到最小稳定年龄后才参与探测。
- 新增事件上限:限制一次探测新增的事件数量。
- 最大扫描深度:限制递归探测目录深度。
- 扫描条目上限:限制一次探测扫描的目录和文件条目。
- 扫描超时(秒):限制文件探测扫描时间。
事件与等待
| 字段 | 是否必填 | 默认值 | 显示条件 | 作用范围 |
|---|---|---|---|---|
| 事件编码 | 条件必填 | 空 | PROBE_FILE / PUBLISH / WAIT_EVENT | 当前任务版本 |
| 业务键 | 可选 | 空 | PROBE_FILE / PUBLISH / WAIT_EVENT | 当前任务版本 |
| 关联键 | 可选 | 空 | PROBE_FILE / PUBLISH / WAIT_EVENT | 当前任务版本 |
| 摘要 | 可选 | 空 | PROBE_FILE / PUBLISH | 当前任务版本 |
| 事件内容(JSON) | 可选 | 空 | PUBLISH | 当前任务版本 |
| 幂等键 | 可选 | 空 | PUBLISH | 当前任务版本 |
| 发生时间 | 可选 | 空 | PUBLISH | 当前任务版本 |
| 抑制同源重复事件 | 有默认值 | true | PUBLISH | 当前任务版本 |
| 等待超时(秒) | 可选 | null | WAIT_EVENT / WAIT_APPROVAL | 当前任务版本 |
| 回看时间(秒) | 有默认值 | 0 | WAIT_EVENT | 当前任务版本 |
| 审批人员 | 条件必填 | [] | WAIT_APPROVAL | 当前任务版本 |
- 事件编码:用于发布事件或筛选等待的事件类型。
- 业务键:关联事件与业务对象;等待时参与匹配。
- 关联键:关联同一业务流程中的事件;等待时参与匹配。
- 摘要:填写事件的简短业务说明。
- 事件内容(JSON):携带事件业务数据,不放入秘密。
- 幂等键:标识同一次事件发布,供重复提交去重。
- 发生时间:填写事件实际发生时间;按 UTC 的 ISO 本地日期时间填写。
- 抑制同源重复事件:抑制来自相同入站事件的重复发布。
- 等待超时(秒):等待事件和审批使用本字段,不使用任务公共超时。
- 回看时间(秒):等待时允许回看已有事件的时间范围。
- 审批人员:列出允许处理此审批的账号标识,仍需审批权限。
使用边界
- WAIT_APPROVAL 至少一个允许审批人;账号须启用且有审批权限。
- 事件编码 [A-Za-z0-9._:-],1–128 字符。
- 发生时间为不含 Z/偏移的 ISO local datetime,界面提示按 UTC 填写。
- payload 最多 16 KiB。
- 文件探测元数据生成载荷、发生时间与幂等键。
典型配置:发布订单就绪事件
按下表填写界面,资源名称需替换为自己的已启用资源。这是配置说明,不是可直接导入的 JSON。完整数据准备与执行步骤见本节末尾教程。
若需要观察等待恢复,先按链接教程运行相同事件编码和业务键的WAIT_EVENT任务;回看0时应先等待再发布。
| 配置项 | 填写内容 |
|---|---|
| 事件动作 | PUBLISH |
| 事件编码 | docs.order.ready |
| 业务键 | order-001 |
| 摘要 | 样例订单已准备好 |
| 事件内容(JSON) | {"rows":3} |
预期结果: 事件记录出现docs.order.ready和order-001。若已按教程先启动相同编码和键的WAIT_EVENT实例,该等待实例继续完成;发布本身不会创建等待实例。
跟做完整教程。保存定义后再手动执行;实例状态与业务结果分别核对。
技术字段对照
以下键名用于导入配置、接口或排障。规则中的 [] 表示集合元素;不需要把这些键名填入界面标签。
| 类别 / 字段 | 技术键名 |
|---|---|
| 动作 / 事件动作 | action |
| 文件探测 / 文件资源 | fileResourceId |
| 文件探测 / 探测目录 | filePath |
| 文件探测 / 文件匹配 | filePattern |
| 文件探测 / 递归目录 | recursive |
| 文件探测 / 区分大小写 | fileCaseSensitive |
| 文件探测 / 最小文件年龄(秒) | minStableAgeSeconds |
| 文件探测 / 新增事件上限 | maxMatches |
| 文件探测 / 最大扫描深度 | maxDepth |
| 文件探测 / 扫描条目上限 | maxScannedEntries |
| 文件探测 / 扫描超时(秒) | scanTimeoutSeconds |
| 事件与等待 / 事件编码 | eventCode |
| 事件与等待 / 业务键 | businessKey |
| 事件与等待 / 关联键 | correlationKey |
| 事件与等待 / 摘要 | summary |
| 事件与等待 / 事件内容(JSON) | payload |
| 事件与等待 / 幂等键 | idempotencyKey |
| 事件与等待 / 发生时间 | occurredAt |
| 事件与等待 / 抑制同源重复事件 | suppressSameInbound |
| 事件与等待 / 等待超时(秒) | timeoutSeconds |
| 事件与等待 / 回看时间(秒) | lookbackSeconds |
| 事件与等待 / 审批人员 | allowedOperatorIds |