Overview
Versions
Report Server Version | Function Changes |
V11.0 | / |
V11.0.9 | The product has the built-in functionality of netty-all-4.1.78.Final.jar. To update to version 11.0.9 or later versions, it is necessary to delete the original netty-related jar files. |
Function Introduction
The product is constantly updated and iterated to meet new needs of customers and improve certain features of previous versions.
FineReport 11.0 has a built-in function supporting one-click update, making the update more convenient. Update is divided into designer update and server update.
Server update: The operator is generally the system administrator, responsible for upgrading the company's test environment and production environment projects, in order to fix bugs existing in the previous version and add new product features.
Designer update: You are the operator. In order to maintain consistency with the company's system, you need to update the local designer.
Server Update
Backing up the Project
Before updating the server, make sure of backing up the project before updating to avoid file loss in case of upgrade failure.
For backup operations, refer to Backup and Restore
Updating the Project
There are two methods for server update: platform update (recommended for external network use) and manual update (recommended for internal network use). You can choose any one of them.
1. Method One: Platform Update
In an external network environment, it is recommended to directly update the server project through the platform.
The administrator logs into the decision-making system, clicks Manage > Intelligent Operations > Backup and Restore > Update Upgrade, and clicks Update Now.
Note: Starting from version 11.0.9, the product has built-in and relevant functionality of netty-all-4.1.78.Final.jar.
When updating from a lower version to version 11.0.9 or later versions, manually delete the netty-related jar package under %TOMCAT_HOME%/webapps/webroot/WEB-INF/lib, otherwise the project may not start.
2. Method Two: Manual Update
In the intranet environment, it is recommended to manually replace and update JAR packages to update the server project.
a. Get JAR files.
After installing the latest designer, free users can copy the upgraded JAR files in the installation directory %FR_Home%/webapps/webroot/WEB-INF/lib.
Paid users can contact technical support team to obtain upgraded JAR files. You can send an email to international@fanruan.com or click at https://www.finereport.com/en/.
The upgraded JAR files include:
fine-accumulator-11.0.jar, fine-activator-11.0.jar, fine-core-11.0.jar, fine-datasource-11.0.jar, fine-decision-11.0.jar, fine-decision-report-11.0.jar, fine-report-engine-11.0.jar, fine-schedule-11.0.jar, fine-schedule-report-11.0.jar, fine-swift-log-adaptor-11.0.jar, fine-third-11.0.jar, fine-webui-11.0.jar, fine-cbb-11.0.jar
b. Replace the JAR files.
After obtaining, replace the 13 JAR files under the server project %TOMCAT_HOME%/webapps/webroot/WEB-INF/lib, and restart the server to complete the upgrade.
Note:
1. There is no fine-cbb-11.0.jar in the server of versions prior to version 11.0.3, so you do not need to replace it.
2. Starting from version 11.0.9, the product has built-in and relevant functionality of netty-all-4.1.78.Final.jar.
When updating from a lower version to version 11.0.9 or later versions, manually delete the netty-related jar package under %TOMCAT_HOME%/webapps/webroot/WEB-INF/lib, otherwise the project may not start.
3. If you need to roll back from a higher version to version 11.0.9 or below, you need to additionally add the netty-related jar file in %TOMCAT_HOME%/webapps/webroot/WEB-INF/lib of the server project.
Click to download the JAR file: netty-all-4.1.78.Final.jar
Restarting the Project
After updating JAR files, restart the project to complete the update.
When restarting, you need to shut down the Tomcat process through Ctrl+C/kill. Using other methods to shut it down may pose certain risks.
Checking Whether the Update Is Successful
After updating and restarting, the administrator logs in to the decision-making system, and clicks Manage > Intelligent Operations > Backup and Restore > Update Upgrade.
This is the latest version appears and Update Now grays out, indicating that the project has been successfully updated.
Designer Update
Backing up the Designer
Before updating the designer, to avoid file loss in case of upgrade failure, make sure of backing up the project before updating.
You can back up the folder %FineReport_HOME%\webapps\webroot.
Updating the Designer
There are two methods to update the designer: online update (recommended for external network use) and manual update (recommended for intranet use). Choose any one of them.
1. Method One: Online Update
Open the designer, click Help > Update&Upgrade, and the new version number appears in Latest JAR. Click Update to update.
Note:
1. The Update&Upgrade function is not supported in the remote design status. You need to switch to the local default environment if you are now in the remote design status.
2. There will be a delay of a few seconds when updating the designer because it needs to retrieve, compare, and parse the JS to obtain the update information.
3. Starting from version 11.0.9, the product has built-in and relevant functionality of netty-all-4.1.78.Final.jar.
When upgrading from a lower version to version 11.0.9 or later, manually delete the netty-releted JAR files under %FR_HOME%/webapps/webroot/WEB-INF/lib, otherwise the project may not start.
2. Method Two: Manual Update
a. Request 14 updated JAR files from the FineReport technical support team:
fine-accumulator-11.0.jar, fine-activator-11.0.jar, fine-core-11.0.jar, fine-datasource-11.0.jar, fine-decision-11.0.jar, fine-decision-report-11.0, fine-report-designer-11.0.jar, fine-report-engine-11.0.jar, fine-schedule-11.0.jar, fine-schedule-report-11.0.jar, fine-swift-log-adaptor-11.0.jar, fine-third-11.0.jar, fine-webui-11.0.jar, fine-cbb-11.0.jar
b. fine-report-designer-11.0: This JAR file contains all the functions of the FineReport. Put it under %FR_Home%/lib.
c. Other JAR files: Put the remaining 13 JAR files into %FR_Home%/webapps/webroot/WEB-INF/lib.
Note:
1. There is no fine-cbb-11.0.jar in the server of versions prior to version 11.0.3, so you do not need to replace it.
2. Starting from version 11.0.9, the product has built-in and relevant functionality of netty-all-4.1.78.Final.jar.
When upgrading from a lower version to version 11.0.9 or later, manually delete the netty-releted JAR files under %FR_HOME%/webapps/webroot/WEB-INF/lib, otherwise the project may not start.
3. If you need to roll back from a higher version to version 11.0.9 or below, you need to additionally add the netty-related jar file in %TOMCAT_HOME%/webapps/webroot/WEB-INF/lib of the server project.
Click to download the JAR file: netty-all-4.1.78.Final.jar
Restarting the Designer
After the online update is completed, the designer will immediately restart automatically.
After the manual update, you need to restart the designer manually.
Checking Whether the Upgrade Is Successful
After updating and restarting the designer, click Help > Update&Upgrade.
This is the latest version appears and Update Now grays out, indicating that the designer has been successfully updated.
Notes
Upgrades are triggered in the following two scenarios.
Triggering Update Through Plugin Management
The designer enables Use New Plugin Manager.
Click Server, Plugin Management. If the JAR file of jxbrowser is not detected, then a prompt box for mandatory upgrade pops up.
Click OK or close the prompt box to jump to the Update&Upgrade page and follow the update procedure as shown in the previous text.
Remote Connection Version Mismatch
The versions of JAR files on the server and in the designer should be consistent, otherwise it may cause some templates to display normally in local preview but have problems when previewed on the server.
When you switch the working directory to Remote Server in the designer, if the JAR files of the server and the designer do not match, a pop-up window will prompt.
Click Sync to Local to retrieve inconsistent content information from the server, download the corresponding JAR file and plugin, replace the local JAR file, and restart the designer. Finally connect to Remote Server again.
For more details, refer to JAR Mismatch.
