系统设计说明书模版.pdf
《系统设计说明书模版.pdf》由会员分享,可在线阅读,更多相关《系统设计说明书模版.pdf(23页珍藏版)》请在淘文阁 - 分享文档赚钱的网站上搜索。
1、-交行集中工作平台交行集中工作平台设计说明书设计说明书2008 年 5 月1 引言 21.1 编写目的 21.2 名词术语 21.3 参考资料 31.4 文档约定 32 总体设计 32.1 建立背景 32.2 系统建立目标 4提示用户体验 4建立统一的 MIS 应用架构 5集中工作平台 52.3 设计和实现约束 52.4 组织构造和用户类 62.5 系统架构 7技术架构 7应用架构 7功能架构 72.6 接口设计 7外部接口 7部接口 82.7 系统环境 8网络拓扑 8硬件环境 8软件环境 82.8 非功能特性设计 8系统兼容性 8平安性 8运行效率 8可扩展能力 9用户文档 93 系统公共模
2、块设计 93.1 日志处理模块 93.2 异常处理模块 93.3 Session 处理 10.目录z.-3.4 UI 框架 114 应用根底框架概要设计 114.1 系统框架 11概述 11业务流程描述 12用例描述 12实体关系描述 164.2 构件包设计 17构件包列表 17构件包关系图 174.2.3*构件包(如:权限管理)175 附录 235.1 词汇表 235.2 数据模型描述 235.3 数据字典 235.4 功能矩阵 231 1 引言引言1.11.1 编写目的编写目的说明编写这份设计书的目的,指出预期的读者和有关阅读建议。本设计说明书文档包括该工程的建立背景、目标、建立容、系统架
3、构、接口、数据模型、功能模型、部署模型、功能设计等的描述,用于指导该工程的开发与部署,同时,作为该工程的重要技术资料,作为系统未来维护或扩展的参考。本文档的阅读者为本系统的设计、开发人员、接口系统的开发人员、系统维护人员。1.21.2 名词术语名词术语描述与该系统相关的特定概念和术语,如*些缩写代号,统一的词汇表达等MISUP:MIS Uniform Platform,MIS 统一架构平台,交通银行为支撑灵活的、高效的、易管控的、良好用户体验的管理型应用的开发、运行和管理,而规划建立的符合 SOA 技术的 MIS应用统一架构体系,该体系规划包括相应的方法论、平台工具以及交通银行 IT 资产容。
4、集中工作平台:应用根底框架:集中任务中心:.z.-EOS:E*T:SOA:Service-Oriented Architecture,面向效劳的架构,SOA 是一个软件架构,同时也是一个构件模型,它将企业应用的不同功能单元 称为业务效劳通过这些效劳之间定义良好的接口和契约联系起来。接口是采用中立的方式进展定义的,它应该独立于实现效劳的硬件平台、操作系统和编程语言。这使得构建在各种这样的系统中的效劳可以以一种统一和通用的方式进展交互。本工程中涉及 SOA 概念,主要侧重于松散耦合的应用架构、复用、业务构件化的意义。1.31.3 参考资料参考资料列出有关的参考文件,如:本工程的经核准的方案任务书或
5、合同、上级机关的批文;属于本工程的其他已发表文件;本文件中各处引用的文件、资料,包括所要用到的软件开发标准。列出这些文件的标题、文件编号、发表日期和出版单位,说明能够得到这些文件资料的来源。集中工作平台预研总结报告.doc集中工作平台技术预研工作总结.pptMISUP-IWP 工程设计与开发规.doc1.41.4 文档约定文档约定说明本文档中的有关约定信息,例如名词的缩写,代码表示,隐含式的约定等。本文档中工作流引擎指 EOS 工作流平台的工作流引擎,交通银行简称为“交行,普元软件技术简称为“普元。Bankm:交行或者交通银行Primeton:普元或普元软件技术本文档中所涉及的构件包、构件均表
6、示基于 EOS 平台的构件包和构件概念。2 2 总体设计总体设计2.12.1 建立背景建立背景说明:.z.-为什么要建这套系统要到达的目标是什么 交通银行大集中完成后,大量的 MIS 系统迫切需要建立,然而我行 MIS 应用建立的方式还是相对孤立的。尽管采用了单点登录、统一认证、门户整合、企业总线等方面的技术,但在应用与应用之间,缺乏统一的业务构件规划;应用实施过程中,缺乏业务构件的抽象和抽取,因此无法形成 IT 资源的有效积累和复用;各个应用分别建立,又缺乏公共资源的复用,导致各个应用需要分别实现用户、权限管理,以及应用的 UI 框架,导致IT 建立的重复投入,以及使用者的体验不好。Inte
7、rnet 已经日益成为应用程序开发的默认平台。用户对应用程序复杂性要求日增,但现在的 Web 应用程序对完成复杂应用方面却始终跟不上步伐。用户与今天中等复杂程度的Web 应用程序交互时,其体验并不能令人满意。上面的这些问题,实际上也是大多数大型企业包括同业IT 建立中的共同挑战,而SOA 的理念和规标准的一步步完善,为解决这些问题带来了曙光,而国平台厂商以及同业银行做出的实践,初步验证了企业级业务构件化和统一架构的可行性。在这样一个外因素的背景下,软件中心提出了 MIS 系统规划和建立的更大目标:建立以业务构件化为根底的,符合先进技术开展趋势的交行MIS 统一架构平台MISUP,以支撑灵活的、
8、高效的、易管控的、良好用户体验的管理型应用的开发、运行和管理。其中,集中工作平台作为 MIS统一架构平台的重要组成局部,关系到使用者的体验,成为最先建立的重点容。2.22.2 系统建立目标系统建立目标描述系统建立的目标,适用围和相关原则集中工作平台实施完成后,将成为交行 MIS 应用的根底平台,各个 MIS 系统将遵循该平台的相关规接入进来,并提供统一的用户操作入口,因此,在设计上将重点考虑如下特性:应用模型的通用性和可扩展能力,技术框架的灵活性,运行的效率和稳定性。以以下出了集中工作平台具体的建立目标:2.2.12.2.1 提高用户体验提高用户体验希望提供应用户:UI 展现、操作友好易交互:
9、交互性强,尽量不使用或少使用页面全部刷新的不友好方式,而采用基于 aja*技术的局部刷新效果;.z.-丰富的控件:开发或集成丰富的UI 控件,既丰富了用户的交互手段,又方便了开发人员。集中桌面一次登录:用户一次登录,即可在各应用中间切换一个工作平台:提供应用户一个统一的工作平台,用户在该平台上即可完成各项操作。正是基于上述原因,要求本系统实现:支持 RIA 的 UI 框架;MIS 应用桌面。2.2.22.2.2 建立统一的建立统一的 MISMIS 应用架构应用架构希望给各个应用提供:公共模型及效劳用户、组织机构模型:从现有系统和交行实际,抽取出公共的模型,为各应用效劳;权限模型:从现有系统和交
10、行实际,抽取出公共的模型,为各应用效劳。集中流程任务处理待办工作:抓取用户在各应用中的待办任务,统一展现给用户处理;已办工作:抓取用户在各应用中的已办任务,供用户查看。待阅中心:抓取用户在各应用的待阅消息,供用户查看。正是基于上述原因,要求本系统实现:应用根底框架;集中任务中心。2.2.32.2.3 集中工作平台集中工作平台以上四个目标有机形成集中工作平台,提供交行MIS 应用的应用统一入口:2.32.3 设计和实现约束设计和实现约束描述系统设计和实现中受到的约束,包括设计与实施策略、开发工具、团队构造、时间表、遗留代码等。通过工程启动前的方案验证和技术预研工作,为本工程的实施打下了良好的根底
11、,并确定了如下的设计和实现原则:技术架构采用 J2EE+普元 EOS6.z.-UI 框架采用 E*T2应用桌面采用 Portal 实现用户认证采用 LDAP2.42.4 组织构造和用户类组织构造和用户类描述系统涉及的组织机构,系统相关的用户集中工作平台旨在为未来交行 MIS 应用提供统一的应用框架、组织模型、权限控制,因此,几乎交行所有需要使用 MIS 应用如 HR、OA、CRM、资金管理等的人员均作为该平台的用户,并且涉及到交通银行的所有组织机构,同时,交通银行的*些合作伙伴如开发中心的外协公司 也可能是该平台的用户。由于本平台涉及的组织构造和用户非常庞大,而且与未来接入本平台的应用相关,无
12、法列出最终完整的组织构造,以下图仅作为组织构造的一个例如。使用本平台及其架构的用户类如下:业务用户普通用户通过集中工作平台,使用各个具体应用系统功能的操作用户,他们一般的操作行为是:通过集中工作平台的统一登录,进入到集中工作平台的主界面,可以浏览到他可以使用的功能菜单树,可以看到自己的集中任务列表,也可以选择自己的菜单项定义为快捷菜单。普通用户通过点击自己权限围可以看到的菜单项,进入具体的应用功能界面。由于接入系统的差异性,业务用户的用户特征差异化很大,操作应用系统的方式的差异也很大,但共同的特性就是:希望在使用不同应用的功能时,不希望屡次登录,并希望所有系统的功能能够集中显示,各个应用系统功
13、能具有一致的操作风格和模式。业务用户由于群体广泛,使用的电脑终端的差异性可能也会比拟大,包括客户端的硬件配置、操作系统版本、浏览器类别和版本,这些差异化要求集中工作平台对于系统环境具有较广泛的兼容性。集中工作平台管理员集中工作平台的管理员主要负责维护集中工作平台的应用根底框架,如应用接入的注册和管理,统一组织模型、集中任务的管理、监控和手工数据同步。集中工作平台管理员要求对集中工作平台的架构和相关接入规比拟熟悉,对计算机应用系统的操作比拟熟练。应用系统管理员应用系统管理员主要负责通过集中工作平台维护其管理的接入应用,包括应用的权限定义、角色设置、参数维护、数据同步等。应用系统管理员熟悉电脑操作
14、,了解集中工作平台的接入规。机构管理员机构管理员主要负责通过集中工作平台维护组织机构和人员信息,以及实现与各个接入应用的组织和人员数据的导入与导出等。机构管理员有管理上的层次,不同层次的机构管理员具有不同层次的数据操作权限.z.-机构管理员熟悉电脑操作,了解集中工作平台提供的组织模型构造关系和相关接口。应用系统开发人员应用系统开发人员指接入集中工作平台的应用工程开发团队技术人员,他们需要了解集中工作平台的相关架构、公用框架、模型、规、接口,以确保实施的应用能够无缝接入到集中工作平台中。另外,开发人员需要将开发的功能定义到集中工作平台的功能管理中。应用系统开发人员熟悉电脑操作和软件开发技术。在系
15、统机构设计和功能设计上,要求充分考虑用户类的使用特征,更好满足使用者的操作体验。2.52.5 系统架构系统架构描述系统的总体框架,从技术、应用、功能几个角度介绍系统组成,使用图例的方式描述子系统、业务单元功能模块和工具之间的关系。使用图例方式描述本系统与外围环境的关系,使用文字描述业务根底件根底构件库的在系统中的作用2.5.12.5.1 技术架构技术架构从技术角度描述系统组成,包括系统使用平台,框架,技术及他们之间关系2.5.22.5.2 应用架构应用架构从应用角度描述系统平台和各个应用的关系2.5.32.5.3 功能架构功能架构从功能角度描述系统的功能及功能之间,功能和用户之间的关系2.5.
16、42.5.4 UIUI 架构架构【从用户交互的角度,描述系统最终的用户操作界面的布局】2.62.6 接口设计接口设计2.6.12.6.1 外部接口外部接口描述系统同外界的所有接口的安排包括软件与硬件之间的接口、本系统与各支持软件之间的接口关系。.z.-2.6.22.6.2 部接口部接口描述系统之的各个系统元素之间的接口的安排2.72.7 系统环境系统环境根据需求的要求描述系统运行的工作环境2.7.12.7.1 网络拓扑网络拓扑描述部署和运行系统的一种或多种物理网络硬件构造,应该包括运行系统的物理节点计算机、CPU及其互连情况总线连接、LAN 连接、点到点连接等。2.7.22.7.2 硬件环境硬
17、件环境简要地说明系统对硬件环境的要求 2.7.32.7.3 软件环境软件环境简要地说明系统对软件环境的要求 2.82.8 非功能特性设计非功能特性设计以列表的方式介绍系统非功能性的特性,以及对特性相关设计,包括系统易用,可管理,低维护本钱2.8.12.8.1 系统兼容性系统兼容性描述系统可能运行的软硬件平台环境以及采用的应用平台的兼容性说明2.8.22.8.2 平安性平安性描述为保证系统应用平安,包括通讯平安,数据平安,为保证平安采取的备份和故障应急处理的策略2.8.32.8.3 运行效率运行效率描述系统能够支持的处理能力,吞吐量,响应时间等定能指标.z.-2.8.42.8.4 可扩展能力可扩
18、展能力描述系统为以后功能和性能扩展提供的特性2.8.52.8.5 用户文档用户文档描述系统为用户培训,用户使用系统帮助方面提供的文档3 3 系统公共模块设计系统公共模块设计描述系统公共模块的设计 3.13.1 权限控制权限控制3.23.2 日志处理模块日志处理模块描述系统日志处理设计和日志使用规 3.33.3 异常处理模块异常处理模块1、在构件包中建立异常资源文件,针对错误码,包括显示在页面的提示和真正的错误提示,例如:abf_auth_0001=无效的用户名或者密码!用户0密码错误!其中0表示变量,如果异常提示中有多个变量,依次为 0,1的信息为真正的错误信息。如果没有,则和前面信息一致。显
19、示给用户的信息为前的信息。异常资源文件为构件包资源配置目录下resources/e*ception/e*ception.properties2、错误码的构成规则构件包名+_+四位数字:例如 abf_auth_00013、实现一个写业务异常的运算逻辑接口如下:publicstaticvoidpublicstaticvoid setBusiE*ception(String errCode,String logFlag,String.params)throwsthrows.eos.system.e*ception.EOSE*ception第一个参数是资源文件中定义的错误码第二个参数为是否写业务日志的
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 系统 设计 说明书 模版
限制150内