一、场景说明
适用场景:
1)客户信息安全较高,不支持通讯录信息展示或仅支持部分展示
2)客户侧通讯录数据量大(2W+),导致全量同步耗时长或同步失败
轻量化集成是指通过第三方原生日程同步的方式,同步WPS协同侧针对日程的预约、编辑、删除操作;
V26的版本轻量化对接WPS协同后支持以下功能点
1) 支持按配置范围同步WPS侧通讯录:同步全部、同步部分
2) 支持同步WPS侧的会议室数据
3) 支持同步WPS侧针对会议室日程的预约、编辑、删除等操作
4) 通过门牌预约、传感器即占即用、日程APP一键延长日程实现smart反向预约WPS日程
5) 已同步通讯录的前提下,部分场景支持通过WPS协同的客户端发送应用卡片消息。如释放通知、签到记录下载等。
二、配置方式
1、WPS侧配置
WPS管理员账号进入开放平台https://open.wps.cn/developer/home
选择企业自建应用,填写如图必填信息后,点击确定
(2)查看应用的凭证信息。复制应用ID和应用密钥,用于Smart侧鉴权配置。
(3)启用应用能力-WPS协作网页应用,编辑能力配置
设置桌面端和移动端的主页地址:域名+/manager/ssoLogin
(用于单点登录跳到smart的地址)
(4)启用应用能力-WPS协作机器人,编辑能力配置(如不需要应用通知功能,可不启用)
注意:应用首次配置后,应用机器人需要先手动触发发送消息,才可正常使用消息通知的功能(WPS侧的设计问题),步骤如下:
a.选择发送消息-消息群发
b.发送对象点击从可见范围内选择,如图指定成员-编辑,按通讯录添加选择任一成员即可
c.发送内容输入任意内容后,点击发送。发送成功后,确认对应用户有正常收到该应用的机器人消息即可。
(5)进入权限管理,开通相关权限
模块
功能名称
scope
权限类型
通讯录
查询通讯录信息
kso.contact.read
app
查询用户基础信息
kso.user_base.read
user
会议室
查询会议室
kso.meeting_rooms.read
app
查询和管理会议室
kso.meeting_rooms.readwrite
app
日历
查询日历
kso.calendar.read
app
查询和管理日历
kso.calendar.readwrite
app
查询日程信息
kso.calendar_events.read
app
查询和管理日程信息
kso.calendar_events.readwrite
app
消息与群组
查询和管理会话消息
kso.chat_message.readwrite
app
(6)根据具体使用场景配置可用范围和数据权限里的通讯录权限范围
全部成员:若选择整个企业,则企业内所有成员均有使用该应用的权限
指定成员:若选择指定成员,需要手动选择部门或成员,仅部分用户拥有该应用的权限
注意:可用范围和数据权限的区别(工作台应用可见对象取决于可用范围,通讯录同步范围取决于数据权限里的通讯录权限范围)
(8)配置事件与回调,订阅配置-编辑订阅方式(WPS仅支持使用HTTP接口进行订阅),配置订阅接口URL地址(复制smart侧鉴权配置的URL),配置完成后保存。
PS:以下列出当前版本所需要配置的所有事件
事件名称
所属权限
会议室预定创建
查询会议室
会议室预定更新
查询会议室
会议室预定删除
查询会议室
备注:
1)若要通过事件订阅达到日程实时自动同步的效果,需要环境支持http订阅,且由于wps仅支持80端口,因此smart侧需要注意:
① 环境开放80端口,同步开启外网映射
②确认环境是否有开启防火墙相关配置影响http请求。如公司内部测试环境之前是通过waf映射的域名,会强制转https,需要IT侧变更策略才可支持http请求。
2)若环境不支持http订阅,则无法实时事件同步。可手动配置环境变量开启定时同步
修改配置文件 vi /opt/apollo/data/modules_conf/extra.yml新增以下变量
system_manager_container_override_env:
THIRD_SDK_CONFIG_WPS_AUTO_SYNC_ENABLE: "true"
##上面这行有两个空格
#wps定时同步开关。未配置默认关闭,订阅不可用时才开启;开启则定时3min同步日程
(9)安全设置,分别配置用户授权回调配置(smart域名+/manager/ssoLogin)、H5可信域名(smart域名)、免重复用户授权域名(smart域名)
(以上主要用于单点登录和应用卡片跳转等功能)
(10)以上配置完成后,需要创建版本并发布。
(11)发布完成后,即可通过WPS协作的工作台找到该应用。
2、Smart侧配置
(1)进行AK配置(系统集成-第三方对接-协同平台选择WPS协作,对接方式默认为第三方原生日程同步,鉴权配置填写WPS应用信息)
(2)数据同步(首次配置需先操作手动同步,后续使用可依赖定时自动同步),可同步的数据类型包括通讯录、会议室、日程。