产品名称总体设计说明书.doc

(产品名称)总体设计说明书哈尔滨银行版权所有内部资料，注意保密。修订历史记录日期说明作者填写说明：1、 文档新增时，该表开始填写，说明本次为新建，不需要填写后续详细修改说明。2、 产品开发过程中或以后产品升级过程中，每次修改都要在该表中登记主要内容，修改内容直接在文档中体现，并在本文档后面依次添加详细修改说明。3、 表格中每行应为一独立任务，例如产品首次建立时，先是编写，后是评审，评审后根据意见再调整等一系列工作，延续的时间可能比较长，仍然只需要填写表中一行。4、 “日期”填写为本行内容修改开始的日期。5、 表中历史内容不应删除，应一直保留。目 录第一章 引言41.1 概述41.2 定义41.3 设计依据4第二章 运行环境和架构设计52.1运行环境设计要素52.2运行环境设计52.2.1硬件环境设计52.2.2软件环境设计52.3系统架构设计62.3.1逻辑架构设计62.3.2系统安全性设计6第三章 数据设计73.1 设计原则73.2数据分析73.3数据设计73.3.1 数据基本表结构设计73.3.2 数据主要索引设计83.3.3 数据库分区设计83.3.4 数据基本视图的设计93.3.5 数据存储设计103.3.6 数据安全性设计10第四章 接口设计114.1 本产品提供给外部系统使用的接口114.2 本产品调用的外部系统提供的接口124.2.1 XXX系统功能接口124.2.2 YYY系统功能接口12第五章 系统出错处理135.1 系统环境错误135.2 应用系统错误13第六章 其它方面的设计考虑14附录A：详细修改说明15第一章 引言1.1 概述待开发软件系统的名称、主要内容及目标等。1.2 定义 给出系统设计和实现所用的命名规范。 列出本文中用到的专门术语的定义和外文首字母组词的原词组.1.3 设计依据列出系统总体设计依据的文档资料，如功能分析说明书等。第二章 运行环境和架构设计2.1运行环境设计要素根据功能分析说明书提到的环境要求，综合考虑现行的系统运行环境，给出设计本系统运行环境时的各种考虑因素，以及解决有关问题的设计思路。2.2运行环境设计2.2.1硬件环境设计详细说明结构图中各设备的型号、配置、数量、网络协议及其它各项需说明的内容，说明设计时有关的技术考虑，并填写下表。如果项目设计阶段确定不了硬件配置，可以先注明最低配置要求,待明确后采取返工的方式再对硬件环境设计进行修订。硬件环境说明列表设备名称型号配置安装位置数量备注2.2.2软件环境设计详细说明软件环境设计的要点，说明设计时有关的技术考虑，并填写下表。软件环境说明列表软件名称版本宿主机开发商备注2.3系统架构设计主要是指本系统与外系统的关系及本系统逻辑结构层次，与技术方案建议书中的技术方案有区别，这里主要关注的是本系统。2.3.1逻辑架构设计给出系统的逻辑架构图，并附相关文字说明。各系统间通讯关系要说明：物理层（局域网、专线、公网、VPN等）、网络层（SOCKET、CICS DPL、CICS CTG、MQ、HTTP、HTTPS等）、表示层（XML、定长报文、8583等）。例如在两个系统的连线上用“专线：SOCKET：XML”表示两个系统间采用以建立专线，通过SOCKET协议传输XML的通讯方式进行连接。2.3.2系统安全性设计针对需求分析阶段对系统提出的安全需求在系统设计中说明各种防御措施，如果防御措施涉及多个系统模块应将该措施提炼为公共模块。第三章 数据设计3.1 设计原则指出本系统数据存储采用何种方式（数据库、文件）、设计的原则、设计时考虑的依据等。3.2数据分析用实体关系图给出业务系统的逻辑模型，建议使用数据建模工具进行实体关系分析。实体就是数据流分析中得到的文件(数据存储)。在图中实体框中只给出如下三类属性：主关键码、外码、与其它实体产生直接联系的属性。其中主码前缀以*号，外码前缀以#号，普通属性名前无前缀。3.3数据设计3.3.1 数据基本表结构设计根据数据分析得到的实体关系图，以表格形式给出数据全部基本表的结构设计结果。数据表结构 表名实体名表类型字段名描述类型可否为空性质取值范围说明字段的性质为主键、外键、普通三者之一。若为外键，则在取值范围一栏给出该外键所属的表名。表类型为表对应的存储类型，有数据库表、VSAM（KSDS、ESDS、RSDS）、TXT。3.3.2 数据主要索引设计根据数据分析得到的实体关系图和操作效率等方面的考虑，以表格形式给出数据主要索引的设计结果。主键索引不需要描述。数据索引表数据表名索引名索引字段说明索引字段若有多项，则用字段名+字段名的形式全部列出。索引名为：“IND_”+数据表名 +”_”+序号。如：IND_FXTBNK_1，表示FXTBNK表的第一个索引。3.3.3 数据库分区设计1、依据数据库分区基本原则和分区方法，对数据表是否采用分区以及分区类型进行分析，并填写分区表总体设计一览表。数据分区原则数据容量表容量大于1.5G或对于OLTP系统记录数据大于1000万。数据访问特性基于表的大部分查询应用，只访问表中少量的数据。 并行操作对于经常执行PDML的表（for oracle）。可用性可用性要求很高的表。可管理性需要按时间段或某个范围删除成批的数据表分区方法区间分区(range)将数据按照某个值逻辑地聚集，考虑区间分区。散列分区(hash)不能按照自然区间进行分区，考虑散列分区。散列分区个数应为2的幂，数据分布才会均匀。列表分区(list)数据中有一列有一组离散值，而且根据应用使用该列是有意义的，考虑列表分区。组合分区(composite)区间分区太大，不能有效管理，考虑组合分区。分区表总体设计一览表表名分区键分区方法分区规则说明设计人列表分区组合分区范围分区哈希分区2、依据分区索引的基本策略，对分区索引进行分析，并填写分区索引总体设计一览表。分区索引策略局部分区索引（locally partitioned index）每个分区表都有一个索引分区，而且只索引该表分区，局部索引使用底层表相同的机制分区。局部分区索引分为两类：(1)局部前缀索引（local prefixed index）：分区键在索引定义的前几列上。(2)局部非前缀索引（local non-prefixed index）：索引不以分区键作为其列列表的前几列，索引可能包含分区键列，也可能不包含。设计时要尽可能保证查询谓词允许分区消除。：如索引字段正好是分区字段，或者复合索引的第一个字段是分区字段，则建立为局部前缀索引。全局分区索引（globally partitioned index）索引按区间或散列分区，一个索引分区可指向任何（所有的）表分区。全局分区索引只有前缀全局索引（ prefixed global index）。对于其它字段的索引，建议优先考虑设计为全局分区索引，最后考虑设计为局部非前缀索引。分区索引总体设计一览表表名索引名称分区方法分区规则说明设计人局部分区索引全局分区索引“局部分区索引”与表相同,无需说明3.3.4 数据基本视图的设计根据数据基本表结构的设计结果和应用系统总体设计的结果，设计系统使用的主要视图，并以表格形式给出各视图的结构设计结果。数据基本视图结构表视图名实体名用途编号字段名来源表/视图来源字段名取值方式取值方式说明该字段是对各来源表或来源视图中相应字段经过怎样的操作得到本字段的值。如果直接取值，则填写为查询。若为其它方式，则需给出计算公式和其它构造细节。3.3.5 数据存储设计根据数据内容和用户需求，给出各数据表、索引的存储要求，明确各数据表中数据保留和更新策略。在填写本表时，要给出估计假设业务范围等。本表估计数值给出一定的余量后可以作为定义生产系统空间的依据。数据表名记录长度(BYTE)估计记录数估计存储空间(MB)保留时间更新策略合计- -3.3.6 数据安全性设计给出数据信息安全方面的设计要求。第四章 接口设计接口设计原则参见应用系统接口规范。4.1 本产品提供给外部系统使用的接口给出本系统提供给其它系统的接口的方式和数据结构。重点描述通讯协议、应用通讯方式、数据包格式、码制等，同时也要说明其它接口双方协定的内容。联机接口按如下格式说明，如果有多个，则需要每个接口一个表：接口名称接口编号（交易码）00101接口性质联机/批量文件序号域名类型及长度意义备注输入项1CHANNELX(1)渠道标识C-Counter柜台P-Phone电话(与Call Center同)N-Net网银T-SelfTerminal自助终端A-Client Application客户端2ACCTNO9(19)帐号/卡号支持17位帐号,19位卡号。仅电话银行可以上送卡号。3JOBTYPEX(2)帐户类型SY-活一本交易;FD-定一本交易;CD-借记卡交易CS-现金交易输出项1SEQ-NOX(9)交易序号2TXN-TIMEX(12)成交时间精确到秒：YYMMDDHHMMSS类型的X表示字符，9表示数字，括号内为长度。定长报文的字符类型域右对齐，长度不足时左补空格；定长报文的数字类型域右对齐，长度不足时左补“0”；本系统提供的批量文件，需要说明文件名称的格式、文件体的头、体、尾的格式。描述本产品需要其他产品提供的功能接口。一般以外部系统提供的接口为准。4.2 本产品调用的外部系统提供的接口与多个外部系统连接，需要分系统给出每一系统接口。4.2.1 XXX系统功能接口概述XXX系统与本产品的功能关系。按照XXX系统提供的本产品需要的功能，逐个说明XXX系统功能接口。4.2.2 YYY系统功能接口概述YYY系统与本产品的功能关系。按照YYY系统提供的本产品需要的功能，逐个说明XXX系统功能接口。第五章 系统出错处理5.1 系统环境错误给出系统软硬件环境可能出错的情况以及出错时的各种处理原则和处理步骤。按以下步骤详细列出：错误类型：处理原则：处理步骤：其中处理原则是指，根据错误性质严重程度，对该类错误的重视程度。包括可以忽略、加强监视等，应按实际情况列出。5.2 应用系统错误指出应用系统出错时，错误信息的分类、形式、内容含义等规定。只给出规定和原则，不给出具体错误内容。具体的错误信息在详细设计说明书中完成。第六章 其它方面的设计考虑在这一部分中，主要说明前述部分之外的设计内容，包括以下几个方面（如果还有其它方面的内容都可以在此部分中描述）： 对非功能性的需求的设计的考虑，专门针对需求的中非功能性需求功能进行描述，例如针对性能方面的需求，在总体设计中是如何考虑的。重点考虑以下与系统性能关系紧密的功能设计。1、 历史数据清理和备份功能设计。2、 公共资源访问机制。3、 复杂和大数据量的数据查询功能设计。4、 跨系统信息交互功能设计。5、 日志和监控功能设计。风险控制设计与解决方案。 系统容错处理方案，可以用一览表的方式说明可能出现的错误或故障及其对应的系统处理措施。 系统维护设计，说明为了系统维护方便而在系统中的技术处理设计,如在系统设计中用于系统检查与维护的检测点及专用维护模块。 潜在的不确定因素，如业务需求的不确定因素。 尚未解决的问题，主要指在总体设计过程中尚未解决，而设计者认为在系统设计完成之前必须解决的各类问题。 说明在软件系统的工作过程中不得不包含的人工处理过程(如果有的话)。附录A：详细修改说明修改日期：2010-09-03 序号修改内容1增加4.3.3数据库分区设计，具体增加内容如下：4.3.3 数据库分区设计z1、依据数据库分区基本原则和分区方法，对数据表是否采用分区以及分区类型进行分析，并填写分区表总体设计一览表。数据分区原则数据容量表容量大于1.5G或对于OLTP系统记录数据大于1000万。数据访问特性基于表的大部分查询应用，只访问表中少量的数据。 并行操作对于经常执行PDML的表（for oracle）。可用性可用性要求很高的表。可管理性需要按时间段或某个范围删除成批的数据表分区方法区间分区(range)将数据按照某个值逻辑地聚集，考虑区间分区。散列分区(hash)不能按照自然区间进行分区，考虑散列分区。散列分区个数应为2的幂，数据分布才会均匀。列表分区(list)数据中有一列有一组离散值，而且根据应用使用该列是有意义的，考虑列表分区。组合分区(composite)区间分区太大，不能有效管理，考虑组合分区。分区表总体设计一览表表名分区键分区方法分区规则说明设计人列表分区组合分区范围分区哈希分区2、依据分区索引的基本策略，对分区索引进行分析，并填写分区索引总体设计一览表。分区索引策略局部分区索引（locally partitioned index）每个分区表都有一个索引分区，而且只索引该表分区，局部索引使用底层表相同的机制分区。局部分区索引分为两类：(1)局部前缀索引（local prefixed index）：分区键在索引定义的前几列上。(2)局部非前缀索引（local non-prefixed index）：索引不以分区键作为其列列表的前几列，索引可能包含分区键列，也可能不包含。设计时要尽可能保证查询谓词允许分区消除。：如索引字段正好是分区字段，或者复合索引的第一个字段是分区字段，则建立为局部前缀索引。全局分区索引（globally partitioned index）索引按