
This document is only for guiding the upgrade of FineBI projects (deployed on non-O&M platforms) within 6.0.x.
For FineBI projects deployed on O&M platforms, upgrade them through the O&M platforms. For details, see O&M Project Update with Extranet and O&M Project Update with Intranet.
Overview
Version
FineBI Version | Functional Change |
---|---|
6.0.5 | / |
6.0.16 | Added the version update push and problem feedback entries. |
Function Description
Our products have constantly been updated and iterated to meet customers' new needs and improve some functions of earlier versions.
This document mainly introduces how to upgrade the FineBI project with minor versions (namely 6.0.x, for example, upgrading FineBI from 6.0.5 to 6.0.9).
You can use either of the two upgrade methods provided in this document.
Upgrade By BI Version Management Tool
This upgrade method is available only to premium users who have purchased technical support services.
Preparation Procedure
Step | Description | |
---|---|---|
1 | Learn about the upgrade notes. | Carefully read the upgrade notes before the upgrade to grasp compatibility issues of each version. For details, see Note on Upgrade of FineBI Within 6.0.x (Minor Version). |
2 | Back up the project. | Before project upgrade, you must back up the original project and then proceed with subsequent operations. This can avoid inability to roll back caused by project file loss if the upgrade fails. For details about how to back up the project, see section "Backup Method" in Project Backup and Restoration. |
3 | Confirm the FineReport compatibility. (Skip this step if no compatibility exists.) | (1) Integrated FineReport If FineBI is integrated with FineReport, just upgrade FineBI, which will trigger the upgrade of FineReport-related JAR packages. In this case, you do not need to upgrade FineReport separately. (2) Independent FineReport If FineBI needs to be used with the matched FineReport that is independently deployed, confirm the version matching before the upgrade. For details, see FineBI and FineReport Version Compatibility Instruction. |
4 | Confirm the FineDataLink compatibility. (Skip this step if no compatibility exists.) | (1) Integrated FineDataLink No JAR packages on which FineDataLink-related functions depend are embedded in FineBI of 6.0.18 and later versions. After the upgrade, FineBI and FineDataLink cannot be integrated. If you need to upgrade FineBI integrated with FineDataLink to 6.0.18 and later versions, contact customer success personnel of FineDataLink before the upgrade and deploy FineDataLink independently. (2) Independent FineDataLink If FineBI needs to be used with the matched FineDataLink that is independently deployed, confirm the version matching before the upgrade. |
5 | Get the BI Version Management Tool program. | Premium users can contact FanRuan technical support and request the BI Version Management Tool program of the latest/specified version. Specify your project environment (Linux/Linux_arm/Windows). For details about how to contact technical support, see Technical Support Channel Introduction. |
Upgrade Procedure - Linux
Step | Description | |
---|---|---|
1 | Close the project. | Disable the standalone project node or each project node in the cluster by referring to Closing or Restarting the FineBI Project. |
2 | Replace JAR packages for upgrade by using BI Version Management Tool. | The steps in this part need to be executed once on the server where the standalone project node/each project node in the cluster is located. 1. Upload the decompression tool. Upload the BI Version Management Tool package provided by technical support to the server where the project is located. Upload the package to a directory on which you have operation permissions and decompress it. The package is uploaded to /home/bi in this example.
2. Start the tool. Enter the bin directory of BI Version Management Tool and execute the following startup statements.
3. Check whether the project is closed.
4. Select the project path. Enter the absolute webroot path of the project to be upgraded and press Enter to proceed with following steps. 5. Check whether incompatible JAR packages exist. If the project to be upgraded is of 6.0.18 or later versions and FDL JAR packages are used in the current project, the message "FDL integration is not supported in 6.0.18 and later versions. Ensure that FDL has been separated and deployed independently." is displayed. (That is to say, you need to check whether FineDataLink compatibility confirmation in the section "Preparation Procedure" has been completed.)
6. Determine whether to perform upgrade.
Wait patiently until the message "The project of the new version is ready. Start the project to perform the upgrade." is displayed, indicating that the JAR package is replaced successfully. |
3 | Start the project. | Start the project node by referring to Closing or Restarting the FineBI Project. If the project is a clustered one, ensure that the upgrade operations in the previous step have been performed for all project nodes before starting the project. If the project is a clustered one, start nodes one by one. Do not start them at the same time. |
Upgrade Procedure - Windows
Step | Description | |
---|---|---|
1 | Close the project. | Disable the standalone project node or each project node in the cluster by referring to Closing or Restarting the FineBI Project. |
2 | Replace JAR packages for upgrade by using BI Version Management Tool. | The steps in this part need to be executed once on the server where the standalone project node/each project node in the cluster is located. 1. Upload the decompression tool. Upload the BI Version Management Tool package provided by technical support to the server where the project is located. Upload the package to a directory on which you have operation permissions, for example, D drive. Decompress the package to obtain BI Version Management Tool. 2. Start the tool. Double-click start-version-manager.bat in the bin directory of BI Version Management Tool to start the tool. 3. Check whether the project is closed.
4. Select the project path. Read the upgrade notes carefully (namely, the related content in the previous section "Preparation Procedure"). Select the webroot folder of the project to be upgraded and click Next. 5. Check whether incompatible JAR packages exist. If the project to be upgraded is of 6.0.18 or later versions and FDL JAR packages are used in the current project, the message "FDL integration is not supported in 6.0.18 and later versions. Ensure that FDL has been separated and deployed independently." is displayed. (That is to say, you need to check whether FineDataLink compatibility confirmation in the section "Preparation Procedure" has been completed.)
6. Confirm version information. Check whether the version of the project to be upgraded is the same as expected. If the target version is correct, click Replace to enter the automatic upgrade process. 7. Wait for automatic JAR replacement for upgrade. Wait patiently until the message "The new version is ready." is displayed. Then the upgrade is successful. Click Next. Then the original and new versions of the project will be clearly listed, and the message "The project of the new version is ready. Start the project to perform the upgrade." will be displayed. In this case, click Finish Replacement to automatically close BI Version Management Tool. |
3 | Start the project. | Start the project node by referring to Closing or Restarting the FineBI Project. If the project is a clustered one, ensure that the upgrade operations in the previous step have been performed for all project nodes before starting the project. If the project is a clustered one, start nodes one by one. Do not start them at the same time. |
Upgrade by Manual JAR Package Replacement
Preparation Procedure
Step | Description | |
---|---|---|
1 | Learn about the upgrade notes. | Carefully read the upgrade notes before the upgrade to grasp compatibility issues of each version. For details, see Note on Upgrade of FineBI Within 6.0.x (Minor Version). |
2 | Back up the project. | Before project upgrade, you must back up the original project and then proceed with subsequent operations. This can avoid inability to roll back caused by project file loss if the upgrade fails. For details about how to back up the project, see section "Backup Method" in Project Backup and Restoration. |
3 | Confirm the FineReport compatibility. (Skip this step if no compatibility exists.) | (1) Integrated FineReport If FineBI is integrated with FineReport, just upgrade FineBI, which will trigger the upgrade of FineReport-related JAR packages. In this case, you do not need to upgrade FineReport separately. (2) Independent FineReport If FineBI needs to be used with the matched FineReport that is independently deployed, confirm the version matching before the upgrade. For details, see FineBI and FineReport Version Compatibility Instruction. |
4 | Confirm the FineDataLink compatibility. (Skip this step if no compatibility exists.) | (1) Integrated FineDataLink No JAR packages on which FineDataLink-related functions depend are embedded in FineBI of 6.0.18 and later versions. After the upgrade, FineBI and FineDataLink cannot be integrated. If you need to upgrade FineBI integrated with FineDataLink to 6.0.18 and later versions, contact customer success personnel of FineDataLink before the upgrade and deploy FineDataLink independently. (2) Independent FineDataLink If FineBI needs to be used with the matched FineDataLink that is independently deployed, confirm the version matching before the upgrade. |
5 | Get JAR packages for the upgrade. | You can install FineBI of the latest version and copy the JAR packages of the latest version from the installation path %FineBI_Home%/webapps/webroot/WEB-INF/lib. |
Upgrade Procedure
Step | Description | |
---|---|---|
1 | Close the project. | Disable the standalone project node or each project node in the cluster by referring to Closing or Restarting the FineBI Project. |
2 | Delete redundant JAR packages. | Delete the following two types of files from /webapps/webroot/WEB-INF/lib of the standalone project node or each project node in the cluster:
|
3 | Delete files from impl. | Delete all files from the impl folder in /webapps/webroot/WEB-INF/classes/com/fr/data of the standalone project node or each project node. (Skip this step if such files do not exist.) |
4 | Replace JAR packages for the upgrade. | Upload the JAR packages obtained in the section "Preparation Procedure" to overwrite the original JAR packages in /webapps/webroot/WEB-INF/lib of the standalone project node or each project node in the cluster. |
5 | Start the project. | Start the project node by referring to Closing or Restarting the FineBI Project. If the project is a clustered one, start nodes one by one. Do not start them at the same time. |
Post-Upgrade Operation
Checking Whether the Update Is Successful
Log in to FineBI as the admin and choose System Management > Registration Management > Version Information.
You can check whether the current JAR version is the desired project version, as shown in the following figure
Plugin Upgrade
After the project upgrade is completed, you are advised to log in to FineBI, choose System Management > Plugin Management and upgrade plugins for which new versions are available one by one.
Data Update
After the project upgrade is completed, you are advised to log in to FineBI, click a common dataset for data update, and check whether the dataset update function is available and whether the post-update data is accurate.
User Login
After the project upgrade is completed, you are advised to log in to FineBI using the super administrator and general user accounts respectively and check whether the login is normal. If so, the upgrade is successful.