Finereport10升11工具升级步骤整理

 

升级须知

1. 10-11授权变更：因大版本的授权不能共用，授权也需要升级，进行10-11前，请务必和对应的销售进行确认，否则会导致升级后授权无法使用。
2. 磁盘容量要求：由于升级工具体积较大，升级过程会对必要的文件进行解压，同时可以对 10.0 进行整体 webroot 备份，所以升级工具所在磁盘保证剩余容量大于 3G 。如果需要备份，备份路径所在磁盘保证剩余容量大于 webroot 工程大小。
3. 工程及升级工具路径：升级工具和工程所在路径不要包含较多特殊字符，可包含中文、英文、数字、英文括号、下划线、英文连接符、空格（一般不要将工程放在 C 盘内）。
4. 工程配置：10.0 工程如果配置了外置库、状态服务器、文件服务器，升级过程需要保证均可以正常连接以便更新文件。
5. 端口占用：升级过程会占用 20216 和 20217 端口。
6. 升级环境：支持断网升级，支持无 JDK 环境升级。
7. JAR 包版本：在进行升级前需要将 JAR 包升级至 2020-08-04 及之后的日期。若未将 JAR 包未升级至 2020-08-04 就使用升级工具进行升级，将会提示报错：工程版本低于2020.08.04，无法升级，建议更新后再尝试升级。
8. 插件适配：当前 FR11.0 只适配了官方插件，所以第三方插件、定制插件可能会出现升级后无法使用的情况，需要提前确认。
9. 定制情况：10.0 工程存在定制情况，比如 JAR 定制、外置库定制、二开、集成定制等，请提前与技术支持确认升级后是否兼容以及如何兼容适配。升级工具在进行 10.0 升11.0 的时候升级工具会替换 webroot\scripts 和 webroot\upm 文件夹，若在 scripts 和 upm 文件夹下存在定制文件（例如自定义的 js、css 文件）需要提前备份，再升级完成后手动复制到升级后的 11.0 工程中。

1.升级前准备https://help.fanruan.com/finereport/doc-view-4825.html

备份平台配置（必做）

备份工程文件（必做）

升级前授权处理

升级前配置外接库需要新建表空间

1.1升级风险检测https://help.fanruan.com/finereport/doc-view-4901.html?source=4

完成插件安装后进入数据决策系统，可以发现左侧目录处出现「升级检测」，如下图所示：

选择「升级检测>升级注意事项」，仔细阅读「进行系统备份」、「升级后重启」两部分内容，并根据注意事项中的内容进行系统备份，完成后即可勾选「已经阅读完上述注意事项」，进行下一步，如下图所示：

点击下一步，即将开始为您自动检测，检测完成后将在界面上显示升级检测结果，可以根据检测内容和导出的excel自行阅读检测，或是发送给技术人员协助评估。

检测内容说明：https://help.fanruan.com/finereport/doc-view-4901.html#37bde8985fcad11a

1.2备份平台配置（必做）

使用管理账号登录数据决策系统，在「管理系统>智能运维>备份还原>平台配置」中选中手动备份。默认备份路径为：.../backup，备份文件储存在工程的 %FR_HOME%/webapps/webroot/backup 文件夹下

1.3备份工程文件（必做）集群的每个节点建议都备份下

可以备份整个 tomcat，或者%TOMCAT_HOME%/webapps下的 webroot 工程包。建议可备份整个 tomcat，原来的 10.0  的工程在 tomcat 中，把 tomcat 复制一份，重命名为 tomcat11。

集群有文件服务器的，也需要把文件服务器上的WEB-INF文件进行备份。

1.4新建数据库表空间 升级前做了外接库的必做

1）如果升级前配置了外接库，升级前准备一个新的表空间，建表相关文档见：配置外接数据库 。

2）升级前不用处理外接库配置，直接升级即可。但是在升级工具处理后，平台回转为默认的内置 finedb 模式。所以为了跟原先 10 的外接库互相独立，不影响之前的表数据，建议新建一个数据库做迁移。待后续 11 运行稳定，可以将原先 10 的外接库删除。

升级工具进行处理时，不会修改外接库里的数据，而是转为内置的表进行升级的

1.5工程拿到其他的环境升级

单机的环境如果需要将工程拿到其他环境下升级，则需要将 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 完全独立，互不影响，但是不能在一个环境上同时启动（端口占用导致不能同时启动）。

1. 再对还原内置 finedb 后的 webroot 用升级工具进行升级即可。

1.6报表工程相关目录

windows系统10-11升级步骤

注意事项

1）已获取授权的 10.0 且可用的工程，升级前请先与销售联系，申请迁移授权，升级后，工程需要重新授权。

2）升级工具仅支持 JAR 包日期为 2020-08-04 及之后的 FineReport 10.0 版本进行升级。目前升级工具仅支持 10.0 版本升级至最新的 11.0.X 版本。

注）升级工具是针对报表工程进行升级，如果是用户本地的设计器，需要自行下载 11.0 版本的设计器，再远程连接到报表工程中：下载 FineReport

4）升级工具的获取以及准备工作，注意事项等

1.升级工具升级步骤

1）先将升级工具上传到服务器端

2）关闭工程后，以管理员身份启动升级工具，如下图所示：

3）将会出现前台操作面板，输入工程路径，如下图所示：

注：需要输入待升级的工程路径，是容器比如tomcat下的webroot，不是设计器目录下

1. 点击「..」，选择备份工程的路径（此步骤可跳过），如下图所示：

若不选择「备份路径」直接进行开始升级，将会出现提示：

未选择备份目录将跳过备份直接升级，请提前确认已备份原工程和配置数据，是否确认跳过备份，选择「Yes」将直接开始升级，如下图所示：

1. 点击「开始升级」，将会显示升级进度，升级成功后，将会显示 upgrade success，如下图所示：

6）手动关闭升级操作面板。

7）升级成功后，启动 Tomcat

指令切换到 tomcat/bin 目录下，双击 startup.bat 启动 tomcat（按照自己的启动方式去启动工程即可），访问决策平台，和原 10.0 的访问路径一致。

平台访问URL：http://IP:端口/webroot/decision（其中，webroot为工程名，decision为Servlet名）

模板访问URL：http://IP:端口/webroot/decision/view/report?viewlet=xxx.cpt  或者 xxx.frm

4.1迁移数据至要启用的数据库主要分为以下四种情况：

1）勾选「迁移数据至要启用的数据库」，新外接数据库为空

点击「启用新数据库」后，会将原 finedb 数据库的平台数据迁移到新外接数据库中。

2）勾选「迁移数据至要启用的数据库」，新外接数据库中已存在平台数据

点击「启用新数据库」后，跳出提示「该数据库已存在平台数据，导入数据前将清空原有平台数据，确认连接该数据库？]。

点击「确定」将清空原有平台数据，将原 finedb 数据库的平台数据迁移到新外接数据库中。

3）不勾选「迁移数据至要启用的数据库」，新外接数据库为空

点击「启用新数据库」后，跳出提示「目标数据库为新数据库，将当前数据迁移至目标数据库后方能使用」。

点击「确定」，将原 finedb 数据库的平台数据迁移到新外接数据库中。

4）不勾选「迁移数据至要启用的数据库」，新外接数据库中已存在平台数据

5. 集群升级

5.1 升级单节点后确认配置好外接数据库

1）按照文档第3节，先对节点一进行升级。

2）节点一升级好后，利用 10-11升级前准备 中建好的表空间，进行外接库迁移，参考文档中的步骤4 。

5.2 确认单节点集群配置正常

配置好外接库后，集群配置默认保留，确认节点管理无飘红即可继续进行下一步。

5.3 同步升级文件

1）关闭所有节点的tomcat，删除未升级节点 webroot 下的WEB-INF文件夹（删除前请确认已经做好备份工作）。

2）复制升级好的节点 webroot 下的WEB-INF文件夹到其他的节点（必须要在配置了外接库，开启集群后才行），并删除WEB-INF\config文件夹下的 cluster.properties 文件

3）依次启动各个节点 tomcat，启动成功后即可看到原始集群升级成功。

1. 补充说明

1）升级工具只对 Web 工程的升级，不提供对完整设计器的升级。设计器如果需要升级，可以先全新安装 11.0，然后将老设计器下的工程升级到 11.0 后，将升级后的工程拷贝到新安装的 11.0 设计器目录下（也就是将 11.0 webapps 目录中的 webroot 文件替换为升级后的工程文件）。

2）如果一个 Web 工程已经升级过，不管是否升级成功，都不要再次运行升级工具来升级。只能通过已备份的 10.0 工程重新执行升级。

3）升级工具不能跨版本升级，如 9.0 工程想升级到 11.0，需要把工程先升级到 10.0，再从 10.0 升级到 11.0。

4）若 10.0 工程已经配置 tools.jar ，则不需要重新引入 tools 工具包，相反则要将 %JAVA_HOME%/jdk/lib 下的环境变量 tools.jar 放到 %TOMCAT_HOME%/lib 和或 %TOMCAT_HOME%/webapps/工程名/WEB_INF/lib下，若不执行此步骤服务器部署过程中会报错 500。相关内容可参考：tools.jar不存在

5）升级工具支持官方的数据集类插件，支持列表如下：

6）Window 系统升级失败时，前台操作面板会提示失败显示具体的失败原因和信息。

7）10.0 升级到 11.0 时，备份默认跳过 schedule、backup、logs 三个目录，若升级失败，需要将原工程下的 schedule、backup、logs 三个文件手动拷贝到备份的目录下后，切换到备份的路径下即可正常使用。

8）日志关键字对照说明：部分升级进程关键字如下表，若有模块升级失败可对应查找关键字确认。

Linux系统10-11升级步骤

备份平台配置（必做）

备份工程文件（必做）

可以使用 cp命令和tar命令：

1. 使用 cp 命令将文件从当前目录复制到另一个目录。例如，命令 cp scenery . jpg / home / username / Pictures 将在您的 Pictures 目录中创建一个 Scene . jpg 副本（来自当前目录）。
2. 使用 tar 命令压缩 解压缩。例如： tar - zcvf boot . tgz / boot ＃将／ boot 目录整合压缩成 boot . tgz 。

解压命令： tar - zxvf boot . tgz

参数说明：- x 是解压的意思。

如果解压的同时指定解压目录可以执行以下命令：

 tar - zxvf boot . tgz - C / home / dir ＃需要使用-C 参数，后面跟上文件路径。

1.升级步骤

1）使用上传工具将升级工具上传到服务器端，升级工具选择一个目录放入即可（不要放到tomcat下面）。

2）停掉tomcat：

     ① ps -ef | grep tomcat   #查看tomcat的进程号pid ②kill -9 pid   #关闭tomcat进程（pid是刚才的查到的进程号）

     ③ ps - ef |grep tomcat查看是否有残留进程，有的话kill掉

3）切换目录到升级工具目录下。

注：FineUpgrade_v11_linux_xxx.sh 代表升级工具名称，下面代码的工具名称为示例，请根据实际情况自行修改。

4）给升级工具赋权 chmod +x FineUpgrade_v11_linux_2022-09-30-amd64-CN.sh

5）启动升级工具 ./FineUpgrade_v11_linux_2022-09-30-amd64-CN.sh

6）输入工程路径 ，可以提前准备好路径，示例：/opt/tomcat11/webapps/webroot

7）根据提示选择是否跳过备份，输入 N 则出现提示：请选择备份路径，输入备份路径后即可正常升级；

      输入Y则表示跳过备份，二次确认再次输入Y即可正常升级。

8）升级成功后出现将会显示 upgrade success。

9）升级成功后启动 Tomcat，指令切换到tomcat/bin 目录下，执行 ./startup.sh，启动成功后访问决策平台，跟原先 10.0 的访问路径一致。

平台访问URL：http://IP:端口/webroot/decision（其中，webroot为工程名，decision为Servlet名）

模板访问URL：http://IP:端口/webroot/decision/view/report?viewlet=xxx.cpt或者xxx.frm

升级过程如下图所示：

根据提示选择是否跳过备份，输入 N 则出现提示：请选择备份路径，输入备份路径后即可正常升级；

输入 Y 后回车出现提示：未选择备份目录将跳过备份直接升级，请提前确认已备份原工程和配置数据库，是否确认跳过备份，再次输入 Y 后即可正常升级，如下图所示：

2. 配置外接数据库

升级工具处理后，平台是默认的内置 finedb 模式，如果需要迁移到自己的数据库，需要重新迁移相关文档见：配置外接数据库。

请按照对应数据库的文档，严格遵循建表的编码等说明进行建表，否则会导致迁移失败。常见外接库的迁移报错如下：外接数据库配置常见问题 。

注1：升级工具不会修改原外接库里的任何数据，而是读取数据生成内置库进行升级修改的。

注2：为了跟原先 10 的外接库互相独立，不影响之前的环境，建议新建一个数据库做迁移，后续 11 运行稳定，可以将原先 10 的外接库删除。

3. 集群升级

3.1 升级单节点后确认配置好外接数据库

1）按照文档第3节，先对节点一进行升级。

2）节点一升级好后，利用 10-11升级前准备 中建好的表空间，进行外接库迁移，具体步骤参考：配置外置库

3.2 确认单节点集群配置正常

配置好外接库后，集群配置默认保留，确认节点管理无飘红即可继续进行下一步。

3.3 同步升级文件

1）关闭所有节点的tomcat，删除未升级节点 webroot 下的WEB-INF文件夹（删除前请确认已经做好备份工作），否则后续复制文件会导致10版本的文件还在，启动异常。

2）复制升级好的节点 webroot 下的WEB-INF文件夹到其他的节点（必须要在配置了外接库，开启集群后才行），并删除WEB-INF\config文件夹下的 cluster.properties 文件后，依次启动各个节点 tomcat，集群配置成功。

升级后注意事项

1. 检查jar包版本，设计器和服务器 JAR 包版本要保持一致，否则在设计时，会引发一系列的问题。
2. 检查12100端口是否开放，宕机处理工具默认的端口为 12100，没有开启会导致无法启动。
3. 检查设计器和服务器版本是否一致，不一致会导致设计器远程设计查询数据集全部报错等。
4. 检查reportlets文件权限，权限不足会导致：远程设计编辑模板触发保存按钮保存显示保存失败等问题。
5. 检查fr_webroot目录权限，权限不足会导致：插件管理，从本地安装和在线安装插件都无法安装；用户管理-用户邮箱变更保存失败；平台数据连接-测试连接全部显示失败，但设计器切换远程设计显示连接成功；备份还原-手动备份点击显示备份失败，重新切换目录在切换到手动备份下显示备份成功；授权注册重新上传文件失败；新增super admin用户会跳到普通用户的问题等。解决方法：新增Everyone权限重启服务解决。