数据库同步至表单插件

1. 简介

1.1 插件简介

该插件支持定时将数据库/视图中的数据同步至简道云表单中，让管理员可以使用这些数据进行表单数据关联、仪表盘分析等。且支持写 SQL 语句进行同步。

1.2 应用场景

常用于主数据同步、业务数据同步等场景。如人员、组织、客户、产品、物料等主数据同步后在表单中引用；合同、订单、费用等业务数据同步后进行数据分析等。

1.3 预期效果

开启数据库同步至表单插件，在「标准订单」表单中设置智能助手定时任务后，在指定时间自动同步数据到表单。

1.4 使用说明

1）该插件需要具有 API 权限才能使用。

2）数据库同步至表单为付费插件，请联系我们增购。插件购买流程如下所示：

2. 插件安装及配置

2.1 安装插件

1）直接安装

2）插件市场处安装

在简道云「插件市场」处，安装「数据库同步至表单」插件。插件市场处安装方法可参见文档：插件市场中【2.3 插件安装】。

2.2 配置插件

1）安装后，在「插件管理」处，点击插件右侧的「设置」按钮，根据企业数据库信息，将「简道云 API Key」、「数据库类型」、「主机地址」、「端口号」、「数据库账号」、「数据库密码」、「数据库名称」等信息配置进去，配置完成后点击确定。

2）进入「开放平台 >> 密钥管理」处，即可查看并复制对应的简道云 API key。

2.3 启用插件

在插件管理中，打开「数据库同步至表单」插件右侧开关，启用插件。

3. 表单搭建

3.1 创建表单

以订单业务为例：新建「标准订单」表单，字段设置如下所示：

3.2 设置字段别名

进入「扩展功能 >> 数据推送」中，点击设置字段别名，依次将字段别名设置为数据库对应字段的名称，设置完成后，点击「保存」按钮。设置如下所示：

4. 智能助手配置

4.1 添加智能助手

设计完表单后，在「扩展功能」处添加「智能助手」，并修改智能助手名称为「数据库同步至表单」。

4.2 设置触发动作

由于需要每日触发智能助手同步数据库数据，故「触发动作」选择「定时重复」，如下图所示：

再分别设置「触发时间」「重复类型」「重复触发结束时间」，设置完成后点击「完成」，如下图所示：

4.3 设置执行动作

该插件支持以下两种同步方式，企业可根据自己实际业务情况按需配置即可。

4.3.1 同步昨日数据

1）选择「数据库同步至表单」插件，如下图所示：

2）设置「表单」「应用 ID」「表单 ID」「数据库表名」「时间字段」，设置完成后点击「完成」，如下图所示：

4.3.2 SQL自定义同步数据范围

1）选择「数据库同步至表单」插件，如下图所示：

2）设置「表单」「应用 ID」「表单 ID」「SQL 查询语句」，设置完成后点击「完成」，如下图所示：

4.4 效果演示

效果参见本文【1.3 预期效果】。

5. 注意事项

5.1 数据库说明

1）目前仅支持 mysql/sqlserver/postgresql 数据库。如希望增加更多数据库，可通过下方联系方式联系开发者增加。

2）本地部署的数据库如具备允许公网访问的固定 IP，则可使用此插件；暂不支持公网访问的本地数据库。如您的数据库 IP 属于如下所示的局域网 IP 地址，则不支持访问：

5.2 子表数据说明

目前仅支持同步数据到表单的主表字段，当需要同时同步数据库的子表数据时，可以将数据库子表也视同为一个单独的表来定时同步到简道云的另一个表单中，同步后使用数据时，再来根据主子表的连接字段做数据的连接；

5.3 数据量限制说明

单次同步的数据条数不能超过 5000 条，若数据量比较大，可以使用 SQL 方式进行同步，设置多个智能助手，每个智能助手把时间范围再拆分细一些或者增加其他条件再来分别同步。SQL 语句无需填写 limit 或者 top，插件会自动填充限制。

5.4 同步字段说明

1）插件按照表单设置的字段别名来将数据库数据写入表单，未设置别名的字段不会同步数据，即字段值为“空”。

2）部门、成员字段暂不支持同步。

5.5 IP地址白名单

如果您的数据库允许外放访问但需要 IP 地址加白名单，请设置白名单 IP 为： 47.97.99.12。

6. 联系方式

该插件为官方合作的服务商开发，若您在使用过程中有任何疑问，可通过以下方式咨询：