概要设计范本.docx

概要设计范本.docx

《概要设计范本.docx》由会员分享，可在线阅读，更多相关《概要设计范本.docx（73页珍藏版）》请在冰豆网上搜索。

概要设计范本

[XXXX公司办公自动化]

概要设计说明书

[V1.0（版本号）]

拟制人______________________

审核人______________________

批准人______________________

[二○○三年四月二十一日]

概要设计说明书

引言

1.1编写目的

信息化是当今世界经济和社会发展的大趋势。

推进电力系统的信息化建设，对于提高现代化管理水平，提高工作效率，都具有重要意义。

为了适应国际形势和我国经济建设与社会发展的需要，我国必须加快电力系统信息化的发展。

对于电力系统的企业，如何充分、快捷、有效地利用企业内外的大量信息，为企业的发展服务，提高企业的工作效率，是企业需要充分考虑的问题之一。

随着企业规模的扩大以及服务内容和办公设施的现代化，这种情况日益突出。

同时为了提高单位的日常办公效率，减轻手工劳动强度，使单位的日常运营纳入高效而快捷的轨道，就必须利用现代的信息手段。

现代的信息技术优势在于对信息的处理高效而精确，可以充分实现信息的共享和传输，及时地反映企业办公的变动情况，完善办公调度，提高企业服务质量，进而实现企业经营管理的信息化、科学化。

充分利用现代的信息技术，是提高企业竞争力的必要手段。

XXXX公司计划建设的办公自动化系统将以先进的信息技术为依托，通过建立全局八个部门的信息网络，全面提高办公效率，并做到信息传输自动化、公共服务远程化、公文交换无纸化、管理决策网络化，实现全局办公系统全面信息化。

本说明书给出XXXX公司办公自动化系统的设计说明，包括最终实现的软件必须满足的功能、性能、接口和用户界面、附属工具程序的功能以及设计约束等。

目的在于：

▪为编码人员提供依据；

▪为修改、维护提供条件；

▪项目负责人将按计划书的要求布置和控制开发工作全过程；

▪项目质量保证组将按此计划书做阶段性和总结性的质量验证和确认。

本说明书的预期读者包括：

▪项目开发人员，特别是编码人员；

▪软件维护人员；

▪技术管理人员；

▪执行软件质量保证计划的专门人员；

▪参与本项目开发进程各阶段验证、确认以及负责为最后项目验收、鉴定提供相应报告的有关人员。

▪合作各方有关部门的负责人；项目组负责人和全体参加人员。

1.2背景

▪伴随着办公自动化的逐步深入，政府、企业对办公自动化的需求也越来越完善，在这样的大环境下，由XX公司，为海南省XXXX公司开发《XXXX办公自动化系统》。

1.3定义

本项目开发的软件，约定：

中文全称：

XXXX办公自动化系统

中文别称：

OA

英文全称：

OA

本报告用到的术语符合国家标准《软件工程术语（GB/T11475-1995）》。

参考资料

与本文直接相关的国家标准包括：

（中国标准出版社1996年）

GB8566-1995软件生存期过程

GB8567-88计算机软件产品开发文件编制指南

GB9385-88计算机软件需求说明编制指南

GB/T11457-1995软件工程术语

2．总体设计

2.1需求规定

在充分理解《XXXX公司办公自动化需求》的基础上，根据XXXXXXXX公司办公的需要，我们设计此方案，来最大限度满足XXXX公司的需要。

2.1.1系统功能

XXXX公司办公自动化系统包括八个部分：

日常办公、企业文化、资源管理、人事管理、个人事务、公共信息、系统维护、计划管理。

系统的结构框图如下：

2.1.2系统性能

充分考虑XXXX公司的需求特色，做到功能齐全；要求操作方便快捷，性能优越；系统要能在XXXX公司可能出现的各种环境下具有很好的稳定性；系统特别强调安全性，杜绝非法入侵，系统要能够使用过程中可能出现的灾难，具有很强的容错能力；系统应充分考虑易扩展性，能适应新业务的变化；系统要求具备完整的文档和清晰风格，具备很好的可维护性。

2.1.2.1良好的用户界面

系统的设计应该充分考虑用户的使用习惯，具有较好的可操作性，实现“0，1，2，3”标准

0Manual不再需要用户手册

1Portal一个个性化主页

2Seconds两秒钟内启动服务

3Clicks最多三次点击得到指定服务

主要设计风格：

采用蓝色色调，象征政府办事的严肃性，国家昌盛。

整个界面以简洁明快为主，利用简单的图案，文字和线条组成，突出政府牢固的基础和为人民服务的精神。

版面设计:

2.1.2.2可维护性

考虑到应用的多变性，系统采用层次化设计思想，每层实现特定的功能，并通过标准接口向上层提供透明的服务，因此，最大限度的实现了系统各模块的功能独立性，每一层的改动不影响其它层次。

这样可以方便的添加、修改、删除应用，提高系统的可维护性；管理系统采用图形化用户界面，方便管理员管理、维护系统；

2.1.2.4可扩展性

系统在设计之初要考虑到系统以后的扩展，除了采用层次结构，保证功能实现与通讯接口最大限度的独立，在与通信平台的接口设计上尽量标准化，以实现和新系统的无缝连接。

2.1.2.5安全性原则

系统的管理系统与维护系统设置了用户管理权限，采用帐号+操作日志作，对管理员采取有效的管理，最大限度降低内部管理、操作失误带来的不必要的损失。

2.1.2.6稳定性

在系统运行的稳定性方面，采用服务器自动重启动（ASR）技术，可在网络操作系统（NOS）挂起时自动重启服务器；

关键应用服务运行状态监听，发现异常情况通过电子邮件自动提醒管理员；

2.1.2.7数据完备性

根据不同的需要，可以对数据库采取实时热备份或定时备份的策略

2.1.3输入输出要求

输入：

一般为使用人员键盘输入，部分为外部文件导入输入。

输出：

一般为屏幕输出、打印输出，部分为文件输出。

2.1.4数据管理能力要求

数据管理能力要求能满足XX市是XXXX公司使用规模的数据处理需求，当前库大小约200MB~400MB，历史库800MB~1.2GB，归档库大小不限。

2.1.5故障处理要求

2.1.5.1硬件故障

客户端硬件故障：

一般性的计算机硬件故障,不能启动、硬件损坏，最好有备用机器。

通讯故障：

客户端与服务器无法通讯，导致局部业务暂停，应检查通讯线路及设置，保证网络通讯畅通。

服务器硬件故障：

web服务器站无法启动，导致办公业务暂停，应有备件或备机替代。

数据服务器硬件故障：

数据无法访问，业务暂停，应有备件或备机替代。

2.1.5.2软件故障

客户端应用程序故障：

部分业务处理不正常，应检查设置或ie等配套设置；

后台服务器故障：

部分业务处理不正常，应检查设置或更换配套程序。

2.1.6其他专门要求

出于系统安全性等考虑！

系统采用了128位非对称加密算法的加密密钥处理，同时采用手写签名方式，因此对于密钥和签名图像管理需要系统管理人员专门处理。

2.2运行环境

2.2.1设备

数据库服务器

奔腾三

内存128MB以上

硬盘9GB

100M网卡

应用服务器

奔腾三

内存128MB以上

硬盘4GB

100M网卡

网络配置

100M/10M

客户端

P-3600以上

内存128MB以上

硬盘1G以上

100M/10M网卡

2.2.2支持软件

服务器操作平台：

Windows2000/LINUX/UNIX/WindowsNT

Web服务器：

resin2.5/Apache

客户端：

IE4.0及以上

网络环境：

Intranet与Internet

支持协议：

TCP/IP、SMTP、POP3、HTTP、SSL

数据库：

ORACLE、SQLServer、SYBASE、INFORMIX、DB2

支撑环境：

JDK1.3及以上

开发工具：

JCreatorPro2.5、BorlandJBuilder9Enterprise

设计工具:

rose2003、Together6.1forJB

2.2.3接口

提供明确的业务规范和业务流程，给第三方内容提供商提供开放的平台，以便提供广泛的合作机会，最终将该系统建设成为一个综合业务平台；其中,工作流引擎和对用户的加密控制算法以及对外部异构系统的数据采集都有严格数据接口,具体:

数据传输采用tcp/ip协议，数据接口采用标准的sql语句连接异构数据库的方式。

2.2.4控制

本系统采用B/S体系架构，服务器采用RESIN2.5，运行只需在服务器端起动RESIN服务，客户端运行Ie浏览器，访问服务器端地址和端口。

即可运行。

所有的控制利用JAVA的多线程技术，实现对共享资源的一致性维护。

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

2.3.1总体流程描述

1.客户在登录界面，输入操作员号，密码后，提交。

2.客户有效性检查：

客户密码有效性检查，客户状态检查。

3.根据客户端提供的客户名称、口令，取出对应的加密后的口令，检查客户口令的正确性

4.若客户登录不合法，则返回客户登录不成功界面

5.若客户登录合法，进入客户登录后界面生成模块

6.进入客户登录后界面JSP，组织并生成客户登录后页面

7.根据客户在页面上的操作分别进入不同处理流程

8.客户点击具有下级菜单的菜单条目，则再进入客户登录后界面生成模块产生下级业务菜单界面。

9.客户点击通知信息条目，则在新窗口显示此通知信息内容

10.客户点击指向业务处理的菜单条目，则再进入客户选择业务列表界面，界面中显示客户所选菜单的经办行业务列表。

若该业务不存在业务列表，则立即进入相应的业务处理流程。

11.客户点击通知业务快捷键，则直接进入该业务的业务列表界面或相应业务处理流程。

客户点击业务列表中的业务条目，则进入相应业务处理流程

2.3.2模块的标准流程

2.3.3安全控制

2.3.4数据模型

2.3.5工作流管理

2.4结构

2.4.1日常管理

1、公文管理子系统包括对公司收文和发文进行的管理,以及对收文和发文进行相关查询；收文管理涵盖了传递、签收、登记、分发、拟办、承办、批办、归档等功能；发文管理涵盖了拟稿、核稿、审核、签发、校核、盖章、分发、归档等功能。

2、收文办理：

完成单位外来公文的登记、批阅、办理、归档、查询的全过程处理

3、发文办理：

完成单位内部和对外公文的拟稿、审稿、会签、审核、签发、复核、分发等处理。

4、文件管理：

把各种文档资料存放在网络服务器上的文件管理库中，或者存放在相应部门客户机的管理库中

5、文件借阅：

填写申请表格后提交给归档管理员，等待获得管理员授权。

查看借阅的文档。

6、文件归档：

将待归档文件和相关登记卡信息添加至待归档列表中，由当案管理员进行集中分类归档

7、档案查询：

用户可以在归档列表浏览或根据条件查询所有归档名称和归档信息，但只有拥有相应权限的用户才可以查看文件内容，未授权用户要进行借阅申请，等待归档管理员审核。

8、会议管理：

有权限的人起草会议计划，领导审核会议计划,向参加会议的人发出参加会议通知。

目标：

针对每个已经召开的会议进行会议纪要起草，会议纪要的审核，会议纪要的审批，会议纪要的分发，最后会议纪要的归档。

9、会议纪要：

由负责会议记录的管理员进行会议记录，会议记录也支持直接从相应的会议安排文档中产生，并继承“会议名称”、“会议分类”、“开会日期”、“开会时间”、“会议地点”等大多数字段内容。

10、会议统计：

按照自己设定的会议统计条件生成会议统计结果。

11、信访管理：

用于来信和访问的业务处理，完成来信和来访登记、信件查询、信访信息管理等工作。

12、手写签名：

将手写的签名以图片的形式实现手写签名的效果。

2.4.2企业文化管理

1、信息采编：

信息采编用于公司内部各部门的员工投稿、发布信息；

2、信息采编统计：

用于统计、汇总信息采编的各种数据;

3、电子刊物：

将信息采编的归档文稿、手工录入的文稿，以电子刊物用于进行对信息的编辑、出版和发行；

4、合理化建议：

用于工作人员根据单位或部门的情况、问题提出自己的建议，统计建议的采用度；

5、培训管理：

用于合理处理培训计划和培训内容的审批和实施；

6、培训记录：

用于统计、记录每次培训的各种信息；

7、奖励与考核：

用于对公司各部门及个人进行考核与奖励；

8、企业论坛：

做为单位内部员工一个交流的平台;

9、厂务公开：

用于将公司内部事务公开的一个通告栏；

10、领导信箱：

用于单位内部的各个部门及员工根据工作情况填写报告、报表等，提交给领导进行查看、浏览；

2.4.3资源管理

1、资源管理：

用于企事业单位常用的共享资源的使用过程（如：

会议室、车辆等）进行管理的系统；

2、资源信息查询：

通过占用资源、逾期未还资源、资源使用历史、资源查询方式来对资源状态查询管理；

3、车辆管理：

对车辆基本信息、里程加油、车辆维修的管理。

具有不同职务的人可以通过本模块对车辆予以管理；

4、车辆维修：

对车辆维修的申报、审批查询管理；

5、办公用品：

对库存办公用品和领用办公用品的入库和领用情况进行登记和管理，并能对所有办公用品进行复合查询，生成库存办公用品统计视图和领用办公用品统计视图；

6、办公用品库存：

对办公用品的购置、库存查询、删除、修改对库存的管理；

7、劳保用品管理：

对库存劳保用品和领用劳保用品的入库和领用情况进行登记和管理，并能对所有劳保用品进行复合查询，生成库存劳保用品统计视图和领用劳保用品统计视图；

8、劳保用品调拨：

对劳保用品的发放等的管理；

9、固定资产：

对固定资产的入库和出库的情况进行管理，并能根据数据库的记录自动生成库存情况视图、出库情况视图、类别情况视图、金额统计视图；

10、固定资产分配：

申请、审核、分配、查询固定资产。

2.4.4人事管理

1、人事信息：

对企业内部人员的基本信息，劳动合同的维护，职工信息的维护从而实现企业的人事资料库和管理库；

2、考勤管理：

通过对员工日常考勤表的维护；最终可以得到考勤统计；

3、电子贺卡：

通过对贺卡库的维护和发送规则的维护，最终可以自动或手动的将贺卡发送；

4、劳动合同：

对公司基本人员劳动合同的管理

5、综合查询：

根据各种条件查询人员信息、人员组成、考勤统计、劳动和同检索等信息

2.4.5个人事务管理

1、电子邮件：

对企业内部人员、外部邮箱管理，处理日常的邮件信息：

收邮件、发邮件、以发邮件、草稿管理、删除、垃圾箱管理、待发邮件、查询等管理；

2、日程安排：

添加日程安排、管理日程安排、查询日程安排；

3、通讯录：

对个人通讯录的新建、维护和查询；

4、口令修改：

对个人口令进行修改，对签名的维护。

2.4.6公共信息系统

1、通过信息管理人员对公用信息的内容、类别等的维护，将公用信息向全体员工展示；

2、部门内的信息管理员对本部门的信息内容、类别等的维护，将公用信息向奔部门员工展示；

3、可以查询出公用和部门的各种信息；

4、部门内的人员结构可以自己维护。

2.4.7计划管理

1、计划上报：

各部门将下月工作计划上报主管经理。

2、计划审批：

主管经理根据情况审批各部门所报计划，并转发到计划部。

3、计划下发：

计划部将各部门计划审核、平衡后下发到各部门。

4、目标管理：

计划部随时检查、督办上级下达的年度目标，以及完成情况。

5、计划考核公示：

各部门每月底将本月计划完成情况报到计划部，计划部考核汇总后公示。

2.4.8系统维护

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

[本条用一张矩阵图说明各项功能需求的实现同各模块的分配关系。

]

行政办公

邮件管理

档案管理

资产管理

会议管理

信息共享

控制面板

二次开发

日常办公

√

√

√

文化管理

√

资产管理

√

人事管理

√

个人事务

√

√

信息系统

√

√

计划管理

√

系统维护

√

2.6人工处理过程

各种表单填制等需要填制的信息.

2.7尚未解决的问题

[说明在概要设计过程中尚未解决而设计者认为在系统完成之前必须解决的各个问题。

]

3．接口设计

3.1用户接口

主要完成字符串、文件和目录操作、中文编码处理及其它操作等常用操作的实现。

调用说明

方式一：

bean方式，例：

useBeanscope=”page”id=”crypt”class=”JavaCrypt”>

<%

out.println（crypt.encrypt（"super","111","IDEA","ECB"））;

%>

方式二：

class方式，例：

System.out.println（JavaCrypt.encrypt（"super","111","IDEA","ECB"））;

方法名

返回值

参数

说明

PubFunc（）

无

无

构造函数

StaticparseInt（）

int

Stringstr

把字符串str转成整型，非整型字符转为0

StaticparseInt（）

int

Objectobj

把对象转成整型，非整型字符转为0，常用于转session的属性值

StatictoString（）

String

Objects

把对象转为字符串，空时转为””

Staticsplit（）

String[]

Stringsource,sign

source为分隔的串

sign为分隔符

用分隔符分隔字符串,返回分隔后的字符串数组列表

Staticunsplit（）

String

String[]source为分隔串列

Stringsign为分隔符

把分隔串列表用分隔符合并成字符串，常和split合用来实现多种分隔符的分隔

StaticisNumeric（）

boolean

Strings

是否为数字串

StaticdelConfItem（）

boolean

Stringconffile,item,value

删除配制文件中配制项匹配的记录

（配制文件读写）

StaticupdateConfItem（）

boolean

Stingconffile,condition,

item,value

修改配制项匹配的记录

（配制文件读写）

StaticaddConfItem（）

boolean

Stringconffile,item,value

增加配制项

（配制文件读写）

StaticaddEndLine（）

boolean

Stringconffile

增加结束分隔行（配制文件读写）

StaticgetConfList（）

Enumeration

Stringconffile,item

读配制文件中配制项的列表

（配制文件读写）

StaticreadConfItem（）

String

Stringconffile,condition,item

按条件读取配制项匹配的记录值

（配制文件读写）

StaticreadConf（）

String

Stringconffile,item

读配制文件的项的值

（属性配制文件读写）

StaticwriteConf（）

boolean

Stringconffile,item,value

写配制文件的项

（属性配制文件读写）

StaticreadFile（）

String

Stringfilename

读取文本文件的内容，返回内容字符串

StaticfileExists（）

boolean

Stringfilename

文件是否存在

StaticfolderExists（）

boolean

Stringpathname

目录是否存在

StaticdeleteFile（）

boolean

Stringfilename

删除指定的文件

StaticdeleteFileEx（）

boolean

Stringfileorpath

删除指定的文件或空目录

StaticdeletePath（）

boolean

Stringpathname

删除指定的目录和目录下文件（一级目录）

StaticdeleteTree（）

boolean

Stringpathname

删除指定的目录及所有的子目录

StaticmoveFile（）

boolean

Stringsource,desc

移动文件或目录（sfilename）到目标文件或目录（dfilename）

StaticcopyFile（）

boolean

Stringsource,desc

复制文件或目录到目标文件或目录

StaticcreateFile（）

boolean

Stringfilename

创建空文件

Staticmkdir（）

boolean

Stringpathname

创建目录

Staticmkdirs（）

boolean

Stringpathname

创建目录（含上级及上上级等目录一同创建）

StaticgetFileName（）

String

StringfilePathName

取文件全称的不含路径的文件名

StaticgetFileExt（）

String

StringfilePathName

取文件名的扩展名

StaticgetFileSize（）

String

StringfilePathName

取物理文件的文件大小

StaticgetFilePath（）

String

StringfilePathName

取文件全称的中路径

StaticinStr（）

boolean

Stringsource,desc

判断字串desc是否存在于source，存在则返回true,不存在返回false

Staticcelling（）

int

inta,b

取两整数相除最大值

Staticmod（）

int

inta,b

取余数

StaticencodeGB（）

String

Stringsource,charset

字符串内码转换-用于写入数据库时

StaticencodeGB（）

String

Stringsource

字符串内码转换-用于写入数据库时（用默认ISO-8859-1）

StaticdecodeGB（）

String

Stringsource,charset

字符串内码转换---用于从数据库读取数据时

StaticdecodeGB（）

String

Stringsource

字符串内码转换---用于从数据库读取数据时（用默认ISO-8859-1）

StaticurlEncode（）

String

Stringsource

URL编码

StaticurlDecode（）

String

Stringsource

URL解码

StatictoHtmlStr（）

String

Strings

字符串转换为HTML格式用来显示，即'&'转为&''转为 '"'转为"'<'转为<'>'转为>

StaticnullT