用户列表管理平台-自动同步

一、 前言

用户列表管理平台为您提供身份相关管理服务，即当您接入腾讯会议时，用户列表管理平台将为您提供账户数据同步、单点登录及多认证源登录到腾讯会议的能力。

二、 部门和人员管理

1.查看组织架构

①进入组织架构管理页面。

②展开部门可直接查看部门直属人员数（不包含子部门的人员数）。以下图为例，技术部直属人员共6人。

③点击图标，查看当前部门人员列表。在弹出的某个部门人员列表，可以搜索或筛选指定的人员。

④点击搜索图标，在展开的输入框，输入目标用户的信息即可搜索到相关用户。

⑤点击筛选图标。

⑥可按人员状态、所在部门、人员属性等对当前部门人员进行筛选。

⑦其中，人员状态可选择其中一种状态筛选；也可以同时选择多种状态进行筛选。

所在部门可选项有两种：

• 本部门：仅包括直属于当前部门的成员；

• 本部门及子部门：不仅包括直属于当前部门的成员，还包括当前部门下所有子孙部门的成员。

人员属性：选择目标属性，并在输入框内输入相应的值，支持同时添加多个属性作为筛选条件。

2.快速搜索部门和成员

在组织架构管理页面，支持直接搜索部门或人员；

①点击搜索图标，在展开的输入框，输入目标部门的信息，下拉框弹出相关部门的列表，单击目标部门进入该部门管理页面。

②在展开的输入框，输入目标人员信息，下拉框弹出相关人员列表，单击目标人员名称，可展开该人员详情。

3.部门管理

1）查看部门详情

①点击具体部门图标，可查看该部门详细信息。以【技术部】部门为例：

②进入部门详情页面，可查看基本信息、部门成员、兼职成员、子部门等。

4.人员管理

1）快速查看人员列表

点击图标展开操作窗口，单击【全部人员】可以查看全部人员列表。

三、 认证源管理

1.如何添加认证源？

①点击【认证源】。

②点击【添加认证源】。

③选择认证源类型，进入配置页面。

2.认证源配置流程

1）配置流程

• 在企业微信创建自建应用

  前置条件：拥有企业微信管理员账号。（目前企业微信可以个人免费注册，注册地址：https://work.weixin.qq.com/）。

  ①登录企业微信。

  

  ②点击“我的企业”标题栏，在企业信息中获取“企业ID”，保存以便于后续配置。

  

  ③点击“应用管理”标题栏，点击左侧“应用”栏，点击下方创建应用，并填入必要信息。

  

  ④点击创建应用。进入应用详情，可获取“AgentId”、“Secret”，保存以便于后续配置。

  

• 在用户列表管理平台创建企业微信认证源

  前置条件：拥有腾讯会议管理员账号。

  ①在 “认证源”页面右上角点击添加认证源。

  

  ②输入必要信息后，点击确定。

  

  ③填写必要参数信息后，点击生成回调链接。

  

  ④生成回调链接后将配置企业微信页面的参数“企业微信授权登录回调域”和“工作台应用主页”信息记录，保存便于后续配置。

  

  ⑤进行账号关联设置，制定相应的规则。

  注：

  对于用户列表管理平台已有身份信息的人员支持管理员自行设定匹配规则，如若设置为邮箱相同则匹配时，人员登录时将会把企业微信帐号自动关联至统一目录中邮箱相同的人员身份下；

  对于用户列表管理平台没有身份信息的人员支持管理员自行设定映射规则，人员登录时将读取企业微信帐号的人员身份信息按照规则写入统一目录中，实现人员创建。

在企业微信进行应用配置

①此时将之前记录的参数“企业微信授权登录回调域”（可在已经配置好的认证源界面查看）。

②填入企业微信后台对应应用的“企业微信授权登录”中，即可实现在用户列表管理平台登录页面通过扫码方式以企业微信身份进入用户列表管理平台主页。

③将之前记录的参数“工作台应用主页”（也可在已经配置好的认证源界面查看）。

④填入企业微信后台对应应用的“企业微信工作台应用主页”中。

⑤将之前记录的参数“企业微信授权登录回调域”（也可在已经配置好的认证源界面查看）。

⑥填入企业微信后台对应应用的“网页授权及JS-SDK”中，即可实现在企业微信工作台以微信身份进入用户列表管理平台主页。

3.认证源设置

1）开启/编辑/设置默认认证源

已配置好的认证源可进行开启/关闭、设置默认认证源（设为默认认证源后，每次登录页将首先展示该登录方式，使用其他非默认登录方式需要点击切换），编辑认证源配置等操作。

2）关闭/删除认证源

关闭的认证源可进行删除操作。

四、 工作台

1.工作台操作流程

1）在用户列表管理平台创建企业微信工作台实例

前置条件：用户列表管理平台主要采用在企业微信自建应用的方式进行企业微信工作台集成，所以要求拥有企业微信管理员账号。（目前企业微信可以个人免费注册，注册地址：https://work.weixin.qq.com/）。

①选择添加企业微信工作台。

②填写基本信息，点击【确定】，至此该企业微信工作台实例创建成功！继续进行具体配置。

③每个企业微信都拥有唯一的企业ID，获取此信息可在企业微信管理后台【我的企业】->“【企业信息】下查看“企业ID”。

2）账号关联设置

若设置为邮箱相同则匹配时，在企业微信工作台将以用户列表管理平台中邮箱字段信息相同的人员身份登录应用。

若用户列表管理平台不存在匹配的人员支持管理员自行设定映射规则，在工作台进行登录时将读取的企业微信人员信息按照设定映射规则写入用户列表管理平台统一目录中。

3）企业微信创建自建应用

①在企业微信管理后台“应用与小程序”->【应用】->点击创建【自建应用】。

②填写应用基本信息。

③至此自建应用创建成功！在企业微信侧开启通讯录权限并完成应用权限分配。

4）应用对接配置

①选择需要在企业微信工作台实现用户列表管理平台单点登录应用实例，即腾讯会议应用。

②从企业微信管理后台【应用管理】->自建应用详情页面获取AgentId以及Secret。

③将获取的参数填写至应用配置页面，点击【生成回调链接】，将生成的链接配置企业微信对应位置。

④可信域名分别配置至自建应用详情页面-网页授权及JS-SDK。

⑤及企业微信授权登录-Web网页。

⑥应用主页配置至自建应用详情页面-工作台应用主页。

⑦至此该应用对接完成。如需在该工作台添加更多应用，进入详情页面进行添加
此时，在企业微信工作台点击创建的自建应用可以跳转至对接的用户列表管理平台应用页面。

五、同步管理

1.名词释义

统一目录：用户列表管理平台的数据存储目录，用于存储人员、组织机构、用户组等信息。

同步管理：帮助客户实现任意应用和统一目录（UD）之间的账号同步功能。

镜像：对“某应用的对象”复制数据的描述，如：UD的人员、钉钉的部门。

同步连接：描述两个应用/UD建立的数据匹配、传输的关系。

同步关系：描述两个镜像间建立的数据匹配、传输的关系。

同步源：同步连接中处于上游的系统，同步信息来自该系统。

同步目标：同步连接中处于下游的系统，同步信息将从同步源同步至该系统。

2.查看同步连接列表

点击【同步】->进入同步管理页面，可以查看已添加的同步连接列表；用户列表管理平台已经预置了UD向腾讯会议的同步连接。

点击具体的同步连接卡片，可以查看该同步连接详情。

3.如何配置同步？

1）创建同步连接
①点击右上角【添加同步】。

②选择【企业微信目录】，点击【确定】，为同步连接自定义一个名称。

③此时同步连接创建成功。进行同步源设置，此时需要获取CropID(企业ID)及Crop Secret(通讯录密钥)。

④获取方式如下：

• 登录企业微信。点击我的企业标题栏，在企业信息中获取企业ID。

• 点击管理工具标题栏，点击通讯录同步。

• 点击开启API接口同步，获取Secret(通讯录密钥)，选择API编辑通讯录，点击保存。

• 此处选择暂不设置即可。

2）创建相关镜像

根据需要同步的数据创建对应的镜像。比如，我此时需要将企业微信中的人员及部门信息同步至用户列表管理平台，那么我需要创建统一目录及企业微信的人员、部门镜像，用于后续进行数据匹配等操作。

这里以企业微信人员镜像的创建为例：

①点击【镜像管理】，进入镜像创建页面，选择同步源（此时指企业微信）进行添加。

②选择【人员】。

③根据需要自定义镜像名称。

④配置镜像数据展示项。存储的人员信息实际为各种人员属性的集合，这里您可以选择展示的人员属性方便后续进行人员判断。这里用户列表管理平台提供了真实JSON格式数据实例供参考。

3）配置同步逻辑

①点击+区域，可以添加同步关系。

②此时就可以选已经创建好的同步源。

③及同步目标的镜像。

④填写同步关系的配置信息，选择当前同步关系的处理策略：DEFAULT表示平铺结构；TREE表示层级结构。

⑤点击【创建】，完成后在同步连接管理页面可以看到新建的同步关系，点击图标开始配置，按需选择操作节点。

⑥各节点含义如下：

⑦常见的同步逻辑图如下图所示：

⑧点击【数据测试】。

⑨输入数据信息，例如关于人员的同步关系可以输入人员姓名；点击目标人员，可查看该数据经过当前同步关系的情况。

⑩单击节点可查看数据详情。

⑪至此一个完整同步配置已经完成。

4.同步连接管理

1）部门&人员同步

部门同步流程

其中需要额外注意的是转换节点和匹配节点的脚本写法会有一些特殊，因为这是和业务相绑定的，一般如果想进行按照层级的部门同步可以这样写。

需要注意一下parentId这个字段对应的脚本内容，其中使用了一个复杂语法，语句中标记出的“WECHAT-DEPT-SYNC”，其实就是我们在创建部门连接关系时输入的编号，我们在同步的时候会根据此编号进行查询已有的连接关系，在正常的使用中，需要根据自己设置的编号进行替换修改。

我们可以针对转换的脚本内容，进行一下预览测试，点击左下角的测试，搜索一条数据，进行测试。

然后我们进行设置匹配节点，对于部门维度，我们一般使用name字段进行匹配。

匹配脚本内容：name 

脚本语言：DIRECT 

之后的同步流设置可以按照下图进行配置。

人员同步流程

然后我们也开始配置人员的同步流，设置同步关系的名称与编号。

人员同步的转换字段较为复杂，大家可以按照下表进行配置，标黄的为可能需要替换的部分。

其中需要注意username和primaryMail都是统一目录中的必填且唯一字段，因此我们使用企业微信中的userid和email进行匹配。deptId需为统一目录的部门ID，因此需要使用部门维度的同步连接编号，用于查询匹配关系。

email 

注意：由于UD中primaryMail不能为空，有些客户在企微中email为空，则对于这样的用户，脚本语言应该选择JavaScript，内容中写：

JavaScript
if(data.email =="") { 
  return data.userid + "@nomail.com"; 
} 
return data.email; 

在UD中secondaryMail是可以空，可以将客户的email保存到UD这个字段中，同时腾讯会议那面email也可以为空，所以建议同步腾讯会议的email映射secondaryMail这个字段。
匹配节点字段，因为唯一标示是企业微信的userid，因此我们使用转换之后的username字段。

配置完成的同步流如下图所示。

2）同步预览测试

进入同步连接详情，可以查看当前同步连接包含的同步关系、同步设置、镜像管理及同步日志等。

管理员可以在同步预览：

①预览和管理数据间的匹配关系，保障数据通过 Sync Flow 同步结果的可控性。

②查看数据同步结果，方便排查同步失败的问题。

• 点击【同步预览】。

  

• 点击【同步】可一键同步/预览数据同步情况。

• 可配置同步任务流，可按照配置好的任务流，一键执行同步或预览。

  

• 点击图标展开操作列表，可进行更多操作。

• 各操作按钮含义如下：

• 勾选具体数据，点击图标展开操作列表，可进行针对当前数据的操作。

  名称	释义
  同步	手动选择某几条数据参与同步
  同步预览	选择多条匹配信息，手动预览
  删除	删除已选择数据的匹配关系

  

• 点击筛选图标。

  

• 可根据同步状态和同步操作筛选预览数据。

  

• 同步或预览任务执行后，可点击图标查看运行错误情况；只可以查看上一次同步/预览运行错误情况。

  

• 点击【同步】可以添加或修改同步任务，点击+图标添加同步任务。

• 点击【预览】/【同步】完成预览/同步当前任务。

3)手动同步

①点击操作图标，展开操作列表，点击【手动同步】。

②点击+，添加同步任务，已添加的任务允许编辑或删除；点击【运行】运行当前同步任务。

4）自动同步设置

①点击操作图标，展开操作列表，点击【自动同步设置】。

②用户列表管理平台支持多个自动同步任务流，点击+图标可以添加多个自动同步任务流。

③点击+区域添加当前同步任务流的子同步任务，支持添加多个子同步任务，已添加的同步任务允许编辑或删除。

④点击编辑图标按需设置定时器，允许添加多个自定义定时器，点击+区域添加当前同步任务流的定时器。

5）同步日志

①点击【同步日志】。

②展开同步日志列表，单击可查看日志详情。

③管理员可在同步日志详情页查看具体数据的同步记录和报错情况等信息。

6）同步关系管理

①点击图标展开当前同步关系的操作列表。

②点击【配置】允许编辑当前同步关系的名称、编号、描述、以及处理策略，完成后点击【保存】。

③点击【自动同步设置】允许设置当前同步关系的自动同步任务；设置方式参照同步任务自动同步定时器设置。

④点击删除可删除当前同步关系。

六、 系统外观设置

1.浏览器标签设置

用户列表管理平台支持浏览器页签、登录页外观、导航栏及背景设置。

①点击【系统外观设置】。

②点击【浏览器页签设置】区域。

③点击logo区域可以更换浏览器页签logo，logo图片需符合系统要求；在输入框可编辑浏览器页签文字；点击【确定】保存编辑的信息。

2.登录页外观设置

①点击【登录页外观设置】区域。

②点击logo区域可以更换登录页logo，logo图片需符合系统要求；点击登录页背景区域可以更换登录页背景，背景图片需符合系统要求；点击【确定】保存编辑的信息。

3.导航栏及背景设置

①点击【导航栏及背景设置】区域。

②可以分别配置导航栏（颜色、文字）、背景等；点击【确定】保存编辑的信息。