Designer Plugin Management

1. Version

1.2 Application scenarios

When users need a plugin to achieve a certain function, they can download the plugin in the designer for use.

Note 1: For downloading plugins in the server, please refer to:  Server Plugin Management

Note 2: When the designer connects to the server remotely, if the server needs to use a plugin function, the plugin must be installed on both the server and the designer, and the plugin version must be the same before it can be used normally.

1.3 Function introduction

The plugin management interface provides a visual interfaceInstall,Delete,Update,Disabled,Enableplugin. In the FineReport designer, click Server > Plugin Management, as shown in the following figure:

Plugin management supports the following features: 

1) Support hot deployment, install, delete, update, disable, enable without restarting.
2) No restart is required to configure the license.
3) Automatically install and update plugin dependencies (including dependencies between plugins).
4) Automatically delete files and service dependencies that are no longer used.
5) Automatically detect whether the plugin matches in the remote environment, and synchronize the running status of the plugIn in real time.

Note: Since FineReport 9.0, the Anti-Crash Plugin and New Chart Plugin are built-in, no need to install.

There are two ways to install plugins, the first is to install from the plugin store, and the second is to install locally. This chapter takes the installation of theExport Excel plugin as an example to introduce the steps to install the plugin in the designer.

Note 1: When the designer installs the plugin, first  Switch the working directory  to the local directory, otherwise there is no Plugin Management option in the server menu.

Note 2: The plugins in FineReport 9.0 and FineReport 10.0 support hot deployment, and the installation does not need to be restarted to take effect.

Note 3: After the plugin is installed successfully, the plugin files are saved in the %FR_HOME%\webapps\webroot\WEB-INF\plugins folder.

1. Plugin store installation

1) Click Server>Plugin Management in the FineReport Designer, enter the plugin name in the search box to search, select the plugin to be installed, and click Install, as shown in the following figure:

2) After the plugin is installed successfully, a pop-up window will pop up. As shown below:

2. Local installation

When the Internet is not available, the plugin can be installed by local installation.

1) Use other computers that can be connected to the Internet to download the plugin in the  FanRuan market  , and the obtained compressed package is shown in the following figure:

2) In the FineReport designer, click "Server > Plugin Management", click the Local Install button, and select the .zip archive of the downloaded (prepared) plugin, as shown in the following figure:

Note: Do not decompress the compressed package obtained above, just install it directly.

In the FineReport designer, click Server > Plugin Management, click the Disable/Enable button, and prompt:Plugin has been disabled / Plugin has been enabled. As shown below:

In the FineReport Designer, click Server > Plugin Management, select the plugin to be deleted, click the Delete button, and click the OKbutton on the pop-up window. As shown below:

In the FineReport designer, click Server > Plugin Management, select the plugin to be updated, click the Updatebutton, and click the OK button on the pop-up window. As shown below:

1. Plugin function cannot be used

Problem Description:

After the plugin is installed on the platform (server side), the designer side cannot be used.

Cause Analysis:

For plugins used by both the designer and the server, both the server and the designer are required to be installed:

1) If the plugin is installed on the server side, but not on the designer side, the plugin will not take effect, and you need to switch to the local for plugin installation.

2) If plugins are installed on both the server side and the designer side, the plugins on the server sideDownload,Delete,DisabledIt will not take effect immediately, it will take a few minutes for it to take effect.

3) If a plugin is installed on both the server side and the designer side, the designer switches to the local and disables the plugin, which does not affect the use of the plugin on the server side when connecting remotely.

4) If plugins are installed on both the server side and the designer side, the plugin on the server side will not take effect. It is necessary to confirm whether the versions of the plugins on the server side and the designer side are the same, and the versions can be used normally.

2. Resources without a plugin store

Problem phenomenon:

When clicking on the plugin center, it prompts:You don't have the resources of the plugin store, do you want to download it?

Solution:

You can click OK directly, or set the%FR_HOME%\webapps\webroot\scriptsCopy the folder to the corresponding project, as shown in the following figure:

3. There is a new version in the plugin store, whether to update

Click Server > Plugin Managementin the FineReport Designer, sometimes a pop-up window will prompt:There is a new version in the plugin store, is it updated?At this time, the plugins in the FanRuan mall are updated, and the installed plugins will not be updated. Click the OK button.

4. Turn off the automatic update function of the plugin

Plugins such as Downtime processing  and Cloud operation and maintenancewill automatically detect and update the plugin version when the project is started, after a period of time, and at 23:00 every night.

For report projects of version 10.0.19 and later, super administrators can disable the automatic update of such plugins through fine_conf_entity Visual Configuration Plugin. The settings take effect after restarting the server.

Note: For the method of modifying the field value of the FineDB database table, please refer to the  modification of Common table fields in FineDBC  .

5. Enable plugin integrity check

When installing plugins locally/manually, in order to prevent malicious tampering with the code in the plugin package, the 10.0.19 and later versions of the project provide the plugin integrity check function. This feature is disabled by default.

The super administrator can enable the integrity verification function of the uploaded plugin installation package through fine_conf_entity Visual Configuration Plugin. The settings take effect after restarting the server.

Note: For the method of modifying the field value of the FineDB database table, please refer to the  modification of Common table fields in FineDBC  .

If the plugin integrity check function is enabled, if the plugin package is decompressed/corrupted:

1) When installing a plugin locally, it is forbidden to install the plugin to the system, and an error is reported to remind The signature of this plugin installation package is damaged, there is a security risk, and it cannot be installed.

2) When manually installing the plugin, the plugin is not loaded into the system, an error will be reported in the log, but no error will be reported at the front end.

Note: This function is only valid for FanRuan official plugins, and third-party plugins are not valid.