1. 概述
1.1 版本
报表服务器版本 | JAR 包版本 | 插件版本 |
---|---|---|
10.0.19 | 2021-09-30 | V1.0.0 |
11.0.5 | 2022-05-10 | V1.0.0 |
1.2 应用场景
用户对于导出资源管理和导出前端体验有一些定制化需求。
针对导出文件,在导出过程中,增加验证码认证功能,保障数据安全
针对导出的excel文件,进行文件安全加固,为文件自身的安全性要求,提供了解决方案
针对导出文件,提供文件中心功能,对导出文件进行统一管理,支持文件导出到FTP服务器;
支持后台异步导出机制,防止出现前端页面卡住的情况
增加导出排队功能,防止并发过多时,可能导致的系统宕机问题
可自定义导出文件格式,如限制用户只可导出带有水印的Excel文件,提升安全性
1.3 功能描述
「导出中心」插件提供四种功能:
功能 | 简介 |
---|---|
导出认证 | 防止用户的数据决策系统账号密码泄露,而导致的恶意导出情况。 导出时,支持通过绑定的用户短信、邮箱方式,接收导出验证码。 输入正确验证码的用户,方可进行导出操作。 |
导出安全 | 1)文件加密 为了防止导出的Excel文件被无限制传播,导出后的Excel文件支持密码锁。 密码会通过邮件的方式,通知到对应的进行导出操作的用户。 2)编辑加密 为了防止导出的Excel文件被恶意篡改,模板制作者可设置编辑密码。 如需编辑导出的Excel文件单元格,必须获得模板制作者/管理员设置的编辑密码。 3)文件水印 为了溯源导出文件的下载者,导出后的Excel文件自带水印 水印内容可自定义。 |
文件中心 | 1)针对大文件导出慢,前端页面易卡住的问题,导出中心插件实现了导出资源管理功能。用户可以将文件导出到文件中心,后台异步导出的形式,确保关闭前端页面也不会有影响,导出完成会有邮件提醒。 2)后台导出能限制导出并发,增加排队导出功能,能有效防止导出并发过多导致宕机的风险。 3)导出文件管理界面,支持文件批量删除下载,文件名查询,展示文件的文件类型,文件大小等信息。 4)支持文件导出到FTP服务器 |
导出日志 | 针对导出中心整个导出过程,使用finedb表记录全过程,方便管理员监控回溯。 |
1.4 使用前提
「导出中心」插件不支持在以下情况下使用:
不支持决策报表、FVS可视化看板导出
当前仅支持常规的word、excel、pdf和图片导出方式
2. 插件介绍
2.1 插件安装
点击下载插件:导出中心插件
设计器插件安装方法请参考:设计器插件管理
服务器安装插件方法请参考:服务器插件管理
2.2 添加导出中心按钮
插件安装后,用户可在模板工具栏中增加「导出中心」按钮。
2.2.1 单张模板
对于单张模板,在「设计器>模板>模板Web属性」中,选择该模板的预览页面设置,选择「为该模板单独设置」。
勾选「使用工具栏」,双击「导出中心」,即可将「导出中心」按钮添加到该模板的工具栏中。如下图所示:
此处也可以自定义导出文件格式,在服务器设置的情况下,选择某种文件格式,添加到工具栏。这样用户只能导出该类型的文件
此时预览该模板,工具栏中会出现「导出中心」的按钮选项。用户可通过该按钮进行导出行为,相关导出行为会被导出中心进行记录/判断。
2.2.2 全局配置
该设置也可对全部模板生效,管理员只需在「服务器>服务器配置」中,在对应预览设置下,编辑工具栏,双击添加「导出中心」按钮即可。
2.3 配置导出中心属性
插件安装后,用户可在自定义配置「导出中心」相关属性。
未配置导出中心属性时,2.2节的「导出中心」按钮,与普通导出按钮没有区别。
配置了导出中心属性后,若使用2.2节的「导出中心」按钮进行导出操作,则会触发相关配置,进行验证码验证、导出文件保护等。
2.3.1 单张模板
对于单张模板,在「设计器>模板>导出中心」中,可为该模板单独设置相关属性。如下图所示:
2.3.2 全局配置
管理员也可对系统中所有模板配置导出中心属性。
管理员登录数据决策系统,点击「管理系统>导出中心>配置中心」,即可进行相关配置。如下图所示:
若使用「导出中心」按钮进行导出操作,则会触发此处的相关配置,进行验证码验证、导出文件保护等。
3. 导出认证
在使用「导出中心」按钮进行导出时,可以通过用户邮箱和短信,进行验证码认证,确保是本人执行相关操作,以防盗用账号进行导出。
本章示例:进行配置,在用户eoco使用「导出中心」按钮导出模板「GettingStarted.cpt」时,可使用邮箱/手机短信收取验证码,输入正确的验证码之后,方可进行导出。
3.1 模板设置
如需使用导出认证功能,必须确保模板工具栏中有「导出中心」按钮,且导出中心开启了「验证码认证」配置。
3.1.1 添加导出中心按钮
打开模板「GettingStarted.cpt」,点击「模板>模板Web属性>分页预览设置」,选择「为该模板单独设置」。
勾选「使用工具栏」,双击「导出中心」,即可将「导出中心」按钮添加到该模板的工具栏中。如下图所示:
3.1.2 设置导出认证
打开模板「GettingStarted.cpt」,点击「模板>导出中心>导出认证」,勾选「验证码认证」,勾选认证方式,可选「短信通知」和「邮件通知」。如下图所示:
3.2 数据决策系统设置
如需使用验证码认证,则必须保证:
1)如需使用短信通知,则必须系统配置了短信发件人,进行导出的用户配置了手机号。
2)如需使用邮件通知,则必须系统配置了邮件发件人,进行导出的用户配置了邮箱。
3.2.1 短信
1)短信发件人
发短信,需要有一个发信人,否则发送动作无法完成。每个数据决策系统的发信人是唯一的,只需要设置一次即可。
管理员登录数据决策系统,点击「管理系统>系统管理>短信」,开启「使用短信平台」,使用一个开通了「短信服务」的「帆软通行证」账户登录。如下图所示:
注1:绑定的帆软通信证需要开启短信服务,且充值一些账户余额,否则无法成功发送短信,具体请参见:短信。
注2:配置完成后,请点击「发送测试信息」,确保该手机号可使用。
2)短信收件人
发短信,需要有一个收件人,否则短信无法发送给任何人。
因此进行导出操作的用户,在数据决策系统中的用户信息,若未绑定手机,则短信无法成功发送。
3.2.2 邮箱
1)邮箱发件人
发邮件,需要有一个发件人,否则发送动作无法完成。
管理员登录数据决策系统,点击「管理系统>系统管理>邮箱」,配置发件人账户,点击「保存」,如下图所示:
设置定时调度任务时,发件人处默认选择「系统默认发件人」,可下拉选择其他发件人。
注1:发件人邮箱类型不同,配置步骤可能不完全相同,具体请参见:邮箱。
注2:配置完成后,请点击「发送测试邮件」,确保邮箱可使用。
2)邮箱收件人
发邮件,需要有一个收件人,否则邮件无法发送给任何人。
因此进行导出操作的用户,在数据决策系统中的用户信息,若未绑定邮箱,则邮件无法成功发送。
3.3 效果预览
由于验证码认证需要发送验证码给用户的邮箱和短信,则必须保证:用户对模板进行导出操作时,登录了数据决策系统。
eoco(eoco,123456)登录数据决策系统,访问挂载到目录中的「GettingStarted.cpt」模板。
使用「导出中心」按钮进行任意一种导出格式,跳出弹窗提示输入验证码。
此时邮箱/手机会收到数据决策系统发送的随机验证码,输入之后点击「确定」,即可触发下载。如下图所示:
收到的验证码邮件和短信如下图所示:
邮件:
短信:
4. 安全设置
为了防止用户随意分发和恶意编辑,对于导出后的Excel文件,支持文件打开密码限制、编辑单元格密码保护、文件水印保护。
本章示例:进行配置,用户eoco导出模板「GettingStarted.cpt」的Excel格式文件后:通过邮箱获取打开文件的随机密码;编辑单元格时需要输入预设密码;Excel文件中存在水印。
4.1 模板设置
如需使用导出认证功能,必须确保模板工具栏中有「导出中心」按钮,且导出中心开启了「安全设置」配置。
如需使用「Excel单元格编辑保护」,需要选择需要被保护的单元格。
如需使用「Excel导出水印」,需要设置模板水印。
4.1.1 添加导出中心按钮
打开模板「GettingStarted.cpt」,点击「模板>模板Web属性>分页预览设置」,选择「为该模板单独设置」。
勾选「使用工具栏」,双击「导出中心」,即可将「导出中心」按钮添加到该模板的工具栏中。如下图所示:
4.1.2 设置安全设置
打开模板「GettingStarted.cpt」,点击「模板>导出中心>安全设置」,勾选「启用Excel导出增强」。
勾选需要开启的保护机制,包括「Excel2007文件保护」、「Excel单元格编辑保护」和「Excel导出水印」。如下图所示:
4.1.3 选择编辑保护生效单元格
如需使用「Excel单元格编辑保护」,需要选择需要被保护的单元格。
对于模板的销售总额总计(D5单元格),需要限制编辑。因此选中D5单元格,点击「Excel单元格编辑保护」,勾选「启用」。如下图所示:
开启单元格保护之后,模板中未灰化的单元格默认使用保护样式,不可编辑
4.1.4 设置模板水印
如需使用「Excel导出水印」,需要设置模板水印。
打开模板「GettingStarted.cpt」,点击「模板>水印」,选择「为该模板单独设置」。
设置水印内容为$fine_username + now(),点击「确定」,如下图所示:
4.2 数据决策系统设置
如需使用「Excel2007文件保护」,则必须保证:系统配置了邮件发件人,进行导出的用户配置了邮箱,用于接收文件打开所需的随机密码。
1)邮箱发件人
发邮件,需要有一个发件人,否则发送动作无法完成。
管理员登录数据决策系统,点击「管理系统>系统管理>邮箱」,配置发件人账户,点击「保存」,如下图所示:
设置定时调度任务时,发件人处默认选择「系统默认发件人」,可下拉选择其他发件人。
注1:发件人邮箱类型不同,配置步骤可能不完全相同,具体请参见:邮箱。
注2:配置完成后,请点击「发送测试邮件」,确保邮箱可使用。
2)邮箱收件人
发邮件,需要有一个收件人,否则邮件无法发送给任何人。
因此进行导出操作的用户,在数据决策系统中的用户信息,若未绑定邮箱,则邮件无法成功发送。
4.3 效果预览
由于验证码认证需要发送验证码给用户的邮箱,则必须保证:用户对模板进行导出操作时,登录了数据决策系统。
eoco(eoco,123456)登录数据决策系统,访问挂载到目录中的「GettingStarted.cpt」模板。使用「导出中心」按钮进行excel格式导出。如下图所示:
导出之后,数据决策系统会即刻通过邮箱发送文件随机密码,如下图所示:
打开导出的excel文件时,会弹出密码输入框,填写邮件接收的密码,即可打开文件。如下图所示:
Excel文件中可以看到设置的水印。如下图所示:
当试图对总计单元格进行编辑时,弹出提示:
5. 文件中心
一般情况下,用户进行导出操作后,导出的文件直接保存到浏览器客户端。
但是大文件导出慢,容易有宕机风险的问题,用户可以将文件导出到文件中心,存储在服务器端。
1)后台导出的形式,确保关闭前端页面也不会有影响,导出完成会有邮件提醒。
2)限制导出并发,增加排队导出功能,能有效防止导出并发过多导致宕机的风险。
3)导出文件管理,支持文件批量删除、下载,文件名查询,展示文件的文件类型,文件大小等信息。
4)排队监控管理,管理员可查看当前系统中待导出的文件信息。
5.1 存储设置
5.1.1 配置存储设置
对于需要存储到文件中心的模板,需要开启「存储到文件中心」的设置。
打开模板「GettingStarted.cpt」,点击「模板>导出中心>导出认证」,勾选「保存到导出中心」,勾选通知方式,可选「短信通知」和「邮件通知」。如下图所示:
5.1.2 使用前提
注意事项1:
由于导出结束后需要发送通知给用户的邮箱/手机,则必须保证:
1)如需使用短信通知,则必须系统配置了短信发件人,进行导出的用户配置了手机号。
2)如需使用邮件通知,则必须系统配置了邮件发件人,进行导出的用户配置了邮箱。
请参考本文3.2节进行配置。
注意事项2:
由于导出结束后文件存放在数据决策系统服务器中,需要依靠用户名方可查询本人导出的文件。
则必须保证:用户对模板进行导出操作时,登录了数据决策系统。
5.1.3 导出结束通知
当文件导出结束后。
1)模板预览页弹窗提示:
点击可跳转到文件中心,查看已导出文件列表。
2)邮件通知:
点击可跳转到文件中心,查看已导出文件列表。
3)短信通知:
短信通知文件导出成功。用户可在浏览器端访问文件中心。
5.2 文件中心使用
上一节介绍了文件可以导出到文件中心,在文件中心的管理页面,可查看用户设置保存到导出中心的全部文件,并且支持文件的批量下载、删除。
文件中心入口:决策平台右上方位置,如下图所示
文件中心地址格式:http://ip:端口/工程名/decision/exportcenter/filecenter/main,页面如下图所示:
支持功能点:
根据文件名(文件类型)、导出时间、文件大小查询对应的文件。默认查询条件为当前时间往前7天导出的全部文件
单文件下载和删除,点击每个文件后的下载和删除选项,即可实现对应功能
批量下载和删除,先勾选需要进行操作的文件,再点击工具栏的删除和批量下载即可
可查看导出失败文件的信息
等待导出的任务支持手动/批量取消
5.3 文件中心管理
5.3.1 文件中心网址配置
在系统管理—常规中,可自行进行导出中心的文件中心网址配置,目前有以下2种情况
文件中心网址为域名链接,则此处配置为域名格式;因为导出中心默认获取的是IP地址
文件中心网址为https链接,则此处配置为https格式;因为https在负载均衡上进行配置,但后端服务器收到的仍然是http请求,所以导出中心默认获取的仍是http链接
5.3.2 文件中心配置
除上一节提到的在文件中心中,用户可对自己导出的文件进行统一管理外。文件中心本身还有很多其他配置项,管理员可以进行全局配置。
管理员登录数据决策系统。点击「管理系统>导出中心>配置中心>文件中心配置」,可进行如下设置:
配置项 | 说明 |
---|---|
并行任务数配置 | 针对导出文件,可限制同时导出的任务数量,多余任务需要排队等待导出执行 |
文件清除配置 | 针对导出文件,可设置定期自动清除,也可手动清除 |
文件存储仓库配置 | 文件导出保存到导出中心时,后台会存储文件的基本信息和实际的文件。 文件的基础信息存储在finedb的fine_plugin_exportCenter_File表中 文件默认存储在报表工程的WEB-INF/filcenter目录下; 同时支持保存到FTP服务器 |
5.3.3 排队监控
针对多文件导出的场景,当导出任务数超过设置的并行限制数时,存在部分导出排队情况。
管理员登录数据决策系统。点击「管理系统>导出中心>排队监控」,可查看导出进度,如下图所示:
6. 其他
6.1 URL直接导出
对于不通过数据决策系统目录查看导出的情况,导出中心也支持通过URL直接导出,采用的是默认的URL功能,可参考:URL直接导出报表
使用前提:
如需使用URL直接导出,则该模板不可开启「导出认证」、「安全设置>Excel文件保护」相关功能。
仅可开启「安全设置>Excel单元格编辑保护」和「安全设置>Excel导出水印」设置。
使用说明:
导出中心的format参数的固定值为export_center,使用exportType参数区分导出类型。
所以直接导出地址为:http://ip:port/webroot/decision/view/report?op=export&viewlet=模板路径&format=export_center&exportType=导出类型
各种导出方式对应的exportType参数值如下表所示:
文件类型 | exportType参数值 | |
---|---|---|
Word | WORD_PLUS | |
PDF_PLUS | ||
Excel | 分页导出 | EXCEL_PLUS_PAGE |
原样导出 | EXCEL_PLUS_SIMPLE | |
分页分sheet导出 | EXCEL_PLUS_SHEET | |
图片 | PNG | IMAGE_PLUS_PNG |
JPG | IMAGE_PLUS_JPG |
6.2 导出日志
通过「导出中心」按钮进行的导出操作行为,均记录在finedb的指定表中。
1)exportCenter_record 记录使用导出中心导出的数据
字段 | 定义 |
---|---|
ID | 唯一标志,主键 |
OPERATETIME | 导出时间 |
OPERATETYPE | 导出的文件位置
|
OPERATEUSER | 导出的数据决策系统用户名 |
FILENAME | 导出的文件名称 |
FILETYPE | 导出的文件类型 |
2)exportCenter_manager_record 记录针对文件中心的操作
字段 | 定义 |
---|---|
ID | 唯一标志,主键 |
OPERATETIME | 操作时间 |
OPERATETYPE | 操作类型
|
OPERATEUSER | 操作的数据决策系统用户名 |
FILEID | 被操作的文件ID 即fine_plugin_exportCenter_File中的记录的文件id |
FILENAME | 被操作的文件名称 |
FILETYPE | 被操作的文件类型 |