管理應用API

1. 概述

數據預警插件目前僅支援郵件、簡訊、平台、部分用戶端通知。但在實際應用中經常會遇到複雜的預警接收場景,同時大部分公司內部都會有自己的 OA 或者專用通知平台,為滿足預警資訊通知的及時性以及更符合使用者接收習慣的通知性,數據預警插件開放API支援通知到自訂的平台或應用,提高數據預警效果。

2. 設定方式

需要完成數據預警插件安裝以及權限配置,可參考:數據預警插件

2.1 設定入口

超管登入平台後,選擇「管理系統>數據預警」,點選設定按鈕,即可進入「第三方預警應用」設定介面,點選新增「新增應用」即可開始進行配置,如下圖所示:


2.2 設定頁面

點選新增「新增應用」即可開始進行配置,使用者需要根據實際情況填寫如下配置項,如下表所示:

配置項是否必填說明
應用名稱使用者可自訂輸入應用名稱
應用說明使用者可自訂輸入應用說明
應用狀態

單選必選,預設選擇「啟用」狀態,不可取消選擇

  • 啟用:使用者建立預警時,勾選「用戶端通知」,在派送終端可選該應用

  • 停用:使用者建立預警時,勾選「用戶端通知」,在派送終端該應用名不可見

請求位址URL使用者可自訂輸入請求位址URL
請求方式

單選必選,分為 POST 和 GET 兩種方式。

預設選擇 POST 請求方式,不可取消選擇

請求頭

需要輸入對應的鍵和值

  • 點選“+”可新增請求頭中的鍵值對。

  • 點選“-”可刪除已編輯的鍵值對,最少保留 1 條鍵值對。

某些 API 要求隨請求一起傳送特標度頭,通常是為了提供有關正在執行的操作的更多元資料,可以在這裏設定這些,輸入您需要的任何鍵值對。

請求body

使用者可自訂輸入,在 body 中填入的內容將作為通知正文內容在預警觸發時傳送到派送終端,僅支援 json / xml / text,同時支援如下參數:

  • 觸發時間:${triggeredTime},格式為yyyy-MM-dd HH:mm:ss

  • 預警名稱:${taskName}

  • 所在模版:${templatePath},模版路徑

  • 存取位址:${targetLink},平台相對位址如webroot/decision/view/report?viewlet=GettingStarted.cpt

  • 觸發條件:${ruleDescription},配置的條件描述

  • 接受人:${receiveUsers},接受者字串使用半角逗號","連接

  • 滿足條件的資料個數:${ruleMatchDataCount},個數

  • 滿足條件的最大值:${ruleMatchDataMax}

  • 滿足條件的最小值:${ruleMatchDataMin}

  • 列表中最大值:listMaxData

  • 列表中最小值:listMinData

  • 监控目标链接:targetLink

  • 所有接收者:receiveUsers

  • 预警任务ID:taskID

  • 预警任务创建人:taskCreator

  • 是否生成待办:createTodo

  • 预警待办责任人:todoAssignee

  • 预警待办解决时长:daysToSolve

若在請求body中新增了 ${notifyContent} 參數,則完成預警任務建立後,在應用中實際接收到的內容 = 應用介面中填寫的「請求body」+ 預警建立頁的通知內容。

若不新增${notifyContent}參數,則在應用中實際接收到的內容 = 應用介面中填寫的「請求body」。

2.3 設定預警

完成配置後儲存,擁有資料預警權限的使用者可在「預警通知>通知方式」中勾選「應用API通知」,即可選擇對應的應用,如下圖所示:

2.4 效果預覽

完成預警任務建立後,使用者在應用中實際接收到的內容 = 應用介面中填寫的「請求body」+ 預警建立頁的通知內容。

超管在應用配置介面的「請求body」中填寫必要的通知內容,使用者在「預警通知」中自訂通知內容,使通知內容更靈活。如下圖所示:

附件列表


主题: 製作儀表板
已经是第一篇
已经是最后一篇
  • 有帮助
  • 没帮助
  • 只是浏览
  • 圖片不清晰
  • 用語看不懂
  • 功能說明看不懂
  • 操作說明太簡單
  • 內容有錯誤
中文(繁體)

滑鼠選中內容,快速回饋問題

滑鼠選中存在疑惑的內容,即可快速回饋問題,我們將會跟進處理。

不再提示

10s後關閉

獲取幫助
線上支援
獲取專業技術支援,快速幫助您解決問題
工作日9:00-12:00,13:30-17:30在线
頁面反饋
針對當前網頁的建議、問題反饋
售前咨詢
業務咨詢
電話:0933-790886或 0989-092892
郵箱:taiwan@fanruan.com
頁面反饋
*問題分類
不能為空
問題描述
0/1000
不能為空

反馈已提交

网络繁忙