文档管理系统详细设计书.doc

资讯科技中心机密级别重要总页数9 页 档案管理软件子系统 模块详细设计说明书 详细设计说明书内部公开 2012 11 08第 2 页 共 12 页 版本历史记录 日期日期版本号版本号版本内容版本内容作者作者审核人审核人审核日期审核日期 2006 4 21V1 1 修改参考文献和 子系统或模块概 述 添加了界面 设计 许辽 2006 7 28V1 2改进整体结构许辽 详细设计说明书内部公开 2012 11 08第 3 页 共 12 页 目目 录录 1 引言引言 4 1 1编写目的 4 1 2文档范围 4 1 3读者对象 4 1 4参考文献 4 1 5术语与缩写解释 4 2 子系统子系统 N 详细设计详细设计 4 2 1子系统概述 4 2 2子系统依赖关系 4 2 3子系统总体结构 5 2 4模块 N 设计说明 6 2 4 1模块描述 6 2 4 2功能 6 2 4 3 性能 6 2 4 4关键算法 6 2 4 5模块构成 6 2 4 5 1Class 关系图 7 2 4 5 2Class 构成说明 8 2 4 6主要数据结构 9 2 4 7界面设计 9 2 4 8 尚未解决的问题 9 1 1 引言引言 1 11 1 编写目的编写目的 本详细设计说明书是针对档案管理系统而编写的 目的是为开发项目小组提供软件设计需求详 细说明 系统功能说明 1 21 2 文档范围文档范围 本详细设计说明书只针对档案管理系统有效 是提供档案管理的管理软件 本详细设计说明书只针对档案管理系统有效 是提供档案管理的管理软件 1 31 3 读者对象读者对象 预期读者 预期读者 1 项目开发人员 项目开发人员 2 软件测试人员 软件测试人员 3 软件维护人员 软件维护人员 1 41 4 参考文献参考文献 文件文件 编编 号号 文献名称文献名称作作 者者出版单位出版单位发行发行 日期日期 1 2 3 1 51 5 术语与缩写解释术语与缩写解释 缩写 术语缩写 术语解解 释释 SPP精简并行过程 Simplified Parallel Process SD系统设计 System Design 2 2 子系统子系统 N N 详细设计详细设计 2 12 1子系统概述子系统概述 1 本软件属于文档管理软件子系统 2 主要功能是 用户文档查询 文档上传 下载 文档资料共享 详细设计说明书内部公开 2012 11 08第 5 页 共 12 页 3 子界面的布局视图 2 22 2子系统依赖关系子系统依赖关系 1 子系统依赖于数据库 2 子系统依赖于网络服务 3 子系统依赖于文档信息系统 2 32 3子系统子系统总体结构总体结构 包引用关系图如下所示 ui 系统界面部分 负责接受用户输入 显示系统输出 负责其他模块功能的协调调用 并含 有站内搜索功能 即在用户指定的已打开的ftp站点中搜索用户需要的资源 ui部分调用 common部分的功能读取xml文件中保存的界面元素属性信息 用户最近访问过的10个ftp信息 用户选择的下载的ftp内容列表及其他需要通过xml文件保存的信息 client 实现ftp客户端的功能 ftp连接 ftp上传及下载 上传或下载用户指定的资源 并 返回相应的信息 search 资源实时检索部分 根据用户输入的资源名称关键字 资源类型和选择的检索方式检 索用户需要的资源 并验证资源的可用性 返回可用资源及其大小 速度等相关信息 preview 资源预览部分 显示用户选择的资源的部分内容 以使用户决定是否需要该资源 preview部分调用common部分读取属性文件的内容亦显示预览资源内容的显示格式 逻辑图 组件结构图 如下所示 详细设计说明书内部公开 2012 11 08第 6 页 共 12 页 2 42 4模块模块 N N 设计说明设计说明 子系统主要模块有 1 用户登录模块 2 用户文档筛选查询模块 3 用户上传文档模块 4 用户户下载文档模块 5 用户预览文档显示格式模块 2 4 12 4 1模块描述模块描述 1 用户登录模块 主要是检验客户登录有效性 2 用户筛选查询模块 主要是查询筛选后的文档资料显示 3 用户上传文档模块 主要是保存用户上传的文档 4 用户下载文档模块 主要是用户选择文档后下载到相应的地址 5 用户预览文档格式模块 主要是给用户提供选择文档的显示格式 2 4 22 4 2功能功能 1 用户登录模块 通过用户用户名 密码检验判断客户信息有效性 检验通过进入系统 未通过则返回 登录 若三次未能通过则退出系统 客户信息由 用户名 密码 组成 2 用户查询文档模块 客户通过输入筛选条件获得相应的文档显示信息 比如 xml txt html word 等 格式选择 3 用户上传文档模块 用户把选取的文档保存到数据库中 以便下次使用 4 用户下载文档模块 用户通过选定文档下载到指定地址 详细设计说明书内部公开 2012 11 08第 7 页 共 12 页 2 4 32 4 3 性能性能 1 档案管理软件在无障碍环境下正常运行时的响应时间短暂 同时处理文件吞吐量大 2 档案管理软件是可维护系统 3 档案管理软件的易用性强 应用领域广泛 4 档案管理软件设置安全级别权限 分多个管理层次操作 保证了文档信息的安全性 2 4 42 4 4关键算法关键算法 1 文档的保存 文档的保存 Add 2 文档的查询 文档的查询 Search 3 文档的下载 文档的下载 Down 4 文档的上传 文档的上传 Up 5 文档的格式转换 文档的格式转换 CharToStr StrTochar 2 4 52 4 5模块构成模块构成 1 文档管理系统包图 2 文档管理系统时序图 详细设计说明书内部公开 2012 11 08第 8 页 共 12 页 3 文档管理系统类图 2 4 5 1Class 关系图关系图 该模块采用了通用的 VISITOR 设计模式 可以通过提供不同的 Visitor 实现不断扩展系统的折 扣算法 从而可以根据客户的特性分类而不断增加新的折扣优惠营销方案 2 4 5 2Class 构成说明构成说明 CBtrapi 是控制 Btrieve 文件 I O 的类 画面中的数据操作是用 CbtrApi 类做成 Btribeve 文件 类的层次和相关类类的层次和相关类 CbtrApi 文件 I O 类 类成员类成员 内部变量内部变量 m sPosBlock BTRCALL 函数的位置块 pCFileInfo 指定 Btrieve 文件信息类的指针 详细设计说明书内部公开 2012 11 08第 9 页 共 12 页 属性 属性 protectedprotected 构造构造 CBtrApi pCFileInfo 的初始化 数据转换 数据转换 protectedprotected CharToStr 记录从 Hex 转换成 CSring StrTochar 记录从 CSring 转换成 Hex 操作 操作 publicpublic GetFirst 用 Btrieve 文件取得第一个记录 GetNext 用 Btrieve 文件取得当前记录后面的记录 Open 打开指定的 Btrieve 文件 Insert 用 Btrieve 文件插入新的记录 Updata 更新指定的记录 Delete 删除指定的记录 Close 关闭 Btrieve 文件 操作详细说明操作详细说明 函数名 com ora UpdateCaseCode 1 功能说明 修改案件编号 2 函数头部 Public Function com ora UpdateCaseCode ByVal P OLDCODE As String ByVal P NEWCODE As String As Long 3 参数及返回值 参数名类型I O说明 P OLDCODEStringI旧的案件编号 P NEWCODEStringI新的案件编号 返回值Long 0 成功 1 失败 1010 旧案件编号长度不是 10 位 1020 新案件编号长度不是 10 位 1030 存在于受理举报立案中 1040 存在于转办举报立案中 1050 存在于重复举报立案中 1060 未查找到旧案件编号 详细设计说明书内部公开 2012 11 08第 10 页 共 12 页 4 参照数据库表 表 EXPOSURECASEINDEX 表 REPEATEXPOSURECASE 5 调用子函数 无 6 补充说明 如果需要添加算法的特殊说明 请添加流程图或伪代码 2 4 62 4 6主要数据结构主要数据结构 1 数据库物理设计 用户表 列名数据类型是否为空备注 IDint 否主键 用户名 Varchar 4 否 密码 Varchar 6 否 档案表 列名数据类型是否为空备注 IDInt 否主键 文档编号 Int 否主键 文档名 Varchar 20 否 文档状态 Varchar 4 否 密级 Int 否 立卷日期 Datetime 否 立卷人 Varchar 4 否 档案类型表 列名数据类型是否为空备注 IDInt 否主键 文档编号 Int 否 文档类型 Varchar 8 否 2 调用类 方法 用户登录需调用 Users 类的 Search 方法 文档的输入输出查询需调用 CBtrapi 类的 Open GetFirst GetNext 方法 文档上传类需调用 UpFile 类的 Upfile 方法 文档下载类需调用 Downlog 类的 Down 方法 文档预览格式需调用 CBtrapi 类的 CharToStr strToChar 方法 2 4 72 4 7界面设计界面设计 A 客户登录界面设计如下图 详细设计说明书内部公开 2012 11 08第 11 页 共 12 页 B 用户查询文档界面设计如下图 C 用户文档上传界面设计如下图 D