表单事件推送
1. 简介
1.1 功能简介
表单事件推送是指,当表单结构发生变更(包括表单保存、字段别名修改)时,可将变更后的表单内容推送至对应的服务器中。
1.2 使用场景
适用于拥有多个系统,且对简道云表单结构有依赖关系的场景中。如:
- 第三方系统集成与数据映射同步:字段别名修改时,实时推送到服务器中,以便及时更新依赖系统的映射规则;
- 自动化工作流规则更新:表单字段被删除时,自动推送至服务器中,以便及时更新工作流的失效规则;
- BI 报表与数据分析平台同步:表单结构变更时,实时推送至 BI 平台或数据仓库管理工具中,平台可以及时通知负责人以便更新报表逻辑、标记依赖项等。
2. 操作步骤
2.1 设置入口
在「扩展功能 >> 数据推送」处,点击「新建数据推送」,即可创建一个数据推送事件。

2.2 设置服务器
2.2.1 选择目标服务器
进入数据推送设置页面后,根据企业需求选择对应的目标服务器。系统支持选择自定义服务器推送,也支持选择 Finereport 服务器进行推送:
- 与 Finereport 对接选择 Finereport 服务器:FineReport 报表对接简道云插件;
- 与 FineBI 对接选择 Finereport 服务器:FineBI 报表对接简道云插件;
- 与九数云对接选择自定义服务器:同步数据源【7. 接受简道云实时推送】;

2.2.2 设置服务器地址
企业根据自身的企业需求,可填写指定的服务器地址,数据会以 HTTP POST 请求的形式,推送至目标服务器地址。

2.2.3 生成Secret
服务器地址填写完成后,点击「生成 Secret」,系统将自动生成对应的 Secret。

2.2.4 服务器连接测试
1)服务器地址确认无误及生成 Secret 后,点击「服务器连接测试」,系统将自动进行服务器连接测试,测试成功后,则显示「服务器连接成功」。

2)若服务器连接失败,也可查看错误详情,并根据错误详情进行调整后重新连接。

2.3 设置推送事件
进行表单事件推送时,企业可根据自身需求来勾选对应的表单推送事件,如下所示:
- 表单结构有变化时:表单保存或字段别名变更时推送。
注:
1)表单上的任何修改,如增删改字段、修改字段属性、表单属性等内容都属于表单结构变化。
2)表单不做任何修改,只要点击了保存按钮,也属于表单结构变化。

3. 注意事项
3.1 推送数据结构
表单事件推送时,数据结构定义如下:
参数 | 说明 |
op | 推送事件。
|
opTime | 推送事件触发时间戳,精确到毫秒 |
data | 具体数据内容 |
3.2 表单事件推送内容
字段 | 字段类型 | 说明 |
appId | string | 应用ID,全局唯一 |
entryId | string | 表单ID,在应用内唯一 |
name | string | 表单名称 |
widgets | array | 用户控件列表,不包含系统字段 |
widgets[].label | string | 控件名称 |
widgets[].name | string | 字段名(设置了字段别名则采用别名,未设置字段别名则采用字段 ID) |
widgets[].widgetName | string | 字段 ID |
widgets[].type | string | 控件类型 |
widgets[].items | array | 可选,当控件类型为子表单时存在 |
3.3 推送失败
当数据推送失败时,管理员会收到通知。管理员可调整配置后,在「数据推送」处点击「重新推送」,重新推送失败的数据。

注:
1)数据推送失败时,管理员可以选择重新推送失败缓存里的数据,也可以放弃缓存。失败数据仅可保留 7 天,超时后无法再进行重新推送。
2)当失败记录达到 100 条,会关闭数据推送功能,同时管理员会收到一条数据推送关闭的消息提醒,需要在数据推送设置中重新启动数据推送,数据推送才会继续推送。

400-111-0890
在线咨询