观远数据-钉钉完全集成方案
观远数据支持与钉钉的深度集成,集成后可实现:
- 观远平台成为钉钉内嵌应用
- 钉钉应用内免密登录(包括移动端和PC端)
- Web端可用钉钉扫码登录
- 订阅预警消息推送至钉钉,一键触达
集成配置步骤——
step1:在钉钉开放平台创建钉钉移动接入
首先我们需要在钉钉开放平台创建一个扫码登录应用,这是观远平台支持钉钉免密登录与Web扫码登录的前提。
在钉钉开放平台>应用开发>移动接入应用>创建扫码登录应用授权。
钉钉开放平台的地址为:https://open-dev.dingtalk.com/#/loginAndShareApp
示例如下,其中回调域名是客户私有化环境的移动端域名(一般以/m结束):
创建完后,可以在列表中看到该新增的App:
同时我们还获得了该App的appId和appSecret,把这些信息记下来,在后面环境配置中还将用到它们。
step2:在钉钉工作台创建观远BI应用
我们需要在钉钉工作台里内嵌观远的微应用,操作方式:
创建入口:钉钉开放平台>应用开发>微应用>微应用管理>创建企业内部应用,
直达地址为:https://open-dev.dingtalk.com/#/suite
点击【创建应用】后,填写相关信息,示例如下:
1)填写基本信息,包括应用名称、logo、应用简介和开发方式。
注:开发方式请选择“企业内部自主开发”。
2)点击【下一步】,配置开发信息
注1:开发模式,请选择“开发应用”。
注2:开发应用类型,请选择“微应用”。
注3:需要特别注意应用首页链接、PC端首页地址和管理后台地址。
以下各个链接地址的配置方法:
- 应用首页链接:在钉钉手机端工作台点击该应用后跳转的地址,为必填项,一般格式为: https://oapi.dingtalk.com/connect/oauth2/sns_authorize?appid=<appid_id>&response_type=code&scope=snsapi_auth&state=app&redirect_uri=<host_url>%2Fm%2F%3Fprovider%3Ddingtalk%26domain%3D<domain_id>
- PC端首页地址:在PC端工作台点击该应用的跳转地址,为可选项,一般格式为: https://oapi.dingtalk.com/connect/oauth2/sns_authorize?appid=<appid_id>&response_type=code&scope=snsapi_auth&state=pc&redirect_uri=<host_url>%3Fprovider%3Ddingtalk%26domain%3D<domain_id>
- 管理后台地址: 这是在钉钉管理后台点击该应用后的跳转地址,是选填项,一般可填相应观远平台的主页地址即可,即为第一步中创建的App的回调域名。
上面地址中用到的<appid>即为第一步中创建的扫码登录应用的appId,<host_url>即为第一步中创建中填写的回调域名(去掉/m)。
<domain_id>为观远平台内的域名,注意不是如bi.abc.com这样的访问地址,一般为公司的缩写,如果不清楚,请联系专属的解决方案顾问。私有化部署情况下,该参数也可做缺省处理(即%26domain%3D<domain_id> 这一串可缺省)。
例子如下:
首页地址
PC版地址
注意,如果不需要配置钉钉免密登录,则相应URL直接填写观远平台的主页地址即可。
3)全部填写完成后,确定创建,成功后系统会自动跳转到该微应用的详情页,示例如下:
点击【查看详情】,可以看到此微应用的详细信息,示例如下。
注意:这里的AgentId、AppKey和AppSecret在step3观远后台的信息填写中会用到。
配置好后,PC端有2个地方可以看到此应用:
① 在钉钉开放平台>微应用列表;
② 钉钉管理后台>工作台>自建应用。
配置完成后,用户可在手机端,钉钉APP > 工作台 > 其他应用中看到创建的应用。
员工如果在手机钉钉中看不到此应用,请在微应用详情页中查看此用户是否在该应用的可见范围里。
step3:在观远后台填写钉钉应用相关信息
为了让观远平台能够跳转到正确的钉钉授权页面,完成正确的用户登录流程,以及提供消息推送等相关功能,我们需要在观远平台内配置相关的钉钉应用信息。
管理员登录到观远平台,在管理员设置>账号关联>钉钉应用配置页,启用钉钉应用,编辑相关配置信息:
其中:
扫码登录应用配置信息里的AppId和AppSecret,是在第一步创建移动接入应用中得到的。
微应用配置信息里的AgentId、AppKey和AppSecret,是在第二步创建企业微应用中得到的。
填写完成示例:
填写完成后可测试连接确保填写无误。
step4:在观远后台关联钉钉账号
第三步的钉钉应用配置【启用】后,系统会自动添加一个用户基础属性——“钉钉账号”。
管理员可以给单个用户添加,也可以在【用户基础属性】中批量配置。
用户的钉钉账号查看入口:
1)钉钉管理后台,通讯录>内部通讯录管理>组织架构>部门人员,点击相应用户。
也可以通过批量导出的方式批量获得钉钉用户的账户:
效果演示
1,PC端登录页面出现 钉钉登录入口,点击后可扫码登录
2,企业员工的钉钉App中,在工作台 > 其他应用 中,可看到创建的应用,点击进入后,通过简单的授权,即可完成免密登录到观远平台H5界面。
3,钉钉PC端应用中,在OA工作台可以看到观远平台应用入口,点击后,通过简单授权(若移动端已授权,则这边就不需要再次授权),即可完成免密登录到观远平台web端界面。
4,订阅、预警消息推送至钉钉:在配置订阅、预警通知渠道时,可以选择“钉钉”作为触达方式。
最后,需要注意的是:
- 钉钉免密登录、扫码登录、消息推送的集成适用于私有化部署用户和SaaS用户,SaaS用户必须在redirect_url中额外配置domain信息。
- SaaS用户可做钉钉内嵌应用的简单集成,通过记住密码来实现快捷登录。
- 私有化部署集成钉钉时,请确保观远服务器与钉钉服务器的网络连通
- 请将观远平台公网IP添加到钉钉“ 服务器公网出口 IP白名单”中,配置地址为:钉钉开发平台> 开发信息 > 开发账号管理 > 修改账号信息。
#观远SaaS平台的公网IP为:139.219.11.100
关于钉钉企业微应用开发的更多资料,可查看相关官方文档,如链接: