1. 概述
1.1 版本
FineDataLink 版本 | 功能變動 |
---|---|
3.6.1 | 新增節點「訊息通知」,可將任務調度結果以企業微信群機器人的形式通知給指定使用者 |
4.0.1 | 可將任務調度結果以郵件的形式通知給指定使用者 |
4.0.3 | 「訊息通知」節點支援的通知渠道新增:簡訊、企業微信應用推播、釘釘應用推播、釘釘群機器人 |
4.0.28 |
|
4.1.5.5 | 訊息通知頻率限制預設關閉 |
1.2 應用場景
使用者基於以下場景時:
希望可以透過郵件/簡訊/企業微信應用推播/企業微信群機器人/釘釘應用推播/釘釘群機器人/飛書應用推播/飛書群機器人的形式將資訊通知給指定使用者。
希望通知內容不僅是通知任務執行狀態,還希望可以通知任務執行程式中產生的某些計算值和參數值,或者根據實際業務需求自訂通知內容。
通知時機不僅在任務結束時,可能是在某個步驟流的環節成功完成後或者資料異常時進行通知。
可使用「訊息通知」功能滿足需求。
1.3 功能簡介
「訊息通知」可將任務調度結果以郵件/簡訊/企業微信應用推播/企業微信群機器人/釘釘應用推播/釘釘群機器人/飛書應用推播/飛書群機器人的形式通知給指定使用者。
同時支援在任務運作程式中通知指定的資料。
注:FineDataLink 中的資料處理程式,詳情參見:https://demo.finedatalink.com/ 「訊息通知-」
2. 使用須知
1)一個「訊息通知」節點中,可同時新增多種通知渠道;但每個渠道傳送的字數會按各個渠道的最大字元數限制。
2)4.1.5.5 之前版本,單個節點通知限制 10s 一次,觸發後的 10s 內,觸發後的 10s 內若再有通知則會報錯。
例如:訊息通知節點 A 在 10:00:00 觸發,那麼在10:00:00~10:00:09.999之間,如果該節點被重複觸發,將報錯。
此時若想要正常運作訊息通知,則可以在訊息通知前增加一個 SQL 腳本節點,使用延遲函式,如下圖所示:
注:不同資料庫文法不同, MySQL 中可使用 sleep 函式,sleep(10)則表示延遲10s 執行。
4.1.5.5 及之後版本,訊息通知頻率限制預設關閉。
3. 功能說明
3.1 郵件
介面如下圖所示:
具體設定項介紹如下表所示:
設定項 | 介紹 |
---|---|
平台使用者組 | 可選擇平台的使用者、部門、角色(三者取並集) |
寄件人 | 可選已配置在平台中的寄件人列表,預設值為平台配置的預設寄件人 如果平台沒有已配置的寄件人,則下拉框為空,配置寄件人步驟請參見:信箱 |
通知物件 | 1)平台使用者組:
2)自訂收件人: 可自訂收件人,輸入信箱即可,多個信箱以","隔開,支援引用參數 |
副本/密送 | 可選平台內已配置信箱的使用者,也可以自訂信箱
例如:a@fanruan.com,b@fanruan.com |
主題 | 填寫郵件主題 支援透過${a}的方式引用參數值(a為參數) |
正文 | 填寫郵件正文 支援透過${a}的方式引用參數值(a為參數) |
3.2 簡訊
介面如下圖所示:
簡訊渠道需要檢查平台中帆軟通行證和簡訊平台的配置情況:
如果沒有登入帆軟通行證,切換到簡訊渠道後,提示點選登入,以獲取簡訊範本和簽章
如果沒有開通簡訊平台,切換到簡訊渠道後,提示尚未開通簡訊服務,申請開通簡訊服務 注:開通簡訊服務請參見:短信;簡訊相關條款請參見:帆軟市場簡訊相關條款
注:如果平台中,簡訊平台已配置,但是沒有啟動,允許配置節點,在發信時報錯。
具體設定項介紹如下表所示:
設定項 | 介紹 |
---|---|
平台使用者組 | 可選擇平台的使用者、部門、角色(三者取並集) |
收件人 | 1)平台使用者組:
2)自訂收件人: 可自訂收件人,輸入手機號碼即可,多個手機號碼以","隔開,支援引用參數 |
簡訊簽章 | 使用的簡訊簽章,預設選中第一項:
|
簡訊範本 | 使用的簡訊範本:不可編輯,展示選擇的簡訊範本 簡訊申請簽章和範本請參見:簡訊申請簽章和範本 4.0.28 版本,遮蔽與 FDL 無關的簡訊範本 |
簡訊參數 | 傳入簡訊範本的參數。名稱預設顯示所選簡訊範本包含的所有參數,值為空:
|
3.3 企業微信應用推播
3.3.1 功能簡介
介面如下圖所示:
具體設定項介紹如下表所示:
API呼叫說明:獲取access_token、傳送應用訊息
設定項 | 介紹 |
---|---|
平台使用者組 | 忽略,通知渠道為簡訊/郵件時,才用到該設定項 |
企業ID | 獲取方式請參考:corpid |
應用證件金鑰 | 應用證件金鑰,可在應用管理頁面查看。獲取方式參考:secret |
AgentId | 傳送訊息時使用應用的 AgentId,可在應用管理頁面查看: |
訊息接收成員 |
|
訊息接收部門 |
|
訊息接收標籤 |
|
訊息類型 | 指定訊息類型,支援正文訊息和Markdown訊息 目前支援的 Markdown 文法請參見:支援的Markdown文法 |
訊息內容 | 填寫訊息內容,允許引用參數:
|
是否是保密訊息 | 非保密訊息可對外分享 保密訊息不可分享且內容有水印 |
開啟重複訊息檢查 | 開啟重複訊息檢查後,在重複訊息檢查間隔內重複推播相同內容訊息,會自動忽略 |
重複訊息檢查間隔 | 指定重複訊息檢查間隔,單位為秒,預設為 1800 秒 允許輸入範圍:1800~14400 |
3.3.2 注意事項
1)每應用不可超過帳號上限數*200人次/天。
注:若呼叫 api 一次發給 1000 人,算 1000 人次;若企業帳號上限是 500 人,則每個應用每天可傳送 100000 人次的訊息。
2)每應用對同一個成員不可超過 30 次/分鐘,超過部分會被丟棄不下發。
3)企業微信應用推播時,被推播人員無應用權限:
全部無權限:訊息通知節點會報錯。
部分無權限:訊息通知正常通知有效的使用者,忽略無效的使用者,並在 WARN 日誌中列印出無效帳號。
3.4 企業微信群機器人
介面如下圖所示:
具體設定項介紹如下表所示:
注:企業微信群機器人發訊息的頻率:每個機器人傳送的訊息不能超過20條/分鐘。
設定項 | 介紹 |
---|---|
平台使用者組 | 忽略,通知渠道為簡訊/郵件時,才用到該設定項 |
群機器人 | 企業微信群機器人 webhook 地址,不允許為空 新增群機器人步驟如下圖所示,機器人新增成功的提示頁面上會有 webhook 地址 |
訊息類型 | 有兩種訊息類型:正文訊息、markdown訊息 1)選擇「正文訊息」時,介面如下圖所示: 提醒方式:選擇提醒群成員的方式,此處提供兩種方式:使用者ID、手機號碼 注:使用者ID即企業成員帳號,管理者可點選管理後台「通訊錄>成員資訊」查看成員帳號;管理者手機端「工作台>管理企業>編輯成員」查看成員帳號
選擇正文訊息時,支援同時提醒多個群成員,多個群成員 ID 或手機號碼間透過「英文逗號」分隔,值為「@all」時,提醒所有人。允許引用參數 2)選擇「markdown訊息」時,介面如下圖所示: |
訊息內容 | 填寫訊息內容,允許引用參數。要求如下:
|
3.5 釘釘應用推播
3.5.1 功能簡介
介面如下圖所示:
具體設定項介紹如下表所示:
API呼叫說明:傳送工作通知
設定項 | 介紹 |
---|---|
平台使用者組 | 忽略,通知渠道為簡訊/郵件時,才用到該設定項 |
AppKey | 應用的唯一標識Key,可在 釘釘開發者後台 的應用詳情頁面獲取 |
AppSecret | 應用的金鑰,可在 釘釘開發者後台 的應用詳情頁面獲取 |
AgentId | 傳送訊息時使用的微應用的AgentId: |
訊息接收成員 |
|
訊息接收部門 |
|
訊息類型 | 選擇通知訊息類型,支援正文訊息和 Markdown 訊息 |
訊息標題 | 只有選擇「Markdown訊息」時,才顯示「訊息標題」輸入框 填寫訊息標題,允許引用參數,不超過100字元,若超過將報錯 |
訊息內容 | 填寫訊息內容,允許引用參數,不允許為空:
|
3.5.2 注意事項
1)釘釘應用推播時,即使接收成員填寫不正確,也不會有錯誤資訊,需要使用者自行確認除錯(釘釘有推播查詢API)。
2)企業內部應用傳送訊息單次最多只能給 5000 人傳送,第三方企業應用傳送訊息單次最多能給 1000 人傳送。
3)給同一員工一天只能傳送一條內容相同的訊息通知。
4)企業內部應用每天給每個員工最多可傳送 500 條訊息通知,第三方企業應用最多可傳送 100 條。
5)企業內部應用或第三方企業應用傳送訊息時,每分鐘最多有 5000 人可以接收到訊息。
3.6 釘釘群機器人
3.6.1 功能簡介
介面如下圖所示:
具體設定項介紹如下表所示:
API呼叫說明:自訂機器人接入
設定項 | 介紹 |
---|---|
平台使用者組 | 忽略,通知渠道為簡訊/郵件時,才用到該設定項 |
群機器人 | 填寫釘釘群機器人 Webhook 地址,允許引用參數,不允許為空 |
訊息類型 | 選擇通知訊息類型,支援正文訊息和 Markdown訊息 |
提醒方式 | 選擇提醒群成員的方式 |
群成員列表 |
|
訊息標題 | 僅Markdown訊息類型顯示 填寫訊息標題,允許引用參數,不超過 100 字元,若超過將報錯 |
訊息內容 | 填寫訊息內容,允許引用參數:
|
3.6.2 注意事項
1)每個機器人每分鐘最多傳送 20 條。
2)如果超過 20 條,會限流 10 分鐘。
3)釘釘群機器人 安全策略 支援情況,僅支援「自訂關鍵詞」與「設定IP白名單」,不支援「加簽」策略。
3.7 飛書應用推播
介面如下圖所示:
具體設定項介紹如下表所示:
設定項 | 介紹 |
---|---|
平台使用者組 | 忽略,通知渠道為簡訊/郵件時,才用到該設定項 |
App_Id | 參考文檔:飛書後台建立應用 的 2.2.3 節,獲取App_Id、App_Secret |
App_Secret | |
訊息接收成員 | 填寫成員ID,多個成員ID以",”隔開,@all為提醒所有人,支援引用參數 最多 200 個成員 注1:「成員ID」為 open_id,獲取方式見連結 如何獲取自己的 Open ID? 注2:如果@all,當可見範圍記憶體在未加入企業的成員的話,會推播失敗 |
訊息接收部門 | 填寫部門ID,多個部門ID以","隔開,支援引用參數 最多 200 個部門 |
訊息類型 | 可選擇:正文訊息、markdown訊息 markdown文法見:Markdown模組 若需要使用飛書應用傳送卡片訊息,訊息類型建議選擇 markdown ,具體範例請參見:卡片範例 |
訊息標題 | 選擇「markdown訊息」顯示此配置項,選擇「正文訊息」時該元件不顯示,已填內容清空 填寫訊息標題,允許引用參數,不超過 100 字元,若超過將報錯 |
訊息內容 | 填寫訊息內容,允許引用參數:
飛書官方文檔 中提到:正文訊息請求體最大不能超過 150KB;卡片及富正文訊息請求體最大不能超過 30KB |
3.8 飛書群機器人
介面如下圖所示:
具體設定項介紹如下表所示:
設定項 | 介紹 |
---|---|
平台使用者組 | 忽略,通知渠道為簡訊/郵件時,才用到該設定項 |
群機器人 | 填寫群機器人 Webhook 地址,允許引用參數,不允許為空 自訂機器人介紹:自訂機器人使用指南 |
訊息類型 | 可選擇:正文訊息、markdown訊息 |
訊息標題 | 訊息類型選擇「markdown訊息」顯示此配置項,支援引用參數,不超過 100 字元,若超過將報錯 |
提醒方式 | 訊息類型選擇「正文訊息」顯示此配置項:輸入「使用者ID」或「手機號碼」,實現@的效果 注1:「使用者ID」為 open_id,獲取方式見連結 如何獲取自己的 Open ID? 注2:提醒方式選擇「手機號碼」時,需要先建一個應用,才可以使用。 |
AppId/AppSecret | 「提醒方式」選擇「手機號碼」條件顯示此配置項,參考文檔:飛書後台建立應用 |
群成員列表 | 訊息類型選擇「正文訊息」顯示此配置項:
|
訊息內容 | 預設為空,填寫訊息內容:
|
4. 特殊場景說明
場景 | 說明 |
---|---|
使用者在配置通知物件為平台使用者時,重複輸入已有的平台使用者 | 收件人的手機號碼/信箱與手填手機號碼/信箱相同時,不做重複通知 |
使用者在配置通知物件為平台使用者時,選擇的使用者未配置對應的郵件/手機號碼資訊 | 交互會進行提醒 |
5. 最佳實踐
實現效果說明 | 範例 |
---|---|
以郵件形式將訊息通知給指定負責人 | 使用邮件进行消息通知 |
一條訊息通知內容中,提醒多個人 | 一条消息通知同时提醒多人 |
| 一条消息提醒一个人,可发送多条消息 |