《应用软件概要设计说明书.docx》由会员分享，可在线阅读，更多相关《应用软件概要设计说明书.docx（22页珍藏版）》请在三一办公上搜索。
1、卷号卷内编号密级应用软件概要设计说明书项目名称：部门级文档管理系统项目编号：编写人员：编写日期：审批人员：审批日期：历史修改记录版本号修改人/日期摘要审定人/日期目录1引言51.1编写日的51.1.1 目的51.1.2文档预期读者51.2背景51.3术语定义51.4参考资料。52总体设计52.1软件体系结构52.2运行环境62.3设计概念和处理流程62.3.1服务器端62.3.2客户端72.4软件结构82.4.1系统功能与程序（模块）的关系92.4.2人工处理过程103接口设计103.1用户接口。103.1.1客户端操作103.1.2服务器端操作103.2外部接口。103.2.1磁盘操作103
2、.2.2数据库操作103.3内部接口。103.3.1 通信103.3.2 加密103.3.3数据处理104数据结构设计114.1逻辑结构设计要点114.2物理结构设计要点114.2.1 Popedom114.2.2 Organize114.2.3 User_Type124.2.4 Path124.2.5 UserInfo124.2.6 Document_Electron134.2.7 Document_Bunf144.2.8 Log144.2.9 Data_Backup144.2.10 Templet154.2.11模板表155用户界面设计155.1服务器端155.1.1主界面155.1.2配
3、置窗体155.1.3数据库连接向导155.1.4日志窗体165.1.5计划备份窗体165.1.6备份还原窗体165.2客户端165.2.1登录窗165.2.2配置连接对话窗165.2.3主界面165.2.4系统栏图标与悬浮窗体166系统出错处理设计166.1出错信息166.2出错处理措施177系统维护设计178尚未解决的问题171引言1.1编写目的1.1.1目的描述部门级文档管理系统的概要设计。1.1.2文档预期读者项目经理、系统分析员、研发经理、测试经理、项目组长、系统开发人员。1.2背景软件系统名称：部门级文档管理系统。1.3术语定义序号名称全称定义1CMAINFORMCUSTOMMAIN
4、FROM客户端界面模块2DOPERATEDOCUMENTOPERATE文档操作模块3DBManageDataBaseManage数据库管理模块4ORManageOrgnizeManage组织管理模块5LICENSEMANAGELICENSEMANAGE权限管理模块6UserLoginUserLogin用户登录模块7DMCSocketDataMessageCustomSocket客户端数据通信模块8DMCIFOOperateDocumentManageClientInfomationOperate通信信息处理模块客户 端。9XMLOperateXMLOperateXML操作模块10DMSSock
5、etDataMessageSocket服务器端数据通信模块11RWDocumentReadWriteDocument读写文档模块12DataSecurityDataSecurity数据安全模块13ValiDateldentityValiDateldentity用户验证14DMSIFOOperateDocumentManageServerInfomationOperate通信信息处理模块服务 器端。15DBOperateDataBaseOperate数据库操作模块16LogManageLogManage日志管理模块17SMainFormServerMainForm服务器端界面模块1.4参考资料。
6、2总体设计2.1软件体系结构本软件采用C/S三层架构，管理和控制在服务器端进行，数据由客户端编码、 加密后送到服务器，服务器将数据写入存储设备。2.2运行环境服务器端 Pentium III 600MHz_ 256MB RAM Windows 2000/NT 4.0 Server IE 5磁盘设备空间10G支持最多2500个客户端，并发最多支持500个客户端 客户端：要求支持 Windows XP Windows 2000 Professional Windows NT 4.0 工作站 Windows Me/98/95 IE 52.3设计概念和处理流程2.3.1服务器端Y件读写铲imlu源脂
7、/ =- =：=：e:：lend = ：=- -Include2.3.2客户端日志记录查看=：=： include：-：-=：-=：in cl ude：=-：=-=：数将备价与导出-=：=： include：-：-=： =： in clude ：=：=：-=：include：=：=说明本系统的基本设计概念和处理流程，尽量使用图表的形式。用一览表及框图的形式说明本系统的系统元素（各层模块、子程序、公用程序等） 的划分，扼要说明每个系统元素的标识符和功能，分层次地给出各元素之间的控制与被 控制关系2.4.1系统功能与程序（模块）的关系对照参考表代号名称程序1CMAINFORM程序2DOPERATE
8、程序3DBManage程序4ORManage程序5LICENSEMANAGE程序6UserLogin程序7DMCSocket程序8DMCIFOOperate程序9DataSecurity程序10XMLOperate程序11DMSSocket程序12RWDocument程序13ValiDateldentify程序14DMSIFOOperate程序15DBOperate程序16LogManage程序17SMainForm本条用一张如下的矩阵图说明各项功能需求的实现同各块程序的分配关系:程序1程序2程 序3程序4程序5程序6程序7程 序8程序9程序10程序11程序12程 序13程序14程 序15程序
9、16程序17文档管理VVVVVVVVVVVV组织管理VVVVVVVVVV权 限 管 理VVVVVVVVVVVV系统VVVVVVVVVV2.4.2人工处理过程无3接口设计3.1用户接口。3.1.1客户端操作提供客户端登录界面，允许合法用户进行文档管理、组织管理以及模板得 管理。3.1.2服务器端操作提供服务器端登录界面，允许管理员用户进行权限管理、系统管理、日志 管理3.2外部接口。3.2.1磁盘操作按照用户要求，对指定文件在服务器磁盘上进行指定操作。3.2.2数据库操作按照用户要求，在服务器数据库上进行相应的操作。3.3内部接口。3.3.1通信负责系统内部客户端和服务器端组件之间的消息传递，保
10、证传送目的的正 确性和消息的完整性。3.3.2加密在客户端将要传递到服务器端的消息加密，提供数据安全。在服务器端对接受到的客户端消息解密，以供其他功能模块调用。3.3.3数据处理在客户端将需要传递到服务器端的消息以XML形式格式化，同时在服务器 端将XML消息解析为所需要的字符格式。4数据结构设计4.1逻辑结构设计要点Duciu men t_E led t- runPK.Document Electron IdFK1DocuiDcnt_NamcDocuiDcnt_Crcato_TiiDCDocument Change TimoDocuincnt_SizcDocuincnt_Edit ionUs
11、cr_Info_IdRemarkUser_lnfoPKUserr Tnfo TdFK1FK2FI3User NamePass WordDi sk Space SumDisk Space OverplusOrganize_Td UserType.Id Popedom Td RemarkOrganizePKOrganize TdOrganise Name Up Organize Td RemarkL*PKL睥TdFK1FK2FK：!FK4Handle TdLog.TineUser TnftjTdDaeument Flee屯toh Td Daciifnent Bumf Td Operate Stat
12、ic RemarkUser TypoPKUser Ty* IdUser_Type_Name RemarkHandlePKHandle IdBandle_Name KemarkDocuincnt_BuiiifPKDocument Bumf Id咔Doc umeiit_N st im?Doc utnent_N umber DocuiierLt_T ime Usr?r Iriln Id RemtirkPopedomPKPopedom IdPcpcdQiD_NamcRemarkPathPKPath IdPathRemarkBackupPKBackup IdIJ&Tckup_KMnie BackupPa
13、th Kemark4.2物理结构设计要点4.2.1 Popedom【中文含义】权限表字段名称数据类型及长度允许为空中文说明备注Popedom_IdintNO权限ID主键Popedom_Namevarchar(100)NO权限名称Remarkvarchar(1000)YES备注【字段说明】Popedom_Id1完全控制权限2修改权限（读写权限，无法删除文件）3读权限（读文件权限，无法删除修改）-1超级系统管理员的专用权限，不能对文件进行操作。注：数据字典，根据权限来对文件进行操作，只权限只对应对文件的操作，不对应基 础信息管理（系统管理员）。4.2.2 Organize【中文含义】组织表字段名称
14、数据类型及长度允许为空中文说明备注Organize_IdintNO组织ID主键Organize_Namevarchar(100)NO组织名称Up_Organize_IdintNO上级组织ID外键RemarkVarchar(1000)YES备注注：数据字典。包括了每个组织的上级组织的信息，如果是最高级组织，上级则为自己，其他必须填写上级。4.2.3 User_Type【中文含义】组织表字段名称数据类型及长度允许为空中文说明备注User_Type_IdintNO用户类型ID主键User_Type_Namevarchar(100)NO用户类型名称RemarkVarchar(1000)YES备注【字段
15、说明】User_Type_Id1系统管理员（管理组织和用户）2普通用户（只能对自己的组内的文档按自己的权 限进行操作）3超级用户（能对所有组的文档按自己的权限进行 操作）注：数据字典。如果是系统管理员就专门负责对基础数据进行维护，如果是普通用户就只能对 自己的组织的文件按照自己相应的权限进行操作，如果是超级用户就能对所有的文件按 照自己相应的权限进行操作。4.2.4 Path【中文含义】路径表字段名称数据类型及长度允许为空中文说明备注Path_IdintNO路径ID主键，自动增1Pathvarchar(500)NO路径RemarkVarchar(1000)YES备注注：服务器上存放文件的路径，
16、用户上传文件全部放到Path这个路径下。4.2.5 User_Info【中文含义】用户信息表字段名称数据类型及长度允许为空中文说明备注User_Info_Idvarchar(100)NO用户ID主键User_Namevarchar(100)NO用户姓名Pass_Wordvarchar(100)NO登陆密码Disk_Space_SumbigintNO最大上传空间Disk_Space_Ove rplusbigintNO剩余上传空间Organize_IdintYES组织ID外键User_Type_IdintNO用户类型外健Popedom_IdintNO权限ID外健Remarkvarchar(1000
17、)YES备注【字段说明】默认添加2条记录，用户类别分别为系统管理员和超级用户。系统管理员：User_Info_IdSystemUser_NameSystemPass_WordSystemDisk_Space_Sum-1Disk_Space_Overplus-1Organize_IdNULLUser_Type_Id1Popedom_Id-1超级用户:User_Info_IdAdminUser_NameAdminPass_WordAdminDisk_Space_Sum10000Disk_Space_Overplus10000Organize_IdNULLUser_Type_Id3Popedom_I
18、d1注：UserInfoId用来和外部连接，做为别的表的外键和唯一标识符，是登陆帐号。并且规定了最大上传空间和剩余上传空间，建立用户时必须规定该用户最大的上 传空间（累积），当用户上传了数据时，剩余空间减少，标识用户类型和用户对文件管理 的权限（如果是系统管理员权限就为-1,不能对任何文件进行操作）。4.2.6 Document_Electron【中文含义】文档信息表电子版字段名称数据类型及长度允许为空中文说明备注Document_Elect ron_Idvarchar(100)NO文档ID主键Document_Namevarchar(100)NO文档名称Document_Creat e_Ti
19、medatetimeNO创建文档日期Document_Chang e_TimedatetimeYES文档修改时间Document_SizeintNO文档大小Document_Editivarchar(100)NO文挡版本onUser_Info_Idvarchar(100)NO用户ID外键Remarkvarchar(1000)YES备注Templet_IdintYES模板ID外健注：电子版文档，上传了文件后，在此表记录该文件的文件名，上传日期，文件大小,文件版本，以及是谁上传的。如果对文件进行修改后,记录最后修改时间。4.2.7 Document_Bunf【中文含义】文档信息表纸张版字段名称数据
20、类型及长度允许为空中文说明备注Document_Bunf_I dvarchar(100)NO文档ID主键Document_Namevarchar(100)NO文档名称Document_NumberintNO文档编号Document_TimedatetimeNO创建文档日期User_Info_Idvarchar(100)YES用户ID外键Remarkvarchar(1000)YES备注Templet_IdintYES模板ID外健注：纸张版文档,记录文挡的存放信息，以便需要时可以进行查询，找到文档编号 员工可以根据文挡编号快速找到文档所存放的位置。4.2.8 Log【中文含义】日志信息表字段名称数
21、据类型及长度允许为空中文说明备注Log_IdintNO日志ID主键，自动增1Handlevarchar(200)NO操作名称Log_TimedatetimeNO操作日期User_Namevarchar(100)NO用户名Document_Electr on_Namevarchar(100)YES电子文档名Document_Bunf_N amevarchar(100)YES纸张文档名Operate_StaticbitNO操作是否成功Remarkvarchar(1000)YES备注注：记录用户对软件的操作，当用户进行了任何操作时,在此表记录该用户什么时间 对哪个文档进行了什么操作。如果操作的是电子
22、文档，Document_Bunf_Name（纸张文档） 就为空，如果操作的是纸张文档，Document_Electron_Name（电子文档）就为空。Operate _Static判断用户操作是否成功,0代表失败,1代表成功。4.2.9 Data_Backup【中文含义】备份表字段名称数据类型及长度允许为空中文说明备注Backup_IdintNO备份ID主键，自动增1Backup_Namevarchar(100)NO备份名称Backup_Pathvarchar(500)NO备份路径Remarkvarchar(1000)YES备注注:记录对数据的备份以及信息。4.2.10 Templet【中文含
23、义】模板名称表字段名称数据类型及长度允许为空中文说明备注Templet_IdintNO模板名ID主键Templet_Namevarchar(100)NO模板名称Templet_Create_TimedatetimeNO模板创建时间注:记录用户自定义模板表的名称。用户添加一个模板，在该表插入模板名，以及创建时间。4.2.11模板表【中文含义】模板表字段名称数据类型及长度允许为空中文说明备注IdintNO模板ID主键Document_Electr on_Idvarchar(100)YES电子文档ID外键Document_Bunf_I dvarchar(100)YES纸质文档ID外键注：用户自定义模
24、板的属性由于其不确定性，在此没有列出。5用户界面设计5.1服务器端5.1.1主界面以按钮形式控制服务的开、关；以单选框控制程序开机自动运行选项（注 册表操作）；再单独的文本框中显示当前连接数量。主程序拥有一个系统栏图标， 使用系统栏图标右键控制菜单使用其它功能。5.1.2配置窗体以文本框输入、按钮确认的方式修改文件服务器的上行（对数据库）、下 行（对客户端）连接；拥有一个按钮打开数据库连接向导。5.1.3数据库连接向导以文本框输入、按钮确认的方式修改数据库连接，并提供连接失败判断 提示。5.1.4日志窗体使用主界面的系统栏图标右键菜单打开日志窗口；使用COMBO选择过滤 显示日志。5.1.5计
25、划备份窗体使用主界面的系统栏图标右键菜单打开。使用单选框选择按月、周、日 进行自动备份操作5.1.6备份还原窗体使用主界面的系统栏图标右键菜单打开。使用列表框显示所有可用备份， 点击还原按钮还原，或删除按钮删除。5.2客户端5.2.1登录窗用户输入帐号、密码，点击确定进行登录；点击取消退出程序。5.2.2配置连接对话窗配置与文件服务器的连接，输入端口号和服务器端地址。当程序启动无法 正常连接或用户手工操作时打开该对话窗。5.2.3主界面所有功能的载体，使用标签卡形式对上传（入库）、下载、组织与人员进 行管理。5.2.4系统栏图标与悬浮窗体主界面由该窗体生成实例，悬浮窗体与系统栏图标拥有相同的右
26、键菜单， 控制整个程序。6系统出错处理设计6.1出错信息输出形式输出值含义处理方法int1011连接字符串错误正确定义连接字符串int1012连接串为空正确定义连接字符串int1013数据库连接错误正确定义连接字符串，并确认数据库正常int102 1查询SQL语句错误正确定义SQL语句int102 2SQL语句为空正确定义SQL语句七int1031操作SQL语句错误正确定义SQL语句int1032SQL语句为空，数据库未 打开正确定义SQL语句，打开数 据库int1041数据库关闭错误正常关闭数据库int5501指定路径的客户端文件 不存在重新指定文件路径int5502向客户端写入文件失败重新指定文件int5504在服务器上写的指定路径的文件失败确认文件或路径是否正确int5505在服务器上的指定路径 的文件不存在重新指定文件int5506删除服务器上的文件失 败确认文件或路径是否正确int5001信息查询失败确认查询的信息有效int7001数据加密错误确认加密程序正确int7002数据解密错误确认解密程序正确6.2出错处理措施捕获错误，返回错误代号，通过专门的错误信息类，将错误反映给用户看。7系统维护设计系统管理模块提供数据备份、导出和恢复功能。8尚未解决的问题无
