1. 概述
1.1 版本
FineBI伺服器版本 | 功能變更 |
---|---|
6.0 | - |
6.1.1 | 調度週期:新增功能「範本報錯中斷執行」 |
6.1.2 | 過濾設定中的資料來源優化 |
1.2 功能簡介
有關排程管理功能基本的介紹和操作方法可以參見文檔:排程管理
排程管理任務設定時包含四個操作步驟,如下圖所示。本文將詳細介紹這四個操作步驟中的設定項。
2. 新增任務
管理者登入數據決策系統,點選「管理系統>排程管理>任務管理」,點選「新增任務」,即可建立一個排程管理任務。如下圖所示:
注:普通使用者若需要設定排程管理任務,需要管理者為其配置「管理系統>排程管理」的使用權限,具體步驟請參見 排程管理管理權限 。
3. 基本設定
「基本設定」介面如下圖所示:
3.1 任務名稱
填寫排程管理任務的名稱。
任務名稱不可為空。
任務名稱不可與其他排程管理任務重複,否則提示「任務名稱已經存在」。
任務名稱只允許包含字母、漢字、數字、底線、減號、點和括號。
進行中的任務名稱禁止修改。
3.2 預設使用者組
用途:設定預設使用者組的目的是為了在第四步「檔案處理」時根據使用者組成員傳送通知。預設使用者組可為空。
設定:點選「編輯」按鈕,支援根據「使用者、部門、角色」來新增預設使用者組成員,點選「確定」即可成功新增,最終的使用者組取三者的並集且去掉重複項。
其中,使用者的新增方式有兩種:
平台:使用者來源於數據決策系統。
自訂使用者:使用者來源於伺服器資料集。但是選擇的資料集列資料需要是平台中的帳號,否則任務執行無法成功。
4. 調度物件
4.1 調度物件
調度物件有四種類型:報表範本、多選報表範本、BI 範本、無調度物件。
本章僅介紹調度物件為「BI 範本」時的設定,其他請參考 排程管理任務設定 的第四章。
1)無調度物件
當調度物件選擇「無調度物件」時,僅支援設定「調度結果」,一般用於企業傳送公告。
2)報表範本
當調度物件選擇「報表範本」時,可選擇單張 FineReport 範本,用於推播、儲存、查看報表執行結果。支援以下設定:
3)多選報表範本
當調度物件選擇「多選報表範本」時,可選擇多張 FineReport 範本,但僅可使用郵件推播報表執行結果。支援以下設定:
多選報表範本和單個報表範本的設定基本相同,可為每張範本單獨配置參數設定、檔案名稱和附件存檔。支援拖曳調整範本的先後順序。
執行條件處若使用「公式判斷」或「自訂類判斷」,涉及到和範本內容相關的,只支援取第一個選中的範本。
檔案處理處僅支援「郵件通知」一種處理方式,標題或正文中若使用公式,只支援取第一個選中的範本。
4)BI範本
當調度物件選擇「BI範本」時,可選擇單張FineBI儀錶板。支援以下設定:
4.2 選擇範本
選擇 BI 工程中建立的儀錶板,不能為空。
4.3 過濾設定
新增過濾條件,對所選擇的儀表板的資料集進行過濾。如下圖所示:
過濾條件中支援選擇的資料來源如下表所示:
版本 | 說明 |
---|---|
6.1.2 及以上版本 | 支援選擇:所選 BI 範本引用的主題下的資料 支援選擇:所選 BI 範本引用的「公共資料」下的、有「授權權限」的資料 注:從低版本升級至 6.1.2 及以上版本後,選擇的資料集若不是所選 BI 範本引用的資料,再次配置該配置時欄位會標紅,需重新配置。 |
6.1.2 之前版本 | 支援選擇:所選 BI 範本引用的「公共資料」下的、有「授權權限」的數據 如選擇「公共資料」下、非 BI 範本引用的資料,雖然可以選擇但過濾不生效 |
注1:若檔案處理方式選擇「用戶端通知」,過濾設定僅對定時結果連結生效,對自訂連結不生效。
注2:過濾條件只是對展示結果做最後過濾,不會對預警條件生效,就是先預警後過濾。
4.4 調度結果
注1:若「排程管理>基本設定>預設使用者組」為空,則「調度結果」這個功能置灰不可用。
注2:若勾選了「除通用結果外,根據預設使用者組內的使用者單獨生成結果」設定項,但是使用者沒有 BI 範本使用到的業務包權限,那麼使用者預覽範本時會失敗。
若勾選了「除通用結果外,根據預設使用者組內的使用者單獨生成結果」設定項,那麼會為「預設使用者組」裏面的所有成員生成獨立的結果。
勾選該按鈕後,可根據設定的 列欄權限 給不同使用者傳送不同資料結果。
4.5 檔案名稱
生成結果檔案的名稱,包括了結果報表、附件(excel、word、pdf),支援公式輸入,比如${now()}。
如果不填寫的話生成的結果報表和附件名稱就使用範本名稱(去後綴)。
注:需勾選調度結果按鈕才能使用公式,後面執行條件等輸入公式同理。
4.6 附件存檔
可選擇生成的附件類型,包括:excel和pdf
若勾選附件存檔後的選項,排程管理任務結束後,會生成不同格式的附件。
附件內容為所選擇的範本內容,儲存在%BI_HOME%\webapps\webroot\WEB-INF\schedule資料夾下。如下圖所示:
4.7 檔案處理
可配置檔案處理的邏輯,預設選中「僅保留最近1次」。
若選擇「任務結束即清理」,任務結束後會將 所有結果檔案 都清理掉(包括 cpr 和附件)。
所以當所設定的排程管理任務需要使用排程管理附件時,例如在 檔案處理 步驟中勾選「使用附件」的「郵件通知、FTP上傳附件、自訂附件處理」等,會出現結果檔案被清理,無法找到的問題。同時存取「定時結果連結」時也會報錯:非常抱歉,您無法查看該頁面,Index: 0, Size: 0,如需存取請交握管理者
注:當生成的結果報表超過 10 個時,在點選下一步時會彈出提示資訊:「預計產生N套結果檔案,可能導致計算量過大,是否繼續」,如果點選繼續,則跳到下一步調度週期的設定。
5. 調度週期
「調度週期」的介面如下圖所示:
5.1 開始時間
設定該排程管理任務的開始執行時間。支援兩種配置:
配置結束立即執行:排程管理任務設定完成後立馬執行。
設定開始時間:在指定的開始時間後執行任務,支援精確到秒。
5.2 執行頻率
1)只執行一次
任務只會執行一次。
2)簡單重複執行
可按分鐘、小時、天、週設定執行間隔的時間段。
3)明細頻率設定
按月、日、時、分的格式設定執行頻率。可自由組合。
注1:設定明細頻率後,無需勾選該頻率前面的方框,所有的頻率都會生效。
注2:明細頻率下方的刪除按鈕預設不顯示。僅當勾選了一條/多條明細頻率之後,方出現刪除按鈕。
注3:若一個調度任務設定了多條明細頻率,任務管理頁面顯示的下次運作時間。會根據第一條明細來顯示,但真正的執行時間仍為所有的明細值。如下圖所示:
2020-08-04 及之後的 JAR ,若不觸發所設定的明細頻率,彈窗提示:以下執行頻率無法觸發,請檢查頻率設定,並確定和任務開始時間、結束時間無衝突。如下圖所示:
4)運算式設定
透過運算式的形式設定執行頻率。
運算式設定的正文框可自己手動填寫 cronExpression,也可透過點選旁邊的運算式設定按鈕來直接選擇相應的運算式,點選「預設運算式」按鈕時,展開預設運算式視窗,點選其中的文字說明,則其上的正文框顯示並儲存相應的 cronExpression,再次點選收起預設運算式按鈕時收起預設運算式視窗,詳細內容參見文檔:表式設定
若運算式設定的執行頻率任務執行中無法觸發,彈窗提示「格式錯誤」。
5.3 結束時間
結束時間包括「任務執行一次後結束、無限期、設定結束時間、額外重複執行次數」四個設定項。
根據執行頻率的不同,結束時間的設定項也會有所不同,詳情請參見下表:
執行頻率 | 結束時間 |
---|---|
只執行一次 | 任務執行一次後結束 不支援更改 |
簡單重複執行 | 支援3種設定 無限期、設定結束時間、額外重複執行次數 |
明細頻率設定 | 支援2種設定 無限期、設定結束時間 |
運算式設定 | 支援2種設定 無限期、設定結束時間 |
5.4 執行條件
執行條件是指在執行定時任務之前進行判斷,滿足條件才執行定時任務,不滿足則不執行或者延遲一段時間後再校驗執行。
執行條件 | 簡介 | 參考文檔 |
---|---|---|
始終執行 | 不進行條件判斷,直接執行定時任務 | - |
公式判斷 | 排程管理任務執行前,對當前公式內容進行判定 公式為 true 則執行定時任務,公式為 false 則不執行或者延遲執行 | 定時任務執行條件之公式判斷 |
自訂類判斷 | 排程管理任務執行前,執行自訂類 回傳值為 true 的時候執行定時任務 | 定時任務之條件判斷 |
預警判斷 | 透過排程管理任務中的預警判斷,可實現組件出現異常值後,主動推播給使用者,方便即時處理/優化 | 排程管理支援組件預警 |
5.5 報錯打斷
「範本報錯中斷執行」,是為了防止儀錶板存在問題時,排程管理將錯誤的資料傳遞給業務使用者。
該功能預設不勾選,如勾選「範本報錯中斷執行」,排程管理執行時,如檢查到FineBI儀錶板存在任意組件報錯,則打斷此次排程管理執行。例如
系統壓力過大,查詢報錯
資料庫傳回報錯
資料集不活躍
資料集從未更新
資料集報錯資料被刪除
明細表不支援N:N
注:以下情況不會導致排程管理中斷執行
儀錶板組件被刪除
儀錶板中圖片顯示異常
儀錶板web組件內容無法存取
儀錶板過濾組件標紅
5.6 任務重啟
任務重啟設定是一項防範措施,用於定時任務執行可能中斷(例如網路原因導致郵件傳送失敗,不滿足執行條件中斷等)時的自動重啟。
如果定時任務執行中斷且設定了自動重啟,那麼該定時任務就會按照自動重啟項的設定重新執行直至成功或者達到所設定重啟次數的最大值,任務重啟設定預設不啟動。
定時任務執行重啟遵循以下規則:
如果「快照生成」失敗,那麼對應的附件傳送不會執行。
重啟策略適用於「條件判斷、快照生成、附件傳送」三個方面的判斷,逐一進行判斷,如果不成功則進行確定是否採用了重啟策略。
重啟時遵循任務最小化原則:如果快照生成正常、附件傳送有問題,那麼只需要重新傳送附件,並且只需要重新傳送之前傳送失敗的項目(郵件、FTP、自訂附件處理,哪個失敗傳送哪個即可)。
6. 檔案處理
「檔案處理」介面,支援多種處理方式,如下圖所示:
注1:調度物件為無調度物件時,僅支援平台通知、郵件通知、簡訊通知、使用者端通知四種處理方式。
注2:調度物件為多選報表範本時,僅支援郵件通知處理方式。
調度物件 | 處理方式 | 簡介 | 參考文檔 |
---|---|---|---|
報表範本 | 定時計算 | 定時計算就是生成結果報表( .cpr 檔案 )和其他附件的程式,預設勾選且不能更改 | - |
掛載平台 | 排程管理任務執行結束後,將生成的結果報表掛載到數據決策系統的目錄下 | 排程管理掛載平台 | |
平台通知 | 排程管理任務執行結束後,給數據決策系統的使用者推播生成的結果報表 | 排程管理平台通知 | |
郵件通知 | 排程管理任務執行結束後,給數據決策系統的使用者的信箱推播生成的結果報表和附件 | 排程管理郵件通知 | |
簡訊通知 | 排程管理任務執行結束後,給數據決策系統的使用者的手機傳送簡訊,提醒查看 | 排程管理簡訊通知 | |
使用者端通知 | 排程管理任務執行結束後,給數據決策系統的使用者的App、HTML5端、釘釘、微信等使用者端推播生成的結果報表 | ||
FTP上傳附件 | 排程管理任務執行結束後,透過FTP將任務生成的結果報表和附件上傳至伺服器 | 排程管理FTP上傳附件 | |
SFTP上傳附件 | 排程管理任務執行結束後,透過SFTP將任務生成的結果報表和附件上傳至伺服器 | 排程管理SFTP上傳附件 | |
自訂附件處理 | 排程管理任務執行結束後,自訂結果報表和附件的上傳方式 | ||
BI範本 | 郵件通知 | 排程管理任務執行結束後,給數據決策系統的使用者的信箱推播生成的結果報表和附件 | 排程管理郵件通知 |
使用者端通知 | 排程管理任務執行結束後,給數據決策系統的使用者的App、HTML5端、釘釘、微信等使用者端推播生成的結果報表 | 排程管理使用者端通知-APP通知 | |
無調度物件 | 平台通知 | 排程管理任務執行結束後,給數據決策系統的使用者推播生成的結果報表 | 排程管理平台通知 |
郵件通知 | 排程管理任務執行結束後,給數據決策系統的使用者的信箱推播生成的結果報表和附件 | 排程管理郵件通知 | |
簡訊通知 | 排程管理任務執行結束後,給數據決策系統的使用者的手機傳送簡訊,提醒查看 | 排程管理簡訊通知 | |
使用者端通知 | 排程管理任務執行結束後,給數據決策系統的使用者的App、HTML5端、釘釘、微信等使用者端推播生成的結果報表 |