Integrating FineReport to FineBI

Application Scenarios

You may need to integrate FineReport projects into FineBI decision-making platform in actual use.

This article will introduce the steps to integrate FineReport into FineBI.

Functions

· You can combine the two software programs into an integrated system requiring one set of application services for maintenance.

· You only need to log into one platform because users, permission system, portal, and management system of two platforms are unified after integration.

Note:

Note: If you want to access the two platforms from a unified portal without integration, see FineBI and FineReport Connection Tool Plugin.

Recommending Server Configuration

For example, if there is high memory consumption, you can increase memory based on the requirements of FineBI. For details, see FineBI Server Configuration Recommendation.

Version Compatibility

Before operation, ensure that versions of FineBI and FineReport are compatible.

Note:

FineBI 6.0 is only compatible with FineReport 11.0. For details about version compatibility, see FineBI and FineReport Version Compatibility.

Checking Report Module Version

Checking FineBI Version

The admin logs into decision-making platform, select Manage > Registration, and view the version in Report Module.

Checking FineReport Version

You can view FineReport version in the designer or platform.

In the designer:

Open the designer, click Help > Update and Upgrade, and view the current FineReport version.

On the platform:

Enter the platform as an admin, click Manage > Registration, and view the current FineReport version.

Checking External Database Configuration

· Before integration, if you have configured an external database in FineReport, and still use it after integration, you need to copy the file db.properties under the directory %FR_HOME%\webapps\webroot\WEB-INF\config to the corresponding path in FineBI. Built-in database does not require the operation.

· If you have configured an external database in FineBI, you can still use it after integration without any operations.

Checking Project License

Before integration, you need to delete the licenses of FineReport and FineBI, and add a license that registers both FineReport and FineBI functions or other license after integration.

Specific Steps Under Different Conditions

Note:

1. You can only maintain the configuration of FineReport or FineBI. If you maintain the configuration of FineReport, the configuration of FineBI will be lost completely, including the dashboard configuration.

2. If you want to maintain the configuration of FineReport and the dashboards and datasets of FineBI, you need to mount the needed dashboards before integration, and export the dashboards and datasets through resource migration. For details, see section "Maintaining Datasets and Dashboards of FineBI and Configurations of FineReport".

3. After integration, the decision-making platform defaults to the port number of FineBI. For example, before integration, if the port number of FineReport decision-making platform is 8075, and the port number of FineBI decision-making platform is 37799, then the project will default to 37799 after integration.

Required Operations

Copying the Main Project JAR Packages

After synchronizing the JAR packages of FineBI and FineReport, you need to copy all JAR packages under FineReport directory %FR_HOME%\webroot\WEB INF/lib to the corresponding folder in FineBI. If there are duplicate JAR packages during the process, you need to keep the FineBI JAR packages.

Note:

 If there are drivers under the directory %FR_HOME%\webroot\WEB-INF\lib, it is necessary to determine which driver is required for data connection after integration and keep the corresponding version of driver.

Copying Plugins

Copy all files under the directory %FR_HOME%\webroot\WEB-INF\plugins to the corresponding path in FineBI. If there are duplicate files, you need to keep the FineBI files.

Copying the folder phantomjs from FineReport to FineBI

Note:

This step is not required for FineReport versions after 2020/04/26.

Copy the folder phantomjs under FineReport directory %FR_HOME%\webroot\WEB-INF\assist to the corresponding directory in FineBI. Without this operation, charts in chart export and task schedule of FineReport will not be displayed.

Optional Operations

You can perform the following operations as needed, choosing to save the embed, logs, or resources folders of FineReport or FineBI. For details about folders, see Structure of FineBI Installation Directory.

Embed Folder

The embed folder stores configuration information of decision-making platform such as built-in database FineDB and template scheduled tasks.

Note:

All configuration information of Manage is kept in the embed folder. When you copy the folder under FineReport directory and paste it to FineBI directory, all data of FineBI will be replaced. Only changing a sub-directory of Manage such as User is not available.

Copy the embed folder from the FineReport directory %FR_HOME%\webroot\WEB-INF to the corresponding FineBI directory and replace the original embed folder of FineBI. If you want to keep the configuration information of FineBI, you can skip this step.

Logs Folder

The logs folder is the built-in database that saves logs after FineBI log monitor is enabled.

If you want to keep the log data in FineReport, you need to copy the logs folder under the FineReport directory %FR_HOME%\webroot to replace the original folder in the FineBI directory %FineBI%\webroot. If you want to keep the log data in FineBI, you can skip this step.

Resources Folder

The resources folder contains report information, configuration information and so on.

If you want to keep relevant information in the folder of FineReport after integration, see Structure of FineBI Installation Directory. Copy the needed files from %FR_HOME%\webroot\WEB-INF\resources to %FineBI%\webroot\WEB-INF\resources and replace the orinigal files in FineBI.

Chartmapsvg Folder

If there are old map templates in the FineReport project, you can copy the chartmapsvg folder under %FR_HOME%\webapps\webroot\WEB-INF\assets\chartmapsvg to the target directory in FineBI.

Maintaining FineBI Datasets and Dashboards and FineReport Configuration

1. If you want to maintain the configuration of FineReport as well as the dashboards and datasets of FineBI, you need to mount the needed dashboards before integration, and export the dashboards and datasets through resource migration.

2. After integration, delete the dashboard folder under %FineBI%\webroot\WEB-INF\dashboards.

3. Build a data connection that is the same as the original FineBI, and then perform resource import.

Demonstration

If you keep the configuration of FineBI, the FineBI project will not change.

If you keep the configuration of FineReport, templates in the Directory nodes, and configurations of sub-directories under Manage such as User, Permission, and Task Schedule of the FineBI project are the same as those in FineReport.

After integration, data processing will be done in FineBI; FineReport projects can still work independently.

For example, before integration, there is a scheduled task named a in FineReport project and a scheduled task named b in FineBI project. If you keep the configuration of FineReport, b will be overwritten by a after integration.

Note:

With the platform external integration plugin, you can remove the navigation bar on the left and the top in FineBI, achieving better integration.

Detailed explanations about integrating templates made in FineReport to FineBI will be given in this section.

1. Go to the template path %FR_HOME%\webroot\WEB-INF\reportlets, copy and paste it under the corresponding FineBI directory. For example, copy the FineReport report GettingStarted.cpt to FineBI.

2. Add the data connection used in FineReport to FineBI and the data connection name needs to be the same. For details, see Configuring Data Connection.

3. Log into FineBI decision-making platform, go to Manage > Directory and click Add Template.

4. Select the copied report template.

5. Click Next to set the name, description and so on of the template, and click OK.

6. Refresh the page and you can see the added FineReport report under Directory.

Note:

When integrating, you need to use the licenses of FineBI for licenses unity.

Missing Images in BI Dashboard

Problem

After integration, the original images in FineBI are lost.

Solution

The uploaded images of FineBI picture component are kept in the file assets/temp_attach. If they are lost after integration, copy the content of these folders to the corresponding folder in FineReport.