文档管理系统概要设计说明书-企业文档管理系统

1、精选优质文档-倾情为你奉上文档编号：EDMS -XT-0003企业文档管理系统项目系统设计说明书 第七 小组2012年04月专心-专注-专业修改记录版本变更原因变更内容简述编制/修订者批准者发布日期V1创建开始书写胡昶 王一然胡建飞 程金星陈正茂2012/4V2不合要求删改部分内容胡昶 王一然胡建飞 程金星陈正茂2012/4V3不全面添加部分内容胡昶 王一然胡建飞 程金星陈正茂2012/4V4不全面添加部分内容胡昶 王一然胡建飞 程金星陈正茂2012/4目 录1 引言目前，大多数文档管理系统在实现了企业各部门日常文档管理的基本功能之外，还增加了很多的新功能以满足文档管理电子化、标准化的新要求；

2、功能强大的档案查询模块，大大方便了管理者日常文档的查找工作，解决了传统管理中查找困难、查找耗时等问题。使用现代化的文档管理系统满足了企业“无纸化”办公需求的要求，实现了通过计算机对文档管理全程跟踪的目标。1.1 编写目的本系统设计说明书用于描述“企业文档管理系统”项目的整体系统设计方案，本说明书以用户需求说明书和系统需求规格说明书作为依据，本说明书是系统详细设计的依据，也作为系统测试需求和系统测试计划和测试程序的重要参考。本用户需求说明书的阅读对象为：项目经理，开发工程师，测试工程师，CM工程师，QA工程师，MA工程师。1.2 项目背景项目委托单位：XXXX公司项目开发单位：四川大学计算机学院

3、项目主管单位：四川大学计算机学院产品面向用户：大、中、小型企业1.3 定义 为了便于阅读理解本文，在此解释一些在本文中用到的简写和专业术语：企业文档管理系统以下简称CSCI。 SQL: 数据库结构化查询语言 Windows: 美国微软公司的操作系统, 网络操作系统 SQL SERVER: 系统服务器所使用的数据库管理系统（DBMS）。1.4 参考资料： 文档管理系统项目系统需求规格说明书，本开发小组 2012年3月； 仓库管理系统概要设计张三2010年11月。2 条件与限制本系统的数据库需要安装在公司内部联网的服务器上，其客户端可以安装在个人PC上，通过互联网连接到数据库中，并且将公司的文档上

4、传到服务器中实现共享，除系统管理员外其他人员不需要专业的计算机知识，普通用户即可方便的使用3 需求规定l 系统应能实现不同区域内的文件传输，将文档上传到公司服务器中l 系统能实现对于上传文档信息的添加、分类、修改，为其安全性提供保障，记录其更改历史l 系统应具备数据的恢复和备份功能l 系统应具备用户分级权限文档查阅功能，并记录用户的操作历史；l 系统应提供文档的浏览，内容修改功能；l 详细需求参见系统需求规格说明书4 运行环境4.1 硬件环境普通的服务器和个人电脑联网即可4.2 软件环境PC操作系统：win 2000/Xp/7数据库：SQL Server 2005/20085 体系架构5.1

5、系统结构图5.1-1 系统总体物理结构图硬件：系统由多个用户终端、数据库服务器和文档服务器组成。用户终端即用户的计算机，用户可以在用户终端计算机上安装使用本软件；数据库服务器由运行在局域网中的多台计算机和数据库管理系统软件共同构成，为客户应用提供查询、更新、事务管理、索引、高速缓存、查询优化、安全及多用户存取控制等服务；文件服务器运行在计算机局域网中，由多台主机和硬盘构成，实现文档存储、文件数据共享等功能。5.2 软件架构图5.1-2 系统总体软件结构图一、 客户端客户端由多个登陆窗体、管理员管理窗体、系统主窗体以及多个功能子窗体构成。1、 登陆窗体用于用户登陆本系统2、 管理员管理窗体用于系

6、统管理员实现对本系统信息、数据库的管理和调整3、 主窗体是用户使用该系统的入口，用户可以根据自己需求通过主窗体选择自己所需要使用的功能。4、 功能子窗体是实现用户所需使用功能的操作界面二、 数据库数据库由用户表、员工表、文档表等多个表构成1、 用户表，用于存储用户注册信息和验证用户登陆信息的表2、 部门表，用户存储公司或企业各个部门的信息3、 员工表，用于记录公司或企业员工信息的表4、 文档表，用于记录文档信息并实现分类分组的表6 逻辑结构设计图6-1 系统顶层软件结构图图6-2 CSCI-3用户管理模块分解图6.1 CSCI列表表6.1-1 全系统CSCI列表企业文档管理系统模块名称、标识功

7、能简述CSCI-1 用户界面提供系统与用户之间的交互功能CSCI-2管理员管理提供管理员的操作功能CSCI-3用户管理提供用户的操作功能CSCI-4日志管理记录当前用户的操作CSCI-5数据库管理提供与数据库之间的交互功能6.2 CSCI关系图参见图6-1。6.3 CSCI-1 用户界面6.3.1 模块名称用户界面6.3.2 功能描述负责与用户之间的交互。包括用户注册、用户登陆、管理员管理、用户管理、日志管理以及数据库管理等界面组成。根据用户的类型和操作类型提供不同的界面。 本CSCI和其他CSCI的关系图如图6.3.2-1图6.3.2-1 CSCI-1 用户界面包外部关系图6.3.3 接口描

8、述6.3.3.1 输入接口l void ReceiveLoginCheckInfo(bool loginResult，string errInfo)输入条件：登录时参数定义：bool loginResult，登陆验证结果；errInfo，错误信息输入方式：函数调用l void ReceiveRegCheckInfo(bool regResult，string errInfo)输入条件：注册时参数定义：bool regResult，注册验证结果；errInfo，错误信息输入方式：函数调用l void ReceiveCPFBInfo(bool result，string errInfo)输入条件：

9、修改密码参数定义：bool result，修改密码验证结果；errInfo，错误信息输入方式：函数调用l void ReceiveAddFBInfo(bool result，string errInfo)输入条件：添加文档参数定义：bool result，添加文档的验证结果；errInfo，错误信息输入方式：函数调用l void ReceiveDocPreInfo(List docPreInfo)输入条件：修改文档信息参数定义： List docPreInfo，文档原信息输入方式：函数调用l void ReceiveAlterFBInfo(bool result，string errInfo)

10、输入条件：修改文档信息参数定义：bool result，修改文档信息的验证结果；errInfo，错误信息输入方式：函数调用l void ReceiveDocPath(string docPath)输入条件：添加文档参数定义： string docPath，文档路径输入方式：函数调用l void ReceiveContAterFBinfo(bool result，string errInfo)输入条件：修改文档后上传到服务器参数定义：bool result，上传的验证结果；string errInfo，错误信息输入方式：函数调用l void ReceiveDocDelFBInfo(bool re

11、sult，string errInfo)输入条件：删除文档参数定义：bool result，删除文档的验证结果；string errInfo输入方式：函数调用l void ReceiveSearchResult(bool result，List docInfo) 输入条件：查询文档参数定义：bool result，查询文档的验证结果，List docInfo文档信息输入方式：函数调用l void ReceiveDisInfo(List category,List docInfo)输入条件：主界面初始化及添加等操作结束后参数定义：List category，文档类别；List docInfo文档

12、信息输入方式：函数调用l void ReceiveAboutDocInfo(List docInfo)输入条件：点击文档类别节点参数定义： List docInfo文档信息输入方式：函数调用l void ReceiveDocLog(List logInfo)输入条件：点击某文档时参数定义：List category，文档类别；List docInfo文档信息输入方式：函数调用6.3.3.2 输出接口l void SendLoginInfo ( )输出条件：登录时参数定义：无输出方式：函数调用l void SendRegInfo( )输出条件：注册时参数定义：无输出方式：函数调用l void S

13、endChangePWDInfo( )输出条件：修改密码时参数定义：无输出方式：函数调用l void SendAdminInfo( )输出条件：管理员初始化系统时参数定义：无输出方式：函数调用l void SendAddDocInfo( )输出条件：管理员初始化系统时参数定义：无输出方式：函数调用l void SendDocAlterInfo( )输出条件：修改文档信息时参数定义：无输出方式：函数调用l void SendDocName( )输出条件：浏览等文件操作时参数定义：无输出方式：函数调用l void SendScanOperate( )输出条件：浏览文件时参数定义：无输出方式：函数调

14、用l void SendDocDelName()输出条件：删除文件时参数定义：无输出方式：函数调用l void SendDocKeyword()输出条件：查询等文件操作时参数定义：无输出方式：函数调用l void SendCateName()输出条件：查询等文件操作时参数定义：无输出方式：函数调用l void SendDocLogName()输出条件：查询日志时参数定义：无输出方式：函数调用6.3.4 流程描述无6.4 CSCI-2 管理员管理6.4.1 模块名称管理员管理6.4.2 功能描述实现管理员操作功能，如系统的初始化，数据库的备份、恢复本CSCI和其他CSCI的关系图如图6.4.2-

15、16.4.3 接口描述6.4.3.1 输入接口l public AdministratorManage( )输入条件：需要使用管理员功能时参数定义：无输入方式：函数调用 l public bool InsertEmployee(string employeeID ,string employeeName,string officeName,string teleNum,string employeeGrade,string address,string memo )输入条件：添加员工信息参数定义：string employeeID ，员工的编号；string employeeName，员工姓名

16、；string officeName ，员工所属部门的名称；string teleNum 员工的联系方式，电话号码；employeeGrade ：string 员工级别；address：string 员工的住址；memo：string 员工的备注输入方式：函数调用l public bool UpdateEmployee(string employeeName,string officeName,string teleNum,string EmployeeGrade,string address,string memo )输入条件：修改员工信息参数定义：同上InsertEmployee的同名参数

17、输入方式：函数调用l public bool DeleteEmployee（string employeeID）输入条件：删除员工信息参数定义：同上InsertEmployee的同名参数输入方式：函数调用l public void QueryEmployee(string employeeID)输入条件：修改员工信息参数定义：同上InsertEmployee的同名参数输入方式：函数调用l public bool InsertOffice(string officeID,string officeName,string teleNum,string address,string memo)输入条

18、件：添加部门信息参数定义： officeID：string 部门的编号；officeName：string 部门的名称；teleNum：string 部门的电话；address：string 部门地址；memo：string 部门备注输入方式：函数调用l public bool UpdateOffice(string teleNum, string address,string memo )输入条件：修改部门信息参数定义：同上InsertOffice的同名参数输入方式：函数调用l public bool DeleteOffice（string officeName）输入条件：删除部门信息参数定

19、义：同上InsertOffice的同名参数输入方式：函数调用l public void QueryOffice(string officeName)输入条件：查询部门信息参数定义：同上InsertOffice的同名参数输入方式：函数调用l public bool InsertCategory(string categoryID,string catagoryName,string officeID,string memo)输入条件：添加类别信息参数定义：categoryID：string 类别编号；catagoryName：string 类别名称；officeID：string 类别所属部门；

20、memo：string 备注输入方式：函数调用l public bool UpdateCategory ( string categoryName,string officeName,string memo )输入条件：修改类别信息参数定义：同上InsertCategory的同名参数输入方式：函数调用l public bool DeleteCategory（string categoryName,string officeName）输入条件：删除类别信息参数定义：同上InsertCategory的同名参数输入方式：函数调用l public void QueryCategory(string C

21、ategoryName,string officeName)输入条件：查询类别信息参数定义：同上InsertCategory的同名参数输入方式：函数调用l public bool RequestBackup ( )输入条件：备份数据库参数定义：无输入方式：函数调用l public bool RequestRecover (string logTime )输入条件：恢复数据库参数定义：string logTime，某一时刻输入方式：函数调用6.4.3.2 输出接口l public OfficeInfo ( )输出条件：修改部门信息参数定义：无输入方式：函数调用l public bool Inse

22、rtOfficeInfo (List columnName,List sql)输出条件：添加部门信息参数定义：columnName：List 表示插入值的列名集合；sql：List 表示插入值的集合输出方式：函数调用l public bool UpdateOfficeInfo (List columnName,List sql)输出条件：修改部门信息参数定义：columnName：List其中包含两个部分，以“0 0 0 0”为分割点，之前为将要修改行的标识列名（如主键等），之后为修改行的列名（即属性名）；sql：List 其中包含两个部分，以“0 0 0 0”为分割点，之前为将要修改行的标识

23、列的值，之后为修改行之后的值输出方式：函数调用l public bool DelelteOfficeInfo (List columnName,List sql)输出条件：删除部门信息参数定义：columnName：List 表示插入值的列名集合；sql：List 表示插入值的集合输出方式：函数调用l public void QueryOfficeInfo (List columnName1,ListcolumnName2,List sql)输出条件：查询部门信息参数定义：columnName1：List要查询行的标识列名（如主键等）；columnName2：要返回值的列名；sql：标识行的值

24、输出方式：函数调用l public EmployeeInfo( )l public bool InsertEmployeeInfo(List columnName,List sql)l public bool UpdateEmployeeInfo (List columnName,List sql)l public bool DelelteEmployeeInfo (List columnName,List sql)l public void QueryEmployeeInfo (List columnName1,ListcolumnName2,List sql) /以上函数与之前输出接口相似

25、l public CategoryInfo ( )l public bool InsertCategoryInfo (List columnName,List sql)l public bool UpdateCategoryInfo (List columnName,List sql)l public bool DelelteCategoryInfo (List columnName,List sql)l public void QueryCategoryInfo (List columnName1,ListcolumnName2,List sql)/以上函数与之前输出接口相似6.4.4 流程

26、描述 图6.4.4-1 添加部门活动图 图6.4.4-2删除部门活动图 图6.4.4-3 添加员工活动图 图6.4.4-4 删除员工活动图 图6.4.4-5备份数据库 图6.4.4-6 还原数据库6.5 CSCI-3 用户管理6.5.1 通信6.5.1.1 模块名称通信6.5.1.2 功能描述用于用户端与服务器端之间的通信,同时负责用户的登陆和注册。6.5.1.3 接口描述6.5.1.3.1 输入接口l void ReceiveLoginMessage (string username,string usrepassword)输入条件：用户登录定义：string username 用户名 st

27、ring usrepassword用户密码输出方式：函数调用l void ReceiveRegMessage (string username,string password,string rePassword,string employId)输入条件：用户注册定义：string username 用户名 string usrepassword用户密码 string rePassword 重复密码 string employId 员工编号输出方式：函数调用l void ReceiveChangePWDMessage (string userName,string prePwd,string n

28、ewPwd,string reNewPwd)输入条件：修改密码定义：string userName 用户名 string prePwd 用户旧密码 string newPwd 新密码 string reNewPwd 重复新密码输出方式：函数调用l void ReceiveAddDocMessage(ListaddDocInfo)输入条件：添加文档定义：ListaddDocInfo 文档相关信息输出方式：函数调用l void ReceiveAddFBMessage (bool result,string errInfo)输入条件：添加文档反馈信息定义：bool result 添加结果 strin

29、g errInfo 错误信息输出方式：函数调用l void ReceiveDocAlterMessage (ListdocAlterInfo)输入条件：修改文档定义：ListdocAlterInfo 文档信息输出方式：函数调用l void ReceiveDocName (string docName,string docNo)输入条件：浏览文档定义：string docName 文档名 string docNo 文档编号输出方式：函数调用l void ReceiveScanOperate (int uScanOperate)输入条件：浏览文档定义：int uScanOperate 相应操作对应

30、的编号输出方式：函数调用l void ReceiveDocDelName (string docName，string docNo)输入条件：删除文档定义：string docName 文档名 string docNo 文档编号输出方式：函数调用l void ReceiveDocDelFBMessage ()输入条件：传递删除信息定义：bool true 删除成功 bool false 删除失败 string errInfo 错误信息输出方式：函数调用l void ReceiveDocKeyword (string keyWord)输入条件：关键字查询定义：string keyWord 关键字

31、输出方式：函数调用6.5.1.3.2 输出接口l string SendLoginCheckMessage ()输入条件：用户登录定义：无输出方式：函数调用l string SendRenMessage ()输入条件：用户注册 定义：bool true ：注册成功 bool false ：注册失败 string errInfo 错误信息输出方式：函数调用l string SendCPFBMessage ()输入条件：修改信息定义：bool true 修改成功 bool false 修改失败输出方式：函数调用l string SendDocPreMessage ()输入条件：修改文档定义：boo

32、l true 修改成功 bool false 修改失败 string errInfo 错误信息输出方式：函数调用l string SendDocPath ()输入条件：传递文档定义：string docPath 文档路径输出方式：函数调用l string SendContAterFBMessage ()输入条件：传递修改信息 定义：bool true 修改成功 bool false 修改失败 string errInfo 显示错误信息输出方式：函数调用l string SendSearchResult (int result ，ListdocInfo)输入条件：关键字查询 定义：int res

33、ult 查询结果 ListdocInfo 文档信息输出方式：函数调用 图6.5.1.4-1上传文件用例图 6.5.1.4-2 下载文件用例图图6.5.1.4-3注册用例图 6.5.1.4-4 登陆用例图6.5.2 文件操作6.5.2.1 模块名称文件操作6.5.2.2 功能描述用于用户对文件的操作，如，文件浏览、添加、修改、删除，上传文件，文件信息浏览、修改等主要功能。6.5.2.3 接口描述6.5.2.3.1 输入接口l void ViewDocument(string uriString)输入条件：浏览文档时调用该功能定义：string uriString，表示服务器文件夹路径输出方式：函

34、数调用l void AddDocument(string filename)输入条件：添加文档时使用该功能定义：string filename，文档名称输出方式：函数调用l void UpdateFileContent(string filename,string fileId)输入条件：修改文档内容时使用该功能定义：string filename，文档名称 string fileId，文档的编号输出方式：函数调用l void DeleteFile(string fileNamePath,string uriString)输入条件：删除文档时使用该功能定义：string fileNamePat

35、h，文件名，全路径格式string uriString，服务器文件夹路径输出方式：函数调用l int SelectInforamtion(int schema1,string information)l int InsertInforamtion(int schema1,string information)l int DeleteInformation(int schema1,string information)l int UpdateInformation(int schema1,string information)/以上4个接口参见CSCI-2的输入接口6.5.2.3.2 输出接口l

36、 void CallUploadTransportion( string fileNamePath)l void CallDownloadTransportation(string uriString)l string ViewLog (int documentID)l void DeleteLog(int documentID)l void WriteLog(int documentID)/以上接口参见CSCI-3的通信输入接口6.5.2.4 流程描述 图6.5.2.4-1浏览文档活动图 图6.5.2.4-2 添加文档活动图图6.5.2.4-3修改文档内容活动图 图6.5.2.4-4 删除文

37、档活动图 图6.5.2.4-5 直接文档信息查询活动图 图6.5.2.4-6 根据职员查询文档信息活动图图 6.5.2.4-7 修改文档信息活动图6.6 CSCI-4 日志管理6.6.1 模块名称日志管理6.6.2 功能描述 功能描述：管理日志。创建、删除、查询事务处理单元执行日志，记录文件的修改历史。6.6.3 接口描述6.6.3.1 输入接口l List ViewLog (string documentName)输入条件：查看日志时使用该功能定义：string documentName，要查看文档历史的文档名称return List，返回查询的结果输出方式：函数调用l int Delete

38、Log(string documentName)输入条件：删除日志时使用该功能定义：string documentName，要删除文档历史的文档名称return 0，表示写失败，1，表示读成功输出方式：函数调用l int WriteLog(string documentName,string changTime,string operatorID,string opretorCategory )输入条件：记录文件日志时使用该功能定义：string documentName，要记录文档操作的文档名称string changTime，记录操作的时间 string operatorID，记录操作人的

39、用户名 string operatorCategory，记录操作的类型（如添加文件、修改文件内容、修改文件信息等）return 0，表示写失败，1，表示读成功输出方式：函数调用l void WriteDBLog(List content)输入条件：记录数据库备份日志时使用该功能。定义：List content,日志的内容。（包括备份时间、备份者ID）6.6.3.2 输出接口l int ExecuteNonQueryHelp (int schema, string tableName,ListcolumnName, List sql)l List ExecuteReader(string tab

40、leName, ListcolumnName，List sql)/以上参见CSCI-5的输入接口6.6.4 流程描述6.7 CSCI-5 数据库管理6.7.1 模块名称数据库管理6.7.2 功能描述提供与数据库之间的交互6.7.3 接口描述6.7.3.1 输入接口l public DataBaseManage( )输入条件：使用数据库时参数定义：无输入方式：函数调用l bool ExecuteNonQueryHelp(schemaType schema, string tableName,ListcolumnName,List sql )输入条件：执行添加、修改、删除等操作时参数定义：sche

41、ma: schemaType 为数据操作类型（包括添加、删除、修改） 当schema=dbInsert时，实现的是DBM-100的功能；schema=dbUpdate时，实现的是DBM-200的功能；schema=dbDelete时，实现的是DBM-300的功能。tableName: string 操作的表名columnName：List 表示将要操作的列名集合，当schema=dbUpdate时，columnName其中包含两个部分，以“0 0 0 0”为分割点，之前为将要修改行的标识列名（如主键等），之后为修改行的列名（即属性名）sql：List 表示与列名集合相对应的操作参数值。当sch

42、ema=dbUpdate时，sql其中包含两个部分，以“0 0 0 0”为分割点，之前为将要修改行的标识列的值，之后为修改行之后的值输入方式：函数调用l List ExecuteReader(string tableName,List columnName1,List columnName2,List sql)输入条件：执行查询操作时参数定义：tableName：string 表示操作的表名；columnName1：List 表示将要操作的列名集合；columnName2：List 表示将要显示哪些列的集合；sql：List 表示与列名集合相对应的操作参数。输入方式：函数调用l bool Ba

43、ckupDataBase( )输入条件：备份数据库时参数定义：无输入方式：函数调用l bool RecoverDataBase(string time )输入条件：恢复数据库时参数定义：time: string 表明将要是数据库恢复到time时刻的状态输入方式：函数调用6.7.3.2 输出接口无6.7.4 流程描述无7 数据（库）结构设计7.1 逻辑结构设计要点图7.1-1全系统数据库ER图7.2 物理结构设计要点图7.2-1 数据库表结构图8 部署设计图8-1 系统整体部署图部署图说明：1. C/S客户端 操作系统为windows系统，包含八个组件：skin.dll、connection.d

44、ll 、office.dll等。其中skin.dll负责对客户端的皮肤，字体以及其他的界面部署；connection.dll负责与IIS服务器的连接和通信；office.dll，负责调用office软件，实现用户在本地暂时建立文档，修改文档等；其他组件间CSCI-1CSCI-5包的描述2. IIS服务器 操作系统为windows系统，安装SQL Server2008数据库。 9 运行设计9.1 运行模块组合无9.2 运行控制注册：打开软件 进入登陆界面 点击注册按钮 填写用户注册信息 确定注册登陆：打开软件 输入用户名、密码 确定登陆系统管理：u 添加（删除、修改）部门信息：管理员登陆 进入系统管理界面 选择添加（删除或修改）部门界面 输入部门信息（选择要删除或修改的部门） 确认添加（删除或修改）u 添加（删除、修改）员工信息：管理员登陆 进入系统管理界面 选择添加（删除或修改）员工界面 输入员工信息（选择要删除或修改的员工） 确认添加（删除或修改）u 添加（删除、修改）文档类别：管理员登陆 进入系统管理界面 选择添加（删除或修改）文档类别界面 输入文档类别（选择要删除或修改的类别） 确认添加（删除或修改）查询：用户登陆 在查询框中输入关键字 单击查询按钮 系统显示查询结果浏览