金山会议

【账号对接】账号同步应用接入指南_v1.0.5

【操作手册】 管理后台-账号同步记录 v1.0.5

云文档单点登录

【场景专项】账号对接

场景产品化

1.应用背景
在账号同步任务中，数据从中间表流向云文档通讯录的过程视为“黑匣子”。当遭遇服务波动、数据异常等挑战导致同步操作未能顺利完成时，我们需要了解同步异常的原因，以便及时进行调整和修正。同时，若定时自动同步任务未能达到预期的同步要求，手动触发同步逻辑已成为一项迫切的需求。鉴于此，我们提供全面的三方账号同步任务状态和记录功能，可随时掌握账号的同步状况，轻松获取最新的账号信息更新。
2.应用说明
2.1.使用前说明
    使用 账号对接-三方账号同步 需上架应用，详细可查阅《部署文档》。
2.2.版本说明
    为保证最佳体验效果，与标准产品保持一致，建议使用谷歌浏览器或基于谷歌内核的浏览器（推荐Chrome 69以上内核版本，最低支持Chrome 49）。若使用其他浏览器（如IE11、Firefox等），部分功能可能会有效果缺失。对应标准产品版本信息如下：
    云文档：release_dc_v7.0.2408b.20240822 
    目前暂不支持XC环境。
2.3.接入说明
该应用无法完全替代第三方账号同步的服务，为了充分发挥其效能，需要与项目方（服务商或客户）合作。项目侧将账号数据源采集至中间表，本应用负责处理中间表与云文档通讯录之间的数据同步。
项目侧采集数据的对接指导可查看文档：【金山文档 | WPS云文档】 账号对接服务商接入指南 https://p.wpseco.cn/wiki/doc/66e01a6a6973c4cf901d3162
 3.功能清单
1.支持概览展示全量和增量同步的最近同步时间（5分钟更新一次）；
2.支持查看全量同步的任务记录和同步汇总详情；
3.支持查看增量同步的同步记录和同步信息详情；
4.支持全量同步的异常任务重试，并配置执行时间；
5.支持全量同步的异常任务自动重试机制，自动默认重试3次；
6.支持增量同步单条异常数据重试；
7.支持增量同步的任务执行频率策略。
4.操作指导
4.1全量同步概况
一、全量同步概况
1．展示全量同步最近结束时间
2．展示自动同步状态：已开启、已暂停
（1）已开启：默认开启自动同步程序，根据项目对数据同步的要求，默认n（采集过程约定）时长频率定时同步数据；
（2）已暂停：自动同步程序暂停。
①可通过设置去开启和关闭自动同步任务；
②当同步的数据有异常时，程序默认重试3次后数据仍有异常，则自动暂停同步程序。
 注意：若自动同步任务程序强制暂停后，需管理员操作“忽略”异常任务，或者手动去「设置」模块，重启自动同步程序。
 
![image.png](/wiki/api/v1/file/download?fid=225cf1dfa69e1f6ab1a87d4bcc8f89c6886efcee)
二、全量同步概况-设置
点击「设置」，对全量同步任务的自动同步程序开启或暂停操作

![image.png](/wiki/api/v1/file/download?fid=35d322962f2e127a0c86d7cb7693b9f066c71871)
4.2全量同步记录
一、同步记录列表
1．展示全量同步的任务记录，记录信息见图；
2．默认展示全部同步任务，需要特别查询，可通过检索条件筛选

![image.png](/wiki/api/v1/file/download?fid=4663c578ce71a430f0fa24d3fc8748613aba18de)
二、同步记录-检索条件
1．同步方式：自动同步、手动同步；支持多选。
（1）自动同步：程序自动推送同步任务并自行同步；
（2）手动同步：同步异常的数据支持手动重试，重试的任务方式则为手动同步。

2．任务状态：待同步、同步中、成功、异常、已取消；支持多选。
（1）待同步：手动同步的任务，配置了同步时间（未来时）；
（2）同步中：当前有任务在同步中
（3）异常：任务结束时或者任务终断，数据异常、服务异常等情况
（4）成功：任务结束时无数据异常等情况
（5）已取消：任务被取消，手动终止任务或者任务冲突取消任务

![image.png](/wiki/api/v1/file/download?fid=6013ae5853ba934f6cb34abb6424aad2c878d348)
<全量同步-检索条件>

三、同步记录-操作
1．操作：查看详情、取消同步、终止任务、手动重试、忽略；以下是可操作的规则：
（1）取消同步：仅「待同步」状态的任务，可执行该操作；

![image.png](/wiki/api/v1/file/download?fid=a478ee642abbec9541f59f945b8410775b9314c4)
<取消同步>
（2）终止任务：仅「同步中」状态的任务，可执行该操作；
<终止任务>

（3）手动重试：仅「异常」状态且未在后续同步成功的任务，可执行该操作；（见后文详细描述）
（4）忽略：仅「异常」状态且未在后续同步成功的任务，可执行该操作，执行该操作后，自动忽略异常任务，正常进行后续推送的同步任务。 
<忽略异常任务>

2．手动重试，需确定「立即同步」或「选择同步时间」
（1）「立即同步」则以当前任务ID的数据进行重新同步，并在同步记录中新增任务，状态为「同步中」
（2）「选择时间同步」则以当前任务ID的数据重新同步，并以选择的同步时间开始同步

![image.png](/wiki/api/v1/file/download?fid=8b20bfc021f8a3508a6fc1fff40cd0c97591aba7)
<手动重试>

![image.png](/wiki/api/v1/file/download?fid=40838e6182d8da04cca502ed71548b43cd1a7ad3)
<手动重试-选择重试时机>

3．自动重试：「异常」状态的任务，同步引擎会默认自动重试3次，且重试时间在凌晨6点前（避免白天大任务重试，造成性能压力）。自动重试任务仍同步异常，则会自动暂停自动同步任务。（见4.1全量同步概况）

4．查看详情：展示任务的详细情况，如图

![image.png](/wiki/api/v1/file/download?fid=32ed942145cd2b7bdf8004b2bbc8656db44a1823)
<成功任务详情>

![image.png](/wiki/api/v1/file/download?fid=81f809fcd32708d1f35fbbff70c427e39c3c3e39)
<异常任务详情>

5．支持翻页查看数据

![image.png](/wiki/api/v1/file/download?fid=e64b3c36992b373262a645073805238750d249df)
4.3增量同步概况
一、增量同步概况
1．展示增量同步最近结束时间
2．展示自动同步状态：已开启、已暂停
（1）已开启：默认开启自动同步程序，根据项目对数据同步的要求，默认n时长频率定时同步数据
（2）已暂停：自动同步程序暂停。
①可通过设置去开启和关闭自动同步任务；
②当全量任务异常，全量自动同步程序被暂停后，增量任务的自动同步程序 也被自动暂停。
 注意：若自动同步任务程序强制暂停后，需管理员手动去「设置」模块，重启自动同步程序。
 
![image.png](/wiki/api/v1/file/download?fid=1b4aabf0e477c955817b2a8c16aa9df1703264ed)
二、增量同步概况-设置
1．点击「设置」，对增量同步任务的自动同步程序开启或暂停操作。
2．对增量同步频率进行配置，其中考虑增量单条数据同步速率、同步引擎的性能问题以及对同步时效性的要求，当选择「小时」配置是，支持1-12小时间隔；选择「分钟」配置，支持1-30分钟间隔。

![image.png](/wiki/api/v1/file/download?fid=12451706c32008ec9a1e673aca6d83e48c7f7c25)
4.4增量同步记录
一、同步记录列表
1．展示全量同步的任务记录，记录信息见图；
2．默认展示全部同步任务，需要特别查询，可通过检索条件筛选。
二、同步记录-检索条件
1．用户/部门：支持输入增量同步的用户或者部门数据；
2．类型：用户同步、部门同步、关系同步；
3．同步方式：自动同步、手动同步；
4．同步结果：异常、成功；
5．同步时间：选择同步时间，由于数据量的压力，仅支持选择跨度为一天内的时间。
换个图

![image.png](/wiki/api/v1/file/download?fid=c83caab7efd35f55feafbe07649b10284f3f52c8)
三、同步记录-操作
1．操作：查看详情、手动重试。
2．点击「查看详情」，展示增量同步的单条数据信息。
每个项目账号相关数据不一致，中间表采集的数据内容有差异，因此同步信息以json形式展示。

![image.png](/wiki/api/v1/file/download?fid=066dc20dba66a773304eb63c44a3997e97c759f0)
3．自动重试：「异常」状态的任务可手动重试

![image.png](/wiki/api/v1/file/download?fid=60133d4dc268bac188532c1698c3b68c843bded1)
6．支持翻页查看数据

![image.png](/wiki/api/v1/file/download?fid=2d29e28a281248e3387c9b2f7f7db4bb3144f119)