1. 概述
1.1 版本
报表服务器版本 | 功能变更 |
---|---|
10.0 | - |
10.0.19 | 支持关闭部分插件的自动更新 新增插件完整性校验功能 |
1.2 应用场景
用户需要插件实现某一功能时,可在设计器中下载插件进行使用。
注1:服务器中下载插件可参考: 服务器插件管理
注2:当设计器远程连接服务器时,服务器如需使用某插件功能,则服务器端和设计器端均需安装该插件,且插件版本需保持一致,方可正常使用。
1.3 功能简介
插件管理界面提供可视化界面安装、删除、更新、禁用、启用插件。在 FineReport 设计器中点击「服务器>插件管理」,如下图所示:
插件管理支持以下特性:
1)支持热部署,安装、删除、更新、禁用、启用不需要重启。
2)配置 License 不需要重启。
3)自动安装和更新插件的依赖(包括插件之间的依赖关系)。
4)自动删除不再使用的文件和服务依赖。
5)远程环境下自动检测插件是否匹配,并实时同步插件的运行状态。
注:自 FineReport 9.0 开始,「防宕机插件」和「新图表插件」已内置,无需安装。
2. 安装插件
插件安装有两种方式,第一种是从插件商城安装,第二种是从本地安装。本章以安装「日期移动端日历样式」插件为例,介绍设计器中安装插件的步骤。
注1:设计器安装插件先 切换工作目录 至本地目录,否则服务器菜单内没有「插件管理」选项。
注2:FineReport 9.0、FineReport 10.0 中插件支持热部署,安装不需要重启即可生效。
注3:插件安装成功后,插件文件保存在 %FR_HOME%\webapps\webroot\WEB-INF\plugins 文件夹中。
2.1 插件商城安装
1)设计器安装插件,必须确保设计器 切换工作目录 至本地目录。远程连接远程服务器时,服务器菜单内没有「插件管理」选项。
2)在 FineReport 设计器中点击「服务器>插件管理」,搜索框输入插件名称进行搜索,选中需要安装的插件,点击「安装」,如下图所示:
3)插件安装成功后,弹出安装成功弹窗。如下图所示:
2.2 本地安装
当无法联网的时候,可以通过本地安装来安装插件。
1)使用其他可以联网的电脑在 帆软市场 中下载插件,得到的压缩包如下图所示:
2)设计器安装插件,必须确保设计器 切换工作目录 至本地目录。远程连接远程服务器时,服务器菜单内没有「插件管理」选项。
3)在FineReport设计器中点击「服务器>插件管理」,点击「从本地安装」按钮,选择已下载(准备)的插件的.zip压缩包,如下图所示:
注:请勿解压上文得到的压缩包,直接安装即可。
3. 禁用/启用插件
在 FineReport 设计器中点击「服务器>插件管理」,点击「禁用/启用」按钮,提示:插件已被禁用/插件已被启用。如下图所示:
4. 删除插件
在 FineReport 设计器中点击「服务器>插件管理」,选中要删除的插件,点击「删除」按钮,点击弹窗上的「确定」按钮。如下图所示:
5. 更新插件
在 FineReport 设计器中点击「服务器>插件管理」,选中需更新的插件,点击「更新」按钮,点击弹窗上的「确定」按钮。如下图所示:
6. 注意事项
6.1 插件功能无法使用
问题描述:
平台(服务器端)安装插件后,设计器端无法使用。
原因分析:
对于设计器和服务器都会用到的插件,要求服务器端和设计器端都要安装:
1)若服务器端安装了插件,设计器端没有安装插件,则插件不会生效,需要切换到本地进行插件安装。
2)若服务器端和设计器端均安装了插件,服务器端的插件下载、删除、禁用不会立即生效,需要等几分钟才会生效。
3)若服务器端和设计器端均安装了插件,设计器切换到本地,禁用该插件,不影响远程连接时服务器端的插件使用。
4)若服务器端和设计器端均安装了插件,服务器端的插件不生效,需要确认服务器端和设计器端的插件版本是否一致,版本一致可正常使用。
6.2 没有插件商店的资源
问题现象:
点击插件中心时,提示:您还没有插件商店的资源,是否下载?如下图所示:
解决方案:
可以直接点击「确定」,或将可用设计器中的%FR_HOME%\webapps\webroot\scripts文件夹拷到相应的工程中,如下图所示:
6.3 插件商店有新版本,是否更新
在 FineReport 设计器中点击「服务器>插件管理」,有时会弹窗提示:插件商店有新版本,是否更新?此时更新的是帆软商城中插件,不会更新已安装的插件,点击「确定」按钮即可。如下图所示:
6.4 关闭插件自动更新功能
「宕机处理」、「云端运维」等插件,在工程启动时、启动一段时间后、每晚 23 点会自动检测插件版本并更新。
10.0.19 及之后版本的报表工程,超级管理员可通过「fine_conf_entity可视化配置插件」关闭此类插件的自动更新。重启服务器后设置生效。
注:修改 FineDB 数据库表字段值的方法请参考 FineDB 常用表字段修改 。
参数名 | 参数描述 | 参数值 |
---|---|---|
UpdateConfig.launchSwitchMap.plugins | 插件自动更新的启动更新是否开启 | 如需关闭工程启动后的插件自动更新,请将参数值修改为false,否则无需改动 |
CronUpdateConfig.typeMap.plugins | 插件自动更新的定时更新是否开启 | 如需关闭工程启动后每晚11点的外网更新插件,请将参数值修改为false,否则无需改动 |
DelayUpdateConfig.delaySwitchMap.plugins | 插件自动更新的延迟更新是否开启 | 如需关闭工程启动后延迟一段时间的插件自动更新,请将参数值修改为false,否则无需改动 |
6.5 插件完整性校验
功能说明:
本地安装/手动安装插件时,为了防止恶意篡改插件包中的代码,10.0.19 及之后版本的工程提供插件完整性校验功能。该功能默认开启。
下载安装/本地安装插件时,若该插件未通过完整性校验,则提示「XXX插件安装包签名损坏,存在安全风险,无法安装」。如下图所示:
解决方案:
如需关闭插件包完整性校验,管理员可通过修改finedb中的PluginFileValidateConfig.fileValidateOpen字段值为false。
如需开启插件包完整性校验,但仍必须要安装某个签名无法通过校验的插件(例如二开插件),则可通过手动安装的方式安装插件。
详情请参见:第三方插件安装失败说明