I. Overview
1. Version
Report server version | Functional changes |
---|---|
10.0 | - |
10.0.19 | Support to turn off automatic update of some plugins Added plugin integrity check function |
2. Application scenarios
The user project is deployed on the server. If a plugin is required to implement a certain function, the plugin can be downloaded from the server for use.
3. Function introduction
Plugin management provides a visual interfaceInstall,Delete,Update,Disabled,Enableplugin. As shown below:
Note: IE8 and below browsers are not supported.
Plugin management supports the following features:
Support hot deployment, install, delete, update, disable, enable without restarting
Configure the license without restarting
Automatically install and update plugin dependencies (including dependencies between plugins)
Automatically delete files and service dependencies that are no longer used
Automatically detect whether the plugin matches in the remote environment, and synchronize the running status of the plugin in real time
Note 1: 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 side and the designer side before it can be used normally. For download plugins in FineReport Designer, please refer to: Designer plugin management
Note 2: FineReport Designer switches the working directory to the remote environment. There is no "Plugin Management" option in the "Server" Tab page in the remote environment.
II. Install the plugin
There are three ways to install plugins on the server: download installation, local installation, and manual installation.
1. Download and install
1) Enter the data decision system as an administrator, clickManagement >Plugin , enter in the search boxPlugin nameSearch, select the plugin you want to install, and clickInstall, take the installation of the Real-time plugin as an example, 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
1) Download the Real-time plugin on the FanRuan market , and the compressed package obtained is shown in the following figure:
Note: In the Fanruan market, you need to log in with the Fanruan pass before you can download the plugin.
2) Enter the data decision system as an administrator, click Management > Plugin > Local Install , and select the .zip archive, as shown in the following figure:
Note: Do not decompress the compressed package obtained above, just install it directly.
3. Manual installation
Note: When there is no purchase decision system or War pack deployment, the plugin can be installed manually.
1) Determine the plugin folderThe plugins installed by FineReport Designer are stored in%FR_HOME%\webapps\webroot\WEB-INF\plugins path, as shown in the following figure:
Note: The folder under the path must be generated by installing the plugin in the designer, not the folder obtained after decompressing the plugin compressed package downloaded from the official website.
Open a plugin folderplugin.xmlfile to identify specific plugins. As shown below:
will%FR_HOME%\webapps\webroot\WEB-INF\pluginsdownplugin-com.fr.plugin.concurrency.count-1.0 Folder copy paste to%Tomcat_HOME%\webapps\webroot\WEB-INF\plugins under the path. As shown below:
Reboot Tomcat server, enter the data decision system as an administrator, clickManage >Plugin , you can see that the Real-time plugin has been successfully installed. As shown below:
III. Disable/enable plugins
At the server My Plugins,checkeda plugin, clickdisable/enablebutton, prompt:Plugin has been disabled / Plugin has been actived. As shown below:

IV. Delete the plugin
At the server My Plugins,checkedTo remove the plugin, clickDeletebutton, click on the pop-upOKbutton. As shown below:
V. Update the plugin
On the platform My Plugins, select the plugin to be updated and clickUpdatebutton, click on the pop-upOKbutton. As shown below:
VI. Precautions
1. Turn off the plugin automatic update function
Plugins such as Downtime processingand Cloud operation and maintenance will 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 FineDB .
Parameter name | Parameter Description | Parameter value |
---|---|---|
UpdateConfig.launchSwitchMap.plugins | Whether the startup update of plugin automatic update is enabled | If you want to disable the automatic update of the plugin after the project is started, please change the parameter value to false, otherwise no need to change |
CronUpdateConfig.typeMap.plugins | Whether the regular update of the plugin's automatic update is enabled | If you need to close the external network update plugin at 11:00 every night after the project starts, please change the parameter value to false, otherwise no need to change |
DelayUpdateConfig.delaySwitchMap.plugins | Whether the delayed update of plugin automatic update is enabled | If you want to disable the automatic update of the plugin that is delayed for a period of time after the project is started, please modify the parameter value to false, otherwise there is no need to change |
2. 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 FineDB .
Parameter name | Parameter Description | Parameter value |
---|---|---|
PluginFileValidateConfig.fileValidateOpen | Whether the plugin package integrity check is enabled | The parameter value needs to be a boolean, the default is false false: Plugin package integrity check is disabled true: plugin package integrity check is enabled |
If the plugin integrity check function is enabled, if the plugin package is decompressed/destroyed, when installing the plugin locally, the installation of the plugin to the system will be prohibited, and an error will be reported to remind The signature of this plugin installation package is damaged, there is a security risk and cannot be installed.
Note 1: If the plugin integrity verification function is enabled, but a plugin whose signature fails to pass the verification (such as a two-open plugin) must be installed, the user can install the plugin manually. For details, please refer to Section II.3 of this document. .
Note 2: The plugin integrity check function is only valid for FanRuan official plugins, and third-party plugns are not valid.