排程管理任務設定

1.1 版本

1.2 功能簡介

有關排程管理功能基本的介紹和操作方法可以參見文檔：排程管理

排程管理任務設定時包含四個操作步驟，如下圖所示。本文將詳細介紹這四個操作步驟中的設定項。

管理員登入數據決策系統，點擊「管理系統>排程管理>任務管理」，點擊「新增任務」，即可新建一個排程管理任務。如下圖所示：

注：普通使用者若需要設定排程管理任務，需要管理員為其配置「管理系統>排程管理」的使用權限，具體步驟請參見 排程管理管理權限 。

「基本設定」介面如下圖所示：

3.1 任務名稱

填寫排程管理任務的名稱。

• 任務名稱不可為空。

• 任務名稱不可與其他排程管理任務重複，否則提示「任務名稱已經存在」。
  

• 任務名稱只允許包含字母、漢字、數字、下劃線、減號、點和括號。

3.2 預設使用者組

用途：設定預設使用者組的目的是為了在第四步「檔案處理」時根據使用者組成員發送通知。預設使用者組可為空。

設定：點擊「編輯」按鈕，支援根據「使用者、部門、角色」來新增預設使用者組成員，點擊「確定」即可成功新增，最終的使用者組取三者的並集且去掉重複項。

其中，使用者的新增方式有兩種：

• 平台：使用者來源於數據決策系統。

• 自訂使用者：使用者來源於伺服器資料集。但是選擇的資料集列資料需要是平台中的使用者名，否則任務執行無法成功。

4.1 排程物件

排程物件有四種型別：報表範本、多選報表範本、BI 範本、無排程物件。

本章僅介紹排程物件為「BI 範本」時的設定，其他請參考 排程管理任務詳細設定步驟 的第四章。

1）無排程物件

當排程物件選擇「無排程物件」時，僅支援設定「排程結果」，一般用於企業發送公告。

2）報表範本

當排程物件選擇「報表範本」時，可選擇單張 FineReport 範本，用於推送、保存、查看報表執行結果。支援以下設定：

3）多選報表範本

當排程物件選擇「多選報表範本」時，可選擇多張 FineReport 範本，但僅可使用郵件推送報表執行結果。支援以下設定：

• 多選報表範本和單個報表範本的設定基本相同，可為每張範本單獨配置參數設定、檔案名稱和附件存檔。支援拖拽調整範本的先後順序。

• 執行條件處若使用「公式判斷」或「自訂類判斷」，涉及到和範本內容相關的，只支援取第一個選中的範本。

• 檔案處理處僅支援「郵件通知」一種處理方式，標題或正文中若使用公式，只支援取第一個選中的範本。

4）BI範本

當排程物件選擇「BI範本」時，可選擇單張FineBI儀表板。支援以下設定：

4.2 選擇範本

選擇 BI 工程中創建的儀表板，不能為空。

4.3 過濾設定

支援對所選擇的儀表板新增過濾條件，比如對所選擇的門店銷售狀況分析新增過濾條件屬於 2017 年的資料，如下圖所示：

注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.1 開始時間

設定該排程管理任務的開始執行時間。支援兩種配置：

• 配置結束立即執行：排程管理任務設定完成後立馬執行。

• 設定開始時間：在指定的開始時間後執行任務，支援精確到秒。

5.2 執行頻率

1）只執行一次

任務只會執行一次。

2）簡單重複執行

可按分鐘、小時、天、周設定執行間隔的時間段。

3）明細頻率設定

按月、日、時、分的格式設定執行頻率。可自由組合。

注1：設定明細頻率後，無需勾選該頻率的方框，所有的頻率都會生效。

注2：5.1.23 及之後版本的工程，明細頻率下方的刪除按鈕預設不顯示，僅當勾選了一條/多條明細頻率之後，方出現刪除按鈕。

注3：若一個調度任務設定了多條明細頻率，任務管理頁面顯示的下次運行時間。會根據第一條明細來顯示，但真正的執行時間仍為所有的明細值。如下圖所示：

2020-08-04 及之後的 JAR ，若不觸發所設定的明細頻率，彈窗提示：以下執行頻率無法觸發，請檢查頻率設定，並確保和任務開始時間、結束時間無衝突。如下圖所示：

4）運算式設定

透過運算式的形式設定執行頻率。

運算式設定的文本框可自己手動填寫 cronExpression，也可透過點擊旁邊的運算式設定按鈕來直接選擇相應的運算式，點擊「預置運算式」按鈕時，展開預置運算式窗口，點擊其中的文字說明，則其上的文本框顯示並保存相應的 cronExpression，再次點擊收起預置運算式按鈕時收起預置運算式窗口，詳細內容參見文檔：運算式設定

2020-08-04 及之後的 JAR ，若運算式設定的執行頻率任務執行中並不觸發，彈窗提示：以下執行頻率無法觸發，請檢查頻率設定，並確保和任務開始時間、結束時間無衝突，如下圖所示：

注：2020-08-04 及之後的 JAR，若運算式設定錯誤，則直接提示：格式錯誤

5.3 結束時間

結束時間包括「任務執行一次後結束、無限期、設定結束時間、額外重複執行次數」四個設定項。

根據執行頻率的不同，結束時間的設定項也會有所不同，詳情請參見下表：

5.4 執行條件

執行條件是指在執行排程任務之前進行判斷，滿足條件才執行排程任務，不滿足則不執行或者延遲一段時間後再校驗執行。

5.5 任務重啟

任務重啟設定是一項防範措施，用於排程任務執行可能中斷（例如網絡原因導致郵件發送失敗，不滿足執行條件中斷等）時的自動重啟。

如果排程任務執行中斷且設定了自動重啟，那麼該排程任務就會按照自動重啟項的設定重新執行直至成功或者達到所設定重啟次數的最大值，任務重啟設定預設不啟用。

排程任務執行重啟遵循以下規則：

• 如果「快照生成」失敗，那麼對應的附件發送不會執行。

• 重啟策略適用於「條件判斷、快照生成、附件發送」三個方面的判斷，逐一進行判斷，如果不成功則進行確定是否採用了重啟策略。

• 重啟時遵循任務最小化原則：如果快照生成正常、附件發送有問題，那麼只需要重新發送附件，並且只需要重新發送之前發送失敗的項目（郵件、FTP、自訂附件處理，哪個失敗發送哪個即可）。

「檔案處理」介面，支援多種處理方式，如下圖所示：

注1：排程物件為無排程物件時，僅支援平台通知、郵件通知、簡訊通知、客戶端通知四種處理方式。

注2：排程物件為多選報表範本時，僅支援郵件通知處理方式。

在「排程物件」步驟中若勾選「附件存檔」，排程管理任務結束後生成的附件可修改語言。

超級管理員可透過「fine_conf_entity可視化配置插件」改變排程管理生成附件的語言。重啟伺服器後設定生效。

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