釘釘管理插件

1.1 版本

注1：報表服務器必須是能夠訪問外網的， http 協議訪問端口号推薦使用 80；https 協議訪問端口号推薦使用 443 。

注2：釘釘管理插件支持代理服務器配置，若有些用戶報表服務器是配置在内網，則需要配置代理服務器地址，來進行釘釘的訪問，配置方法參見 代理服務器配置

1.2 應用場景

用戶如果将釘釘作爲移動端辦公平台，可以通過安裝此插件直接将報表集成到釘釘中，以釘釘爲統一入口進行報表的查看。

1.3 功能簡介

• 安裝釘釘管理插件，就可以實現釘釘集成。
  

• 在釘釘管理中配置釘釘平台的基本參數，就可以讀取到釘釘平台通訊錄，将報表用戶與釘釘用戶綁定，就可以實現單點登錄。

• 在定時調度的輸出設置中，可以配置并推送釘釘消息。

• 支持集成多個企業應用，進行釘釘升級時請注意進行兼容設置。

注1：釘釘集成下若使用「掃碼控件」， 要求 單點登錄

注2：JAR 包爲 2020-04-26 及之後、「釘釘管理」插件版本爲 V10.4.69 及之後時，釘釘集成支持 集群

2.1 安裝插件

點擊下載插件：釘釘管理、HTML5 移動端展現插件

設計器插件安裝方法參照 設計器插件管理

服務器安裝插件方法參照 服務器插件管理

注：微信/釘釘集成過程中，必須确保各版本相對應，請參見：微信、釘釘、H5、服務器、JAR 之間的依賴關系

2.2 新建 H5 微應用

1）管理員登錄釘釘企業号，在「工作台」Tab 頁下點擊自建應用，如下圖所示：

2）在左側 Tab 中點擊H5微應用，點擊創建應用，如下圖所示：

2.3 配置 H5 微應用

1）填寫應用名稱，上傳應用 Logo，填寫應用簡介，開發方式選擇企業内部自主開發，點擊下一步。如下圖所示：

2）開發模式選擇開發應用，開發應用類型選擇微應用，應用首頁地址可以先填數據決策系統的地址，具體的地址需要在後續步驟生成後，将生成的鏈接再粘貼過來，設置服務器出口 IP，點擊創建。如下圖所示：

服務器出口 IP 獲取方法本文提供 4 種，如下所示：

• 百度浏覽器輸入 IP 獲取地址

• 點擊右邊鏈接獲取：獲取服務器出口IP

• Linux 系統中，輸入curl ifconfig.me 獲取

• 打開 cmd 命令窗口，輸入如下指令：ping 域名（内網映射到外網的域名）如下圖所示：

2.4 應用發布

在 應用發布 Tab 頁下點擊确認發布，選擇可使用範圍後，點擊保存修改。如下圖所示：

注：可使用範圍應以部門爲主，不能選擇到個人。

2.5 獲取參數值

1）需獲取的四個參數及說明如下表所示：

2）在新創建的應用中點擊查看詳情，即可查看 AgentID、AppKey、AppSecret 這三個參數的值。如下圖所示：

3）首頁查看企業的 CorpID，如下圖所示：

2.6 平台中添加釘釘應用

以管理員身份進入數據決策系統，點擊管理系統>釘釘管理，如下圖所示：

2.6.1 保存報表服務器地址

必須設置報表服務器地址并保存，如果不設置，推送的時候可能會有問題，例如：http://secure.finedevelop.com:65081/webroot/decision

輸入「報表服務器地址」，如下圖所示：

2.6.2 新建釘釘應用

點擊新建釘釘應用按鈕，将本文 2.4 節已确認的 AgentID、CorpID、AppKey、AppSecret 分别填到釘釘應用 ID、CropID、AppKey、AppSecret 中，點擊确定。如下圖所示：

注：請填寫合乎規範的信息，釘釘應用名稱、釘釘應用 ID（AgentId）、CropID、AppKey、AppSecret 均不可爲空，且釘釘應用名稱不可重複。

新建釘釘應用成功後，可對信息進行修改和删除，支持集成多個釘釘應用。如下圖所示：

2.7 應用快捷配置

2.7.1 釘釘代理跳轉

内網環境：

若報表服務器是配置在内網，則需要配置代理服務器地址，來進行釘釘的訪問。如下圖所示：

注：釘釘集成既需要設置正向代理，也需要設置反向代理，配置方法參考 代理服務器配置

文本框中輸入正确的代理服務器地址，點擊測試連接，連接成功後，會提示信息：連接成功

外網環境：

外網環境不需要設置代理服務器地址。

2.7.2 生成釘釘鏈接

該功能可以生成訪問決策平台或某個模板的鏈接，通過 模板消息事件插件 可以将該鏈接推送給移動端用戶，用戶點開後即可訪問鏈接對應的内容。

1）生成訪問決策平台的微信鏈接

首先要選擇企業應用名稱，鏈接頁面下拉選擇決策平台，點擊生成鏈接後，點擊複制按鈕即可，如下圖所示：

2）生成訪問某個模板的微信鏈接

首先要選擇企業應用名稱，鏈接頁面下拉選擇單個模板，然後選擇一張模板，如果需要設置參數，可以點擊設置參數默認值進行設置，設置了參數後可以根據自己的需要選擇是否解析參數值，最後點擊生成鏈接，點擊複制按鈕即可，如下圖所示：

下面介紹下如何配置參數，如果想要使用設置參數默認值功能需要将插件更新到 10.4.76 版本，如果想要使用解析參數值功能需要更新到 10.4.97 版本。

• 設置參數默認值

點擊設置參數默認值後，如果模板本身有參數，那麽會顯示在下方，用戶可以設置參數的默認值，當然也可以點擊右上角新增參數，如下圖所示：

注：如果想删除參數，可以鼠标懸浮在參數列表的右邊，會出現删除按鈕。

• 解析參數值

假如一張模板a.cpt設置了一個參數date，其值爲公式${today}。

如果勾選了解析參數值，那麽點擊生成鏈接後，鏈接中會自動解析出今天的日期，也就是變成了：a.cpt&date=2020-11-03。

如果不想鏈接中直接解析參數，想要保留這個公式，可以取消勾選解析參數值，點擊生成鏈接後，公式保留：a.cpt&date=${today}。

注1：微信/釘釘集成鏈接必須勾選解析參數值，否則将導緻參數丢失。

注2：模板消息推送的消息鏈接可選擇不解析參數值，從而實現推送的公式計算。

2.7.3 新建釘釘群

10.4.976 版本新增的功能，可以給釘釘應用新建釘釘群，支持通過定時調度推送群消息到釘釘群。建群方法如下：

1）在釘釘開放平台裏新增一個權限：企業會話。步驟詳情請參見釘釘幫助文檔：企業群消息---概述

否則會出現報錯，如下圖所示：

釘釘返回失敗信息爲：{'errcode':60011,'errmsg':'沒有調用該接口的權限，接口權限申請參考：https://ding-doc.dingtalk.com/doc#/serverapi2/rnomdt'}

2）開啓企業會話權限後，點擊「新建釘釘群」，選擇「釘釘應用」，填寫「釘釘群名稱」，選擇「群主」和「群成員」，如下圖所示：

注：所有設置項均不允許爲空。

10.4.976 版本支持推送釘釘群消息，詳細介紹參見文檔：釘釘定時推送消息

2.8 修改首頁地址鏈接

用戶若需要設置 PC 端單點登錄，參考本文 2.8.2 節内容；若不需要設置 PC 端單點登錄，請忽略本文 2.8.2 節内容。

2.8.1 應用首頁地址

1）進入本文 2.3 節中已創建的H5微應用，點擊查看詳情>修改，如下圖所示：

2）将生成的鏈接粘貼到應用首頁地址，點擊提交，如下圖所示：

2.8.2 PC 端首頁地址

1）版本适配

JAR 爲 2019-12-05 及之後，釘釘管理插件爲 V10.4.69 及之後，HTML5 移動端展現插件版本爲 V10.4.45 及之後時，釘釘集成支持 PC 端單點登錄 。

注：若用戶版本不滿足該條件，升級 JAR 包和插件後，重新生成釘釘鏈接。用戶清理 PC 端釘釘登錄的緩存，即可單點登錄。

2）具體步驟

用戶若需要設置 PC 端單點登錄 ，需填寫「PC端首頁地址」，該地址與「應用首頁鏈接」地址一緻。如下圖所示：

2.9 開啓權限

點擊接口權限，開啓通訊錄只讀權限和手機号碼信息權限。如下圖所示：

2.10 成員管理

2.10.1 用戶匹配方式

可根據實際情況選擇一種用戶匹配方式。

用戶匹配方式：釘釘工号匹配、手機号匹配、手動匹配、自定義匹配，默認爲釘釘工号匹配。「成員管理」頁面如下圖所示：

注：不管集成幾個釘釘應用，用戶統一進行管理。

釘釘工号匹配：

釘釘工号匹配和手機号匹配展示列相同。

釘釘工号匹配，則是釘釘工号與報表裏的用戶名匹配，爲一對一匹配。

手機号匹配，釘釘用戶的手機号是唯一的，但是報表用戶可以設置多個用戶有同一個手機号，此時的匹配邏輯爲哪個報表用戶先創建則匹配哪個

選擇這兩個匹配方式時，釘釘通訊錄信息展示：姓名、釘釘工号、釘釘成員ID、釘釘部門和釘釘成員手機号，如下圖所示：

手動匹配：

當匹配方式爲手動匹配時，釘釘成員列表中多出「報表用戶名」一列信息，點擊出現下拉框，選擇相應的報表用戶名，進行手動匹配。如下圖所示：

注1：手動匹配時，報表用戶名支持選擇「不選」選項。

注2：手動匹配方式是用戶可以自由選擇與釘釘用戶匹配的報表用戶，可實現多個釘釘用戶匹配同一個報表用戶。

自定義匹配：

即通過設置的服務器數據集，将對應數據列的釘釘用戶和報表用戶相匹配。若出現一個釘釘用戶對應了多個報表用戶的情況，默認匹配第一個報表用戶

選擇自定義匹配時，下方多出「匹配設置」項，選擇數據集、釘釘成員ID以及報表用戶名，進行匹配。如下圖所示：

注：自定義匹配時，釘釘用戶列填寫的是釘釘成員 ID 。

2.10.2 通訊錄更新

點擊左側立即更新按鈕，立即更新通訊錄内容。也可設置定時更新，點擊自動更新按鈕，彈出設置框，設置更新頻率。如下圖所示：

注1：用戶匹配方式爲「釘釘工号匹配」或「手機号匹配」時，如果用戶增删改報表用戶或者在後台增删改釘釘用戶，需要手動同步通訊錄更新。

注2：用戶匹配方式爲「手動匹配」或「自定義匹配」時，如果用戶增删改報表用戶或者在後台增删改釘釘用戶，無需更新同步。

2.11 效果查看

登錄釘釘，點擊工作台>文檔測試，該用戶會看到自己權限内可以查看的目錄，如下圖所示：

3.1 推送到釘釘的模板報表塊展示異常

問題描述：

設置定時調度任務推送包含報表塊的決策報表給釘釘，其中「文件處理」步驟客戶端通知中，「鏈接」選擇定時結果鏈接，報表塊展示異常。如下圖所示：

原因分析：

模板受到 PC 端自适應屬性 的影響。

解決方案：

「文件處理」步驟客戶端通知中，「鏈接」選擇自定義鏈接。如下圖所示：

3.2 内網開放白名單

在做釘釘集成時，有的客戶爲内網環境，不允許所有網頁都能訪問，但要确保能訪問釘釘的域名：https://oapi.dingtalk.com/