一、概述
支持将eteams应用集成到钉钉上使用,包括“通讯录同步”“应用集成到飞书"”消息互通“。
二、操作说明
集成钉钉需要配置外网域名地址,在【云桥】-【基础参数设置】配置当前系统的外网域名地址,配置好之后点击保存,位置如下图所示:
【开通服务器网络权限的说明】
1.如果使用本系统进行钉钉集成功能,则需要调用钉钉接口,并且最终用户是通过钉钉来使用集成的功能,所以本系统部署的云桥服务器必须要求,能够访问外网:即开通这台服务器的上网权限,让云桥服务器能够访问互联网,如果贵公司对网络安全要求较高,至少需要让这个服务器能够访问以下地址:
阿里钉钉号API:https://oapi.dingtalk.com
2.同时请网络管理员将本系统的访问地址映射到外网。
3.可以用如下方式验证网络是否通畅:
在云桥服务器上按如下方式检查网络:
ping oapi.dingtalk.com 查看是否能ping通
Windows:
浏览器访问 https://oapi.dingtalk.com/gettoken 查看是否有返回结果
Linux:
执行命令 curl https://oapi.dingtalk.com/gettoken 查看是否有返回结果
钉钉接入功能主要是在云桥中建立阿里钉钉接入信息,将基本的企业CorpID等写入云桥中;
1. 1 点击后台管理中心,在所有服务中选择云桥或者平台引擎里点击云桥,即可进入云桥页面,如下图所示:
1.2 访问【阿里钉钉集成】菜单,点击右上角【新建钉钉】,如下图所示:
1.3 输入企业名称以及corpid,如下图所示:
1.4 其中CorpID获取方式:请登录钉钉开放平台https://open-dev.dingtalk.com,在【首页】获取CorpId,如下图:
请登录钉钉开放平台https://open-dev.dingtalk.com,进入菜单【应用开发】-【企业内部开发】,点击【创建应用】,选择H5微应用,如下图:
创建应用后,进入此应用的【应用信息】界面,即可获取到AgentID、AppKey、AppSecret,如下图所示:
访问云桥【阿里钉钉集成】,在当前集成的钉钉企业页面,点击【添加应用】,如下图:
进入应用详情页面,填写钉钉应用的AgentID、AppKey、AppSecret【步骤2中获取到的应用信息】,如下图:
应用主页 是设置阿里钉钉应用的主页功能,调用模块默认为打开应用,选择应用中心已经存在的主页型应用,如下图所示:
也支持自定义链接地址,如下图:
点击应用主页地址后面的复制按钮,把复制到的地址填到钉钉开放平台【开发管理】-【应用首页地址】和【PC端首页地址】中,如下图:
访问钉钉开放平台菜单【权限管理】,设置应用的权限(具体见 文档2.2章)
访问钉钉开放平台菜单【版本管理与发布】,发布应用到钉钉上,如下图:
【通讯录管理相关】执行从钉钉同步
选择读、获取等相关的权限打开,需要申请开通的接口权限选择钉钉后台权限分类为【个人权限】和【通讯录管理】,如下图:
2.【通讯录管理相关】执行从ecology同步
选择写、维护、访问等相关的权限打开,需要申请开通的接口权限选择钉钉后台权限分类为【通讯录管理】,如下图:
3.【普通消息推送相关】文字类型、图文类型
工作通知系列接口权限,是创建应用后默认开通的,开发者无需申请,如下图:
4.【待办消息推送相关】
待办:需要申请开通的接口权限选择钉钉后台权限分类为【待办任务】,如下图:
5.【考勤打卡相关】
需要申请开通的接口权限选择钉钉后台权限分类为【考勤】,如下图:
备注:具体某个细节的接口权限是否需要开启,可以参考接口的描述以及对应的接口文档来判断是否需要开启对应权限。
6. 【权限范围】默认配置全部员工,可根据实际需求调整(必须要包含部门,不能单独只设置用户)
2.3 其他配置
当客户安全限制只允许固定ip才可以调用钉钉服务端API时,可以配置服务器出口IP,如下图:
3.1 消息配置设置
消息管理功能主要是将OA应用消息推送到阿里钉钉中,即实现在阿里钉钉中接收并处理业务系统的消息。消息正常推送的前提是,阿里钉钉用户要关联OA系统用户账号,详情可参考4.2.3。
① 在【云桥】-【消息推送设置】-【消息推送规则】 页面,点击新建,如下图所示:
① 例如将 日报 的消息推送到阿里钉钉:填写好规则名称,消息来源选择日报,如下图所示:
在规则详情页面,点击【新建】,设置推送目标,第三方企业类型选择【钉钉】,企业和应用根据实际需要,选择对应的企业团队和应用,如下图所示:
消息类型有:图文、文字、待办,可以根据需求选择相应的消息类型
注意:推送目标新建之后,要点击【保存】,如下图所示:
消息推送规则新建之后,可以点击【编辑】按钮,对规则详情进行编辑,如下图所示:
① 将 日报 的消息推送到阿里钉钉:除了第二点中所述将消息来源选择日报之外,还可以将消息来源选择为全部,如下图所示:
注意:若消息来源选择全部,OA其他应用的消息(例如审批,出勤等)也会通过这条消息推送规则推送到阿里钉钉。
3.2 注意事项
1、公有环境不支持自动创建消息规则和明细,需要手动新建。
2、私有环境:可以使用应用模板功能,例如日报,选择日报模板,创建后,会自动创建主页和消息推送规则,只需要将应用地址配置到钉钉对应应用中即可。
3.3 消息类型展示
1. 文字 (注:钉钉PC端推文字类型消息无法打开,钉钉客户端限制,手机端正常)
2. 普通图文
3. 状态栏图文
4. 待办--待办样式
待办--已办样式
5、应用机器人
前往钉钉开放平台,开启接收消息应用的 机器人与消息推送 的功能:
开启机器人权限:
将复制的RobotCode填写到云桥消息推送规则里:
6、互动卡片消息-普通版
前往钉钉开放平台,开启接收消息应用的 机器人与消息推送 的功能:
将复制的RobotCode填写到云桥消息推送规则里:
消息到达:
审批后效果:
退回消息:
注意事项:
需要在流程工作流设置中开启【消息入口显示操作按钮】:
没有开启【消息入口显示操作按钮】,推送模块卡片消息,则不会有快捷审批按钮,只有点击查看:
需要推送 待办、互动卡片、图文启用状态栏 类型的消息,必须保证推送的消息是【待办】类型的 (工作流程只有 待处理流程、退回流程、抄送流程、转发流程、传阅流程、意见征询流程 这几个事件的消息支持待办, 其他的提醒反馈、催办等消息是不支持待办的),否则会推送失败。
云桥组织架构同步分两种:
将 钉钉 的组织架构同步到云桥(不修改OA的组织架构)
将OA的组织架构同步到云桥,同时同步到 钉钉(默认在同步前会先执行“从企业号同步”,以保证从OA同步的时候正确比对人员和部门信息)
执行同步前,需要已经集成过对应应用
进入【通讯录集成】,未进行过配置,首先会提示配置【接口参数设置】,切换到【接口参数设置】页面。
同步部门id:如果同步钉钉所有组织架构,可以不填;如果只同步部分部门,填钉钉的部门id。
新用户关联系统:设置本次同步过来的新成员(即云桥中不存在对应账号的成员)是否要自动建立与OA组织架构中人员的关联关系。具体使用见4.3.1章节
是否定时同步:定时任务,开启可执行定时从钉钉同步组织架构。
顶级部门:执行【从OA同步】,会将选择的部门以及人员,挂载到选择的顶级部门下面。
新用户是否添加到钉钉:设置从OA同步过来的新成员是否要调用阿里钉钉接口自动创建到阿里钉钉通讯录中。
用户所在部门是否包含兼职部门:默认只同步用户的主部门,开启后,同步范围中包含用户的兼职部门,则会同步到钉钉。
用户所在部门是否完全以本系统为准:
当人员在钉钉端所在的部门存在多个:
是 - 会以该人员在系统端所在的部门完全覆盖人员在钉钉端所在的部门,
例如人员在钉钉端在部门A、B下,而在系统端在部门C下,如果选是,同步效果就是该人员在钉钉端只在部门C下。
否 - 同步效果就是该人员在钉钉端同时在A、B、C三个部门下。
当人员在钉钉端所在的部门只有一个时,不受此配置控制,同步效果始终以系统为准。
用户绑定:将OA用户和钉钉用户关联。详情见 【4.2.3 用户绑定】
用户字段对应关系:设置从OA同步过来的成员与阿里钉钉中已有的成员(但还没有OA关联关系的那部分成员)自动关联时的字段的对应关系
系统默认会将系统中的所有部门及人员数据同步到钉钉的通讯录中,同步范围不需要做任何设置。
如果有特殊的需要只将一部分部门及人员同步到钉钉的通讯录中,则可以设置需要同步的部门及人员范围(也可以部门和人员分开设置)
不在此范围内的并且已经与系统建立关联关系的部门或人员将会被从钉钉中删除,并且删除操作不可逆转,所以请谨慎选择范围。
分部/部门范围:不选择特定分部/部门,默认为全部
用户范围(包含):在此范围内的用户将被添加或者更新到钉钉
用户范围(排除):在此范围内的用户不会被添加到钉钉,如果用户已关联钉钉,同步后将被删除。
注:部门和人员可以分开设置。
用户范围(排除)的优先级高于 用户范围(包含)
3. 安全设置和定时设置
用户减少数量阈值:本次同步的OA用户数量和上一次相比,减少的数量超过x,将停止同步OA用户信息。x可以自己设置
定时设置:设置是否开启定时自动执行从OA系统同步操作。
将OA用户和钉钉人员绑定的方式有多种:
手动绑定(需要配置应用)
用户完成应用集成之后,可以直接访问应用,然后输入正确的系统账号密码后,对应集成的钉钉-通讯录中会记录用户的钉钉账号信息以及绑定关系。
2. 自动绑定设置
有三个设置的地方:一个地方配置之后,其他两处也会开启自动同步;修改任意一处,也会变更其他两处的设置。
用户单点通讯录->用户绑定设置
从钉钉同步->新用户关联系统账号(使用见4.3.1)
从OA同步->用户绑定(使用见4.3.2)
根据配置的条件,比如:钉钉手机号 匹配 OA手机号,如果匹配上了,就会自动将关联关系写入,如下图
3. 关联导入
将已经同步到云桥本地的数据(单点写入或者从钉钉同步写入)导出,并且将需要绑定的OA人员的对应字段写入到文档中,上传文档,点击导入按钮,即可将关联关系写入。
例如:钉钉人员B要绑定OA人员的B1,选择的关联字段是【手机号】,在导出的B这一栏的关联字段中,填写B1的手机号,保存后将文件再导入,并且关联字段选择【手机号】,然后点击导入按钮即可。
4. 人员卡片绑定/解绑
将云桥本地的数据和OA的人员进行绑定或者解绑
5. 批量解绑
解除云桥本地所有人员和OA人员的关联关系
云桥主要是将钉钉和OA的组织架构关联起来,所以同步前需要确认组织架构以企业微信/钉钉端为准,还是以OA端为准!
首先执行【从钉钉同步】,然后把人员在钉钉中的身份和在OA系统中的身份关联上,使用如下任何一种方式。
方法一:手动关联(见4.2.3)。
方法二:在 从钉钉同步时进行自动关联:需要在【从钉钉同步】时,开启【新用户关联系统账号】,配置关联字段之后,进行同步。
例如:人员在钉钉的身份和OA身份 使用 手机号进行关联。
后续可以在 【从钉钉同步】时,开启定时同步,每隔一段时间将钉钉的组织架构的变动更新到云桥
如果不希望在OA修改组织架构后影响到钉钉的组织架构或者在云桥菜单中修改,可以开启通讯录的只读模式:只允许钉钉的修改同步到云桥本地。
分为两种情况:
(默认已经执行过从钉钉同步)
无需进行人员账号绑定。
执行【从OA同步】,执行完成后,云桥会把OA的人员创建到钉钉,并且自动把人员在企业微信/钉钉中的身份和在OA系统中的身份关联上。在创建钉钉人员时,钉钉人员的账号使用OA人员的如下配置字段的值:
(默认已经执行过从钉钉同步)
设置钉钉历史人员账号绑定,选择如下任意一种方式进行关联:
方法一:手动关联(见4.2.3)
方法二:自动关联,在第二步执行同步的时候配置人员匹配字段。
注:如果自动绑定无法满足将钉钉人员和OA人员关联,可以在从OA同步前先使用手动绑定关联这些人员。
2. 设置顶级部门
是否设置顶级部门决定了同步后的组织架构。
部门关联的逻辑是:层级相同且部门名称相同,在执行同步的时候,会自动关联,否则,在云桥和钉钉新建部门。关联上的部门前面会有一个黑色实心原点,代表已关联
举例说明:
没有设置顶级部门,默认同步OA整体组织架构
如下图所示,根据层级和名称首先进行顶级部门匹配,则OA顶级部门【钉钉xy】去匹配云桥顶级部门【钉钉xy】,可以匹配。一级部门能够匹配上的只有【部门A】,则其他没有匹配上的部门,会在云桥和钉钉新建。
同步后效果(可以先同步模拟同步查看效果):橘色为匹配,紫色为新增
注:如果顶级部门的名称不相同,例如【Re部门】和【钉钉xy】名称不同,则顶级部门无法匹配,同步立刻中止。
提示如下:
设置了顶级部门,默认同步OA整体组织架构。选定【其他部门】为此次同步的顶级部门:
如图所示,组织架构层级对应如下:
执行同步,会将OA【Re部门】及其下级部门,同步到云桥【其他部门】下,作为以及部门。
根据部门匹配的原则,OA一级部门【Re部门】和顶级部门下的一级部门没有名称相同的,直接新建。
同步效果如图:
1. 当钉钉的组织架构发生变化之后,需要在执行【从EC同步】之前,先执行【从钉钉同步】。
2. 如果该钉钉用户已经关联OA的账号,那么从OA同步的时候,人员匹配字段的配置将不会修改原有的绑定关系,该配置只针对未关联OA的钉钉端人员。
3. 接口参数设置,如果设置了只读权限,所有在云桥对组织架构进行的操作(不包括人员手动关联人员),都不能操作。
①请先登录钉钉开放平台https://open-dev.dingtalk.com找一个用来获取打卡数据的应用,然后点击【权限管理】,如图:
在权限管理里面找到【考勤】,然后将查询,获取相关权限勾选,点击【批量开通】,如图:
访问云桥【阿里钉钉】集成,点击【考勤同步】后面的【设置】进入考勤同步配置页面,复制刚才开通考勤权限的应用的appkey和appsecret,粘贴到对应的位置,点击保存,如图:
③手动同步
④定时同步
此功能在企业集成--业务集成,此功能主要实现通过钉钉自带的扫一扫功能扫描OA。
系统首页的二维码进行登录OA系统,具体位置如下图:
如果在未集成企业和应用的情况下,直接点击后面的【设置】按钮,会提示“请先添加钉钉”,故配置扫码登录功能前,请先集成企业和应用,参考手册第1、2点。
点击扫码登录功能后面的【设置】按钮,进入配置页面,先点击开启按钮,再选择集成的应用后保存,如下图所示:
打开OA系统登录首页,扫码入口在右上角,如下图所示:
使用手机端钉钉自带的扫一扫功能,扫OA系统登录首页二维码,如下图所示:
扫完之后,需要选择租户(也就是团队名称)及集成的企业名称,如下图所示:
此处需要注意:
①当人员处于单租户及单企业的情况下,扫描之后可直接登录OA系统。
②当人员处于多租户或多企业情况之下才需要选择租户或选择企业。
选择完企业之后,如果人员在集成企业的通讯录里无关联关系且未开启自动关联(如下图1),则会出现此界面(如下图2):
需要人员建立了关联关系后才可正常登录oa系统,具体建立关联的操作方法可参考4.2.3(开启了关联设置,此时用户访问应用,也可通过关联设置自动关联)④用户卡片绑定;扫码选择完企业后,若建立了关联关系,就能正常登录oa系统页面,效果如下图所示: