設計器插件管理

1.1 版本

1.2 應用場景

使用者需要插件實現某一功能時，可在設計器中下載插件進行使用。

注1：伺服器中下載插件可參考： 伺服器插件管理

注2：當設計器遠端連結伺服器時，伺服器如需使用某插件功能，則伺服器端和設計器端均需安裝該插件，且插件版本需保持一致，方可正常使用。

1.3 功能簡介

11.0.18 及之後版本，新插件管理器對插件管理介面進行了全面優化，並支援批量管理插件。本文將對新插件管理器的使用進行介紹。

在 FineReport 設計器中點選「伺服器>插件管理」，如下圖所示：

• 應用商城：提供插件商城安裝、本地安裝插件功能。

• 我的插件：提供已安裝插件的資訊以及多種插件管理操作，包括：刪除、更新、禁用/啟用、批量禁用/啟用和全部更新操作。

插件管理支援以下特性： 

1）支援熱部署，安裝、刪除、更新、禁用、啟用不需要重啓。
2）配置 License 不需要重啓。
3）自動安裝和更新插件的依賴（包括插件之間的依賴關係）。
4）自動刪除不再使用的檔案和服務依賴。
5）遠端環境下自動檢查插件是否匹配，並實時同步插件的運作狀態。

注：自 FineReport 11.0 中，「防當機插件」和「新圖表插件」已內建，無需安裝。

1.4 使用前提

在設計器中安裝、管理插件時，必須確定設計器 切換工作區間 至本地目錄，如下圖所示：

注：遠端連結遠端伺服器時，「伺服器」菜單欄內沒有「插件管理」選項，無法在設計器中進行插件安裝、管理操作。

插件安裝有兩種方式，第一種是從插件商城安裝，第二種是從本地安裝。

本章以安裝「後臺單點登入插件」為例，介紹設計器中安裝插件的步驟。

注1：設計器安裝插件先 切換工作區間 至本地目錄，否則「伺服器」菜單欄內沒有「插件管理」選項，詳情請參考本文 1.4.2 節。

注2：FineReport 11.0 中插件支援熱部署，安裝不需要重啓即可生效。

注3：插件安裝成功後，插件檔案儲存在 %FR_HOME%\webapps\webroot\WEB-INF\plugins 資料夾中。

2.1 插件商城安裝

1）在 FineReport 設計器中點選「伺服器>插件管理>應用商城」，在搜尋框內輸入插件名稱進行搜尋，選中需要安裝的插件，點選「安裝」，如下圖所示：

2）插件安裝成功後，彈出安裝成功彈窗，如下圖所示：

2.2 本地安裝

當無法網路連結的時候，可以透過本地安裝的方式來安裝插件。

1）使用其他可以網路連結的電腦在 帆軟市場 中下載插件，得到的壓縮包如下圖所示：

2）在 FineReport 設計器中點選「伺服器>插件管理>應用商城」，點選「從本地安裝」按鈕，選擇已下載（準備）的插件的.zip壓縮包。

插件安裝成功後，彈出安裝成功彈窗，點選「確定」，如下圖所示：

注：請勿解壓上文得到的壓縮包，直接安裝即可。

在 FineReport 設計器中點選「伺服器>插件管理>我的插件」，「我的插件」頁面中以列表形式展示已安裝插件的資訊，並支援對插件進行管理操作。

• 插件資訊包括：插件名稱、版本、待更新（僅在插件可更新時出現）、費用類別、狀態。

• 插件操作包括：搜尋、更新、禁用/啟用、刪除、全部更新、批量禁用/啟用。如下圖所示：

3.1 更新插件

3.1.1 單獨更新

在 FineReport 設計器中點選「伺服器>插件管理>我的插件」，當插件可更新時，插件版本右側會新增「待更新」標識。

點選「更新」按鈕，更新完成後出現彈窗提示：XXX插件更新成功，點選「確定」即可。如下圖所示：

3.1.2 全部更新

在 FineReport 設計器中點選「伺服器>插件管理>我的插件」，點選「全部更新」按鈕，將對已安裝的所有插件進行更新。

更新過程中提供進度條，便於獲知更新進度，全部插件更新完成後，出現彈窗提示：插件更新成功，點選「確定」即可，如下圖所示：

若部分插件更新失敗，將彈窗提示：XXX項插件處理失敗，XXX項插件處理成功，點選「查看詳情」按鈕即可查看失敗原因，如下圖所示：

3.2 禁用/啟用插件

3.2.1 單獨禁用/啟用

在 FineReport 設計器中點選「伺服器>插件管理>我的插件」，點選「禁用/啟用」按鈕，出現彈窗提示：XXX插件已被禁用/啟用，點選「確定」即可，如下圖所示：

3.2.2 批量禁用/啟用

在 FineReport 設計器中點選「伺服器>插件管理>我的插件」，勾選需要禁用/啟用的插件，點選「禁用/啟用」按鈕，出現彈窗提示：所選插件禁用/啟用成功，點選「確定」即可，如下圖所示：

3.3 刪除插件

在 FineReport 設計器中點選「伺服器>插件管理>我的插件」，點選「刪除」按鈕，點選彈窗上的「確定」按鈕即可，如下圖所示：

4.1 插件功能無法使用

問題描述：

平台（伺服器端）安裝插件後，設計器端無法使用。

原因分析：

對於設計器和伺服器都會用到的插件，要求伺服器端和設計器端都要安裝：

1）若伺服器端安裝了插件，設計器端沒有安裝插件，則插件不會生效，需要切換到本地進行插件安裝。

2）若伺服器端和設計器端均安裝了插件，伺服器端的插件下載、刪除、禁用不會立即生效，需要等幾分鐘才會生效。

3）若伺服器端和設計器端均安裝了插件，設計器切換到本地，禁用該插件，不影響遠端連結時伺服器端的插件使用。

4）若伺服器端和設計器端均安裝了插件，伺服器端的插件不生效，需要應答伺服器端和設計器端的插件版本是否一致，版本一致可正常使用。

4.2 沒有插件商店的資源

問題現象：

點選插件中心時，提示：您還沒有插件商店的資源，是否下載？如下圖所示：

解決方案：

可以直接點選「確定」，或將可用設計器中的%FR_HOME%\webapps\webroot\WEB-INF\assets下的upm新插件管理資源資料夾拷到相應的工程中，如下圖所示：

4.3 應用商城有新版本，點選更新

在 FineReport 設計器中點選「伺服器>插件管理」，有時會彈窗提示：應用商城有新版本，點選更新，此時更新的是帆軟商城中的插件，不會更新已安裝的插件，點選更新即可。如下圖所示：

4.4 關閉插件自動更新功能

「當機處理」、「雲端健檢分析」等插件，在工程啟動時、啟動一段時間後、每晚 23 點會自動檢查插件版本並更新。

超級管理者可透過「fine_conf_entity視覺化配置插件」關閉此類插件的自動更新。重啓伺服器後設定生效。

注：修改 FineDB 資料庫表欄位值的方法請參考 FineDB 常用表欄位修改。

4.5 插件完整性校驗

功能說明：

本地安裝/手動安裝插件時，為了防止惡意篡改插件包中的代碼，提供插件完整性校驗功能。該功能預設開啓。

下載安裝/本地安裝插件時，若該插件未透過完整性校驗，則提示「XXX插件安裝包簽章損壞，存在安全風險，無法安裝」。如下圖所示：

解決方案：

如需關閉插件包完整性校驗，管理者可透過修改finedb中的PluginFileValidateConfig.fileValidateOpen欄位值為false。

如需開啓插件包完整性校驗，但仍必須要安裝某個簽章無法透過校驗的插件（例如二開插件），則可透過手動安裝的方式安裝插件。

詳情請參見：第三方插件安裝失敗說明