数据库同步至表单插件

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 同步昨日数据

4.3.2 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。

5.6 关于定时同步数据并修改的思路探讨

5.6.1 表单搭建

1）表单搭建

如同步的数据需要进行自动修改，则需要创建两张表单。保持原来同步表单不变：下方称【数据目标表】，再复制一个中间表：下方称【数据中间表】，并在复制后的中间表中新增一个【数据状态】单行文本字段，用于后续配置使用。

2） 设置字段别名

在【数据目标表】和【数据目标表】均需设置对应数据库中的字段别名。（参考3.2）

5.6.2 智能助手配置

智能助手搭建可参考【4智能助手配置】中的步骤，在插件执行节点之后，需在后续新增循环容器节点：

1）插件节点下方新增循环容器：

2）在循环节点中添加「查询多条数据」节点：

3）在「循环节点>>查询多条数据」节点后添加「条件分支」：

4）在「分支条件」节点后添加「修改数据节点」：

5）在上述节点后再添加一个「修改数据节点」：

6）在「其他条件」节点下方新增「结束循环」，最后点击保存并启用。

5.7 其他说明

5.7.1 多国语言说明

sqlserver 数据库支持多国语言数据录入。

5.7.2 低版本兼容

增加 tds 协议，兼容 sqlserver 低版本用户。

6. 联系方式

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