Overview
Version
Report Server Version | Functional Change |
11.0 | / |
11.0.7 | If the plugin A (installed in the former project) is built-in in the new version project, a prompt will pop up after you upgrade the JAR. If you manually install a plugin that has been provided as a built-in function, a prompt will pop up indicating that the plugin is already built-in. |
Application Scenarios
When you need a plugin to achieve a certain function, you can download and use them in the designer.
Note:
Functions
The plugin management interface provides a visual interface for installing, deleting, updating, disabling, and enabling plugins. Choose Server > Plugin Management in FineReport designer.
Plugin management has the following features:
1. Supports hot deployment. No need for restart after you Install, Delete, Update, Disable, or Enable a plugin
2. No need for restart after you configure a License
3. There are dependencies between automatic installation and plugin updating (including dependencies between plugins).
4. Automatically deletes unused files and service dependencies.
5. Automatically detects whether the plugin is compatible in a remote environment and synchronizes the running status of the plugin in real time.
Note: Starting from FineReport 11.0, the anti-crash plugin and new chart plugin are built-in (no need to install).
Installing a Plugin
There are two ways to install plugins: Install (from Store APP) and Local Install.
This section takes Component Event Manager plugin as an example to introduce how to install a plugin in the designer.
1. To install a plugin, you need to first switch the working directory to DEFAULT, otherwise the Plugin Management option will not be available in Server. 2. FineReport 11.0 supports hot deployment for plugins. Installation can take effect without restarting. 3. After a plugin is successfully installed, the plugin file is saved under the path %FR_HOME%\webapps\webroot\WEB-INF\plugins.Note:
Installing a Plugin in Store APP
1. Ensure that the designer switches the working directory to DEFAULT before installing a plugin. There is no Plugin Management option in Server when the designer is remotely connected to a server.
2. In the FineReport designer, choose Server > Plugin Management, enter the plugin name in the search box, select the plugin to be installed, and click Install.
3. After the plugin is successfully installed, a prompt pops up: Component Event Manager Plugin Install Successfully.
Installing a Plugin Locally
You can install plugins locally if network is not connected.
1. Download the plugin in Plugins by using another computer that can connect to the network. The compressed package obtained is shown in the following figure.
2. Ensure that the designer switches the working directory to DEFAULT before installing a plugin. There is no Plugin Management option in Server when the designer is remotely connected to a server.
3. Choose Server > Plugin Management in FineReport designer, click Local Install, and select the downloaded (or prepared) plugin's compressed package (in ZIP format).
Note:
Disabling/Enabling a Plugin
Choose Server > Plugin Management in FineReport Designer, and click Disable or Enable. A prompt pops up: Component Event Manager Plugin has been disabled/enabled.
Deleting a Plugin
Choose Server > Plugin Management in FineReport designer, select the plugin that needs to be deleted, click Delete, and click OK on the pop-up window.
Updating a Plugin
Choose Server > Plugin Management in FineReport designer, select the plugin that needs to be updated, click Update, and click OK on the pop-up window.
Notes
Unable to Use Plugin Function
Problem:
After installing a plugin on the platform (server-side), the plugin cannot be used on the designer side.
Cause:
For plugins that are used in both the server side and the designer side, both sides need to install:
1. If the server side installs the plugin while the designer side does not, the plugin will not take effect. Install the plugin in the designer side, which needs to switch to the local.
2. If both the server side and the designer side have installed the plugin, operations including Download, Delete, and Disable on the server side will not take effect immediately. It will take a few minutes to take effect.
3. If both the server side and the designer side have installed the plugin and the designer switches to the local, disabling the plugin will not affect the plugin's use on the server side during remote connection.
4. If both the server side and the designer side have installed the plugin, the plugin on the server side still does not take effect. You need to ensure whether the plugin versions on both sides are consistent. If they are, the plugin can be used normally.
No Resources of Plugin Store
Problem:
When you click the plugin center, a prompt pops up: You don't have resources for the plugin store yet. Download them?.
Solution:
Click OK directly. Or you can copy the scripts folder under the path %FR_HOME%\webapps\webroot in the available designer into the corresponding project.
Not Updating the Plugin Store
In the FineReport designer, when you choose Server > Plugin Management, a prompt pops up sometimes: There is a new version of the plugin store, do you want to update?. In this case, the updated plugins are those in the FanRuan Store, not the installed plugins. Click OK to proceed.
Disabling Automatic Update Function
The version of plugins like Crash Handle and Cloud Operation and Maintenance will be automatically detected and updated at the project starting time, after a period of starting, and every night at 11:00 PM.
Super admin can disable the automatic update function of these plugins through the FINE_CONF_ENTITY Visual Configuration plugin. The settings take effect after the server is restarted.
Parameter Name | Description | Parameter Value |
UpdateConfig.launchSwitchMap.plugins | Check whether the startup update of plugin automatic update is enabled. | Modify the parameter value to false if you need to disable the plugin automatic update after project startup, otherwise no modification is required. |
CronUpdateConfig.typeMap.plugins | Check whether the regular update of plugin automatic update is enabled. | Modify the parameter value to false if you need to disable the plugin update in the external network at 11:00 PM every night after the project starts, otherwise no modification is required. |
DelayUpdateConfig.delaySwitchMap.plugins | Check whether the delayed update of plugin automatic update is enabled. | Modify the parameter value to false if you need to disable the plugin automatic update after a period of the project startup, otherwise no modification is required. |
Verifying Plugin Integrity
Functions
The function of verifying plugin integrity is provided to prevent malicious tampering of the code in the plugin package when you install plugins locally or manually. This function is enabled by default.
If the plugin fails the integrity verification when you install it from the store or the local, a prompt pops up indicating that the signature of the plugin installation package is damaged and you cannot install for the sake of security.
Solution:
To disable the function of plugin package integrity verification, the admin can modify the field value of the PluginFileValidateConfig.fileValidateOpen in finedb to false.
If you need to enable the function of plugin package integrity verification and need to install a plugin (such as a secondary development plugin) that cannot pass the verification at the same time, you can install the plugin manually.
For details, see Explanation of Third-Party Plugin Installation Failure.
