Overview
Version
Report Server Versions | Function Changes |
V11.0 | / |
Problem Description
There are two main types of JAR package mismatch:
1. Mismatch between server and designer JAR packages.
2. Mismatch between plugins and server/designer JAR packages.
This article mainly introduces the solutions and impacts of JAR package mismatch.
Mismatch Between Server and Designer JAR Packages
Problem Description
When you remotely connect to the server through the designer for remote design, the versions of the designer and server JAR packages must be consistent. Otherwise, there will be a series of problems during the design process.
In FineReport 11.0, during remote design, if the JAR packages of the server and designer do not match, a pop-up window will appear in the upper right corner of the designer, and the Notice button will show a new message status.
When the designer switches the working directory to a remote server (either by directly switching in the menu or by clicking OK after opening the configuration working directory pop-up), or when the designer starts up with the remote server connected, if the JAR packages of the server and the designer do not match, the Notice button will show a new message status. You can click to know the specific error information, and a pop-up window as shown below will appear.
Solutions
1. Checking the Current Version
To ensure version consistency, you first need to know how to check the version of the designer and server.
a. Designer version
Open FineReport, and click Help > About Software to view the JAR package time of the designer.
b. Server version
Open the corresponding decision-making platform of the server, click Manage > Intelligent Operations > Backup and Restore > Update Upgrade, and you can view the JAR package time of the server.
Note: The decision-making platform referred to here corresponds to the server, not to the local designer.
2. Updating JAR Package
If the JAR package times are inconsistent after checking, it indicates that the versions of the designer and server are inconsistent, and it is necessary to update and upgrade them to achieve consistency.
a. When the designer is able to connect to the external network, click Sync to local to retrieve inconsistent content information from the server, download the corresponding JAR file and plugin, replace the local JAR file (only synchronize plugins in enabled status), and restart the designer. Finally connect to Remote Server again. As is shown below:
If some plugins fail to synchronize, there are two possible reasons:
The plugin has been removed from the plugin store for some reason.
It is a built-in plugin and does not require manual installation. Simply restart the designer.
b. When the designer cannot connect to the external network, you need to manually replace the inconsistent content. If the JAR package versions are inconsistent, you can contact technical support team to obtain the relevant version of the JAR package. For the method of manually replacing JAR packages, see A Guide to Updating the Minor Version. If the plugins are inconsistent, you can copy all the plugins under %FR_HOME%/webapps/webroot/WEB-INF/plugins on the server, and paste them into %FR_HOME%/webapps/webroot/WEB-INF/plugins and %FR_HOME%/plugins of the designer. Then restart the designer.
Potential Problems Arising from Ignoring Mismatches in JAR Packages
When the versions are inconsistent, the potential problems are as follows.
There are differences between previewing some templates locally and previewing them after they are mounted on the platform.
The chart elements are not fully displayed, such as incomplete display of chart percentages and failure to display extended charts.
The template cannot be previewed. An error occurs when previewing the template or dataset.
Failed to switch working directory.
The template content is incomplete, such as failure to display the dataset and some widgets.
Data connection is successful, but it is unable to match the table data in the database.
When renaming a template or saving it as another file, it shows that you have no permission.
Below is a detailed introduction of some problems.
1. Failure to Preview After Data Connection Is Successful
Data connection is successful, but when creating a dataset, the views and tables cannot be seen, showing database connection failure.
When viewing the logs, an error occurred: connection pool shut down.
2. Error When Previewing the Dataset
When previewing the dataset, an error occurred: java.lang.reflect.UndeclaredThrowableException
3. No Permission to Operate on the Template
During remote design, when renaming a template or saving it as another file, it shows that you have no permission.
4. Alarm During Remote Connection
When switching the working directory to the remote server, a warning pops up: Remote design can be connected, but the versions do not match.
5. The fetchsize of the Platform Disappeared
The Fetchsize setting in the advanced settings of Data Connection may disappear.
Mismatch Between Plugin and JAR Package
Each plugin will indicate the JAR package requirements in the plugin management interface, the FineReport market plugin interface, and the corresponding plugin introduction document.
When the plugin version does not match the JAR package version, the use of the plugin will be affected. In severe cases, it will impact the operation of the entire server. Therefore, it is recommended that you make sure the plugin version and JAR package version are consistent when using the plugin.
When you install and update plugins, or update servers, the plugin version and JAR package version may not match. In this case, if there is no reminder or restriction, the server will have a potential risk. Starting from 2021/01/25, if the server JAR package version does not match the plugin version, the plugin will be automatically disabled and a reminder will be given.
When installing, updating, upgrading, enabling plugins in Plugin Management or starting the server after updating it, the system will automatically check whether the plugin version and JAR package match. A pop-up window will appear when there is a mismatch.
The system checks whether there is a match between major versions, such as 10.0 and 11.0. It also checks whether the current server's JAR package version meets the minimum JAR package version required by the plugin instructions.
When Operating the Plugin
Problem description:
When installing, updating, or enabling a plugin online or locally in the designer, if the plugin version matches, you can operate it normally and a prompt indicating successful operation will appear. If the installation fails due to inconsistent plugin versions, a pop-up window will prompt that the versions do not match.
When the plugin version is higher than the required version of the JAR package, it will prompt: The plugin version is too high, please upgrade the JAR package or install a lower version of the plugin.
When the plugin version is lower than the version required by the JAR package, prompt: The plugin version is too low, please install a higher version plugin.
Solution: You need to check the versions of the installed plugins and JAR packages, and adjust them to be consistent to avoid error warnings.
When Starting the Server
Problem description:
When starting the server after updating it, if the plugin version does not match the version required by the JAR package, the plugin will be disabled. When the admin logs in to the platform, a pop-up window will appear, indicating the version mismatch.
Note: In a cluster environment, multiple nodes will perform matching checks. If the benchmark node starts up first, only the benchmark node's checking results will be used for the notification and the notification will only be given once. If other nodes start up first, multiple notifications will be given.
When the plugin version is higher than the required version of the JAR package, the notification will be: Plugin version is too high and has been disabled by the system. Please upgrade the JAR package or install a lower version plugin.
When the plugin version is lower than the version required by the JAR package, the platform message notification is: Plugin version is too low and has been disabled by the system. Please update it.
Solution: Click the message content to jump to the Plugin page for corresponding processing, or in System Messages, there is a Process jump link after the notice content. After clicking, it will directly jump to the Plugin page, where the admin can delete or update the plugin to make it available.
When Using the Designer
Problem description:
If the plugin version does not match the local designer JAR package version, when you open the designer, a pop-up window will prompt you: The following plugin does not match the JAR version and has been disabled.
The pop-up window lists the mismatched plugins in detail. Click Deal immediately to go to the Plugin Management page to handle the plugins accordingly.
When the designer switches to other local directories, it will also check whether the plugins and server JAR packages match. If they do not match, a pop-up window will appear to prompt you.
Note: During remote design, the information of the plugin version and server JAR package version will not be checked. Therefore, there is no pop-up window when they do not match.
Solution: Click Deal immediately to delete the plugin or update the plugin to make it available.
