数据导出发布服务概要设计说明书.docx

数据导出发布服务概要设计说明书.docx

《数据导出发布服务概要设计说明书.docx》由会员分享，可在线阅读，更多相关《数据导出发布服务概要设计说明书.docx（25页珍藏版）》请在冰豆网上搜索。

数据导出发布服务概要设计说明书

数据导出发布服务概要设计说明书

文件编号：

CVICSE/DZ0183/06-00

分册号：

04/19

页码：

28

密级：

A

山东省交通政务信息系统（二期）

概要设计说明书

数据中心卷

数据导出发布服务

山东省交通厅

山东中创软件工程股份有限公司

二ОО四年九月

文件变更记录

*A–增加M–修改D–删节

变更版本

日期

图表、表格、段落号

A/M/D

原因与修改情况描述

修订人

审核人

1引言

1.1编写目的

本阶段的主要任务是根据需求规格说明确定设计目标，以及它们的优先顺序，并根据目标确定最适合的设计方法，制定各种规范。

将系统按功能划分成模块的层次结构。

确定每个模块的功能，建立与已确定的软件需求的对应关系。

确定模块之间的调用关系，确定模块之间的接口，即模块之间传递的消息。

设计好接口的信息结构，评估模块划分的质量及导出模块结构的规则。

完成应用服务设计的数据的导出和发布的服务设计。

本说明书的编写目的是通过对本次软件开发的系统设计、约定及相关内容作出具体描述，说明对程序系统的设计考虑，包括其处理流程，组织结构、模块划分、功能分配、接口设计、运行设计、数据结构设计，为程序的详细设计奠定基础，也做为本项目开发人员、测试人员的指导性文件，作为他们工作的依据之一。

该概要分析说明书的预期读者主要有评审专家、交通厅领导、事业部分管领导、监理人员、项目组成员、QA人员、测试人员及其他相关人员等。

1.2背景

A、软件系统的名称：

数据的导出和发布服务，Ver1.00

B.开发的软件系统的最终用户或适用的领域：

本系统的最终用户为厅机关、厅直单位、17地市交通局。

1.3定义

办公人员：

由系统管理员指定的进行数据导出发布的人员。

导出功能：

从数据中心中选择要导出的数据，执行导出功能形成XML或XLS数据文件。

发布功能：

指选择需要的数据集，把需要在专网上公布的数据发布到专网上（对于发布到外网，由本系统导出的XML文件加上样式单由外网的发布系统发布）。

数据集的维护：

指办公人员对要导出的数据集新建、修改、删除操作。

参考资料

A.《需求分析说明书—数据中心平台及服务功能》

2系统设计

2.1需求规定

开发目标：

对数据中心需要对外发布的数据（如车船路统计等体现政务公开的分析经营决策性的数据，运营企业及人员的诚信数据，催收征交数据，尤其是针对发布比较大的数据文件）提供向外发布接口服务,另外。

应用目标：

实现数据中心对需要发布的数据发布的信息化。

具体包含三个方面的内容：

1、所需发布数据的导出

2、数据集的维护

3、数据的发布

2.2系统运行环境

参见总章。

2.3基本设计概念和处理流程

参见总章。

2.4系统模块结构

软件结构：

本系统的模块设计在考虑具体情况的前提下，分为三个模块来设计，如下图示：

数据的导发出布

数据的导出

数据的发布

数据集的维护

修改数据集

新建数据集

删除数据集

2.5功能需求与功能模块的关系

功能需求

设计功能模块

数据的导出功能

数据导出模块：

从数据中心导出需要发布的数据，形成XML数据文件或者根据需要导出XLS（EXCEL）数据表格文件

数据的发布功能

数据发布模块：

根据需要，新建或直接在数据集列表中选择数据集，把数据发布到专网上（对于发布到外网上，由本系统导出的XML文件加上样式单由外网发布系统发布到外网上）

数据集的维护

数据集维护模块：

实现对现有的数据集进行新建、修改、删除等功能。

2.6人工处理过程

在数据的导出的时候，如果是要发布到外网上而导出的XML数据文件，需要手动把XML数据文件放到“处室业务的发布系统”进行发布。

此操作实现了数据中心和外网的物理隔离。

3系统部署结构

结构图如下：

数据的导出发布服务

Dept子目录（放置本系统jsp文件）

Common子目录（放置本系统内公用功能的文件）

Resource子目录（放置本系统用到的资源文件，如图片等）

本系统部署根目录为zwyy/2q_deptapp/sjzx/dcfb

类文件部署根目录

类文件部署根目录为zwyy/WEB-INF/classes/jtzw2q

Dept/dcfb子目录（放置本系统独自用到的类文件）

Global子目录（放置和其他系统公用的类文件）

4系统功能设计

系统功能概述：

数据的导出和发布服务功能是对数据中心需要公开发布的数据提供的一项功能

可以实现对数据中心数据的导出（导成XML文件或XLS文件）、发布和数据集维护的功能。

系统功能图如下：

4.1数据的导出

功能概述：

由办公人员从数据中心中导出需要数据（如：

要发布的信息量很大的数据文件的时候，手工的打出很麻烦，甚至不可能），形成xml文件数据（要发布的文件）或者形成xls（EXCEL）表格文件。

输入：

要保存文件的名称、要保存文件的路径

录入项

可空

限制（录入方式直接录入还是选择录入还是系统自动生成？

）

要保存文件名称

否

手工录入

要保存的路径

否

选择录入

处理:

办公人员进入数据导出界面，选择数据集和要导出的文件类型（XML文件或XLS文件），点击“导出某某文件”，系统显示导出的“文件名称”和“导出操作”，点击“导出”，执行导出，系统提示“保存”或“打开”操作，点“保存”，系统提示选择保存位置和名称，并执行导出，点打开，则系统执行打开操作。

时序图:

协作图:

重要场景说明：

1、进入界面：

办公人员登录系统后，进入数据导出界面。

2、显示数据集信息：

进入数据导出界面后，系统会显示数据集信息，以利于办公人员选择要导出的数据集。

3、选数据集并点导出操作：

办公人员根据需要选择要导出的数据集和导出类型，然后点击数据集后面的“导出XML”或“导出EXCEL”操作。

4、提示输入信息：

办公人员点击“导出”操作后，系统会显示导出的文件名称和导出操作信息。

6、点击确定

办公人员点击“导出”系统会提示选择导出路径，如要修改名称，则输入新名称，并导出数据XML文件。

8、执行导出：

指系统执行导出操作。

9、回导出完毕与否

系统提示导出完毕信息。

输出：

显示保存结果信息：

信息保存成功（导出XML数据文件或者XLS文件）；信息保存失败。

数据表操作:

只读表：

数据集执行的所有表、数据集表（tdatalist）

4.2数据集的维护

4.2.1更新数据集

功能概述：

办公人员要对现有的数据集进行修改，预览修改结果，再根据预览结果，进行修改、预览反复，然后保存修改。

输入：

维护人员登录进入到更新数据目录的页面，选择要更新的数据目录，更新源数据表，更新源数据字段，更新查询条件参数、更新生成数据目录的sql检索条件，执行预览，查看检索的数据集是否正确，如不正确，可以再次修改，修改完成后，保存数据目录，系统将数据目录名称、源数据表、源数据字段、SQL检索语句存入数据库内。

通过删除功能可以删除数据目录

更新的数据目录信息：

录入项

可空

限制

数据集名称

否

数据集的具体名称。

源数据表名称

否

构成数据集的源数据表，从表目录中选择。

源数据表别名

否

源数据表的别名

源字段名称

否

构成数据集的源字段，从字段目录中选择。

字段内容描述

否

用于说明字段内容。

字段公式

否

输入字段运算公式。

字段显示顺序

否

输入字段显示顺序

查询条件

可

输入生成数据集的查询条件

查询条件参数

可

输入查询条件中用到的参数

系统处理过程：

判断必输数据是否都已录入内容，如果都已录入，则保存输入数据到数据库中，并反馈保存结果给当前操作员。

时序图:

协作图:

输出：

显示修改结果信息：

信息修改成功；信息修改失败。

数据表操作：

可写表：

数据目录表、数据目录数据源表、数据目录字段表、数据目录条件表、数据目录查询参数表。

只读表：

主题目录表、表目录表、字段目录表。

4.2.2新建数据集

功能概述：

办公人员根据实际的需要，可以新建数据集，并可以预览新数据集的结果，并确认新建。

输入：

维护人员登录进入到新建数据集的页面，输入新建数据集名称，选择源数据表，选择源数据字段，录入查询条件参数、录入生成数据集的sql检索条件，执行预览，查看检索的数据集是否正确，如不正确，可以再次修改，修改完成后，保存数据集，系统将数据集名称、源数据表、源数据字段、SQL检索语句存入数据库内。

输入的数据集信息：

录入项

可空

限制

数据集名称

否

数据集的具体名称。

源数据表名称

否

构成数据集的源数据表，从表目录中选择。

源数据表别名

否

源数据表的别名

源字段名称

否

构成数据集的源字段，从字段目录中选择。

字段内容描述

否

用于说明字段内容。

字段公式

否

输入字段运算公式。

字段显示顺序

否

输入字段显示顺序

查询条件

可

输入生成数据集的查询条件

查询条件参数

可

输入查询条件中用到的参数

处理：

判断必输数据是否都已录入内容，如果都已录入，校验数据是否重复，如果不重复则保存输入数据到数据库中，并反馈保存结果给当前操作员

时序图

协作图：

输出：

显示保存结果信息：

信息保存成功；信息保存失败。

数据表操作：

可写表：

数据目录表、数据目录数据源表、数据目录字段表、数据目录条件表、数据目录查询参数表。

只读表：

主题目录表、表目录表、字段目录表。

4.3数据的发布

功能概述：

办公人员根据需要，选择数据集，点击发布操作，直接发布到专网上（对于发布到外网上，由本系统导出的XML文件加上样式单由外网发布系统发布到外网上）。

发布时和处室发布公用一个tfbxxb表，而且发布形式,采用的是导出一个以tfbxxb中最大id＋main.htm为名称的htm文件来进行发布的，且htm文件保存在../picnews文件下；发布成功后，点击专网上的发布“条目”发布系统会自动连接htm文件。

输入：

登录信息、指定数据条目和栏目信息

录入项

可空

限制（录入方式直接录入还是选择录入还是系统自动生成？

）

输入数据发布的条目

否

手工录入

指定数据发布到的栏目

否

选择录入

处理:

办公人员数据导出发布系统后，系统显示可以发布的数据集信息，选择数据集，点击“发布操作”，系统提示输入发布的数据条目和选择信息栏目，点击“确认”，系统会显示，发布的数据栏目和发布的数据条目，如果确认正确，点执行发布。

系统提示发布成功/失败。

时序图:

协作图:

重要场景说明：

1、进入界面

办公人员登录系统后，进入数据发布界面。

2、显示数据集信息

办公人员进入数据发布界面后，系统显示数据集信息，以利于选择要发布的数据集。

3、选数据集并点发布操作

选择要发布的数据集，并点击后面的发布操作。

4、提示输入发布信息

体统提示输入输入发布的条目信息和选择发布所在的栏目。

5、输入发布的条目和选择发布所在的栏目

6、执行发布

系统执行发布。

7、返回发布成功/失败

系统显示发布成功失败信息。

输出：

外网数据库发布记录。

数据表操作:

只读表:

数据集信息表、数据集执行的表

5接口设计

5.1外部接口

本系统是数据中心的一个组成部分,可以为应用服务前端展现提供服务接口，可以为基础数据查询服务提供数据集接口服务。

本系统建立的数据集，基础数据查询系统可以直接应用。

5.2内部接口

客户端IE浏览器通过HTTP协议访问Inforweb应用服务器；应用服务器通过局域网,JDBC访问数据库服务器；数据库中有数据中心统一的权限信息，用户登录后系统调用权限信息来显示不同的菜单并可以进行不同的操作。

5.3用户接口

用户要进行数据的导出、发布或者数据集的维护工作，首先有权限的用户进入数据导出发布系统，再根据菜单的提示进行导出、发布和数据集维护等工作。

数据导出：

用户可以根据数据集表的提示进行导出操作，或导出XML文件，或导出EXCEL表格文件。

数据发布：

用户如要想把数据直接发布到专网上，可以根据数据集表的提示进行发布操作。

数据集维护：

用户可以根据需要进行，创建数据集，修改或者删除数据集的操作。

创建数据集，要求用户根据数据集的含义或者内容进行命名，根据需要进行选择表、相应字段和条件；修改和删除数据集，选择要更新的数据集，更新源数据表，更新源数据字段，更新查询条件参数、更新生成数据集的sql检索条件，执行预览，查看检索的数据集是否正确，如不正确，可以再次修改，修改完成后，保存数据目录，系统将数据目录名称、源数据表、源数据字段、SQL检索语句存入数据库内。

通过删除功能可以删除数据集。

6安全性设计

参见总章

7系统出错处理设计

参见总章

8数据库设计

PDM图

8.1

表清单

名称

代码

表目录表

TSEARCH_TABLE

查询条件参数表

TDTVARRY

数据目录表

TDATALIST

数据目录访问权限表

TDTACL

数据目录条件表

TDATAWHERE

数据目录源表

TDATASOURCE

数据目录字段表

TDATAFIELD

主题目录表

TSEARCH_TOPIC

字段目录表

TSEARCH_FIELD

8.2表目录表（TSEARCH_TABLE）

8.2.1表目录表字段列表

名称

代码

数据类型

主要的

强制

文本说明

顺序号

TABLE_SEQ

NUMBER（9）

TRUE

TRUE

序列

表名称

TABLE_NAME

VARCHAR2（50）

FALSE

TRUE

说明表的内容，如车辆信息表

表代码

TABLE_CODE

VARCHAR2（30）

FALSE

TRUE

存放表的真实名称；如tcarinfo

表说明

TABLE_NOTE

VARCHAR2（100）

FALSE

TRUE

状态标志

TABLE_FLAG

CHAR

（2）

FALSE

TRUE

状态标志

8.3查询条件参数表（TDTVARRY）

8.3.1查询条件参数表字段列表

名称

代码

数据类型

主要的

强制

文本说明

顺序号

TVAR_SEQ

NUMBER（9）

TRUE

TRUE

序列

查询条件id

TVAR_WHEREID

NUMBER（9）

FALSE

TRUE

参数名称

TVAR_NAME

VARCHAR2（30）

FALSE

TRUE

参数名称，如wheret.ryid=v_ryid;v_ryid是参数

参数描述

TVAR_NOTE

VARCHAR2（100）

FALSE

TRUE

对参数的说明描述

参数值

TVAR_VALUE

VARCHAR2（100）

FALSE

TRUE

存放用户输入的参数

状态标志

TVAR_FLAG

CHAR

（2）

FALSE

TRUE

状态标志

8.4数据目录表（TDATALIST）

8.4.1数据目录表字段列表

名称

代码

数据类型

主要的

强制

文本说明

顺序号

TDATA_SEQ

NUMBER（9）

TRUE

TRUE

序列

数据目录名称

TDATA_NAME

VARCHAR2（100）

FALSE

TRUE

状态标志

TDATA_FLAG

CHAR

（2）

FALSE

TRUE

8.5数据目录访问权限表（TDTACL）

8.5.1数据目录访问权限表字段列表

名称

代码

数据类型

主要的

强制

文本说明

顺序号

TDTACL_SEQ

NUMBER（9）

TRUE

TRUE

序列

操作员id

TDTACL_RYID

NUMBER（9）

FALSE

TRUE

操作员id，与数据目录id是多对一的关系

数据目录id

TDTACL_DATAID

NUMBER（9）

FALSE

TRUE

数据目录id

状态标志

TDTACL_FLAG

CHAR

（2）

FALSE

TRUE

状态标志

8.6数据目录条件表（TDATAWHERE）

8.6.1数据目录条件表字段列表

名称

代码

数据类型

主要的

强制

文本说明

顺序号

TDTWHERE_SEQ

NUMBER（9）

TRUE

TRUE

序列

数据目录id

TDTWHERE_DATAID

NUMBER（9）

FALSE

TRUE

查询语句的参数说明

查询条件

TDTWHERE_WHERE

VARCHAR2（200）

FALSE

TRUE

查询语言使用说明

状态标志

TDTWHERE_FLAG

CHAR

（2）

FALSE

TRUE

状态标志

8.6.2数据目录源表（TDATASOURCE）

8.6.2.1数据目录源表字段列表

名称

代码

数据类型

主要的

强制

文本说明

顺序号

TDTSRC_SEQ

NUMBER（9）

TRUE

TRUE

序列

源数据表id

TDTSRC_TABLEID

NUMBER（9）

FALSE

TRUE

对应源数据表的id，一对多的关系

数据目录id

TDTSRC_DATAID

NUMBER（9）

FALSE

TRUE

数据目录id

源数据表别名

TDTSRC_ALIAS

VARCHAR2（30）

FALSE

TRUE

指定源数据表的别名

状态标志

TDTSRC_FLAG

char

（2）

FALSE

TRUE

状态标志

8.7数据目录字段表（TDATAFIELD）

8.7.1数据目录字段表字段列表

名称

代码

数据类型

主要的

强制

文本说明

顺序号

TDTFILED_SEQ

NUMBER（9）

TRUE

TRUE

序列

字段描述

TDTFIELD_NOTE

VARCHAR2（100）

FALSE

TRUE

对数据目录中的字段内容描述

字段id

TDTFIELD_FIELDID

NUMBER（9）

FALSE

TRUE

与源数据表中的字段对应

数据目录id

TDTFIELD_DATAID

NUMBER（9）

FALSE

TRUE

计算公式

TDTFIELD_FROMAT

VARCHAR2（100）

FALSE

TRUE

select语句中的计算公式，常数等，当字段id等于0时生效

字段显示顺序

TDTFIELD_SORT

NUMBER

FALSE

TRUE

字段在数据目录中的显示顺序

状态标志

TDTFIELD_FLAG

CHAR

（2）

FALSE

TRUE

状态标志

8.8主题目录表（TSEARCH_TOPIC）

8.8.1主题目录表字段列表

名称

代码

数据类型

主要的

强制

文本说明

顺序号

TOPIC_SEQ

NUMBER（9）

TRUE

TRUE

序列型

主题名称

TOPIC_TITLE

VARCHAR2（100）

FALSE

TRUE

存放主题名称：

如车辆主题、人员主题。

主题代码

TOPIC_CODE

NUMBER（9）

FALSE

TRUE

表代码

TOPIC_TABLEID

NUMBER（9）

FALSE

TRUE

状态标志

TOPIC_FLAG

CHAR

（2）

FALSE

TRUE

状态标准

8.9字段目录表（TSEARCH_FIELD）

8.9.1字段目录表字段列表

名称

代码

数据类型

主要的

强制

文本说明

顺序号

FIELD_SEQ

NUMBER（9）

TRUE

TRUE

序列

字段名称

FIELD_NAME

VARCHAR2（30）

FALSE

TRUE

字段内容描述，如；姓名

字段代码

FIELD_CODE

VARCHAR2（30）

FALSE

TRUE

字段的名称，如name

字段说明

FIELD_NOTE

VARCHAR2（100）

FALSE

TRUE

表代码

FIELD_TABLEID

NUMBER（9）

FALSE

TRUE

字段所在表的顺序号

字段类型

FIELD_DATATYPE

VARCHAR2（30）

FALSE

TRUE

字段类型

状态标志

FIELD_FLAG

CHAR

（2）

FALSE

TRUE

状态标志