数据事件推送 - 简道云

数据事件推送

1. 简介

1.1 功能简介

数据事件推送是指，当表单中的数据发生如下所示变更时，可将变更后的数据推送至对应的服务器中：

有新数据提交时；
有数据被修改时；
有数据被删除时；
有数据被恢复时。

1.2 使用场景

适用于需要将数据变更（新增、修改、删除或恢复）情况推送至企业所需服务器等场景中，以便及时获取最新、最准确的数据状态：

实时库存与订单管理：表单中的数据（地址、数量、订单状态等）发生变更时，立即推送到库存管理系统、物流系统、订单管理系统中；
动态销售线索管理与分配：客户信息实时推送到 crm 创建线索记录，自动推送新线索至服务器中；
实时数据看板与决策支持：将新增或变更的数据实时推送至 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 设置推送事件

进行数据事件推送设置时，企业可根据自身需求来勾选对应的数据推送事件，不同事件含义如下：

有新数据提交时：当表单中新增一条数据时推送；
有数据被修改时：当表单中数据被修改时推送；
有数据被删除时：当表单中数据被删除时推送；
有数据被恢复时：当表单中数据被恢复时推送。

全部设置完成后，点击「保存」。

注：批量修改、删除和恢复时不支持推送。

3. 注意事项

3.1 推送数据结构

数据事件推送时，数据结构定义如下：

参数	说明
op	推送事件。包括 data_create(数据提交)、data_update(数据修改)、data_remove(数据删除)、data_recover(数据恢复)
opTime	推送事件触发时间戳，精确到毫秒
data	具体数据内容

3.2 数据事件推送内容

可根据数据推送配置界面的「字段对照表及 JSON 样例」参考当前表单推送数据的格式及内容。

1）新数据提交/数据修改/数据恢复时

所属模块	字段类型	数据类型	说明
表单字段	单行文本	string	——
	多行文本	string	——
	流水号	string	表单新增流水号控件时，历史数据无流水号
	数字	number	——
	日期时间	string
	单选按钮组	string
	复选框组	array
	下拉框	string
	下拉复选框	array
	分割线		不推送
	地址	json	格式为 { “province”: “江苏省”, “city”: “无锡市”, “district”: “梁溪区”, “detail”: “清扬路 138 号茂业天地” } 如果选择了部分属性，则未选择的属性以空字符串补齐。如未选择区和地址详情时，格式为 { “province”: “江苏省”, “city”: “无锡市”, “district”: “”, “detail”: “” }
	定位	json	格式为 { “province”: “江苏省”, “city”: “无锡市”, “district”: “梁溪区”, “detail”: “清扬路 138 号茂业天地”, “lnglatXY”: [120.31237,31.49099] } 省、市、区、地址详情属性中如果只输入了部分属性，则其中未输入属性以空字符串补齐 (API 接口推送数据时可以仅输入部分属性)
	图片	array	推送数据中包含的url为图片链接，15 天内有效
	附件	array	推送数据中包含的url为附件链接，15 天内有效
	手写签名	json	推送数据中包含的url为手写签名的图片链接，15 天内有效
	子表单	array	——
	查询		不推送
	关联数据	json	——
	计算	number/string	——
	成员单选	json	status 对应的逻辑: -1 离职 0 未加入 1 已加入
	成员多选	array	status 对应的逻辑: -1 离职 0 未加入 1 已加入
	部门单选	json	——
	部门多选	array	——
	手机	json	格式为 { “phone”:“15852540044”, “verified”:false }
	流程状态(仅流程表单)	number	2 表示流程手动结束 1 表示流程已完成 0 表示流程进行中
	表单名称	string	——
	数据id	string	——
	提交人	json	status 对应的逻辑: -1 离职 0 未加入 1 已加入
	修改人	json	status 对应的逻辑: -1 离职 0 未加入 1 已加入
	删除人	json	status 对应的逻辑: -1 离职 0 未加入 1 已加入
	提交时间	string	使用 utc 时间戳，请根据所在时区处理
	修改时间	string	使用 utc 时间戳，请根据所在时区处理
	删除时间	string	使用 utc 时间戳，请根据所在时区处理
	微信OpenID	string	——
	用户昵称	string
	用户性别	string
CRM 特殊字段	客户名称	string	——
	线索池	json
	所属公海	json
	销售阶段	json
	联系人	string
	跟进主体	json
	跟进商机	json

注：字符串类型数据为空时可能为 null 或空字符串， json 格式数据为空时可能为 null 或空 json。在解析数据时，将 null、空字符串、空 json 均作为控件空值处理。

2）数据删除时

字段	数据类型	说明
formName	String	表单名称
_id	String	删除数据的 ID
deleter	json	删除操作执行人
deleteTime	String	删除时间

3.3 推送失败

当数据推送失败时，管理员会收到通知。管理员可调整配置后，在「数据推送」处点击「重新推送」，重新推送失败的数据。

注：

1）数据推送失败时，管理员可以选择重新推送失败缓存里的数据，也可以放弃缓存。失败数据仅可保留 7 天，超时后无法再进行重新推送。

2）当失败记录达到 100 条，会关闭数据推送功能，同时管理员会收到一条数据推送关闭的消息提醒，需要在数据推送设置中重新启动数据推送，数据推送才会继续推送。