反馈已提交

网络繁忙

You are viewing 5.1 help doc. More details are displayed in the latest help doc.

Plugin Management

  • Recent Updates: September 28, 2022
  • Ⅰ. Overview

    1.Version

    FineBI version

    Functional changes

    5.0

    -

    5.1.13

    All BI plug-ins will be automatically upgraded following the upgrade of   the corresponding BI

    5.1.16

    Support to turn off automatic update of some plugins

    Added plugin integrity check function


    2. Application scenarios

    If you need a plug-in to achieve a certain function, you can download the plug-in in "plug-in management" for use.

    3. Function introduction

    Plugin management provides a visual interface to install , delete , update , disabled , and enable plugins. As shown below:

    Note: IE8 and below browsers are not supported.

    1.png

    Ⅱ. Install the plugin

    There are three ways to install plug-ins on the server: download installation, local installation, and manual installation.

    Note: The example server in this chapter is the Tomcat server , and the example plug-in is "HTML5 Mobile Display Plug-in".

    1. Download and install

    1) Enter the Decision-making System as an administrator, click Manage > Plugin, enter the name of the plugin in the search box to search, select the plug-in to be installed, and click Install . Take the installation of the "HTML5 Mobile Display" plug-in as an example, as shown in the figure below Show:

    1.png

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

    2. Local installation

    1) Download the "HTML5 Mobile Display" plugin on the https://community.finereport.com/market/, and the obtained compressed package 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 plug-in

    1.png

    2) Enter the data decision system as an administrator, click Management System > Plug-in Management > Install from Local , and select the .zip archive

    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 folder

    • The plugins installed by FineBI are stored in the %BI_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 plug-in in FineBI, not the folder obtained after decompressing the plug-in zip package downloaded from the official website.

    1592190869885409.png

    • plugin.xml file in a plugin folder to determine the specific plugin. As shown below:

    1592188501979200.png

    2) Copy and paste plugin files

    Copy and paste the plugin-com.fr.plugin.mobile.web-10.4.76 folder under %BI_HOME%\webapps\webroot\WEB-INF\plugins to the % Tomcat_HOME%\webapps\webroot\WEB-INF\plugins path Down. As shown below:

    1592189488513861.png

    3) Effect display

    Restart the Tomcat server, enter the data decision system as an administrator, click Management System > Plugin Management,and you can see that the "HTML5 Mobile Display" plugin has been successfully installed. As shown below:

    2022-07-13_17-44-51.png

    Ⅲ. Disable/enable plugins

    On the server "My Plugins", select a plugin, click the Disable/Enable button, it will prompt: Plugin has been disabled/Plugin has been enabled 

     Ⅳ. Remove the plugin

    On the server "My Plugins", select the plugin to be deleted, click the Delete button, and click the OK button on the pop-up window.

    Ⅴ. Update the plugin

    On the platform "My Plugins", select the plugin to be updated, click the Update button, and click the OK button on the pop-up window.

    Ⅵ. Precautions

    1. Turn off the plug-in automatic update function

    Plug-ins such as "downtime processing" and "cloud operation and maintenance" will automatically detect and update the plug-in version when the project is started, after a period of time, and at 23:00 every night.

    For BI projects of version 5.1.16 and later, the super administrator can disable the automatic update of such plug-ins through "fine_conf_entity Visual Configuration Plug-in". 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 plug-in 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

    In order to prevent malicious tampering with the code in the plug-in package when installing the plug-in locally/manually, the BI project of version 5.1.16 and later provides the plug-in 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: Plug-in 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/corrupted:

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

    2) When manually installing the plug-in, the plug-in 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 1: If the plug-in integrity verification function is enabled, but a plug-in whose signature fails to pass the verification (such as a two-open plug-in) must be installed, the user can install the plug-in manually. For details, please refer to Section 2.3 of this article. .

    Note 2: The plug-in integrity check function is only valid for FanRuan official plug-ins, and third-party plug-ins are not valid. To add verification signatures to third-party plugins, please contact technical support. Technical support contact information: QQ "800049425", telephone "400-811-8890".

    Attachment List


    Theme: Admin Guide
    Already the First
    Already the Last
    • Helpful
    • Not helpful
    • Only read

    售前咨询电话

    400-811-8890转1

    在线技术支持

    在线QQ:800049425

    热线电话:400-811-8890转2

    总裁办24H投诉

    热线电话:173-1278-1526

    文 档反 馈

    鼠标选中内容,快速反馈问题

    鼠标选中存在疑惑的内容,即可快速反馈问题,我们将会跟进处理。

    不再提示

    10s后关闭