企业微信数据同步集成

最后更新：2023-01-31

所有数据同步集成方案的实现使用IDP中的Connector组件来完成。
此处的数据指：组织机构数据，账户数据与组数据（组数据可选，没有不影响同步功能）。

1. 场景描述

应用场景图描述：
（1） 管理员在IDsConnector系统中创建同步任务，同步任务的触发可设置为手动或自动两种方式；
（2） 触发同步任务后IDsConnector系统通过调用接口拉取企业微信的部门和账户数据；
（3） IDsConnector系统会将拉取到的部门/用户数据通过SCIM的方式推送IDP4系统中。

2. 支持的对象

支持同步组织机构、用户。

3. 同步模式

使用connector配置企业微信到IDP4的同步，同步计划配置为：
image.png

  • 同步模式为：主动拉取

  • 同步模型为：经典目录模式(无序)

其他参数配置如定时同步、多线程等可以根据下列说明选择开启或关闭。

4. Connector配置方式

image.png
说明配置流程如上。如果没有特殊需求，可以跳过创建映射模板操作，直接使用connector内置的映射模板，或者再创建同步任务中进行调整。

4.1. 新建同步来源

  1. 登录 connector 之后，在来源管理页面点击新建同步来源

image.png

  1. 配置同步来源

来源管理配置如图：
image.png

  • 来源名称：随意填写，注意唯一性即可；

下面还有一个环境的选择，默认是开发环境。需要注意的是来源和目标的环境必须是一样的，否则不会执行同步任务
image.png

  • 来源主类型：APP_STANDARD

  • 来源子类型：选择ENTERPRISE_WECHAT

  • 企业ID：企业ID，获取方式看下面的截图

image.png

  • 应用secret：应用的secret，获取方式看下面的截图

image.png
有的可能查看方式不一样，需要到企业微信查看：
image.png
点击测试连接，确保连接的参数配置正确。然后点击保存
注意：多企业微信同步选项，若开启的话，组织机构id和账户名称会自动对应加上前缀”enterprise_wechat_任务ID_”。

4.2. 新建同步目标

connector已经内置了IDP4默认目标，可以不用重新创建。

4.3. 映射模板

image.png
image.png
connector4.11版本企业微信来源数据支持账户主组织字段，IDP 4.11版本上支持主组织字段接收
image.png
注意：建议配置企业微信的账号作为IDP的外部ID及IDP的账户名称。来源的username和目标的username可能映射不合规，需要根据实际情况配置可参考如下：
image.png
如果缺少用户的外部id，可参考如下配置：
image.png

4.4. 新建同步任务

image.png

  1. 先登录IDP，创建一个企业微信应用，并开启应用的API。点击

image.png

  1. 设置数据同步的范围和接口的范围，数据范围和接口范围根据需要设置，如下图：

image.png
image.png

  1. IDP4中点击机构与组 -> 导入 -> 新建拉取任务：

image.png

  1. 在创建同步任务页面：

  • 同步任务名称：名称不能和其他同步任务重复。

  • 同步来源：选择在4.1中新建的企业微信来源。

  • 来源根节点标识：在拉取企业微信/IDP数据时，可以用一个唯一标识来指定拉取的范围。需要和企业微信来源配置的 企业微信组织ID 一致。如下图，在企业微信中查看部门ID。

image.png

  • 目标根节点标识：填写I需要同步到IDP4中的组织机构外部ID，注意，该组织机构应该是在第二步数据范围里面的组织机构，不然会同步失败。查看方式如下：

image.png

  • 映射模版选择4.3中创建的映射模版，或者connector内置映射模版。

image.png

  • 关联应用：选择在第一步中创建的应用：

image.png

4.5. 企业微信数据回调

如配置这个，企业微信的数据变动后可以同步到IDP4。
image.png
image.png
修改URL，注意替换{host}和{taskId}
其中host为idp服务地址，taskId为同步任务的id。
url :{host}/public/api/sync/v1/data_accept/enterprise_wechat/event_cb/{taskId}
例如：(http://summer.vaiwan.com/public/api/sync/v1/data_accept/enterprise_wechat/event_cb/5)
注意，保存时保存失败会提示，connector的网络需要被企业微信访问到。
image.png