一、概述
云桥支持与云之家系统集成,包括“通讯录同步”“应用集成到云之家"”消息互通“,即实现在云之家上使用我们的应用,包括推送消息。
二、操作说明
1. 企业集成
2. 业务集成
2.1 接口参数设置
2.3 用户绑定设置
3. 应用集成
4. 消息推送
5. 扫码登录
6. 其他
6.1 用户绑定解绑
6.2 同步功能使用
6.3 其他注意事项
【开通服务器网络权限的说明】
1.如果使用本系统进行钉钉集成功能,则需要调用钉钉接口,并且最终用户是通过钉钉来使用集成的功能,所以本系统部署的云桥服务器必须要求,能够访问外网:即开通这台服务器的上网权限,让云桥服务器能够访问互联网,如果贵公司对网络安全要求较高,至少需要让这个服务器能够访问以下地址:
云之家API:https://www.yunzhijia.com
2.同时请网络管理员将本系统的访问地址映射到外网。
3.可以用如下方式验证网络是否通畅:
在云桥服务器上按如下方式检查网络:
ping www.yunzhijia.com 查看是否能ping通
Windows:
浏览器访问 https://yunzhijia.com/gateway/oauth2/token/getAccessToken 查看是否有返回结果
Linux:
执行命令 curl https://yunzhijia.com/gateway/oauth2/token/getAccessToken 查看是否有返回结果
1. 从【后台管理中心】-【平台引擎】-【云桥】中进入云桥集成页面,如下图所示:
2. 选中【云之家集成】-【新建云之家】进入创建云之家配置页面,如下图所示:
企业名称:根据需要填写云之家号的名称
企业EID:填写云之家管理后台【管理中心】--【团队概况】--【团队总览】界面中的注册EID,如下图:
部署方式:如果您部署的是私有云之家,请修改API服务地址,否则不用修改默认值
正确填写以上所有参数后点击保存,系统会创建云之家配置信息
点击【通讯录管理】的设置按钮进入设置页面,如下图所示:
通讯录密钥:如果使用通讯录管理功能,则必须要输入通讯录管理密钥,密钥值请填写云之家管理后台【管理中心】--【系统设置】--【系统集成】中的密钥,如果需要对云之家中的数据进行新建或编辑操作则请确保对应的权限设置为可编辑密钥,接口权限选择读写,如下图所示:
云桥组织架构同步分三种:
1. 将云之家的组织架构同步到云桥(不修改OA的组织架构)
2. 将云之家的组织结构同步到云桥同时同步到OA(修改OA的组织架构)
3. 将OA的组织架构同步到云桥,同时同步到云之家(默认在同步前会先执行“从云之家同步组织用户绑定关系”,以保证从OA同步的时候正确比对用户和部门信息)
点击【从云之家同步组织用户绑定关系】
新用户关联系统账号:设置本次同步过来的新成员(即云桥中不存在对应账号的成员)是否要自动建立于集成系统的关联关系
用户字段:设置云之家中成员字段对应eteams系统中人员字段的对应关系,若字段值可以匹配,则从云之家同步可以自动关联上,具体说明可在界面点击查看用户自动说明文档
定时同步:设置是否开启定时自动执行从云之家同步操作,如果通讯录数据是统一在云之家端维护的那么建议开启定时同步,即系统会定时的将云之家数据同步到移动平台中并自动建立与eteams的关联关系,具体设置建议为每隔一天同步一次,同步开始时间建议设置为凌晨2点或3点,例如开始时间设置为2019-02-02 02:00:00 则表示从2019年2月2日凌晨2点开始同步,并且每隔一天2点进行一次同步,结束时间一般不用填写;如果云之家通讯录数据是希望自动从eteams系统同步,则无需设置此同步,后面开启从eteams定时同步即可
是否同步到eteams:若选择是,可在从云之家同步时修改eteams的用户数据,可根据需求开启,具体规则见文档从云桥同步到E10,如图:
顶级部门:设置从eteams系统同步过来的部门要以哪个部门作为上级部门,即放在哪个部门下,一般默认设置为当前的根部门即可
新成员是否自动添加到云之家:设置从eteams同步过来的新成员是否要调用云之家接口自动创建到云之家通讯录中,默认建议开启此选项
用户绑定:设置从eteams同步过来的成员与云之家中已有的成员(但还没有eteams关联关系的那部分成员)自动关联时的字段的对应关系
用户字段对应关系:该配置可以将该成员在eteams系统的里个人信息,同步到成员在云之家里的个人信息里
范围设置:设置从eteams同步数据的范围,即哪些数据(分部、部门、人员)需要同步到云之家通讯录中,如果是需要将eteams系统的所有数据都同步到云之家中则无需设置,如果只希望一部分人员添加到云之家中,即使用云之家功能,则根据需要进行设置,这里需要注意选择的范围表示每次同步只有范围内的数据(分部、部门、人员)会添加到云之家中,不在范围内的如果之前同步过的(有eteams关联关系的)数据将被删除,没有关联关系的数据不会有影响,所以此范围选择需要慎重,根据实际的情况进行设置
注:部门和用户可以分开设置;
用户范围(排除)的优先级高于 用户范围(包含)
安全设置:用户减少数量阈值指本次同步的OA用户数量和上一次相比,减少的数量超过x,将停止同步OA用户信息,x可以自己设置
定时同步:设置是否开启定时自动执行从eteams系统同步操作,此处建议开启,并且每隔一天同步一次,同步开始时间建议设置为凌晨2点或3点,例如开始时间设置为2019-02-02 02:00:00 则表示从2019年2月2日凌晨2点开始同步,并且每隔一天2点进行一次同步,结束时间一般不用填写
导出用户账号关联关系表:根据需求选择需要导出的用户范围,以及用户在云桥的关联状态、云之家状态、添加状态,之后点击导出人员账号关联关系表
在导出的文件中配置【关联字段】,再进行导入:首先选择关联字段类型,再在第一步中导出的excel表中进行对该字段的维护,然后点击上传附件将excel表导入,即可实现人员批量关联
根据配置的条件,比如:云之家手机号 匹配 OA手机号,如果匹配上了,就会自动将关联关系写入,如下图
应用管理功能主要是在移动平台中将云之家应用与业务系统(eteams)功能模块进行对接,即实现在云之家中使用业务系统的相关业务功能
1. 点击添加应用
进入云之家开发者平台点击【新建应用】并输入应用名称,如下图所示:
2. 在后台点击【添加应用】并将云之家后台的信息填入
3.应用主页是设置云之家应用的主页功能,调用模块默认为打开应用,选择应用中心已经存在的主页型应用,如下图所示
将应用主页地址复制至云之家后台后提交审核即可
可在【业务中心】-【应用管理】中修改应用可见范围
也可使用自定义链接,将地址填入自定义链接处即可
注意:若需要用系统默认浏览器打开云之家 应用 或 消息,需要调整云之家开发者平台-应用桌面端打开方式,暂时只能通过以下方式才能实现!!!
https://www.yunzhijia.com/developers/#/app-manage/details?appId=500815087
消息管理功能主要是将OA应用消息推送到云之家中,即实现在云之家中接收并处理业务系统的消息。消息正常推送的前提是,云之家用户要关联OA系统用户账号。
1.在【云桥】-【消息推送设置】-【消息推送规则】 页面,点击新建,如下图所示:
例如将 日报 的消息推送到云之家:填写好规则名称,消息来源选择日报,如下图所示
在规则详情页面,点击【新建】,设置推送目标,第三方企业类型选择【云之家】,企业和应用根据实际需要,选择对应的企业团队和应用,如下图所示
消息类型可选择【通知】或者【待办】:
选择【通知】的话,需要填写【消息推送账号】和【消息推送密钥】
这两个参数首先需要在云之家后台【业务中心】新建公共号
若当前操作者没有公共号的管理权限需先赋权
然后在【业务中心】-【公众号列表】选择创建的公众号【进入】点击开发者进行复制,点击保存即可
将 日报 的消息推送到云之家:除了第二点中所述将消息来源选择日报之外,还可以将消息来源选择为全部,如下图所示:
注意:若消息来源选择全部,OA其他应用的消息(例如审批,出勤等)也会通过这条消息推送规则推送到云之家。
推送示例:
【待办】
【通知】
此功能主要实现通过云之家自带的扫一扫功能扫描OA系统首页的二维码进行登录OA系统
开启按钮选择依赖应用即可,不在应用可见范围的人员将无法使用
将OA用户和云之家人员绑定的方式有多种:
1.手动绑定(需要配置应用)
用户完成应用集成之后,可以直接访问应用,然后输入正确的系统账号密码后,对应集成的云之家-通讯录中会记录用户的云之家账号信息以及绑定关系。
2.自动绑定
用户字段有三个设置的地方:一个地方配置之后,其他两处也会开启自动同步;修改任意一处,也会变更其他两处的设置。
用户单点通讯录->用户绑定设置
从云之家同步->新用户关联系统账号
从OA同步->用户绑定
根据配置的条件,比如:云之家手机号 匹配 OA手机号,如果匹配上了,就会自动将关联关系写入,如下图所示:
1. 关联导入
将已经同步到云桥本地的数据(单点写入或者从云之家同步写入)导出,并且将需要绑定的OA人员的对应字段写入到文档中,上传文档,点击导入按钮,即可将关联关系写入,详情可见2.2.4
4.人员卡片绑定/解绑
将云桥本地的数据和OA的人员进行绑定或者解绑
5.批量解绑
解除云桥本地所有人员和OA人员的关联关系,如下图所示:
首先执行【从云之家同步】,然后把人员在云之家中的身份和在OA系统中的身份关联上,使用如下任何一种方式。
方法一:手动关联。
方法二:在从云之家同步时进行自动关联:需要在【从云之家同步】时,开启【新用户关联系统账号】,配置关联字段之后,进行同步。
后续可以在 【从云之家同步】时,开启定时同步,每隔一段时间将云之家的组织架构的变动更新到云桥。
如果不希望在OA修改组织架构后影响到云之家的组织架构或者在云桥菜单中修改,可以开启通讯录的只读模式:只允许云之家的修改同步到云桥本地。
若希望从云之家同步的同时可以修改e10的组织架构,可开启同步到e10
情况一:云之家没有组织架构(默认已经执行过从云之家同步)
1.无需进行人员账号绑定。
2.执行【从OA同步】,执行完成后,云桥会把OA的人员创建到云之家,并且自动把人员在云之家中的身份和在OA系统中的身份关联上。在创建云之家人员时,云之家人员的账号使用OA人员的如下配置字段的值:
情况二:云之家有组织架构(默认已经执行过从云之家同步)
1.设置云之家历史人员账号绑定,选择如下任意一种方式进行关联:
方法一:手动关联
方法二:自动关联,在第二步执行同步的时候配置人员匹配字段。
注:如果自动绑定无法满足将云之家人员和OA人员关联,可以在从OA同步前先使用手动绑定关联这些人员。
2.设置顶级部门
是否设置顶级部门决定了同步后的组织架构。
部门关联的逻辑是:层级相同且部门名称相同,在执行同步的时候,会自动关联,否则,在云桥和云之家新建部门。关联上的部门前面会有一个黑色实心原点,代表已关联
举例说明:
① 没有设置顶级部门,默认同步OA整体组织架构
如下图所示,根据层级和名称首先进行顶级部门匹配,则OA顶级部门【演示部门】去匹配云桥顶级部门【演示部门】,可以匹配。一级部门能够匹配上的只有【部门A】,则其他没
同步后效果(可以先同步模拟同步查看效果):橘色为匹配,紫色为新增
注:如果顶级部门的名称不相同,例如【Re部门】和【演示部门】名称不同,则顶级部门无法匹配,同步立刻中止。
提示如下:
① 设置了顶级部门,默认同步OA整体组织架构。选定【其他部门】为此次同步的顶级部门:
如图所示,组织架构层级对应如下:
执行同步,会将OA【Re部门】及其下级部门,同步到云桥【其他部门】下,作为顶级部门。
根据部门匹配的原则,OA一级部门【Re部门】和顶级部门下的一级部门没有名称相同的,直接新建。
同步效果如图:
1. 当云之家的组织架构发生变化之后,需要在执行【同步通讯录到云之家】之前,先执行【从云之家同步组织结构绑定关系】
2. 如果该云之家用户已经关联OA的账号,那么从OA同步的时候,人员匹配字段的配置将不会修改原有的绑定关系,该配置只针对未关联OA的云之家用户
3. 接口参数设置,如果设置了只读权限,所有在云桥对组织架构进行的操作(不包括用户手动关联用户),都不能操作。