1、ICS 35.080CCS L 77DB4403深圳市地方标准DB4403/T 384.52023代替 SZDB/Z 6.22007基础教育管理信息化技术规范第 5 部分:数据交换Technical specifications forbasic education management informatizationPart 5:Data exchange2023-11-15发布2023-12-01 实施深圳市市场监督管理局发 布DB4403/T 384.52023I目 次前言.I引言.III1范围.12规范性引用文件.13术语和定义.14缩略语.15数据共享交换基本要求.16数据共享交换方
2、式.26.1基于数据库的交换方式.26.2基于文件的交换方式.26.3基于服务接口的交换方式.37共享平台接入方式.47.1接入流程.47.2接口说明.47.3消息确认模式.4附录 A(资料性)数据交换接口参数.6附录 B(资料性)错误码信息.15附录 C(资料性)消息体格式.16参考文献.18DB4403/T 384.52023II前 言本文件按照 GB/T 1.12020标准化工作导则第 1 部分:标准化文件的结构和起草规则的规定起草。本文件是 DB4403/T 3842023基础教育管理信息化技术规范的第 5 部分。DB4403/T 3842023已经发布了以下部分:第 1 部分:数据结
3、构;第 2 部分:数据代码;第 3 部分:教育大数据统计分析;第 4 部分:教育用户数据;第 5 部分:数据交换。本文件代替 SZDB/Z 6.22007深圳市基础教育管理信息化技术规范第二部分:数据交换,与SZDB/Z 6.22007 相比,对结构和内容都进行了调整。主要技术变化如下:a)增加了“数据共享交换基本要求”(见第 4 章);b)增加了“数据共享交换方式”(见第 5 章);c)增加了“共享平台接入方式”(见第 6 章);d)增加了“数据交换接口参数”(见附录 A);e)增加了“错误码信息”(见附录 B);f)增加了“消息体格式”(见附录 C);g)删除了“组成要素”(见 2007
4、年版第 3 章)。本文件由深圳市教育局提出并归口。本文件起草单位:深圳市教育信息技术中心、华中师范大学、深圳市福田区教育局。本文件主要起草人:张惠敏、梁为、吴砥、黄伟龙、戴俊雄、吴晨、曾艳锋、林雪芳、张涛、徐建、陈梦、易韵涵、刘韦司、马继满。本文件及其所代替文件的历次版本发布情况为:2007 年首次发布为 SZDB/Z 6.22007;本次为第一次修订。DB4403/T 384.52023III引 言2007 年发布的 SZDB/Z 62007深圳市基础教育管理信息化技术规范有效提升了深圳市教育管理信息化建设水平,极大促进了深圳市各级各类信息化教育平台数据的互联互通。随着教育信息化应用场景的不
5、断拓展和平台数据的不断丰富,且随着 2017 年 GB/T 352982017信息技术学习、教育和培训教育管理基础信息、GB/T 337822017信息技术学习、教育和培训教育管理基础代码等国家标准的发布,对深圳市基础教育管理信息化技术规范的更新和修订提出了需要。为提高标准的适用性和准确性,以便更好服务于大数据时代深圳市教育管理信息化建设,起草组围绕深圳市教育大数据治理工作需要,对深圳市基础教育管理信息化技术规范的系列标准内容进行了内容修订,拟由五个部分构成:第 1 部分:数据结构。目的在于规范基础教育管理信息的分类信息和数据集;第 2 部分:数据代码。目的在于规范学校管理、学生管理、教学管理
6、和教职工管理等类型数据的标识码格式、代码集等内容;第 3 部分:教育大数据统计分析。目的在于规范教育大数据统计分析指标;第 4 部分:教育用户数据。目的在于规范教育用户身份认证数据、用户角色数据和用户接口数据;第 5 部分:数据交换。目的在于规范教育管理数据共享交换基本要求、交换方式及共享平台接入方式。DB4403/T 384.520231基础教育管理信息化技术规范第 5 部分:数据交换1范围本文件规定了教育管理数据共享交换基本要求、交换方式及共享平台接入方式。本文件适用于深圳市教育管理信息化建设工作。2规范性引用文件本文件没有规范性引用文件。3术语和定义下列术语和定义适用于本文件。3.1数据
7、交换data interchange为满足不同平台或应用间数据资源的传送和处理需要,依据一定的原则,采取相应的技术,实现不同平台和应用间数据资源流动过程。来源:GB/T 352742017,3.114缩略语下列缩略语适用于本文件。HTTP:超文本传输协议(Hypertext Transfer Protocol)HTTPS:超文本传输安全协议(Hypertext Transfer Protocol Secure)URL:统一资源定位器(Uniform Resource Locator)XML:可扩展置标语言(Extensible Markup Language)JSON:JavaScript 对
8、象表示法(JavaScript Object Notation)5数据共享交换基本要求5.1数据共享交换遵循“数据驱动、应用牵引、协同共进”的原则。5.2数据共享交换参与方主要包括:数据提供方、数据需求方和平台管理方。以下为各数据共享交换参与方的主要职责:数据提供方应保障所提供教育数据的完整性、准确性、时效性和可用性;DB4403/T 384.520232数据需求方应按照数据申请流程获取数据,按照共享范围使用数据;平台管理方应负责数据对接/共享平台的运行维护和数据资源的归集、更新和发布。6数据共享交换方式6.1基于数据库的交换方式6.1.1结构说明基于数据库的交换方式结构图见图 1。图 1基于
9、数据库的交换方式6.1.2适用场景基于数据库的数据交换方式适用于实时、周期性、大数据包、小数据包、结构化数据场景。6.1.3数据库接入参数基于数据库的接入参数见附录 A 中的 A.1。6.2基于文件的交换方式6.2.1结构说明基于文件的交换方式结构图见图 2。DB4403/T 384.520233图 2基于文件的交换方式6.2.2适用场景基于文件的交换方式适用于实时、周期性、大数据包、小数据包、结构化数据、非结构化数据、半结构化数据场景。6.2.3文件上传下载接口说明文件上传和下载接口协议使用 HTTP(HTTPS)协议,通过提供访问的 URL,用户使用 HTTP POST 方法发送请求。文件
10、上传下载接口参数见附录 A 中的 A.2。6.3基于服务接口的交换方式6.3.1服务接口结构说明基于服务接口的数据交换方式见图 3。图 3基于服务接口的交换方式DB4403/T 384.5202346.3.2适用场景基于服务接口的交换方式适用周期性、小数据包、结构化数据、非结构化数据、半结构化数据场景。6.3.3服务接口请求对象参数服务接口请求对象参数见附录 A 中的 A.3。7共享平台接入方式7.1接入流程共享平台的接入流程主要包含以下四个步骤:a)第三方应用在共享平台注册,并由平台管理方审核:1)通过审核可接入交换平台;2)审核未通过不应接入交换平台。b)第三方应用注册并审核通过以后,调用
11、初始化接口进行数据初始化;c)第三方应用调用共享平台数据开放接口进行数据同步;d)当应用在共享平台删除时,清除其接入权限。7.2接口说明7.2.1接口均需连接共享平台校验 token,客户端在调用接口之前需先向共享平台申请 token。7.2.2接口返回的校验信息包含错误码和错误信息,默认为 xml 格式。7.2.3错误码信息见附录 B。7.3消息确认模式7.3.1概述6.3.1.1消息确认模式包括同步响应、异步回调和轮询三种模式。6.3.1.2消息体格式见附录 C。7.3.2同步响应模式接收方收到消息后,通过发送方发送消息的消息传送连接(如 HTTP 连接)向发送方发送对该消息的确认消息。7
12、.3.3异步回调模式接收方收到消息后,建立一个消息传送连接,并通过该连接向发送方发送对该消息的确认消息。7.3.4轮询模式轮询模式可分为:a)同步轮询模式:发送方在向接收方发送一定数目的消息后,对其发送的所有消息发送一个确认请求消息给接收方。接收方接收到这个确认请求后,查询已经收到的消息,查找其中是否有满足确认请求消息中包括的 ID 值的消息,并在这个确认请求消息所在的连接上,返回查询的确认结果;b)异步轮询模式:发送方在向接收方发送一定数目的消息后,对其发送的所有消息提出一个确认请求消息。接收方接收到这个确认请求后,轮询自己已经收到的消息,查找其中是否有满足确认请求消DB4403/T 384
13、.520235息中包括的 ID 值的消息,新建一个连接,将查询的结果发送给发送方。DB4403/T 384.520236附录A(资料性)数据交换接口参数A.1数据库接入规范A.1.1Mysql 数据库接入规范Mysql 数据库接入规范见表 A.1。表 A.1Mysql 数据库接入规范表接入参数说明是否必填数据源名称自定义是数据源描述自定义是数据库 IP数据库 IP 地址是JDBC 端口数据库端口是数据库名Mysql 数据库名称是用户名数据库账号,必须提供有读取数据表权限的账号是密码数据库密码是数据库表列表数据库表列表是数据库表结构数据库表列表是A.1.2ORACLE 数据库接入规范ORACLE
14、 数据库接入规范见表 A.2。表 A.2ORACLE 数据库接入规范表接入参数说明是否必填数据源名称自定义是数据源描述自定义是数据库 IP数据库 IP 地址是JDBC 端口数据库端口是是否集群如果是集群,提供信息为“是”,不是集群,提供信息为“否”是数据库名/SIDOracle 数据库名称是用户名数据库账号,必须提供有读取数据表权限的账号是密码数据库密码是数据库表列表数据库表列表是数据库表结构数据库表列表是A.1.3GBase8a 数据库接入规范GBase8a 数据库接入规范见表 A.3。DB4403/T 384.520237表 A.3GBase8a 数据库接入规范表接入参数说明是否必填数据源
15、名称自定义是数据源描述自定义是数据库 IP数据库 IP 地址是JDBC 端口数据库端口是是否集群如果是集群,提供信息为“是”,不是集群,提供信息为“否”是数据库名Gbase8a 数据库名称是用户名数据库账号,必须提供有读取数据表权限的账号是密码数据库密码是数据库表列表数据库表列表是数据库表结构数据库表列表是A.1.4SQLSERVER 数据库接入规范SQLSERVER 数据库接入规范见表 A.4。表 A.4SQLSERVER 数据库接入规范表接入参数说明是否必填数据源名称自定义是数据源描述自定义是数据库 IP数据库 IP 地址是JDBC 端口数据库端口是数据库名SQLSERVER 数据库名称是
16、用户名数据库账号,必须提供有读取数据表权限的账号是密码数据库密码是数据库表列表数据库表列表是数据库表结构数据库表列表是A.1.5LibrA 数据库接入规范LibrA 数据库接入规范见表 A.5。表 A.5LibrA 数据库接入规范表接入参数说明是否必填数据源名称自定义是数据源描述自定义是数据库 IP数据库 IP 地址是JDBC 端口数据库端口是是否集群如果是集群,提供信息为“是”,不是集群,提供信息为“否”是DB4403/T 384.520238表 A.5LibrA 数据库接入规范表(续)接入参数说明是否必填数据库名LibrA 数据库名称是用户名数据库账号,必须提供有读取数据表权限的账号是密码
17、数据库密码是数据库表列表数据库表列表是数据库表结构数据库表列表是A.1.6PostgreSQL 数据库接入规范PostgreSQL 数据库接入规范见表 A.6。表 A.6PostgreSQL 数据库接入规范表接入参数说明是否必填数据源名称自定义是数据源描述自定义是数据库 IP数据库 IP 地址是JDBC 端口数据库端口是数据库名PostgreSQL 数据库名称是用户名数据库账号,必须提供有读取数据表权限的账号是密码数据库密码是数据库表列表数据库表列表是数据库表结构数据库表列表是A.1.7Dameng 数据库接入规范Dameng 数据库接入规范见表 A.7。表 A.7Dameng 数据库接入规范
18、表接入参数说明是否必填数据源名称自定义是数据源描述自定义是数据库 IP数据库 IP 地址是JDBC 端口数据库端口是数据库名Dameng 数据库名称是用户名数据库账号,必须提供有读取数据表权限的账号是密码数据库密码是数据库表列表数据库表列表是数据库表结构数据库表列表是DB4403/T 384.520239A.1.8DB2 数据库接入规范DB2 数据库接入规范见表 A.8。表 A.8DB2 数据库接入规范表接入参数说明是否必填数据源名称自定义是数据源描述自定义是数据库 IP数据库 IP 地址是JDBC 端口数据库端口是数据库名DB2 数据库名称是用户名数据库账号,必须提供有读取数据表权限的账号是
19、密码数据库密码是数据库表列表数据库表列表是数据库表结构数据库表列表是A.1.9GP 数据库接入规范GP 数据库接入规范见表 A.9。表 A.9GP 数据库接入规范表接入参数说明是否必填数据源名称自定义是数据源描述自定义是数据库 IP数据库 IP 地址是JDBC 端口数据库端口是数据库名GP 数据库名称是用户名数据库账号,必须提供有读取数据表权限的账号是密码数据库密码是数据库表列表数据库表列表是数据库表结构数据库表列表是A.1.10HDFS 数据库接入规范HDFS 数据库接入规范见表 A.10。表 A.10HDFS 数据库接入规范表接入参数说明是否必填数据源名称自定义是数据源描述自定义是Name
20、ServiceHDFS NameService是DB4403/T 384.5202310表 A.10HDFS 数据库接入规范表(续)接入参数说明是否必填NameNode 列表HDFS 的 NameNode 列表用逗号隔开是开启 Kerberos 认证如果是 Kerberos 认证,提供信息为“是”,不是 Kerberos 认证,提供信息为“否”是A.1.11Hbase11x 数据库接入规范Hbase11x 数据库接入规范见表 A.11。表 A.11Hbase11x 数据库接入规范表接入参数说明是否必填数据源名称自定义是数据源描述自定义是ZK 地址ZK 服务的 IP:port,如果是集群用逗号隔
21、开(Ip1:port1,IP2:port2)是A.1.12Hive 数据库接入规范Hive 数据库接入规范见表 A.12。表 A.12Hive 数据库接入规范表接入参数说明是否必填数据源名称自定义是数据源描述自定义是数据库 IP数据库 IP 地址是JDBC 端口数据库端口是MetaStore 端口MetaStore 端口是数据库名hive 数据库名称是用户名数据库账号,必须提供有读取数据表权限的账号是密码数据库密码是ZK 地址ZK 服务的 Ip:port,如果是集群用逗号隔开(Ip1:port1,Ip2:port2)是Hive 命名空间Hive 命名空间是配置文件目录Hive 配置文件目录是开
22、启 Kerberos 认证如果需要开启 Kerberos 认证,填写“是”;不需要开启 Kerberos认证,填写“否”是A.1.13Kafka 数据库接入规范DB4403/T 384.5202311Kafka 数据库接入规范见表 A.13。表 A.13Kafka 数据库接入规范表接入参数说明是否必填数据源名称自定义是数据源描述自定义是Kafka 地址Kafka 的 IP 和端口,集群用逗号隔开是开启 Kerberos 认证如果需要开启 Kerberos 认证,填写“是”;不需要开启 Kerberos认证,填写“否”是TopicKafka 的主题名称是主题数据Kafka 主题中的数据样例(注释
23、)是A.1.14RocketMQ 数据库接入规范RocketMQ 数据库接入规范见表 A.14。表 A.14RocketMQ 数据库接入规范表接入参数说明是否必填数据源名称自定义是数据源描述自定义是NameServerRocketMQ 的 NameNerver 地址是Topic主题名称是主题数据主题中的数据样例是A.1.15Rabbitmq 数据库接入规范Rabbitmq 数据库接入规范见表 A.15。表 A.15Rabbitmq 数据库接入规范表接入参数说明是否必填数据源名称自定义是数据源描述自定义是服务器地址Rabbitmq IP 地址是端口Rabbitmq 端口是用户名Rabbitmq
24、账号,必须提供有读取数据表权限的账号是密码Rabbitmq 密码是Queue 名称Rabbitmq 队列的名称是A.1.16Activemq 数据库接入规范Activemq 数据库接入规范见表 A.16。DB4403/T 384.5202312表 A.16Activemq 数据库接入规范表接入参数说明是否必填数据源名称自定义是数据源描述自定义是集群地址IP 地址是Topic主题名称是主题数据主题中的数据样例是A.1.17ES 数据库接入规范ES 数据库接入规范见表 A.17。表 A.17ES 数据库接入规范表接入参数说明是否必填数据源名称自定义是数据源描述自定义是ES 集群名ES 集群名是UR
25、LES IP:端口是TransportES 传输客户端 IP:端口否VersionES 的版本号是索引名称ES 索引名称是索引 TypeES 索引所使用的 Type是数据结构数据结构,带注释是A.1.18MongoDB 数据库接入规范MongoDB 数据库接入规范见表 A.18。表 A.18MongoDB 数据库接入规范表接入参数说明是否必填数据源名称自定义是数据源描述自定义是数据库 IP数据库 IP 地址是JDBC 端口数据库端口是数据库名MongoDB 数据库名称是用户名数据库账号,必须提供有读取数据表权限的账号是密码数据库密码是数据库表列表数据库表列表是数据库表结构数据库表列表是DB44
26、03/T 384.5202313A.2文件上传下载接口说明A.2.1文件上传接口参数见表 A.19。表 A.19文件上传接口参数表接口参数参数说明uploadPath文件上传路径fileName上传文件名称userName账户名称passWord账户密码A.2.2文件下载接口参数见表 A.20。表 A.20文件下载接口参数表接口参数参数说明targetFile文件下载路径userName账户名称passWord账户密码A.2.3服务端返回调用状态码见表 A.21。表 A.21服务端返回调用状态码表状态码状态说明200调用成功401鉴权异常:用户不存在、用户密码错误400参数为空417下载文件不
27、存在、上传时创建文件夹失败A.3服务接口请示对象参数A.3.1服务接口请求对象的 XML Schema 格式为:DB4403/T 384.5202314A.3.2服务接口请求对象的参数说明,见表 A.22。表 A.22服务接口请求对象参数表参数名称参数类型参数说明esb_service_idInteger访问服务标识,关联以下 8 个属性:senderCode:数据请求发送方机构代码senderName:数据请求发送方机构名称receiverCode:数据请求接收方机构代码receiverName:数据请求接收方机构名称esb_service_idIntegerresourceID:资源标识符
28、(业务编码)resourceName:资源名称(业务名称)userID:用户标识符userName:用户名称esb_tokenString认证令牌DB4403/T 384.5202315附录B(资料性)错误码信息错误码信息见表 B.1。表 B.1错误码信息表状态码状态说明200成功400未知的应用,即应用未注册401应用冲突402未激活队列403队列冲突,即重复激活404应用不能访问该区域的信息405从共享平台校验 token 失败,token 无效;或者过期500内部异常700其他未知错误DB4403/T 384.5202316附录C(资料性)消息体格式C.1XML 格式updateclas
29、scommon200000000100069990902admin20000000010000000022015-09-07T13:29:5211230611281124test1110200903DB4403/T 384.52023171000012015-07-20T16:29:50C.2JSON 格式action:update,code:classentity:Fields:BH:,BJDID:100001,BJID:2000000001000000002,BJKJKTSJ:,BJMC:test1,BJXH:,BZ:,CJNF:2009,CJSJ:2015-07-20T16:29:50,
30、CJZ:admin,DZYX:,JYSCBJ:0,SJ:,SSCSID:1124,SSGJID:1,SSNJ:06,SSQXID:1128,SSSFID:1123,SSXXID:2000000001000699909,SSYYMC:common,XD:03,XGSJ:2015-09-07T13:29:52,XGZ:,XZ:02DB4403/T 384.5202318参考文献1GB/T 352742017信息案例技术大数据服务安全能力要求2W3C XML Schema Definition Language(XSD)1.1 Part 1:StructuresEB/OL.(2012-04-05)2
31、022-01-14.https:/www.w3.org/TR/xmlschema11-1/3W3C XML Schema Definition Language(XSD)1.1 Part 2:DatatypesEB/OL.(2012-04-05)2022-01-14.https:/www.w3.org/TR/xmlschema11-2/4Extensible Markup Language(XML)EB/OL.(2016-10-11)2022-01-14.https:/www.w3.org/XML/5Namespaces in XML 1.0(Third Edition)EB/OL.(2009
32、-12-08)2022-01-14.https:/www.w3.org/TR/xml-names/6The SQL Standard ISO/IEC 9075:2016(ANSI X3.135)EB/OL.(2018-10-05)2022-01-14.https:/blog.ansi.org/2018/10/sql-standard-iso-iec-9075-2016-ansi-x3-135/?_ga=2.127778382.219009236.1642059063-2079891152.16420590637The application/json Media Type for JavaScript Object Notation(JSON)EB/OL.(2010-10-05)2022-01-14.http:/