1. 版本编辑
报表服务器版本 | JAR 包 | 报表对接简道云插件版本 |
---|---|---|
10.0 | 2019-05-20 | V1.5 |
2. 描述编辑
2.1 软件简介
1)简道云简介
简道云:简道云是领先的 SaaS 提供商,借助其强大易用的功能,为用户提供极其方便的在线数据管理、协作服务,几乎不需要任何技术基础就可以快速构建数据应用。
2)性能对比
FineReport 和简道云在使用场景下各有优劣。简道云在支撑业务部门的新增的数据采集场景有其灵活方便的优势,而 FineReport 在展现上的灵活和丰富上又是无与伦比的。
2.2 应用场景
通过报表对接简道云插件,强强结合,能提供给客户更好的解决方案。支持将简道云的数据通过 FineReport 抽取到用户的私有库中,并基于 FineReport 制作展现形式更为丰富的报表。当简道云开启推送后,FineReport 会随着简道云的数据更新而更新。
2.3 功能简介
可将简道云中的数据通过 FineReport 抽取到私有库中。并且当简道云开启推送后,FineReport 会随着简道云的数据更新而更新。
注:如果报表工程内存在 %FR_HOME%/webapps/webroot/WEB-INF/lib/commons-codec-1.6.jar,则需要删除。
3. 操作步骤编辑
3.1 安装插件
插件名称:报表对接简道云 。点击下载插件:fr-plugin-integrate-jdy-1.5.zip
设计器插件安装方法参照 设计器插件管理
服务器安装插件方法参照 服务器插件管理
安装完成后,默认插件启用,管理员登录决策系统,管理系统里新增标签「简道云对接」,插件安装成功。如下图所示:
3.2 简道云账户中心创建 API Key
在登录简道云且购买的情况下,API Key 即简道云密钥(若没有看到 API Key,点击创建 API Key 即可),如下图所示:
3.3 简道云表单开启数据推送(Webhook)
数据推送(Webhook)可将表单数据推送到 FineReport 服务器,功能介绍及使用说明请查看帮助文档
注:这里 FineReport 报表服务器需要外网可以访问
1)登录简道云,选择一个表单,点击扩展功能>数据推送>新建数据推送,选择模板服务器:FineReport 服务器。
2)填写服务器地址,例如http://www.finereporthelp.com:8181/xxx/ReportServer?op=fs_jdy
3)点击「服务器连接测试」,若连接失败提示失败的原因,点击保存。如下图所示:
4)设置完成,如下图所示:
注:这一步必须成功才可以,如果推送失败,简道云会重试最多 5 次。如果连续重试 5 次均失败,该表单的数据推送功能将被关闭,管理员将会获得消息通知。管理员需要在数据推送设置中重新启动数据推送,数据推送才会继续。
这样这一张表单开启 Webhook 就完成了,需要同步的表单,都需要开启 Webhook 。
3.4 FineReport 插件同步表单数据
3.4.1 配置关联第一次同步数据
1)点击管理系统>简道云对接>数据同步>配置关联,填写简道云密钥,填写私有库的信息:包含驱动、地址、用户名、密码。如下图所示:
注:私有库暂时只支持 MYSQL 数据库
2)点击「开始连接」,连接成功后,点击「开始同步」,弹出「同步成功」,如下图所示:
3)同步成功后可以看到「关联成功」,同时简道云里的表单也同步到私有库里,如下图所示:
3.4.2 修改私有库表名
1)第一次配置私有库时,可以重命名,如下图所示:
2)配置成功后,可以实时拉取到需要同步的表,双击私有库表名,重命名,点击同步表单即可,如下图所示:
3.4.3 同步表单/表单数据
1)简道云设置
简道云设置推送后,表单就是实时同步的。如未设置推送,仅在数据决策平台设置了联库,则需要手动点击同步表单更新。如下图所示:
2)FineReport 服务器设置
同步表单:同步表结构的变化,包含数据库表的增删改和表字段的增删
同步表单数据:同步表内容的变化,包含表内容的增删改
勾选需要同步的简道云表单名,然后点击同步表单/同步表单数据,如下图所示:
3.5 运行监控
切换到运行监控标签页,只监控表结构的变化,包含数据库表的增删改和表字段的增删,不需要记录具体表数据的变化,如下图所示:
4. 注意事项编辑
1)MYSQL 数据库同步含有 emoji 的文本会出错,需要先把 MYSQL 数据库改成 utf8mb4 编码。
2)如果简道云传过来的是数组,FineReport 转化成字符串,用","分隔;
如果有子表单,报表对接简道云插件 V1.5 及之后的版本支持解析子表单,如下图所示:
3)配置存储
a. 私有库相关的配置信息存储到 jdyconfig.xml 中,xml在插件所处文件夹下,例如/WEB-INF/plugins/plugin-com.fr.plugin.third.integrate.jdy-1.0/jdyconfig.xml
b. 表单和表名的对应关系存储到数据库里(同步的 MYSQL 数据库里)
在私有库配置成功后,数据库中新增表JDY_CONFIG(如果已存在则加数字编号,从 0 开始),表结构如下:
字段 | 含义 |
---|---|
id | 主键 |
jdyformid | 简道云表单 id |
jdyformname | 简道云表单名称 |
frtablename | FineReport私有库表名称 |
c.表字段的 ID 和实际名称的对应关系存储到数据库(同步的 MYSQL 数据库里)
数据库中新增表 JDY_FIELD_CONFIG(如果已存在则加数字编号,从0开始),表结构如下:
字段 | 含义 |
---|---|
id | 主键 |
jdyformid | 简道云表单id |
jdyfieldid | 简道云字段id |
jdyfieldname | 简道云字段名称 |
表 JDY_FIELD_CONFIG 中存在以下固定字段 ID:
字段ID | 含义 |
---|---|
creator | 提交人 |
updater | 修改人 |
deleter | 删除人 |
createTime | 提交时间 |
updateTime | 更新时间 |
deleteTime | 删除时间 |
flowState | 流程状态 |
ext | 扩展字段 |