1. 概述
1.1 适用版本
适用于 5.1.5-5.1.18版本升级。
注：FineBI 5.1.19及之后版本适配 FineReport 11.0.1，因此提供单独的升级工具。
如需将 BI 工程升级至 5.1.19 以及之后的版本，请参考：5.1.19后的版本升级指南
1.3 升级前准备
2. 升级步骤
2.1 进行系统备份
注：版本升级不支持直接回退lib文件，请务必进行备份完成后再执行升级；5.1.14 以及之后的版本重启后会检测配置与 JAR 版本是否一致，如检测不匹配将无法正常启动，需替换同版本lib在进行重启。
进入「管理系统>智能运维>备份还原」，在「平台配置」、「报表模板」、「BI模板」、「jar 包」、「插件」 Tab 栏下分别点击「手动备份」，如下图所示：
若「管理系统>智能运维>备份还原」页面提示为当前环境为内置库不支持备份还原功能，表示该工程为旧版本 BI，暂不支持平台备份，需手动将%FineBI%/webroot/WEB-INF下的 dashboards、embed、lib、plugins、reportlets、resources 六个文件夹拷贝到%FineBI%/webroot/backup目录下。更多详情信息见：备份还原
自动备份方法：
若不想每次进行都手动进行备份，5.1.13 之后的版本支持在升级过程中自动进行备份。
使用 FINE_CONF_ENTITY可视化配置 插件，点击「管理系统>系统工具」，选择「自定义参数配置」，输入系统参数名「BIUpdateConfig.autoBackup」和系统参数值「true」，点击保存，如下图所示：
则会在升级时自动判断是否有升级当天的外接数据库备份，若没有则会在升级前自动进行备份。
注：自动备份只备份外接数据库，是用于防止忘记备份外接数据库的情况，若需要回退还是需要手动备份的 webroot 文件夹，详情参见：跨版本升级后回退至原版本
2.2 新建 newJarPath 文件
如果你的 BI 工程使用了单点登录或者二次开发相关的插件，请执行该步骤。
此步骤是为了检测升级后插件依赖是否会丢失，如果升级后插件不能使用，则会在风险项中提示：请先删除插件，升级后安装最新插件。
注：由于二次开发插件较多，不保证所有插件问题均被检测出来，此项仅收集部分已知问题。
在 BI 安装目录的 WEB-INF目录下新建一个 newJarPath 文件夹作为检测目录，将要升级的新版本 BI 的 Jar 包放到检测目录，如下图所示：
若插件依赖缺失，会在 2.3 节检测项中提示。
2.3 运行升级工具执行升级检测
1）点击 「BI 升级」进入BI升级界面，升级工具会先进行系统升级前检测，将升级中存在的风险项列出，进入「升级注意事项」，阅读注意事项并点击「下一步」，如下图所示：
确认完成工程备份后，点击「确定」，如下图所示：
进入「系统升级检测」，系统自动检测风险项，可以导出查看升级详情，如下图所示：
风险项分为三类：升级阻塞项和升级建议项，如下所示：
| 风险项 | 说明 |
|---|---|
| 升级阻塞项（BLOCK） | 该检测的风险项大概率会导致升级失败，升级后系统无法使用，需要在升级前进行处理，如不处理则无法进行下一步升级。比如：磁盘空间不足、外置库无表的编辑权限、存在升级后容易产生故障的配置等。 |
升级建议项（WARNNING） 注：在检测完成后的 BI 界面上显示。 | 该检测的风险项建议进行修改，不会引发系统故障，但会对后续某些功能使用产生一定影响。比如：插件升级、驱动更新提示。 |
升级建议项（SUGGEST） 注：BI 界面不显示检测结果，需要导出 Excel 查看。 |
用户需要根据自己的情况对这些风险项进行处理后在进行升级。
详细风险项以及处理方案见 ：升级风险项及处理方法
2.4 上传 JAR 文件并执行升级
将阻塞风险项处理完成后需要手动替换 JAR 文件到%FineBI%/webroot/WEB-INF/lib目录下。
2.5 重启工程
单机工程直接重启即可。
集群工程替换 JAR 文件后，先启动一个节点，等该节点启动成功后，再启动其他的节点，不可以同时启动。
2.6 升级后验证
1）系统升级完成后建议分别使用超管&普通用户登录系统查看是否能正常登录，确保升级成功。
2）系统升级完成后建议登录系统，切换插件管理界面，将提示需升级的插件进行在线升级，如遇问题请勿回退。
3）系统升级完成后建议登录系统，点击常用数据集进行数据更新验证数据集更新是否可用以及更新后数据是否准确。
3. 注意事项
3.1 升级后重启启动慢
在升级后第一次重启会对配置进行兼容升级，兼容过程可能较慢请耐心等待，过程中可以查看日志，有输出即为正常升级兼容，请勿中途 kill 进程再重启，否则会导致升级失败。
3.2 升级严重故障回退方案
详情参见：跨版本升级后回退至原版本。
3.3 检查驱动隔离插件
若在升级之前使用过 5.1.1 版本驱动隔离插件 ，可点击「管理系统>插件管理」检查，若「我的插件」下有ClassLoader 拦截器字样的插件，则需要删除原插件，如下图所示：
在升级后根据 5.1.2 版本驱动隔离插件 重新安装。
