数据同步操作手册

一、概述

泰山平的数据同步功能目前有两套系统模式，一是使用平台新接口的“默认模式”，二是为兼容使用“监执问”同步接口的业务系统的“兼容模式”。

1、默认模式：使用平台提供的同步接口，由业务系统自己拉取同步数据。具体参考《数据同步功能对接文档》。

2、兼容模式：兼容使用“监执问”同步接口的业务系统，需要额外部署一个同步扩展功能服务，由同步拓展服务实现中转，即拓展服务先使用平台同步接口拉取数据，处理后调用“监执问”同步接口推送给各业务系统。

二、数据同步功能配置项说明

1、配置界面

2、组织（账号）同步模式

①未启用：组织（账号）同步模块功能未开启。

②仅同步：仅开启同步功能，即只能由平台向业务系统推送数据。

③仅映射：仅开启映射功能，即由业务系统方提供业务系统的组织（账号）数据查询接口，由用户在映射功能页面手动勾选平台数据和业务系统数据进行映射关联。

④映射及同步：映射功能和同步功能都可使用，第一次使用即初始化时，必须先完成数据映射，再进行数据同步。（即当业务系统本身存在一套组织架构已经账号数据时，可以使用映射功能将其与平台的数据映射关联起来；若需要业务系统没有但平台有的数据时，则使用同步功能推送到业务系统）

3、组织/账号自动同步模式

自动同步指的是平台的组织（账号）数据有变动时，自动对开启该模式的业务系统进行推送，无需到同步模块再手动推送。

①未启用：不开启组织（账号）的自动同步功能。

②仅已同步项：仅已经完成同步的数据发生改动时才进行自动推送。

③已映射及已同步项：已经完成映射或者同步的数据发生改动时自动推送。

④配置范围内(除已映射项)：在配置范围内的除了通过映射关联的数据发生改变时自动推送。

⑤配置范围内(包含已映射项)：在配置范围内的包含通过映射关联的数据发生改变时自动推送。

注：④、⑤模式下，只要在配置范围内，新增的数据也会自动推送。

5、映射处理模式

①通用：针对泰山平台映射功能开发的映射接口。

②通用（加密）：兼容“监执问”的映射接口。

6、使用的同步系统

数据同步推送数据时使用的系统模式。

①默认：使用平台的同步接口的业务系统选择该模式。

②兼容：使用“监执问”同步接口的业务系统选择该模式。

7、根节点绑定和同步范围配置

该项配置决定可以同步的组织架构的范围，左侧的组织架构树可以预览该范围包含的组织机构。人员账号的范围由组织架构范围决定。

①根节点绑定：选择一个平台的机构作为同步范围的根节点（起始）。如有需要须提供业务系统的根节点与选定的平台根节点进行绑定（涉及映射和使用”监执问“同步接口时必须绑定），如无需要则只需要选定平台根节点即可。

②组织同步层级范围：即根据选定的根节点开始，往下其多少层的子节点包括在同步范围。

③组织同步类型范围：仅机构-选择该模式时同步范围将不包含部门；机构和部门-选择该模式将包含机构和部门。

例：

根机构A
	一级机构A1
		部门A1-1
		部门A1-2
	一级机构A2
		部门A2-1
		部门A2-2
	一级机构A3
		部门A3-1
		部门A3-2
		二级机构A3B
			部门A3B-1
		二级机构A3C
			部门A3C-1
			部门A3C-2
		
		
			
假如存在如上组织架构，同步范围选择“根机构A”为根节点，选择“组织同步层级”为“1”，同步范围为：
根机构A
	一级机构A1
		部门A1-1
		部门A1-2
	一级机构A2
		部门A2-1
		部门A2-2
	一级机构A3
		部门A3-1
		部门A3-2

若选择“组织同步层级”为“2”，同步范围为：
根机构A
	一级机构A1
		部门A1-1
		部门A1-2
	一级机构A2
		部门A2-1
		部门A2-2
	一级机构A3
		部门A3-1
		部门A3-2
		二级机构A3B
			部门A3B-1
		二级机构A3C
			部门A3C-1
			部门A3C-2

8、业务系统映射接口

该接口由对接平台的业务系统方提供，用于查询业务系统的相关数据。当同步模式选择“仅映射”和“映射及同步”时，该项必填。

①组织机构映射接口：由业务系统方提供，查询业务系统的组织数据，用于与平台组织架构映射关联。

②人员账号映射接口：由业务系统方提供，查询业务系统的账号数据，用于与平台人员账号映射关联。

9、同步数据包含的字段配置

推送的同步数据所包含的字段信息。

①机构传输数据项

id,orgCname,orgShortCname,orgCode,purpose,deptType,organType,validFlag,organOrder,isParent,parentOrgId,validDate,mappingOrgId,mappingOrgCode,mappingOrgName,mappingParentOrgId,optType

注：使用“兼容”模式时必须包含“mappingOrgId,,mappingParentOrgId,optType”。

②账号传输数据项

innerCode,orgId,orgCode,orgName,deptId,deptCode,deptName,userEname,userCname,leaderFlag,userCode,secretType,rankCode,rankName,dutyCode,dutyName,userTypeCode,userTypeName,sexCode,sexName,cdTypeCode,cdTypeName,cdNum,userEmail,telephone,mobilePhone,personOrder,validFlag,mappingOrgId

注：使用“兼容”模式时必须包含“mappingOrgId,,mappingParentOrgId,optType”。

三、数据推送

1、组织数据推送页面

（1）推送方式

①仅推送已勾选节点：只推送左侧树上被勾选的节点数据。

②所有节点：推送配置的同步范围内所有组织数据。

③推送已绑定的节点：推送所有已经完成映射或同步的节点。

注：以上三种推送方式可推送的数据，具体还需要看以下三个配置。

（2）是否包含已同步节点

若决定要推送的数据中包含有已经完成同步的，想要重新推送则需要选择“是”，不想重新推送则选择“否”。

（3）是否包含已映射节点

若决定要推送的数据中包含有已经完成映射的，想要重新推送则需要选择“是”，不想重新推送则选择“否”。

（4）是否包含根节点

根节点为左侧树显示的最高级节点，想要推送则需要选择“是”，不想推送则选择“否”。

（5）推送应用

仅查询与当前应用所配置同步范围完全相同的应用，即根节点相同，组织同步层级范围，组织同步类型相同的应用。

选择其他应用后，推送给当前应用的数据同时也会给已选择的其他应用。

2、账号数据推送页面

（1）推送方式

①仅推送列表勾选的账号：只推送在列表上勾选的数据。

②推送已勾选树节点下的账号：左侧树是组织架构树，若选择该模式，则推送当前勾选树节点（部门）下的全部账号。

③所有节点：推送配置的同步范围内所有部门下的账号。

④推送已绑定的节点：推送所有已经完成映射或同步的账号。

注：以上四种推送方式可推送的数据，具体还需要看以下三个配置。

（2）是否包含已同步账号

若决定要推送的数据中包含有已经完成同步的，想要重新推送则需要选择“是”，不想重新推送则选择“否”。

（3）是否包含已映射账号

若决定要推送的数据中包含有已经完成映射的，想要重新推送则需要选择“是”，不想重新推送则选择“否”。

（4）是否包含三员账号

若决定要推送的数据中包含三员账号，想要推送则需要选择“是”，不想推送则选择“否”。如果“推送应用”选择了其他应用，不会将该应用的三员推送给其他应用。

（5）推送应用

仅查询与当前应用所配置同步范围完全相同的应用，即根节点相同，组织同步层级范围，组织同步类型相同的应用。

选择其他应用后，推送给当前应用的数据同时也会给已选择的其他应用。

四、初始化同步

组织映射、组织同步、账号映射、账号同步是存在先后顺序的，初次开启同步功能的业务系统需要完成初始化同步，即按规定流程完成映射、同步初始化。

具体流程取决于所选择的同步模式，根据所选择的组织（账号）同步模式会自动生成同步流程，该流程可以在“同步管理”-“同步进度”查看。

1、初始化流程示例图

2、初始化操作具体说明

按照流程图完成前置配置后，进行初始数据推送，当初始数据全部同步成功后，可以通过按钮“标记初始化同步完成”来标记当前步骤初始化完成，进入下一步骤。需要注意，当组织和账号都开启同步功能时，必须先完成组织的初始化同步，账号才能进行数据推送，若组织的初始化同步未完成，无法进行账号推送。

注：初始化阶段推送的数据量，全部推送还是仅推送一条，根据需求由用户自己决定，推送后将该推送数据“置为无效”后，也可以通过按钮“标记初始化同步完成”来标记当前步骤初始化完成。

五、数据同步状态监控

1、组织同步状态监控

（1）“组织同步”功能主页面

（2）页面功能按钮说明

“1”：选择当前查看的业务系统。

“2”：当前同步数据的各项状态

①数据编码：调用接口dataSyncRequest（获取同步数据编码）获取到的数据编码。

②取用状态：该同步数据的数据编码是否被取用，即业务系统是否调用dataSyncRequest接口获取编码，若未获取则状态为“未取用”，若已获取则状态为“已取用”。

③反馈状态：若调用接口querySyncDataInfo（获取同步数据）后，该状态为“未反馈”，之后再调用接口feedbackRequest（反馈同步情况）后会根据反馈情况显示状态为“反馈成功”或“反馈失败”。

“3”：列表操作项

①同步记录：可查看该数据的历次同步记录。

②置为无效：可将该数据的本次推送置为无效，置为无效后业务系统无需对本次推送进行处理。

“4”：树节点操作项

①查看状态：会打开一个新页面展示该组织已经有哪些应用映射或同步。

②查看记录：打开该组织的历次同步记录页面。

③撤销同步：撤销该组织对当前应用的同步，即对当前应用重新推送该组织，推送状态为“删除”。

2、账号同步状态监控

（1）“账号同步”功能主页面

（2）页面功能按钮说明

“1”：选择当前查看的业务系统。

“2”：当前同步数据的各项状态

①数据编码：调用接口dataSyncRequest（获取同步数据编码）获取到的数据编码。

②取用状态：该同步数据的数据编码是否被取用，即业务系统是否调用dataSyncRequest接口获取编码，若未获取则状态为“未取用”，若已获取则状态为“已取用”。

③反馈状态：若调用接口querySyncDataInfo（获取同步数据）后，该状态为“未反馈”，之后再调用接口feedbackRequest（反馈同步情况）后会根据反馈情况显示状态为“反馈成功”或“反馈失败”。

“3”：列表操作项

①同步记录：可查看该数据的历次同步记录。

②置为无效：可将该数据的本次推送置为无效，置为无效后业务系统无需对本次推送进行处理。

六、同步扩展服务（使用“兼容”模式时必看）

同步扩展服务实现兼容“监执问”接口的中转功能，即由同步扩展服务：“调用平台同步接口拉取数据”——“处理数据”——“调用‘监执问’接口推送数据”——“收到‘监执问’接口响应数据”

1、应用接口管理页面

使用”兼容“模式的业务系统需要在此处录入业务系统的组织（账号）数据同步接口地址。

①应用名称、应用编码和应用密钥可以从平台的“认证管理”处获取。

②接口地址：业务系统的同步接口完整地址。

③平台接口服务IP：平台服务的IP和端口。

2、组织同步、账号同步、同步数据

这三个模块总体功能一致，都是查看同步记录的，可以查看各条数据的同步情况，及调用各个接口的响应情况。

3、请求记录

该页面可查看所有接口请求记录，详细页面可以查看请求的参数和响应值。

4、执行同步、断点续同步

（1）执行同步

选择业务系统，点击”执行同步“按钮，会主动拉取该业务系统的同步数据开始进行同步。如果业务系统使用的模式为“兼容”，在平台推送数据时会自动触发同步扩展服务，无需主动点击”执行同步“。

（2）断点续同步

如果同步过程中某条数据出现异常会导致同步流程中断，需要定位到异常数据做相应处理，处理完成后，复制该数据的”数据编码“使用”断点续同步“功能，即可从该数据开始继续同步流程。

5、同步扩展服务地址配置（重要）

如果要使用同步拓展服务，需要在泰山平台的“系统管理”——“配置管理”——”后台配置“里配置同步拓展服务的地址，以便推送数据时自动触发同步拓展服务的功能。

配置方式如图所示，配置编码必须按图中所示填写。