信息系统数据交换信息规范模板.docx

信息系统数据交换信息规范模板.docx

《信息系统数据交换信息规范模板.docx》由会员分享，可在线阅读，更多相关《信息系统数据交换信息规范模板.docx（13页珍藏版）》请在冰豆网上搜索。

信息系统数据交换信息规范模板

信息系统数据交换信息规范

（模板）

目次

范围

本标准规定了XXXX集团信息系统之间进行数据交换时采用的信息规范。

本标准适用于XXXX集团信息系统之间进行数据交换。

1规范性引用文件

下列文件对于本文件的应用是必不可少的。

凡是注日期的引用文件，仅注日期的版本适用于本文件。

凡是不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。

GB18030-2005信息技术中文编码字符集

XXXX-2018应用系统基础公共数据标准体系_第4部分

2术语与定义

下列术语与定义适用于本文件。

2.1数据交换dataexchange

数据交换是一个或多个计算机软件系统之间传递数据的过程。

本标准中的数据交换是指通过中间文件实现的一种交换方式，由数据选择、编码、传输、解码、集成等环节构成。

2.2数据交换文件dataexchangefile

用来在两个系统之间传递数据的中间文件，本标准中的数据交换文件采用XML进行描述，数据交换文件的扩展名为.xml。

数据交换文件包含不仅限于XML格式文件、JSON格式文件。

2.3XML文件XMLfile

按XML语法组织的数据文件

2.4JSON文件JSONfile

按JSON语法组织的数据文件。

2.5元素element

元素是XML文件（或JSON文件）内容的基本单元。

2.6实体entity

任何具体的或抽象的事物，包括事物间的联系。

在不同的系统中，实体可能有不同的叫法，如“表”、“类”等。

实体与这些术语是等价的、通用的。

3数据交换文件

3.1数据交换文件的定义规则

定义规则为：

a）数据交换文件必须有一个唯一的根元素；

b）文件中元素名称中字母的大小写敏感。

3.2数据交换文件的基本要素

基本要素为：

a）数据集：

定义要交换的数据；

b）操作信息：

定义交换的数据到达目标系统进行的操作信息；

c）环境信息：

定义交换的数据的来源系统、目标系统等环境信息；

d）应答信息：

定义交换的数据到达目标系统操作后的反馈信息；

e）参数信息：

定义交换的参数信息。

3.3约定

约定如下：

a）所有的示例都以片段的形式给出。

b）“XML示例”用来说明所定义的类型或元素如何在XML文件中实例化，示例中的语法符合XML规定。

3.4字符集

交换文件是文本文件，采用GB18030-2005规定的文件中字符。

3.5根元素

一个数据交换文件必须有且仅有一个根元素，数据交换文件的根元素定义为DEM。

根元素DEM下有五个子元素，分别表示数据集、操作信息、环境信息、应答信息、参数信息五部分。

其中：

a）数据集用元素DataSet定义，可选。

b）操作信息用元素OperInfo定义，可选。

c）环境信息用元素EnviInfo定义，可选。

d）应答信息用元素RespInfo定义，可选。

e）参数信息用元素ParaInfo定义，可选。

下面是一个根元素的XML示例：

—根元素-->

—环境信息元素-->

—操作信息元素-->

—数据集元素-->

—应答信息元素-->

—参数信息元素-->

4数据集的定义

4.1数据集

数据集是数据交换的主要内容，以实例、属性值为基本单位进行描述。

数据集的构成见图1。

数据集由元素DataSet定义，一个数据集中包含多个实例集。

一个实例集中包含多个实例，一个实例集下的实例可以来自同一个相同的实体，也可以来自多个来不同的实体。

建议将一个实体下的所有要交换的实例表示成一个实例集，这样有利于数据交换程序的实现，数据的组织也比较整齐。

图1：

通用数据集的构成

一个数据集元素有以下子元素：

a）name:

可选。

数据集名称；

b）description:

可选。

数据集描述性说明；

c）objs:

可选。

实例集。

一个实例集定义了0个或或0个以上实体的实例。

一个数据集有一个或多个实例集。

由于数据集中可能包含数量庞大的实例，为节省数据空间，实例集、实例采用了非常简洁的缩写，分别用objs、obj，属性值元素直接采用应用系统基础公共数据标准体系_第4部分的元数据字典的缩写名。

4.2实例集

一个实例集定义了0个或多个实例，这些实例可以来自同一个实体，也可以来自多个不同的实体。

一个数据集有0个或多个实例集。

实例集用元素objs定义，objs有两个属性：

a）entity：

可选。

用于指定实例集中的实例所属的实体名称。

实体名称用大写：

1）当一个实例集中的实例都来自一个实体时，实例集的属性entity用于定义实例集对应的实体名。

如果实例集元素objs指定了entity属性值，其子元素obj的entity属性可以省略，每一个obj定义的实例所属实体均由entity指定；

2）当实例集中的实例来自多个不同的实体时，实例集objs的属性entity应为空，其子元素obj的entity属性不能为空，用于指定每一个实例所属实体。

b）name:

可选。

用于指定实例集的名字。

实例集的名字与源数据库可以没有任何关系，是为了标识实例集而取的，应该是一个便于理解的名称，特别是当实例集中有多个实体时，name可标识实例集的含义，如“省投资集团员工基本信息”。

4.3实例

一个实例集体由多个实例组成，一个实例包括多个属性值。

在关系型数据库中，一个实体对应一个关系表，一个实例对应一个数据行或数据记录，属性对应表中的字段或列。

实例用元素obj表示,obj是实例集元素objs的子元素。

obj有一个可选属性entity，用于指定实例所属的实体名称。

实体名称中的英文字母用大写。

当一个obj的父元素objs的属性entity不为空时，这时obj的entity属性可以省略，或与objs的entity值相同，实例集中的实例都来自一个实体。

当一个obj的父元素objs的属性entity为空时,表示实例集中的实例来自多个不同的实体，obj的entity属性不能为空，用于指定每一个实例所属实体。

同一个objs下的各obj可以指定不同的entity属性值。

一个实例有0个或多个属性值，属性值元素采用应用系统基础公共数据标准体系_第4部分的元数据字典的缩写名。

4.4属性值

一个实例有0个或多个属性值。

属性值元素只能作为实例元素obj的子元素出现。

属性值元素采用应用系统基础公共数据标准体系_第4部分的元数据字典的缩写名。

下面是一个数据集的XML示例：

人员基本信息和最高学历信息集

人员基本信息和最高学历信息集

PersonnelBasicInformation

员工基本信息

1001

张三

1002

李四

BusinessProjectBasicInformation

学历信息

1001

本科

计算机专业

5操作信息的定义

操作信息定义交换的数据到达目标系统进行的操作信息。

操作信息用元素OperInfo定义，有1个子元素：

OperType表示数据交换文件的到达目标系统进行的操作类型代码，如：

增加操作为A、删除操作为D、修改操作为U、查询操作为S。

详见附件C（规范性附录）数据交换文件操作类型。

下面是一个数据集的XML示例：

—操作信息元素-->

A

—增加操作-->

6环境信息的定义

6.1环境信息概述

环境信息定义交换的数据的来源系统、目标系统、创建者等相关环境。

环境信息由元素EnviInfo定义。

环境信息元素EnviInfo有四个子元素：

DataSource表示数据交换文件的数据来源信息,DataTarget表示数据交换文件的数据目标信息，Creator表示数据交换文件的的创建者信息。

6.2数据来源信息

数据来源信息用于描述数据交换文件来源的情况。

包括数据源的名称、数据源的服务器、数据源类型。

数据源由EnviInfo的子元素dataSource定义，dataSource下有3个子元素：

a）name：

可选。

数据源名称；

b）server：

可选。

数据库服务器名称或IP地址。

Server用于确认数据的准确来源；

c）sourceType：

可选。

数据源类型。

数据源为数据库时sourceType给出数据库产品名称，如SQLServer、Oracle等；对非数据库，数据源可能来自数据文件或某个应用软件，sourceType给出数据格式或应用软件名称，如XML、XSL、TXT、ArceGis等。

6.3数据目标信息

数据目标信息用于描述数据交换文件目标的情况。

包括目标系统名称、目标服务器、目标数据类型描述。

数据源由EnviInfo的子元素DataTarget定义，DataTarget下有3个子元素：

a）name：

可选。

目标系统名称；

b）server：

可选。

目标系统服务器名称或IP地址；

c）targetType：

可选。

目标系统数据类型。

目标系统数据为数据库时targetType给出数据库产品名称，如SQLServer、Oracle等；对非数据库，目标系统数据可能生成数据文件或某个应用软件，targetType给出数据格式或某个应用软件，如XML、XSL、TXT等。

6.4创建者信息

数据交换文件的的创建者信息由EnviInfo的子元素creator描述，有三个属性：

a）name:

可选。

创建者的名称，可以是姓名，也可以是系统的帐号；

b）uint:

可选。

表示创建者所属单位；

c）description:

可选。

用于对创建者、交换文件进行描述。

人力资源系统

192.168.138.8

Oracle

法务管理信息系统

192.168.138.18

SQLServer

张三

安徽省投资集团有限公司

人员基本信息数据交换

7应答信息的定义

应答信息定义交换的数据到达目标系统操作后反馈信息。

应答信息用元素RespInfo定义。

操作信息由元素RespInfo有2个子元素：

CompFlag表示数据交换文件的到达目标系统进行操作后的标志信息，如：

1表示成功，2表示失败；ErroMess表示数据交换文件的到达目标系统进行操作出现错误的错误信息。

2

最高学历信息中缺少人员代码

8参数信息的定义

参数信息定义数据交换的参数。

参数信息用元素ParaInfo定义。

参数信息由元素ParaInfo有2个子元素：

ParaNumb表示数据交换中的参数数量；Para表示数据交换中的参数实例。

一个参数实例有0个或多个属性值，具体属性元素采应用系统基础公共数据标准体系_第4部分的元数据字典的缩写名。

2

张

男

附录A

（资料性附录）

A

人力资源系统

192.168.138.8

Oracle

法务管理信息系统

192.168.138.18

SQLServer

张三

XXXX公司

人员基本信息数据交换

人员基本信息和最高学历信息集

人员基本信息和最高学历信息集

PersonnelBasicInformation

员工基本信息

1001

张三

BusinessProjectBasicInformation

学历信息

1001

本科

员工基本信息数据交换文件-XML文件

附录B

（资料性附录）

员工基本信息数据交换文件-JOSN文件

{

"DEM":

{

"OperInfo":

{"OperType":

"A"},

EnviInfo":

{

"DataSource"":

{

"name":

"人力资源系统",

"server":

"192.168.138.8",

"sourceType":

"Oracle"

},

"DataTarget":

{

"name":

"法务管理信息系统",

"server":

"192.168.138.18",

"description":

"SQLServer"

},

"creator":

{

"name":

"张三",

"uint":

"XXXX公司",

"description":

"人员基本信息数据交换"

}

},

"DataSet":

{

"name":

"人员基本信息和最高学历信息集",

"description":

"人员基本信息和最高学历信息集",

"objs":

[

{

"entity":

"PersonnelBasicInformation",

"name":

"员工基本信息",

"obj":

{

"personnelCode":

"1001",

"name":

"张三"

}

},

{

"entity":

"BusinessProjectBasicInformation",

"name":

"学历信息",

"obj":

{

"personnelCode":

"1001",

"highestDegree":

"本科"

}

}

]

}

}

}

附录C

（规范性附录）

表C1数据交换文件操作类型

代码

名称

A

增加

D

删除

U

修改

S

查询

表C2数据交换反馈标志代码

代码

名称

1

成功

2

失败