1. 概述
1.1 功能簡介
本文將簡單介紹插件的安裝以及插件具體的功能詳情。插件適用版本可參考:數據預警簡介
1.2 注意事項
1)只支援使用儀錶板內的表格、折線圖、柱形圖、儀表盤、KPI指標卡和折線圖與柱形圖組合的自訂圖表設定預警。
2)數據預警任務支援郵件、簡訊、平台通知、使用者端通知、應用API通知五種方式。使用者端通知支援釘釘、飛書、微信、App通知四種方式,需要先進行整合後才可使用。
3)任務建立者和接收人需要綁定信箱/簡訊,否則懸浮接收人右側的小感嘆號提示“未綁定信箱、電話號碼的使用者無法透過對應渠道接收預警資訊”。綁定信箱可參考:使用者設定 。
4)公共連結分享的儀錶板,沒有數據預警按鈕。
5)為防止當機並優化效能,經過維度過濾後的資料最多能支援 100W 條參與預警計算。
1.3 參數設定
1.3.1 數據預警是否保留儀錶板過濾效果
6.0.14在 fine_conf_entity視覺化配置 新增參數 SystemOptimizationConfig.useAllVisibleDataForSentinel 控制數據預警的資料是否保留儀錶板的過濾效果。
參數名 | 參數描述 | 參數值 |
---|---|---|
SystemOptimizationConfig.useAllVisibleDataForSentinel | 數據預警對範本過濾條件是否保留 | 參數值需為布林型,預設為true true:應用全量儀錶板資料(使用者可見即可用) 參數值為true時,應用全量儀錶板資料(使用者可見即可用) false:保留儀錶板預設過濾情況,使用者僅可使用儀錶板預設展示資料進行預警,預覽時調整的過濾條件不生效 |
1.3.2 異常資料推播條數控制
fine_conf_entity視覺化配置 新增參數 SentinelConfig.showDetailAbnormalData 控制數據預警「異常資料」推播的是全部異常資料還是部分異常資料。
參數名 | 參數描述 | 參數值 |
---|---|---|
SentinelConfig.showDetailAbnormalData | 控制數據預警「異常資料」推播顯示全部異常資料還是只保留1條異常資料 | 參數值需為布林型,預設為true true:“異常資料”變數中的內容包含全部異常資料 false:“異常資料”變數中的內容包含對應條件下的異常資料 |
使用說明:
「異常資料」顯示全部異常資料時,推播的內容會逐條顯示異常資料資訊。如下圖所示:
推播全部異常資料可能會導致內容超長無法接收到訊息
針對「異常資料」變數截取5000個字元,超出5000字元的部分不生成通知內容,不影響其他內容長度
2. 安裝插件
2.1 安裝插件
1)獲取插件:數據預警插件
2)進入「管理系統>插件管理>從本地安裝」插件。詳情可參考文檔:插件管理
3)如果希望超管之外的使用者也能使用數據預警插件。需要先對其進行權限配置。詳情見第3章。
2.2 插件授權
使用該插件需要在 FineBI 的 License 註冊中購買數據預警功能點,詳情請諮詢銷售顧問。
工程未正式註冊,安裝數據預警插件可試用插件全功能。
工程已註冊但未註冊數據預警功能點,使用數據預警插件時僅支援建立兩個預警任務。
3. 插件權限說明
3.1 建立預警使用者
超管如果需要給其他使用者「建立預警」的權限。需要在「管理系統」中分配權限。
1)插件安裝完成後,管理者需要在為不同的使用者分配報表的查看權限,詳情可參考:目錄查看權限。
2)該插件安裝成功後。
平台上的範本、透過目錄存取的範本,可以直接使用預警功能
把BI儀錶板整合到其他系統直接預覽,需要開啟「範本認證」功能。
3)管理者對其設定數據預警權限。
該插件安裝成功後,需要開啟「分級授權」功能,並在「普通權限配置」中對相關人員開通「數據預警」權限後才能使用。
①設定分級授權。如下圖所示:
注:分級授權的需要註冊「集團權限控制」功能點,如果沒有註冊,無法開啟分級授權,只有超管使用者可以建立預警。
②開啟數據預警權限。如下圖所示:
3.2 普通使用者
如果未進行權限配置,支援接受訊息提醒。
3.3 訂閱使用者
超管需要為使用者開通如下權限,使用者才能訂閱所有人可見的任務。
數據預警使用權限
建立預警任務的儀錶板的查看權限
注:配置了動態接收人的預警任務不支援訂閱。
3.4 超級管理者
1)超管有插件的最高權限,可建立、管理任務。
2)超管在管理預警任務時,還能夠管理其他使用者建立的任務。如下圖所示:
3)超管還支援進行「預警設定」,配置第三方預警應用資訊。詳情見:數據預警API
4. 功能介紹
4.1功能入口
1)安裝預警插件後,在分析主題的儀錶板預覽處出現「建立預警」按鈕,提示使用者可建立預警任務。
2)儀錶板介面也有入口進入。如下圖所示:
3)目錄中的儀錶板也支援數據預警。如下圖所示:
點選「數據預警」之後,可以看到介面如下:
如果儀錶板已新增數據預警條件,並且「隱私設定」為所有人可見。
使用者在預覽儀錶板時,可以在「數據預警」介面,新增「訂閱」關注數值變化。如下圖所示:
4.2 建立預警任務
預警任務設定主要分為三部分:「基本設定」、「預警通知」、「更多設定」。點選「建立預警任務」進入設定介面。
4.2.1 基礎設定
1)「預警名稱」:可以自訂預警任務名稱。
2)「選擇組件」:可以選擇儀錶板內表格、圖表組件。
(目前支援建立數據預警的組件:表格、折線圖、柱形圖、儀表盤、KPI指標卡和折線圖與柱形圖組合的自訂圖表。)
3)「維度」:選擇表格組件下的維度欄位並新增條件。(不支援設定了鑽取的欄位)
若維度是日期欄位,可以選擇「日期範圍/最近N筆資料」設定預警範圍。
最近N筆資料實際就等於動態時間,比如儀錶板的資料是以天為粒度的,最近2筆資料就是對儀錶板裏的資料以日期做排序取top2的效果,相當於最近2天的資料。
注:欄位來源於明細表時,不支援設定「最近N筆資料」。
因為最近N筆資料,本質上是在做topn排序後選最近N條,而明細表不支援topn的功能。
4)「觸發條件」:僅支援選擇數值欄位。①支援新增多個條件,並選擇是「滿足所有條件」或「滿足任一條件」;②判斷方式支援大於、小於、等於、不等於、大於等於、小於等於、介於、不介於、任一為空、全部非空多種觸發條件。
5)「檢查通知」:支援設定多種檢查頻率。可選擇每年/每月/每週/每天/每小時檢查一次。如設定每小時00分檢查一次,則整點時刻都會執行檢查。開啟重複通知免打擾:若資料檢查與上次通知內容一致,則不再觸發通知。
4.2.2 預警通知
接收人
接收人主要包括:「接收人」和「通知方式」。
「接收人」:支援設定「指定接收人」和「動態接收人」。
注:如果選擇不到想要的接收人,是因為管理者沒有給使用者授予對應的「人員管理的管理權限」,需要交握企業管理者設定。
接收人 | 詳細說明 |
---|---|
指定接收人 | 可以根據使用者、部門、角色設定接收人,支援多選接收人(勾選誰通知誰)。 注:當設定者僅有某父部門的其中一個子部門的管理權限時, 6.1.2及之前版本:數據預警接收人選擇該子部門,父部門直屬使用者及全部子部門的使用者均可收到預警通知。 6.1.3及之後版本:數據預警接收人選擇該子部門,僅該子部門使用者可以收到預警通知。 升級前建立的數據預警任務,升級後不會自動切換接收人邏輯,可透過編輯並儲存,即可優化。 |
動態接收人 | 可以根據使用者、部門、角色設定接收人
若部門名稱是「技術支援」,那麼會給所有的子節點(最下層節點)為「技術支援」的部門傳送訊息。 若部門的結構是「帆軟-華東-技術支援」,那這個部門裏的使用者都會收到訊息(技術支援是最下層的節點)。 若部門的結構是「帆軟-華東-技術支援-技術支援A組」,僅「技術支援A組」可以收到訊息。
使用者-按鈕-帳號 點選按鈕可以進行組件裏面使用者列的選擇,選中的使用者列和平台的使用者資訊做匹配,匹配到的使用者+使用者所在維度的指標觸發了預警 = 該使用者接收通知 注意事項:
|
通知方式
支援郵件、簡訊、平台通知、使用者端通知、應用API通知。
注1:使用者端通知支援釘釘、飛書、企業微信、App通知,需要先進行整合後才可使用。
注2:應用API通知需要管理者在「管理系統>數據預警>預警設定」中新增 第三方預警應用 後,才可使用。
正文內容 |
可以引用的變數有:預警名稱、所在範本、觸發維度、觸發條件、觸發時間、滿足條件資料個數、滿足條件最大值、滿足條件最小值、異常資料 注:簡訊不支援自訂正文內容。 若新增變數「異常資料」,支援自訂異常資料通知顯示的維度欄位。 當預警物件為「數量」,選擇「是否已交貨、合同類型」,預警條件為是否已交貨為否、合同類型為購買合同時,最大異常資料量為172.0。效果如下圖所示: 注:預設只顯示一條異常資料,範例顯示的是3條預警資料中的最大值。如果需要顯示所有異常資料可修改參數配置,詳情參見 1.3.2 節。 |
其他內容 | 其中郵件支援「其他內容」設定,可選擇「結果連結」或「預警物件」,預設為「結果連結」。
|
4.2.3 更多設定
「更多設定」主要包括:「隱私設定」和「預警待辦」。
隱私設定 | 支援設定為公開或僅自己和接收人可見; 當設定為公開時,擁有數據預警權限和報表查看權限的使用者可查看此任務,並訂閱此任務,訂閱後使用者可收到數據預警通知 |
預警待辦 | 預警觸發之後會形成待辦,傳送給責任人進行處理,並設定觸發預警後需要解決問題的時間 |
注:超管需要為責任人開通數據預警權限後,責任人才能處理預警待辦。
4.3 管理預警任務
4.3.1 功能入口
1)儀錶板預覽介面
2)管理系統介面
4.3.2 功能介紹
任務管理介面主要包括:「我建立的預警」、「我接收的預警」、「其他使用者建立的預警」、「預警待辦中心」,如下圖所示:
「我建立的預警」:可以查看任務的歷史趨勢圖以及預覽範本,或刪除預警任務。
「我接收的預警」:可以查看任務的歷史趨勢圖以及預覽範本,或取消訂閱任務。
「預警代辦中心」:可以查看相關待辦的處理狀態以及預計解決時間。
「其他使用者建立的預警」:僅超管擁有此功能,可刪除其他使用者建立的預警任務,或查看預警任務的範本和歷史趨勢圖。
詳情請參見:管理預警任務
注:儀錶板上新增的數據預警任務在儀錶板刪除後,在數據預警任務管理介面依舊顯示任務,需要使用者手動刪除。
5. 範例
範例詳情參見文檔:數據預警插件使用範例、【動態接收人】數 據預警插件範例