反馈已提交

网络繁忙

钉钉管理插件

  • 文档创建者:doreen0813
  • 编辑次数:39次
  • 最近更新:April陶 于 2022-05-24
  • 1. 概述

    1.1 版本

    使用钉钉集成,需要 FineBI 、H5 、钉钉插件版本均匹配才能集成,FineBI 5.0 及 5.1 版本的对应情况如下表所示:

    FineBI 版本钉钉管理插件功能变动
    5.1.5
    V10.4.976新增配置钉钉群入口,支持群消息推送
    V10.4.994新增「钉钉管理>应用快捷配置>其他设置」。支持使用外部浏览器打开消息推送内容
    V10.4.998
    • 「应用快捷配置>其他设置」由勾选框变成按钮框,详情见本文2.7.3节

    • 「应用快捷配置>生成钉钉链接」中,生产单个模板链接支持选择其他用户的仪表板,详情参见本文 2.7.2 节

    注:升级到该版本的钉钉插件不支持回退到之前版本,回退需重新添加应用。

    V11.0.62
    • 「应用快捷配置>生成钉钉链接」支持生成自定义链接,详情参见本文 2.7.2 


    • 「成员管理」支持同步多个企业的数据

    1.2 应用场景

    用户如果将钉钉作为移动端办公平台,可以通过安装此插件直接将 BI 集成到钉钉中,以钉钉为统一入口进行仪表板的查看。

    1.3 功能简介

    • 安装钉钉管理插件,就可以实现钉钉集成。 

    • 在钉钉管理中配置钉钉平台的基本参数,就可以读取到钉钉平台通讯录,将 BI 用户与钉钉用户绑定,就可以实现单点登录。

    • 在定时调度的输出设置中,可以配置并推送钉钉消息。

    • 支持集成多个企业应用,进行钉钉升级时请注意进行兼容设置。

    注1:钉钉集成下若使用「扫码控件」, 要求 单点登录

    注2:JAR 包为 2020-08-04 及之后、「微信管理」插件版本为 V10.4.69 及之后时,微信集成支持 集群配置 

    2. 示例

    2.1 环境准备

    2.1.1 安装插件

    点击下载插件:钉钉管理 、HTML5 移动端展现插件

    插件安装方法参照: 插件管理

    2.1.2 网络环境配置

    在配置集成之前,必须先完成网络环境配置,参考文档:微信钉钉集成环境准备

    2.2 新建 H5 微应用

    1)管理员登录钉钉企业号,在「工作台」Tab 页下点击自建应用,如下图所示:

    2021-08-02_14-01-17.png

    2)管理员登录钉钉企业号,在「工作台」Tab 页下点击「自建应用」,如下图所示:

    2021-08-02_12-16-02.png

    3)填写创建应用的相关信息:①应用类型选择「H5微应用」;②填写对应的应用信息;③开发方式选择「企业内部自主开发」。填写完成点击「确认创建」。本文示例的应用名称为「文档测试」,如下图所示:

    2021-08-02_12-19-11.png

    2.3 配置H5微应用

    配置「文档测试」应用的开发管理信息。点击「开发管理>修改」进入配置界面。

    具体如下:①开发模式选择「开发应用」;②设置服务器出口 IP;③填写应用首页地址(可以先填数据决策系统的地址,具体的地址需要在后续步骤生成后,将生成的链接再粘贴过来)。点击「保存」完成配置。如下图所示:

    2021-08-02_14-29-15.png

    服务器出口 IP 获取方法本文提供 4 种,如下所示:

    • 百度浏览器中输入 IP 获取地址

    • 点击右边链接获取:获取服务器出口IP

    • Linux 系统中,输入 curl ifconfig.me 获取

    • 打开 cmd 命令窗口,输入如下指令:ping 域名(内网映射到外网的域名)如下图所示:

    1587985281312087.png

    2.4 发布H5微应用

    在「文档测试」应用中点击「版本管理与发布>确认发布」。发布后,设置应用的可使用范围,并点击「保存」。如下图所示:

    注:可使用范围应以部门为主,不能选择到个人。

    2021-11-18_15-57-33.png

    2.5 获取参数值

    1)需获取的四个参数及说明如下表所示:

      参数 说明
    AgentID在创建应用时,系统会自动生成一个 AgentID,可用于发送企业会话消息等场景
    AppKey在创建应用时,系统会自动分配一对 AppKey 和 AppSecret,该 AppKey 是应用开发过程中的唯一性标识
    AppSecret AppSecret 和上面 AppKey 一同生成,使用 AppKey 和 AppSecret 来换取 access_token
    CorpID企业 ID

    2)在新创建的应用中点击查看详情,即可查看 AgentID、AppKey、AppSecret 这三个参数的值。如下图所示:

    2021-08-02_14-54-45.png


    3)首页查看企业的 CorpID,如下图所示:

    2021-08-02_14-58-11.png


    2.6 平台中添加钉钉应用

    以管理员身份进入数据决策系统,点击管理系统>钉钉管理,如下图所示:

    2021-08-02_17-29-06.png

    2.6.1 保存报表服务器地址

    必须设置服务器地址并保存,如果不设置,推送的时候可能会有问题,例如:http://secure.finedevelop.com:63778/webroot/decision,输入「服务器地址」,如下图所示:

    2021-08-02_17-29-06.png

    2.6.2 新建钉钉应用

    点击「新建钉钉应用」,输入钉钉应用名称,并将本文 2.5 节已确认的 AgentID、CorpID、AppKey、AppSecret 分别填到钉钉应用 IDCropIDAppKeyAppSecret 中,点击「确定」。如下图所示:

    2021-08-02_17-30-00.png

    注:请填写合乎规范的信息,钉钉应用名称、钉钉应用 ID(AgentId)、CropID、AppKey、AppSecret 均不可为空,且钉钉应用名称不可重复。

    新建钉钉应用成功后,可对信息进行修改和删除,支持集成多个钉钉应用。如下图所示:

    10.png

    2.7 应用快捷配置

    2.7.1 钉钉代理跳转

    内网环境:

    若 BI 服务器是配置在内网,则需要配置代理服务器地址,来进行钉钉的访问。如下图所示:
    2021-11-19_10-57-20.png

    注:当客户需要配置正向代理时,可将对应代理服务器的地址填写在快捷配置这里,具体正向代理的配置可以参考 微信钉钉集成环境准备第 4 节

    文本框中输入正确的「代理服务器地址」,点击「测试连接」,连接成功后,会提示信息:「连接成功」

    外网环境:

    外网环境不需要设置代理服务器地址。

    2.7.2 生成钉钉链接

    该功能可以生成访问「决策平台」或「某个模板」的链接。

    链接可应用于:1)应用的 主页 配置;2)定时调度最后一步「文件处理>客户端通知」推送「自定义链接」。可参考文档:定时调度任务设置步骤

    1)生成访问决策平台的钉钉链接

    选择相应的钉钉应用名称和链接页面「决策平台」,点击「生成链接」,生成钉钉链接,点击「复制」,如下图所示:

    2021-11-19_10-39-38.png

    2)生成访问单个模板的钉钉链接

    选择相应的钉钉应用名称和链接页面「单个模板」,选择对应的模板,点击「生成链接」生成钉钉链接,点击「复制」,如下图所示:

    2021-12-24_14-13-55.png

    单个模板可设置「BI仪表板」和「报表」:

    • 单个模板选择「BI仪表板」时:

      ①(只有选择仪表板和制作仪表板的人都在同一部门,该情况才生效)若用户分配到部门,可选择到:部门内可管理用户制作的仪表板、其他部门的用户制作的仪表板、自己账号下的仪表板;

      ②若用户未分配到部门,跟随定时调度的权限规则。

      注 1:若没有设置其他用户的管理权限,则只能选择自己的仪表板。

      注 2:关于用户部门管理可参考:用户管理

    • 单个模板选择「报表」下模板,操作步骤参考报表平台的 钉钉管理插件 2.7.2节内容。

    2021-12-24_14-17-53.png

    3)生成自定义链接

    生成在钉钉能够访问的轻应用链接。

    首先,选择「企业应用名称」,生成「自定义链接」并填入「移动端轻应用」中生成的链接。然后点击「生成链接」并复制即可。如下图所示:

    2022-04-15_15-49-02.jpg

    2.7.3 其他设置

    若用户希望 PC 端点击消息推送的链接,能够在外部浏览器下打开内容,打开按钮「PC端在浏览器打开链接」。

    2021-12-24_13-54-12.png

    在 PC 端点击推送消息后,钉钉内置浏览器提示「链接将在外部浏览器打开」。

    2021-11-19_10-23-43.png

    2.7.4 新建钉钉群

    10.4.976 版本新增的功能,可以给钉钉应用新建钉钉群,支持通过定时调度推送群消息到钉钉群。

    建群方法如下:

    1)先完成钉钉集成。

    2)在钉钉开放平台里新增一个权限:chat相关接口的管理权限。步骤详情请参见钉钉帮助文档:企业群消息---概述

    63e16f2a-a581-45d1-8e50-24c83a513eff.png

    否则会出现报错,如下图所示:

    钉钉返回失败信息为:{'errcode':60011,'errmsg':'没有调用该接口的权限,接口权限申请参考:https://ding-doc.dingtalk.com/doc#/serverapi2/rnomdt'}

    企业微信截图_16136357871830.png

    3)点击「新建钉钉群」,选择「钉钉应用」,填写「钉钉群名称」,选择「群主」和「群成员」,如下图所示:

    注:所有设置项均不允许为空。

    Snag_2a8b5630.png

    10.4.976 版本支持推送钉钉群消息,详细介绍参见文档:钉钉定时推送消息

    Snag_2a941718.png

    2.8 修改首页地址链接

    用户若需要设置 PC 端单点登录,参考本文 2.8.2 节内容;若不需要设置 PC 端单点登录,请忽略本文 2.8.2 节内容。

    2.8.1 应用首页地址

    进入本文 2.3 节中已创建的H5微应用,点击「开发管理>修改」,将 2.7.2 节 生成的链接粘贴到「应用首页地址」,点击「保存」。如下图所示:

    2021-08-02_15-32-10.png

    2.8.2 PC 端首页地址

    1)版本要求

    JAR 为 2020-08-04 及之后,钉钉管理插件为 V10.4.69 及之后,HTML5 移动端展现插件版本为 V10.4.45 及之后时,钉钉集成支持 PC 端单点单点登录 。

    注:若用户使用的钉钉管理插件为 V10.4.69 版本,但 URL (本文 2.7.2 节生成的链接)依然使用之前已生成的链接,会显示 H5 的效果。

    2)具体步骤

    用户若需要设置 PC 端单点登录 ,需填写「PC端首页地址」,该地址与「应用首页链接」地址一致,如下图所示:

    2021-08-02_15-41-10.png


    2.9 开启权限

    点击「权限管理>通讯录管理」,开启权限。如下图所示:

    开通的权限为以下4项:

    • 企业员工手机号信息

    • 通讯录部门信息读权限

    • 成员信息读权限

    • 通讯录部门成员读权限

    e74621ec-d165-4773-81ed-0410d7633ad9.png

    若要实现群消息推送,需要在钉钉开放平台里新增一个权限:chat相关接口的管理权限。

    63e16f2a-a581-45d1-8e50-24c83a513eff.png

    2.10 成员管理

    2.10.1 用户匹配方式

    可根据实际情况选择一种用户匹配方式。

    用户匹配方式:「钉钉工号匹配」、「手机号匹配」、「手动匹配」、「自定义匹配」,默认为「钉钉工号匹配」。「成员管理」页面如下图所示:

    注:不管集成几个钉钉应用,用户统一进行管理。

    2021-08-02_17-35-07.png

    钉钉工号匹配:

    「钉钉工号匹配」和「手机号匹配」展示列相同。

    • 钉钉工号匹配,则是钉钉工号与 BI 里的用户名匹配,为一对一匹配。

    • 手机号匹配,钉钉用户的手机号是唯一的,但是 BI 用户可以设置多个用户有同一个手机号,此时的匹配逻辑为哪个 BI 用户先创建则匹配哪个。

    选择这两个匹配方式时,钉钉通讯录信息展示:姓名钉钉工号钉钉成员ID钉钉部门钉钉成员手机号,如下图所示:

    24.png

    手动匹配:

    当匹配方式为「手动匹配」时,钉钉成员列表中多出「用户名」一列信息,点击出现下拉框,选择相应的用户名,进行手动匹配。如下图所示:

    注1:手动匹配时,用户名支持选择「不选」选项。

    注2:手动匹配方式是用户可以自由选择与钉钉用户匹配的 BI 用户,可实现多个钉钉用户匹配同一个 BI 用户。

    2021-08-02_17-39-16.png

    自定义匹配:

    即通过设置的「服务器数据集」,将对应数据列的钉钉用户和 BI 用户相匹配。若出现一个钉钉用户对应了多个 BI 用户的情况,默认匹配第一个 BI 用户。

    选择自定义匹配时,下方多出「匹配设置」项,选择数据集钉钉成员ID以及用户名,进行匹配。如下图所示:

    17.png

    2.10.2 通讯录更新

    点击左侧立即更新按钮,立即更新通讯录内容。也可设置定时更新,点击自动更新按钮,弹出设置框,设置更新频率。如下图所示:

    注1:用户匹配方式为「钉钉工号匹配」或「手机号匹配」时,如果用户增删改 BI 用户或者在后台增删改钉钉用户,需要手动同步通讯录更新。

    注2:用户匹配方式为「手动匹配」或「自定义匹配」时,如果用户增删改 BI 用户或者在后台增删改钉钉用户,无需更新同步。

    注3:时间点设置不要为 00:00,可能会概率导致通讯录同步失败,因为钉钉管理平台那边有接口频率调用限制,限制600次/秒,而大部分企业的时间可能都会使用00:00这个时间点,导致同步失败,通讯录获取的用户信息缺失。

    2021-08-02_17-45-13.png

    2.11 效果查看

    登录钉钉,点击工作台>文档测试,该用户会看到自己权限内可以查看的目录,如下图所示:

    1588058258273152.jpg

    3. 消息推送

    1)参考[通用]定时任务推送消息至 App ,「文件处理」步骤中选择钉钉通知即可,如下图所示:

    2021-08-02_17-49-38.png

    2)钉钉用户登录钉钉,可收到消息。如下图所示:

    09.jpg

    4. 注意事项

    4.1 内网访问白名单

    在做钉钉集成时,有的客户为内网环境,不允许所有网页都能访问,但要确保能访问钉钉的域名:https://oapi.dingtalk.com/

    4.2 插件不支持内外网同时配置

    若同时配置会出现报错 redirect_uri,以及部分用户登陆有问题。如下图所示:

    1616401056182823.png

    5. 钉钉集成问题处理

    1)环境是否配置好:微信钉钉集成环境准备

    2)使用工具排查出现的各类常见(单点登录失败、同步通讯录失败、消息推送失败)问题:微信钉钉调试工具微信钉钉推送/单点/同步失败通过日志定位

    3)「应用管理」报错;定时调度消息推送报错;网络异常等:微信钉钉应用列表报错

    4)出现错误码,对照错误码找问题:微信钉钉错误码对照表

    附件列表


    主题: 移动端
    • 有帮助
    • 没帮助
    • 只是浏览

    售前咨询电话

    400-811-8890转1

    在线技术支持

    在线QQ:800049425

    热线电话:400-811-8890转2

    总裁办24H投诉

    热线电话:173-1278-1526

    文 档反 馈

    鼠标选中内容,快速反馈问题

    鼠标选中存在疑惑的内容,即可快速反馈问题,我们将会跟进处理。

    不再提示

    10s后关闭