Version upgrade guide after 5.1.5

1.1Version 

1.2 Applicable version

Applicable to version upgrades after 5.1.5 and 5.1.5.

1.3 Preparation before upgrade

• If you are an individual user who has not contacted the Fanruan sales manager, you can call Fanruan Business at 400-8118890 ext. 1 to obtain relevant information; if you have already connected with the Fanruan sales manager, you can use FineBI technical support (QQ: 800049425) Get the new version JAR file download link and "BI Upgrade" plugin package.

• Install the "BI Upgrade" plugin package in "Management > Plugin". For details, see: Plug-in Management .

2.1 Perform a system backup

Note: The version upgrade does not support the direct rollback of the lib file. Please be sure to perform the upgrade after the backup is completed. After the 5.1.14 and later versions are restarted, the configuration and the JAR version will be checked to see if the configuration is consistent with the JAR version. Replacing the same version of the lib is restarting.

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:

If the "Management > Intelligent Operation > backup and restore " page displays that the current environment is the built-in library does not support the backup and restore function, indicating that the project is an old version BI and does not support platform backup. You need to manually copy the dashboards, embed, lib, plugins, Reportlets, Resources folders in %FineBI%/webroot/WEB-INF to%FineBI%/webroot/backup directory. For more information, see Backup and Restore

Automatic backup method:

If you don't want to manually backup every time, versions after 5.1.13 support automatic backup during the upgrade process.

Use the  FINE_CONF_ENTITY configuration  plugin, click "Manage > System Tools", select "CustomParameterConfiguration", enter the system parameter name "BIUpdateConfig.autoBackup" and the system parameter value "true", and click Save, as shown in the following figure:

During the upgrade, it will automatically determine whether there is an external database backup on the day of the upgrade, if not, it will be automatically backed up before the upgrade.

Note: Automatic backup only backs up the external database. It is used to prevent forgetting to back up the external database. If you need to return the webroot folder that needs to be backed up manually, please refer to:Rollback to the original version after a cross-version upgrade

2.2 Create a new newJarPath file

If your BI project uses single sign-on or secondary development related plug-ins, please perform this step.

This step is to detect whether the plug-in dependencies will be lost after the upgrade. If the plug-in cannot be used after the upgrade, it will prompt in the risk item: Please delete the plug-in first, and install the latest plug-in after the upgrade.

Note: Due to the large number of secondary development plug-ins, it is not guaranteed that all plug-in problems will be detected. This item only collects some known problems.

Create a newJarPath folder in the %FineBI%/webroot/WEB-INF directory of the BI installation directory as the detection directory, and put the Jar package of the new version of BI to be upgraded into the detection directory, as shown in the following figure:

If the plugin dependency is missing, it will be prompted in the detection item in Section 2.3.

2.3 Run the upgrade tool to perform upgrade detection

1) Click "BI Upgrade" to enter the BI upgrade interface. The upgrade tool will first check the system before the upgrade, list the risk items in the upgrade, enter the "Upgrade Notes", read the notes and click "Next", as follows As shown in the figure:

2) After confirming that the project backup is completed, click "OK".

3) Enter "System Upgrade Detection", the system automatically detects risk items, and you can export and view the upgrade details.

Risk items are divided into three categories: escalation blocking items and escalation recommended items, as follows:

Users need to deal with these risk items according to their own situation before upgrading.

For detailed risk items and treatment plans, see: Upgrade Risk Items and Treatment Methods

2.4 Upload the JAR file and perform the upgrade

After processing the blocking risk item, you need to manually replace the JAR file to the %FineBI%/webroot/WEB-INF/lib directory.

2.6 Post-upgrade verification

1) After the system upgrade is completed, it is recommended to log in to the system using the super-manager and ordinary users respectively to check whether they can log in normally to ensure the success of the upgrade.

2) After the system upgrade is completed, it is recommended to log in to the system, switch the plug-in management interface, and upgrade the plug-ins that need to be upgraded online. If there is a problem, please do not roll back.

3) After the system upgrade is completed, it is recommended to log in to the system, click on the commonly used data set to update the data, and verify whether the data set update is available and whether the updated data is accurate.

3.1 Slow restart after upgrade

The first restart after the upgrade will perform a compatible upgrade on the configuration. The compatibility process may be slow. Please wait patiently. You can view the log during the process. If there is an output, it means that the upgrade is compatible. Do not kill the process halfway and restart it, otherwise the upgrade will fail. .

3.2 Upgrade Severe Failure Fallback Solution

For details, see: Rollback to the original version after a cross-version upgrade .