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

数据导出发布服务概要设计说明书文件编号:CVIC SE/DZ0183/06-00分 册 号:04/19页 码:28密 级:A山东省交通政务信息系统(二期)概要设计说明书数据中心卷数据导出发布服务山东省交通厅山东中创软件工程股份有限公司二四年九月文件变更记录*A 增加 M 修改 D 删节变更版本日期图表、表格、段落号A/M/D原因与修改情况描述修订人审核人目 录1引言31.1编写目的31.2背景31.3定义32系统设计42.1需求规定42.2系统运行环境42.3基本设计概念和处理流程42.4系统模块结构42.5功能需求与功能模块的关系52.6人工处理过程63系统部署结构64系统功能设计84.1数据的导出84.2数据集的维护124.2.1更新数据集124.2.2新建数据集144.3数据的发布175接口设计215.1外部接口215.2内部接口215.3用户接口216安全性设计227系统出错处理设计228数据库设计228.1表清单238.2表目录表(TSEARCH_TABLE)238.2.1表目录表字段列表238.3查询条件参数表(TDTVARRY)248.3.1查询条件参数表字段列表248.4数据目录表(TDATALIST)258.4.1数据目录表字段列表258.5数据目录访问权限表(TDTACL)258.5.1数据目录访问权限表字段列表258.6数据目录条件表(TDATAWHERE)258.6.1数据目录条件表字段列表258.6.2数据目录源表(TDATASOURCE)268.7数据目录字段表(TDATAFIELD)268.7.1数据目录字段表字段列表268.8主题目录表(TSEARCH_TOPIC)278.8.1主题目录表字段列表278.9字段目录表(TSEARCH_FIELD)288.9.1字段目录表字段列表281 引言1.1 编写目的本阶段的主要任务是根据需求规格说明确定设计目标,以及它们的优先顺序,并根据目标确定最适合的设计方法,制定各种规范。将系统按功能划分成模块的层次结构。确定每个模块的功能,建立与已确定的软件需求的对应关系。确定模块之间的调用关系,确定模块之间的接口,即模块之间传递的消息。设计好接口的信息结构,评估模块划分的质量及导出模块结构的规则。完成应用服务设计的数据的导出和发布的服务设计。本说明书的编写目的是经过对本次软件开发的系统设计、约定及相关内容作出具体描述,说明对程序系统的设计考虑,包括其处理流程,组织结构、模块划分、功能分配、接口设计、运行设计、数据结构设计,为程序的详细设计奠定基础,也做为本项目开发人员、测试人员的指导性文件,作为她们工作的依据之一。该概要分析说明书的预期读者主要有评审专家、交通厅领导、事业部分管领导、监理人员、项目组成员、QA人员、测试人员及其它相关人员等。1.2 背景A、软件系统的名称:数据的导出和发布服务,Ver1.00B.开发的软件系统的最终用户或适用的领域:本系统的最终用户为厅机关、厅直单位、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/jtzw2qDept/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中最大idmain.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_FIELD8.2 表目录表(TSEARCH_TABLE)8.2.1表目录表字段列表名称代码数据类型主要的强制文本说明顺序号TABLE_SEQNUMBER(9)TRUETRUE序列表名称TABLE_NAMEVARCHAR2(50)FALSETRUE说明表的内容,如车辆信息表表代码TABLE_CODEVARCHAR2(30)FALSETRUE存放表的真实名称;如tcarinfo表说明TABLE_NOTEVARCHAR2(100)FALSETRUE状态标志TABLE_FLAGCHAR(2)FALSETRUE状态标志8.3 查询条件参数表(TDTVARRY)8.3.1查询条件参数表字段列表名称代码数据类型主要的强制文本说明顺序号TVAR_SEQNUMBER(9)TRUETRUE序列查询条件idTVAR_WHEREIDNUMBER(9)FALSETRUE参数名称TVAR_NAMEVARCHAR2(30)FALSETRUE参数名称,如 where t.ryid=v_ryid;v_ryid是参数参数描述TVAR_NOTEVARCHAR2(100)FALSETRUE对参数的说明描述参数值TVAR_VALUEVARCHAR2(100)FALSETRUE存放用户输入的参数状态标志TVAR_FLAGCHAR(2)FALSETRUE状态标志8.4 数据目录表(TDATALIST)8.4.1数据目录表字段列表名称代码数据类型主要的强制文本说明顺序号TDATA_SEQNUMBER(9)TRUETRUE序列数据目录名称TDATA_NAMEVARCHAR2(100)FALSETRUE状态标志TDATA_FLAGCHAR(2)FALSETRUE8.5 数据目录访问权限表(TDTACL)8.5.1数据目录访问权限表字段列表名称代码数据类型主要的强制文本说明顺序号TDTACL_SEQNUMBER(9)TRUETRUE序列操作员idTDTACL_RYIDNUMBER(9)FALSETRUE操作员id,与数据目录id是多对一的关系数据目录idTDTACL_DATAIDNUMBER(9)FALSETRUE数据目录id状态标志TDTACL_FLAGCHAR(2)FALSETRUE状态标志8.6 数据目录条件表(TDATAWHERE)8.6.1数据目录条件表字段列表名称代码数据类型主要的强制文本说明顺序号TDTWHERE_SEQNUMBER(9)TRUETRUE序列数据目录idTDTWHERE_DATAIDNUMBER(9)FALSETRUE查询语句的参数说明查询条件TDTWHERE_WHEREVARCHAR2(200)FALSETRUE查询语言使用说明状态标志TDTWHERE_FLAGCHAR(2)FALSETRUE状态标志8.6.2数据目录源表(TDATASOURCE)8.6.2.1数据目录源表字段列表名称代码数据类型主要的强制文本说明顺序号TDTSRC_SEQNUMBER(9)TRUETRUE序列源数据表idTDTSRC_TABLEIDNUMBER(9)FALSETRUE对应源数据表的id,一对多的关系数据目录idTDTSRC_DATAIDNUMBER(9)FALSETRUE数据目录id源数据表别名TDTSRC_ALIASVARCHAR2(30)FALSETRUE指定源数据表的别名状态标志TDTSRC_FLAGchar(2)FALSETRUE状态标志8.7 数据目录字段表(TDATAFIELD)8.7.1数据目录字段表字段列表名称代码数据类型主要的强制文本说明顺序号TDTFILED_SEQNUMBER(9)TRUETRUE序列字段描述TDTFIELD_NOTEVARCHAR2(100)FALSETRUE对数据目录中的字段内容描述字段idTDTFIELD_FIELDIDNUMBER(9)FALSETRUE与源数据表中的字段对应数据目录idTDTFIELD_DATAIDNUMBER(9)FALSETRUE计算公式TDTFIELD_FROMATVARCHAR2(100)FALSETRUEselect 语句中的计算公式,常数等,当字段id等于0时生效字段显示顺序TDTFIELD_SORTNUMBERFALSETRUE字段在数据目录中的显示顺序状态标志TDTFIELD_FLAGCHAR(2)FALSETRUE状态标志8.8 主题目录表(TSEARCH_TOPIC)8.8.1主题目录表字段列表名称代码数据类型主要的强制文本说明顺序号TOPIC_SEQNUMBER(9)TRUETRUE序列型主题名称TOPIC_TITLEVARCHAR2(100)FALSETRUE 存放主题名称:如车辆主题、人员主题。主题代码TOPIC_CODENUMBER(9)FALSETRUE表代码TOPIC_TABLEIDNUMBER(9)FALSETRUE状态标志TOPIC_FLAGCHAR(2)FALSETRUE状态标准8.9 字段目录表(TSEARCH_FIELD)8.9.1字段目录表字段列表名称代码数据类型主要的强制文本说明顺序号FIELD_SEQNUMBER(9)TRUETRUE序列字段名称FIELD_NAMEVARCHAR2(30)FALSETRUE字段内容描述,如;姓名字段代码FIELD_CODEVARCHAR2(30)FALSETRUE字段的名称,如 name字段说明FIELD_NOTEVARCHAR2(100)FALSETRUE表代码FIELD_TABLEIDNUMBER(9)FALSETRUE字段所在表的顺序号字段类型FIELD_DATATYPEVARCHAR2(30)FALSETRUE字段类型状态标志FIELD_FLAGCHAR(2)FALSETRUE状态标志