[Standalone] Upgrade from 5.1 to 6.0.5- FineBI Document

Last update： 2023-03-20

Overview

Functions

This tool helps users smoothly upgrade BI project from version 5.1 to 6.0.5.

Upgrade Process

Preparation Before Upgrade

1. Read Version 6.0 Compatibility Description to learn about the changes from version 5.1 to version 6.0.

2. Backup the 5.1 project, detect and repair upgrade risk items.

3. You can send an email to international@fanruan.com or click at https://intl.finebi.com/

to get support.

Windows Upgrade

Closing BI Project

1. Close the BI project.

Common issue: Directly closing the FineBI project on a Windows system may not shut down the anti-crash plugin process, resulting in the failure to replace JAR files during the upgrade process and leading to upgrade failure.

Solution: In cmd, enter jps to check if there is a process named Operation. If so, enter taskkill /f /pid %pid% to kill the process named Operation.

To check whether the process has been closed completely, rename the lib file under %FineBI%\webapps\webroot\WEB-INF, and if the file can be renamed, it indicates that the project has been completely closed. Remember to change the file name back after verification.

Uncompressing the Upgrade Tool

1. Unzip the upgrade tool.

2. Go to fine-bi-upgrade-windows\bin and edit the JvmConfig.properties file to add memory. If you do not edit the file, the default allocation will be 1/4 of the BI project.

5.0-6.0.5 Upgrade2.png

Note: You need to adjust the memory for the upgrade tool based on the actual situation of the BI project. The upgrade tool requires a minimum of 12 GB of running memory, ideally 1.5 times the memory configured by the BI project. You can adjust it based on available server memory.

Upgrading

1. Double-click start-upgrade.bat to run the tool. Select Closed and click Next.

5.0-6.0.5 Upgrade3.png

2. Select %FineBI%\webapps\webroot as Project path and click Start detection.

5.0-6.0.5 Upgrade4.png

3. After the detection is completed, click Next.

5.0-6.0.5 Upgrade5.png

4. Select the mode and click Start Upgrade.

5.0-6.0.5 Upgrade6.png

5. After the upgrade is completed, click Next.

5.0-6.0.5 Upgrade8.png

Note: The duration of this process is dependent on the size and performance of the configuration database. As long as there are no errors reported on the interface, you can keep waiting.

6. Upgrade completed.

5.0-6.0.5 Upgrade9.png

Checking the Upgrade Report

You can check upgrade.log file under fine-bi-upgrade-windows\logs.

Risk items detected are under fine-bi-upgrade-windows\exports.

Starting the Project

1. Start the project and click Global Update Now in the pop-up window.

5.0-6.0.5 Upgrade10.png

2. Clicking Global Update Now will initiate the update of all self-service datasets configured to update with the parent table.

Until the upgrade is finished, accessing any project URL will redirect to the following page and project access will be unavailable.

Note: Only self-service datasets will be updated, and the base table will not be updated.

5.0-6.0.5 Upgrade11.png

Linux Upgrade

1. Close the BI project.

2. Unzip the upgrade tool. Go to fine-bi-upgrade-windows\bin and edit the JvmConfig.properties file. If you do not edit the file, the default allocation will be 1/4 of the BI project.

3. In the fine-bi-upgrade-linux\bin directory, enter the command to run the upgrade tool. Enter 2 and press Enter to run the upgrade tool.

./start-upgrade.sh

4. Select %FineBI%\webapps\webroot as the project path and press Enter to start the detection.

Note: The progress bar may display abnormally due to version incompatibilities with the tool used to connect to the remote server. However, this does not impact the upgrade detection, and Next Step will appear when the detection is completed.

5. After the detection, enter number to select mode and press Enter.

6. Wait until the upgrade is completed.

7. Check update report.

You can check upgrade.log file under fine-bi-upgrade-linux\logs.

Risk items detected are under fine-bi-upgrade-linux\exports.

8. Start the BI project.

Start the BI project and click Global Update Now.

Upgrade Mode

There are four upgrade modes available to upgrade to version 6.0.

Mode	Explanation
Extract mostly	Extract: The business package structure is retained. Direct: The business package is collapsed and placed under Public business package – direct.
Direct mostly	Direct: The business package structure is retained. Extract: The business package is collapsed and placed under Public business package – extract.
Fold both	Extract: Placed under Public business package – extract. Direct: Placed under Public business package – direct.
Merge both	The structure of the extract and direct connection business packages is retained and displayed together. Note: If a group or business package with the same name exists in both the Direct and Extract categories, the Direct category's group or business package will be suffixed with "direct".