1. 概述
1.1 版本
報表伺服器版本 | 功能變動 |
---|---|
11.0 | - |
11.0.7 | 隨版本升級,部分插件的功能可能直接合併到主JAR,無需安裝插件。 升級後此類插件直接禁用,無法全新安裝此類插件。 |
11.0.18 | 插件管理全面優化: 1)支援批量管理插件,包括:批量禁用/啟動、全部更新 2)插件管理介面拆分為「應用商城」和「我的插件」介面,並採用全新介面風格
|
1.2 應用場景
使用者工程部署在伺服器上,若需要插件實現某一功能時,可在伺服器中下載插件進行使用。
1.3 功能簡介
11.0.18 及之後版本,插件管理介面全面優化,並支援批量管理插件。本文將對插件管理的使用進行介紹。
管理者登入數據決策系統,點選「管理系統>插件管理」,如下圖所示:
應用商城:提供插件商城安裝、本地安裝插件功能。
我的插件:提供已安裝插件的資訊以及多種插件管理操作,包括:刪除、更新、禁用/啟用、批量禁用/啟用和全部更新操作。
注:IE8 及以下版本瀏覽器不支援。
插件管理支援以下特性:
支援熱部署,安裝、刪除、更新、禁用、啟用不需要重啟
配置 license 不需要重啟
自動安裝和更新插件的依賴(包括插件之間的依賴關係)
自動刪除不再使用的檔案和服務依賴
遠端環境下自動檢查插件是否匹配,並實時同步插件的運作狀態
注1:當設計器遠端連結伺服器時,伺服器如需使用某插件功能,則伺服器端和設計器端均需安裝該插件,方可正常使用。
注2:FineReport 設計器中下載插件請參見: 設計器插件管理
注3:FineReport 設計器切換工作區間到遠端環境,遠端環境下「伺服器」Tab 頁中沒有「插件管理」選項。
2. 安裝插件
伺服器上安裝插件有三種方法:下載安裝、本地安裝、手動安裝。
2.1 下載安裝
1)管理者登入數據決策系統,點選「管理系統>插件管理>應用商城」,在搜尋框中輸入插件名稱進行搜尋,選中需要安裝的插件,點選「安裝」,如下圖所示:
2)插件安裝成功後,彈出安裝成功彈窗。如下圖所示:
2.2 本地安裝
1)在 帆軟市場 內下載需要安裝的插件,得到的壓縮包如下圖所示:
注:在帆軟市場中需使用帆軟通行證登入後,才能下載插件。
2)管理者登入數據決策系統,點選「管理系統>插件管理>應用商城」,點選「從本地安裝」按鈕,選擇已下載(準備)的插件的.zip壓縮包。
插件安裝成功後,彈出安裝成功彈窗,點選「確定」,如下圖所示:
注:請勿解壓上文得到的壓縮包,直接安裝即可。
2.3 手動安裝
注:當使用者環境不允許上傳檔案或 War 包部署時,可手動安裝插件。
2.3.1 確定插件資料夾
1)FineReport 設計器所安裝的插件儲存在%FR_HOME%\webapps\webroot\WEB-INF\plugins 路徑中,如下圖所示:
注:路徑下的資料夾必須是在設計器中安裝插件生成的,不是官網下載的插件壓縮包解壓後得到的資料夾。
2)開啟某個插件資料夾下的plugin.xml檔案,可確定具體插件。如下圖所示:
2.3.2 複製貼上插件檔案
將設計器路徑%FR_HOME%\webapps\webroot\WEB-INF\plugins下的某個插件資料夾plugin-com.fr.plugin.decision.background.sso.v11-1.2.2複製貼上到伺服器%Tomcat_HOME%\webapps\webroot\WEB-INF\plugins 路徑下。如下圖所示:
2.3.3 重啟報表工程
手動安裝插件後,需要重啟報表工程,插件方可生效。
2.3.4 效果展示
重啟後,管理者登入數據決策系統,點選「管理系統>插件管理>我的插件」,搜尋插件名稱,可以看到伺服器中已成功安裝插件。如下圖所示:
3. 管理插件
管理者登入數據決策系統,點選「管理系統>插件管理>我的插件」,「我的插件」頁面中以列表形式展示已安裝插件的資訊,並支援對插件進行管理操作。
插件資訊包括:插件名稱、版本、待更新(僅在插件可更新時出現)、費用類別、狀態。
插件操作包括:搜尋、更新、禁用/啟用、刪除、全部更新、批量禁用/啟用。如下圖所示:
3.1 更新插件
3.1.1 單獨更新
管理者登入數據決策系統,點選「管理系統>插件管理>我的插件」,當插件可更新時,插件版本右側會新增「待更新」標識。
點選「更新」按鈕,更新完成後出現彈窗提示:XXX插件更新成功,點選「確定」即可。如下圖所示:
3.1.2 全部更新
管理者登入數據決策系統,點選「管理系統>插件管理>我的插件」,點選「全部更新」按鈕,將對已安裝的所有插件進行更新。
更新程式中提供進度條,便於獲知更新進度,全部插件更新完成後,出現彈窗提示:插件更新成功,點選「確定」即可,如下圖所示:
若部分插件更新失敗,將彈窗提示:XXX項插件處理失敗,XXX項插件處理成功,並提供更新失敗原因,如下圖所示:
3.2 禁用/啟用插件
3.2.1 單獨禁用/啟用
管理者登入數據決策系統,點選「管理系統>插件管理>我的插件」,點選「禁用/啟用」按鈕,出現彈窗提示:XXX插件已被禁用/啟用,點選「確定」即可,如下圖所示:
3.2.2 批量禁用/啟用
管理者登入數據決策系統,點選「管理系統>插件管理>我的插件」,勾選需要禁用/啟用的插件,點選「禁用/啟用」按鈕,如下圖所示:
出現彈窗提示:所選插件禁用/啟用成功,點選「確定」即可,如下圖所示:
3.3 刪除插件
管理者登入數據決策系統,點選「管理系統>插件管理>我的插件」,點選「刪除」按鈕,點選彈窗上的「確定」按鈕即可,如下圖所示:
4. 注意事項
4.1 關閉插件自動更新功能
「當機處理」、「雲端健檢分析」等插件,在工程啟動時、啟動一段時間後、每晚 23 點會自動檢查插件版本並更新。
超級管理者可透過「fine_conf_entity視覺化配置插件」關閉此類插件的自動更新。重啟伺服器後設定生效。
注:修改 FineDB 資料庫表欄位值的方法請參考 FineDB 常用表欄位修改 。
參數名 | 參數描述 | 參數值 |
---|---|---|
UpdateConfig.launchSwitchMap.plugins | 插件自動更新的啟動更新是否開啟 | 如需關閉工程啟動後的插件自動更新,請將參數值修改為false,否則無需改動 |
CronUpdateConfig.typeMap.plugins | 插件自動更新的定時更新是否開啟 | 如需關閉工程啟動後每晚11點的外網更新插件,請將參數值修改為false,否則無需改動 |
DelayUpdateConfig.delaySwitchMap.plugins | 插件自動更新的延遲更新是否開啟 | 如需關閉工程啟動後延遲一段時間的插件自動更新,請將參數值修改為false,否則無需改動 |
4.2 插件完整性校驗
功能說明:
本地安裝/手動安裝插件時,為了防止惡意篡改插件包中的程式碼,提供插件完整性校驗功能。該功能預設開啟。
下載安裝/本地安裝插件時,若該插件未透過完整性校驗,則提示「XXX插件安裝包簽章損壞,存在安全風險,無法安裝」。如下圖所示:
解決方案:
如需關閉插件包完整性校驗,管理者可透過修改finedb中的PluginFileValidateConfig.fileValidateOpen欄位值為false。
如需開啟插件包完整性校驗,但仍必須要安裝某個簽章無法透過校驗的插件(例如二開插件),則可透過手動安裝的方式安裝插件。
詳情請參見:第三方插件安裝失敗說明
4.3 插件內建提示
隨版本升級,部分插件的功能可能直接合併到主JAR,無需安裝插件。
1)使用者手動全新安裝此類已內建功能的插件,提示「XX插件因功能內建而自動失效,不影響原功能使用」
2)工程升級後,原插件直接禁用,提示「以下插件已內建進主產品,建議刪除殘留檔案」。
建議前往插件管理手動刪除插件。