Guide to Upgrade Projects of Minor Versions

Version

Function Description

Our products have constantly been updated and iterated to meet customers' new needs and improve some functions of earlier versions.

The built-in one-click upgrade function in FineReport 11.0 makes the upgrade more convenient. You can perform the upgrade in the designer and on the server.

• Designer upgrade: Generally, template design users upgrade the local designer to ensure the consistency with company systems.

     For the designer upgrade, see Designer Upgrade Guide.

• Server upgrade: Generally, system administrators upgrade the company's projects in the test and formal environments to fix issues in earlier versions and add product functions.

This document mainly describes how to upgrade the server project within minor versions (for example, upgrading FineReport from 11.0.5 to 11.0.9). Select the applicable solution based on your situation.

This section describes how to upgrade the FineReport project from a lower 11.0 version to the latest 11.0 version online.

Note:

Due to potential risks, such as insufficient memory or network communication issues, in the server environment where the project is located, this solution is not recommended for formal projects.

You are advised to use the manual upgrade solution in section "Upgrade to a Specific Version via Extranet/Intranet" for formal projects. Use this solution with caution.

Project Backup

Before project upgrade, you must back up the original project and then proceed with subsequent operations. This can avoid rollback inability caused by project file loss if the upgrade fails.

Back up the project by referring to Backup and Restoration.

Online Update

1. Log in to the decision-making system as the admin, and choose System Management > Intelligent O&M > Backup & Restoration > Update/Upgrade.

2. Check if the Update Now button can be clicked. If this button is grayed out, the current version is already the latest one, requiring no upgrade.

3. If the Update Now button can be clicked, click it.

Project Restart

1. Close the FineReport project.

2. To upgrade the project from versions earlier than 11.0.9 to 11.0.9 or later versions, manually delete netty-related JAR packages from %Tomcat_HOME%/webroot/WEB-INF/lib.

In 11.0.9 and later versions, the functions related to netty-all-4.1.78.Final.jar have been built into the product. Therefore, additional JAR packages must be deleted to avoid potential startup anomalies.

Note:

To roll back the project from a later version to a version earlier than 11.0.9, netty-related JAR packages must be added to %Tomcat_HOME%/webapps/webroot/WEB-INF/lib of the server project.

You can download the JAR package netty-all-4.1.78.Final.jar here.

3. Restart the FineReport project.

Checking Whether the Upgrade Is Successful

After the upgrade and restart, log in to the decision-making system as the admin, and choose System Management > Intelligent O&M > Backup & Restoration > Update/Upgrade.

If the tip "Already Latest Version" is displayed and the Update Now button is grayed out, the project is updated successfully. The following figure shows the effect.

This section describes how to upgrade the FineReport project from a lower 11.0 version to the latest 11.0 version/specific version manually.

Project Backup

Before project upgrade, you must back up the original project and then proceed with subsequent operations. This can avoid rollback inability caused by project file loss if the upgrade fails.

Back up the project by referring to Backup and Restoration.

Obtaining JAR Packages

Free users can install the designer of the latest version and copy the JAR packages of the latest version from the installation path %FR_Home%/webapps/webroot/WEB-INF/lib.

Premium users can contact FanRuan technical support and request the JAR packages of the latest/specified version. For details about how to contact technical support, see Technical Support Channel Introduction.

The JAR packages for the upgraded 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, and fine-cbb-11.0.jar

Manual Update

1. Close the FineReport project.

2. Replace the original JAR packages in %Tomcat_HOME%/webapps/webroot/WEB-INF/lib with these 13 JAR packages.

Note:

In versions earlier than 11.0.3, fine-cbb-11.0.jar is not available, and only 12 JAR packages are available. If you need to roll back the version, delete this JAR package.

3. To upgrade the project from versions earlier than 11.0.9 to 11.0.9 or later versions, manually delete netty-related JAR packages from %Tomcat_HOME%/webapps/webroot/WEB-INF/lib.

Reason: In 11.0.9 and later versions, the functions related to netty-all-4.1.78.Final.jar have been integrated into FR-related JAR packages. Therefore, the netty-related JAR packages must be deleted to avoid potential startup anomalies.

Note:

To roll back the project from a later version to a version earlier than 11.0.9, netty-related JAR packages must be added to %Tomcat_HOME%/webapps/webroot/WEB-INF/lib of the server project.

You can download the JAR package netty-all-4.1.78.Final.jar here.

4. Restart the FineReport project.

Checking Whether the Upgrade Is Successful

After the upgrade and restart, log in to the decision-making system as the admin, and choose System Management > Intelligent O&M > Backup & Restoration > Update/Upgrade.

You can check whether the current JAR version is the desired project version. The following figure shows the effect.