1. 概述
本文将详细的介绍 Finereport 10.0 升级至 11.0 前,需要做的准备工作。
2. 升级工具获取与升级技术协助
2.1 升级技术协助
Finereport 大版本升级技术协助,目前由专属的升级团队负责,您可以通过提交「升级风险评估书」,做个简单的前置环境信息了解,评估书链接如下:升级风险评估书 。在提交「升级风险评估书」后会自动进入系统排队,升级团队会在您填写的预期升级时间内,主动与您取得联系,对接具体升级事宜,商务问题请联系您的销售经理进行确认。
2.2 升级工具获取
由于 FineReport 功能不断优化,产品不断迭代升级,因此升级工具也在不断更新,本文暂不提供升级工具下载链接。您可以选择直接提交风险评估书,届时升级团队会给您发放;或者联系技术支持获取。技术支持联系方式:前往「服务」,选择「在线支持」;电话:400-811-8890
3. 升级须知
1)升级前请先仔细阅读::10-11 兼容说明 。
2)10-11需要使用升级工具:FineReport 10.0 与 11.0 版本之间没有内置升级功能,用户需要使用 10-11 升级工具完成。升级工具使用可参考:10-11 升级工具 。
3)FineReport 9.0 升级 FineReport 11.0:要先升级到 FineReport 10.0,再升级至 11.0。FineReport 9.0 升级 FineReport 10.0 可参考 :FineReport 9.0 版本升级 10.0 。
4)FineReport 与 FineBI 集成使用的用户:请您在升级前仔细阅读:FineBI与FineReport版本适配说明 。
5)升级前务必备份:用户在进行升级前,为避免升级失败出现文件丢失的情况,请将所需要的文件进行备份后再升级。备份可参考:文档第4节 。
6)10-11授权变更:因大版本的授权不能共用,授权也需要升级,进行10-11前,请务必和对应的销售进行确认,否则会导致升级后授权无法使用。
7)磁盘容量要求:由于升级工具体积较大,升级过程会对必要的文件进行解压,同时可以对 10.0 进行整体 webroot 备份,所以升级工具所在磁盘保证剩余容量大于 3G 。如果需要备份,备份路径所在磁盘保证剩余容量大于 webroot 工程大小。
8)工程及升级工具路径:升级工具和工程所在路径不要包含较多特殊字符,可包含中文、英文、数字、英文括号、下划线、英文连接符、空格(一般不要将工程放在 C 盘内)。
9)工程配置:10.0 工程如果配置了外置库、状态服务器、文件服务器,升级过程需要保证均可以正常连接以便更新文件。
10)端口占用:升级过程会占用 20216 和 20217 端口。
11)升级环境:支持断网升级,支持无 JDK 环境升级。
12)JAR 包版本:在进行升级前需要将 JAR 包升级至 2020-08-04 及之后的日期。若未将 JAR 包未升级至 2020-08-04 就使用升级工具进行升级,将会提示报错:工程版本低于2020.08.04,无法升级,建议更新后再尝试升级。
13)插件适配:当前 FR11.0 只适配了官方插件,所以第三方插件、定制插件可能会出现升级后无法使用的情况,需要提前确认。
14)定制情况:10.0 工程存在定制情况,比如 JAR 定制、外置库定制、二开、集成定制等,请提前与技术支持确认升级后是否兼容以及如何兼容适配。升级工具在进行 10.0 升11.0 的时候升级工具会替换 webroot\scripts 和 webroot\upm 文件夹,若在 scripts 和 upm 文件夹下存在定制文件(例如自定义的 js、css 文件)需要提前备份,再升级完成后手动复制到升级后的 11.0 工程中。
4. 升级前准备
4.1 备份平台配置(必做)
使用管理账号登录数据决策系统,在「管理系统>智能运维>备份还原>平台配置」中选中手动备份。默认备份路径为:.../backup,备份文件储存在工程的 %FR_HOME%/webapps/webroot/backup 文件夹下。
4.2 备份工程文件(必做)
注:集群的每个节点建议都备份下。
可以备份整个 tomcat,或者%TOMCAT_HOME%/webapps 下的 webroot 工程包。建议可备份整个 tomcat,原来的 10.0 的工程在 tomcat 中,把 tomcat 复制一份,重命名为 tomcat11。
集群有文件服务器的,也需要把文件服务器上的WEB-INF文件进行备份。
4.3 新建数据库表空间
注:升级前做了外接库的必做
1)如果升级前配置了外接库,升级前准备一个新的表空间,建表相关文档见:配置外接数据库 。
2)升级前不用处理外接库配置,直接升级即可。但是在升级工具处理后,平台回转为默认的内置 finedb 模式。所以为了跟原先 10 的外接库互相独立,不影响之前的表数据,建议新建一个数据库做迁移。待后续 11 运行稳定,可以将原先 10 的外接库删除。
注1:升级工具进行处理时,不会修改外接库里的数据,而是转为内置的表进行升级的。
注2:finedb 与数据连接的区别:升级后须知 中 2.2 节
5. 正式授权预处理
升级之前,如果使用了正式的授权文件,因大版本的授权不能共用,需要对原授权进行处理,待升级成功后,再去申请新版本的正式授权。
这一步骤请联系升级小组的技术人员协助处理。
6. 工程拿到其他的环境升级
单机的环境如果需要将工程拿到其他环境下升级,则需要将 finedb 还原成内置 finedb 模式,避免新环境外接库连不上而导致升级失败。还原内置 finedb 具体操作:
1)“4.1 节备份平台配置”操作完成后,进入工程的 /webapps/webroot/backup/config/manual/ 下,找到最新的日期的文件夹(比如:2022-04-13-13:47:53,文件夹名字是手动备份的时间),其中 config.zip 里面存放的是转换为内置库模式的 finedb。
2)解压 config.zip 文件,将解压后的 finedb 文件拷贝到备份工程的 /webapps/webroot/WEB-INF/embed 中,替换掉之前的 finedb 文件夹(按照 tomcat10 为原始环境,tomcat11 为备份环境来看,就需要将tomcat11/webapps/webroot/WEB-INF/embed中的 finedb 替换掉)。
3)再进入备份 tomcat11/webapps/webroot/WEB-INF/config 目录,删除 db.properties 配置文件(该文件保存了外接数据库的配置)。
tomcat1 1完成转换为内置 finedb 模式,至此 tomcat11 和原先的 tomcat10 完全独立,互不影响,但是不能在一个环境上同时启动(端口占用导致不能同时启动)。
4)再对还原内置 finedb 后的 webroot 用升级工具进行升级即可。
7. 工程瘦身(选做)
文件夹/文件 | 文件路径以及用途 | 清理范围 |
备份文件 | 1)文件路径: 若自定义备份文件路径,则扫描自定义路径 config:平台配置备份,内含finedb jar:历史jar包备份 plugins:历史安装插件备份 reportles:历史模板文件备份
| 可删除所有文件夹下的atuo文件夹(自动备份路径) manual文件夹(手动备份)不建议清理,不然会删除我们4.1节手动备份的平台配置 |
schedule | 1)文件路径: %FR_HOME%\webapps\webroot\WEB-INF\schedule 2)文件用途: 存储定时调度任务产生的中间文件,子文件名字为定时调度的任务名称 | 如果没有访问历史结果链接的需求,直接清空即可。 或者可以选择保留最近3个月的数据。 |
treasure | 1)文件路径: | 可直接删除文件夹,升级后重启会自动生成, |
logs | 1)文件路径: | 可直接清空内容 |
FineReport 11.0 版本其他的目录使用说明,如果需要了解,请参考:报表安装目录。
此外,FineReport 11.0 版本新出了磁盘清理的功能,详情见:磁盘清理 。