1. 概述编辑
1.1 版本说明
报表服务器版本 | 插件版本 | 自定义加载项版本 | 系统要求 | office要求 | 功能变动 |
---|---|---|---|---|---|
11.0 | 1.0.12 | 1.0.0 | Windows | office 2013 及以上 / WPS 2019 专业版 | 新增 Word 报告功能 |
注:该功能只支持普通报表,也就是 .cpt 报表。
1.2 应用场景
场景一:
将数据分析的结果转成 Word 报告是比较常见的业务需求,但是如果直接将报表导出为 Word 有时候并不合适。
因为正式的报告其实对内容和排版都是有较高要求的,比如想要在报告里面加描述性的语句来对指标进行分析,或者对字体和段落格式有固定要求。
如果直接将报表导出为 Word ,这个 Word 文件只有报表自身的内容,且 Word 格式和排版都是默认的,无法控制。
场景二:
报告中涉及到大量的数据指标,如果每次都要手动去改这些数字,麻烦不说还容易出错。
例如下图的空气质量监测报告,其中红字是数据指标,每个月都会改变,黑字都是固定格式的套话,不需要改动。怎么可以让这样的报告每个月自动生成呢?
FineReport方案:
FineReport 新推出的 Word 报告插件采用「Word+设计器」的设计模式。
设计器里的数据集字段、参数、公式、图表、表格等称之为资源,这些资源的准备或设计都是在设计器里面完成。
Word 里面可以直接插入这些资源,然后对这些资源的格式和排版进行调整,进而实现导出固定格式的 Word 文件。
在预览 Word 报告模板时,可以直观看到报告的最终效果,且支持原样导出该 Word 报告。预览效果如下图所示:
2. 环境准备编辑
使用 Word 报告功能需要给报表服务器安装一个插件,同时还要给 office 软件安装一个自定义加载项。点击此处获取两个安装包:FineWord
2.1 安装插件
得到插件安装包 fine-plugin-com.fr.plugin.widget.word 后直接本地安装即可。
设计器插件安装方法参照:设计器插件管理
服务器安装插件方法参照:服务器插件管理
2.2 安装自定义加载项
得到 fineWord.exe 后,直接双击安装即可。
打开 Word 软件,上方功能区出现 FineReport 即代表加载项安装成功,如下图所示:
3. 制作报告编辑
2.1 配置服务器地址
新建一个空白 Word 文档,点击功能区域的「FineReport」,再点击「服务器配置」设置项,弹出的「FineReport地址」对话框填写报表服务器地址。
下图连接的是设计器内置服务器,地址为:http://localhost:8075/webroot/decision,如果是远程设计环境,需要填入远程设计服务器地址。最后点击「保存」即可。
这样 Word 就已经连接到了报表服务器,后面可以跟设计器一起联动设计报告。
2.2 登录服务器
上面配置服务器地址点击「保存」后,会自动弹出登录界面,也可以使用左上角的「登录」设置项进入登录界面。
如果是远程设计,则账号的登录权限跟 远程设计权限 保持一致,无远程设计权限的用户无法登录,且提示:无远程设计权限,若要进行远程设计,请管理员开启权限后登录。
登录的用户名和密码跟决策平台配置的用户名和密码相同,且登录时「保持登录状态」暂不可用,也就是每次重新打开 Word 后,要重新登录。
登录后左上角「登录」变为「注销」,点击可注销账号。
且文档左侧出现资源列表,这里显示跟这个 Word 关联的普通报表中的数据集、参数、图表等资源,可以添加到 Word 中。
当然下图中由于还没有到配置关联这一步,所以资源列表是空的。点击左上角「数据列表」可以隐藏或打开资源列表。
2.3 关联普通报表
数据集、参数、图表这样的资源是添加在报表里面的,那么如何让 Word 也使用这些资源呢?
这就需要将当前 Word 文档跟普通报表关联起来,这样 Word 就可以使用报表里面的资源了。
点击「FineReport」加载项下的「保存」,在报表工程下新建一个跟这个 Word 文档关联的普通报表。
选择报表路径并给模板命名后,点击「确定」,弹出「上传成功」对话框,表示创建关联模板成功。
这时回到设计器,点击报表管理面板的刷新按钮,就可以看到新建的普通报表了。
双击进入模板,可以看到 A1~K60 已经合并为一片区域。这个区域是 Word 占用的,预览模板时,可以在这个区域展示 Word 的实时内容。
报表相关内容在这片区域的右侧或下方设计即可,报表设计出来的内容是可以被 Word 直接引用的哦。
2.4 准备资源
在 test.cpt 中新建两个数据集:
ds1 的 SQL 语句为:SELECT * FROM 销量
ds2 的 SQL 语句为:SELECT SUM(销量) AS 销售总量 FROM 销量
并在 L1~N2 区域设计一个表格,将数据集中字段拖到对应单元格中,如下图所示:
普通报表中准备好资源后,一定要点击「保存」报表,这样在 Word 中点击资源列表的「刷新」按钮,就可以让这些资源显示在资源列表处,如下图所示:
注:也就是说只要在报表中改动了一些资源,想要在 Word 中刷新生效,就一定要先保存这张报表。
2.5 插入资源
此处只展示往 Word 中插入数据集字段、公式、报表区域,其他类型的资源后面会介绍。
首先是插入公式实现动态标题,让 Word 标题里的日期一直是今天,在正文处输入文本:{{=FORMAT(today(),"yyyy年MM月dd日")}}销售报告,文本中包含公式和普通文字。
插入公式的方法:把光标放在要插入公式的地方,点击左上角「公式」按钮,光标处会出现{{=}},在等号后面输入公式即可。操作如下图所示:
注:暂未支持所有 FineReport 公式,存在个别公式插入后不生效的情况。
插入数据集字段的方法:左侧资源列表将数据集展开,双击或拖拽字段,即可将字段添加到 Word 光标处,操作如下图所示:
可以将报表中一片表格区域插入到 Word 中。
插入方法:把光标放在要插入的地方,点击左上角「报表区域」按钮,弹出「插入报表区域」对话框,输入表格左右范围即可。操作如下图所示:
2.6 预览文档
Word 端和设计器端都可以直接预览报告的效果,入口分别如下:
1)Word 端
点击「FineReport」加载项下的「保存」,再点击「预览」即可。
这里的预览其实就是预览那个关联的普通报表,预览界面左侧是 Word 内容的 PDF 展示,右侧是我们设计时添加的资源。
注:只要改动了 Word 想要预览时生效,就一定要先点「保存」再点击「预览」,否则改动不会生效。
2.7 导出Word
当我们需要将 Word 导出到本地,发送给领导或者其他用户时,只需要在预览页面工具栏点击「导出>使用新插件导出>word导出」即可,如下图所示:
4. 资源插入方法编辑
4.1 插入公式
把光标放在要插入公式的地方,点击左上角「公式」按钮,光标处会出现{{=}},在等号后面输入公式即可。如下图所示:
开发须知:
1)插入公式时不需要格式嵌套,例如:
插入一个单元格的写法是:{{=M3}}
此时如果想要对这个单元格求和,正确的写法是:{{=SUM(M3)}}
求和公式括号里面的单元格不要再加公式格式了,也就是不要错写成:{{=SUM({{=M3}})}}
2)插入公式是支持引用层次坐标的,例如:
插入一个绝对层次坐标:{{=B2[A2:2]}}
4.2 插入单元格
可以用公式按钮,也可以直接手写,在{{=}} 的等于号后面写单元格即可,如下图所示:
4.3 插入数据集字段
现在关联的那张报表里面添加数据集,然后保存这张报表,之后回到 Word 点击资源列表的刷新按钮,刷新后数据集就会出现在资源列表处。
左侧资源列表将数据集展开,双击或拖拽字段,即可将字段添加到 Word 光标处,如下图所示:
4.4 插入报表区域
报表区域其实就是表格,把光标放在要插入的地方,点击左上角「报表区域」按钮,弹出「插入报表区域」对话框,输入报表中表格左右范围。
这样就可以把一片区域单元格插入到 Word 中,如下图所示:
4.5 插入自定义参数
可以直接在 Word 中自定义参数,这样下文可以直接引用这个参数,这样就不用进行二次复杂计算了。
这个参数可以直接用公式来定义,如下图所示:
预览效果如下图所示:
4.6 插入图表
在关联的那张报表中设计图表,然后保存报表。
回到 Word ,点击左侧资源列表的刷新按钮,在图表栏会出现图表资源,展开后双击将图表添加到 Word 中,如下图所示:
注:图表资源只能双击不支持拖拽哦,这个跟数据集字段有区别,需要注意。
4.7 参数面板查询
给关联的那张报表添加参数,然后在参数面板,给参数添加控件,实现查询效果,保存报表,如下图所示:
Word 中插入报表区域,参数面板查询时,左侧 Word 内容预览区域也会跟随改变,效果如下图所示: