Overview
Version
Report Server Version | Plugin Version | JAR Package Version | Functional Change |
10.0 & 11.0 | 4.1 | 2020/08/04 and later versions | / |
4.2 | Added detection for external database connection state. | ||
4.3 | Added detection for automatic backup state. | ||
4.4 | Added detection for the information item. |
Application Scenarios
The FRBI Upgrade Detection Tool plugin is mainly used to check whether the engineering environment meets the upgrade requirements and whether there are any upgrade risk items before product upgrade, and to obtain important information required for the upgrade, thus avoiding problems during the upgrade process.
The plugin is applicable to all version upgrades of FineReport.
Introduction
Plugin Installation
Click to download the plugin: FRBI Upgrade Detection Tool
For details about installing plugins in Designer, see Designer Plugin Management.
For details about installing plugins in Server, see Server Plugin Management.
Operation Method
1. After the plugin installation is completed, go to the decision-making platform. You can view Upgrade Check in the left directory.
2. Choose Upgrade Check > Upgrade Notes, carefully read the content of [Important] Backup and Upgrade Compatibility, and back up the system according to the content in the notes.
After completion, select Have read the above notes and click Next.
3. Click Next to start automatic detection for you. After the detection is completed, the upgrade detection results are displayed on the interface. You can read the detection content and the exported Excel file, or send the results to technical personnel for assistance in evaluation.
Explanation for Detection Content
The upgrade detection levels are defined as follows:
Blocking item: affects upgrade execution. If not adjusted, the next upgrade cannot proceed.
Warning item: affects functionality usage after upgrade, rather than normal upgrade. Manually handling is required after upgrade.
Suggesting item: prompts the risks handled automatically by the system and suggests you check the items according to the configuration after upgrade.
Information item: records environment information related to upgrades.
Note: Both blocking items and warning items will be displayed on the interface. But prompt items can only be viewed in the exported Excel file.
The detection content and information are shown in the following table.
Detection Content | Detection Item | Prompt Information |
Check disk space. | Blocking item (if disk space is less than 3 GB) Warning item (if no disk space can be detected) | It is detected that the current remaining disk space is less than 3 GB. Ensure that the disk space is greater than 3 GB before upgrade. You can first clean up the disk space and then upgrade. |
Check if it is an external database. | Suggesting item (If it is an external database, provide a prompt; otherwise, label as the internal database directly.) | It is detected that it is an external database, the platform will change to the default built-in FineDB mode after the upgrade tool processes the upgrade. After the upgrade, it is necessary to create a new database for external database migration. |
Check the permission of the external database. | Blocking item (if the external database loses the DDL permission) | The external database lost the DDL permission which needs to be opened. |
Check the code of the external database. | Blocking item (If the MySQL code is not utf8 or utf8mb4) Warning item (if the SQL Server code is Chinese_PRC_CS_AS); Blocking item (if not) | It is detected that the code of the external database is not the required one. |
Check JDK. | Blocking item (if JDK version is Oracle 1.8.0.102) Warning item (if JDK version information cannot be detected) | The JDK version is earlier than 1.8.0.102, and the system may fail to start after upgrade due to a JDK vulnerability. You need to upgrade the JDK version first. |
Check the lib folder. | Blocking item (Check if there exists fr-xxxx-8.0, fr-xxxx-9.0, or JAR packages ending with .bak.) | It is detected that there is a blockage caused by abnormal lib files. You need to delete redundant JAR packages. |
Port number detection | Blocking item (Check if port 20216 and port 20217 are occupied because the upgrade process will occupy these two ports.) | It is detected that the port is occupied. Because port 20216 and port 20217 being occupied will cause upgrade failure, you need to ensure that the two ports are not occupied. |
Web container detection | It is detected that web container version is incompatible. You need to upgrade version. | |
Plugin detection | 1. Warning item (Check if there is any second-developed custom plugin or If there are plugin names contains JSD, SLN.) 2. Warning item (Check if there is any plugin that is not adapted to FineReport 11.0.) Note: Adaptation for version 11.0 can be detected, but if some plugins are not adapted according to the rules, they cannot be detected. 3. Warning item (if the network is not available during customer network environment detection) | 1. It is detected that there are second-developed plugins in the plugin management. You are advised to contact technical support to confirm whether the new version of the plugin is compatible. 2. It is detected that version 11.0 is temporarily incompatible with the plugin, and the plugin may not work after upgrade. 3. It is detected that the network link is unavailable and plugin compatibility detection cannot be performed, which may cause plugins (if they are not adapted) to be unusable after upgrade. |
Custom resource detection | Warning item (Check if custom CSS files and class files are imported.) | It is detected that there are custom styles or classes that may be at risk of becoming invalid. If they become invalid, they will need to be re-adapted after upgrade. |
Automatic backup state detection | Check if there are any backup files configured within 24 hours. | Check if there are platform backup files. If no backup files are detected in the platform configuration of the current system within the last 24 hours, a prompt will appear: It is detected that Platform Configuration in the current system has no backup files in the last 24 hours. Manual backup is advised. You need to select manual backup in Management System > Intelligent Operation > Backup and Restore > Platform Configuration to confirm whether the backup is successful. If the backup fails, you need to contact the technical personnel to resolve backup issues first. |
Deployment method | Check the deployment method of existing projects. | / |
Operating system | Check the current operating system and its version used by the server. | / |
Check Whether FineReport integrates with FineBI. | Check whether FineReport integrates with FineBI. | / |
Check if there is a formal authorization. | / | / |
Number of templates | Check the number of templates (exclude the built-in templates) in the reportlet folder. | / |
Detection Completed
After the detection is completed, a prompt pops up: The upgrade check is completed, please refer to the upgrade guide to upgrade: https://help.fanruan.com/finebi-en/doc-view-1487.html.
You can continue with the version upgrade.
