FRBI upgrade tool (for FR11)

Since FineReport 11.0.1 adapted to FineBI 5.1.19 is a major version update, the Lic must be replaced. If you have any questions, please contact technical support (QQ: 800049425) for help.

1.1 Version 

1.2 Application scenarios

FineBI 5.1.19 is compatible with FineReport 11.0.1, so this upgrade tool is provided. If you need to upgrade the BI project to 5.1.19 and later versions, you can refer to this article for upgrade operations.

For details about the precautions before upgrading, please refer to the document: BI5.x Version Adaptation FR10.0/11.0 Maintenance Policy Notice

1.3 Scope of use

See functional changes in section 1.1 of this document.

Version information can be viewed in the  registration management  .

1.4 Cluster Upgrade Notes

To upgrade the cluster environment, please stop the processes of all nodes first, run the upgrade tool on any of the nodes, and copy the WEB-INF, scripts, and upm under the webroot file of the current node  to other nodes after the upgrade is completed. After completion, start a node first. After the project can be accessed, start other nodes in sequence.

2.1 Get the upgrade tool

If you are an individual user who has not contacted the sales manager of FanRuan, you can contact FanRuan Business at 400-8118890 ext. 1 to obtain relevant information;

If you have connected with the sales manager of FanRuan, you can obtain the upgrade tool and the "BI upgrade" plug-in package through FineBI technical support (QQ: 800049425).

2.2 Confirm the existing registration function

Since the Lic file must be replaced after the upgrade, the existing registration function points can be determined before the upgrade. For details, please refer to: Registration Management .

2.3 Project Backup

Go to "Management  > System  > General" and confirm the database type, as shown in the following figure:

• If "To be configured" is displayed: the database type is the built-in database.

• If "configured" is displayed: the database type is an external database.

• Built-in database backup method:

Close the FineBI project and copy the webroot folder in the path %FineBI%\webapps\webroot (the backup webroot file cannot be placed in the FineBI installation path)

Note: If the webroot is relatively large (more than 4G), the backup will take too long, you can only backup the WEB-INF folder under the webroot; if the WEB-INF is also very large (more than 2G), the backup will still take a long time. You can only backup the dashboards, embed, lib, plugins, reportlets, resources folders under WEB-INF.

• External database backup method:

Option One:

1) Close the FineBI project and copy the webroot folder under the path %FineBI%\webapps\webroot (the backup webroot file cannot be placed in the FineBI installation path)

Note 1: If the webroot is relatively large (more than 4G), the backup will take too long, you can only backup the WEB-INF folder under the webroot; if the WEB-INF is also very large (more than 2G), the backup will still take a long time , you can only backup the dashboards, embed, lib, plugins, reportlets, resources folders under WEB-INF.

Note 2: If the cluster environment has several nodes, back up several webroot projects.

2) Manually back up the external database. The password of the backup database needs to be the same as that of the previous database.

Option II:

Go to "Management  > Intelligent Operation > Backup and Restore", and perform "manual backup" of "Platform Configuration, Report Template, BI Template, Jar Package, Plugin", as shown in the following figure:

2.4 Perform upgrade detection

Refer to  Section 2.2 of the 5.1.15-5.1.18 Upgrade Guide for pre-upgrade detection, and modify the "Blocked Items" and "Suggested Items" according to your actual situation.

2.5 Close the project

Close the BI project after the backup is complete.

2.6 Running the upgrade tool

Note 1: The upgrade process will occupy ports 20216 and 20217, please confirm that the ports are not occupied by other processes.

Note 2: The default memory when the upgrade tool is running is Xms: 4G -Xmx: half of the physical memory. It is necessary to ensure that the server has at least 8G of available memory to prevent memory overflow during the upgrade process.

Note 3: Only one node can be upgraded in a cluster environment. After the upgrade, copy the upgraded webroot to other nodes.

Note 4: The upgrade tool log is in the same directory of the tool, and the name is upgrade.log.

2.6.1 Windows system upgrade

Run the upgrade tool, select the location where the BI project webroot is located, and then click Start upgrade, as shown in the following figure:

Note: The path where the upgrade tool and the project are located should not contain many special characters, but can contain Chinese, English, numbers, English brackets, underscores, English connectors, and spaces (generally do not put the project in the C drive).

Wait for the upgrade to complete.

Note: After the upgrade is completed, check whether the jars under %FineBI%/webroot/WEB-INF/lib are correct before starting. Because of the characteristics of the windows environment, the files are occupied by the system, and the 10.0 jars may not be deleted.

2.6.2 Linux system upgrade

After downloading the upgrade tool in the Linux system, use the command 

chmod 777 upgrade tool sh filename

 to grant permissions to the tool, as shown in the following figure:

Then start the upgrade tool, as shown in the following figure:

Enter the project webroot path and wait for the upgrade, as shown in the following figure:

After the upgrade is completed, it will prompt: The upgrade is successful.

2.7 Restart the project

After the upgrade is complete, the project is closed, and the project needs to be started manually.

2.8 Replacing the Lic file

After upgrading to 5.1.19, the Llic needs to be replaced. The replaced Lic function needs to be consistent with the previous Lic function. For details, please refer to:Registration Management

3.1 Cluster

If an external database, state server, and file server are configured, the upgrade process needs to ensure that they can all be connected normally so that files can be updated.

3.2 Plugins

Currently, FR11.0 is only compatible with official plugins, so third-party plug-ins and custom plugins may not be available after upgrade.

3.3 Others

If a project has already been upgraded, do not run the upgrade tool again to upgrade, regardless of whether the upgrade was successful or not. Need to restore backup, re-upgrade.

If the project is configured with an external database, the database driver that comes with the upgrade tool may not be able to connect to the external database, causing the upgrade to fail. In this case, it is recommended to switch to the built-in database for upgrade, and then migrate it out.