概要设计说明书_v1.0(范版).doc_第1页
概要设计说明书_v1.0(范版).doc_第2页
概要设计说明书_v1.0(范版).doc_第3页
概要设计说明书_v1.0(范版).doc_第4页
概要设计说明书_v1.0(范版).doc_第5页
已阅读5页,还剩18页未读, 继续免费阅读

下载本文档

版权说明:本文档由用户提供并上传,收益归属内容提供方,若内容存在侵权,请进行举报或认领

文档简介

编写:王正韬、赵伟楠 日期:2006 年 6 月 23 日 审核:日期: 批准:日期: 受控状态:是 发布版次:1.0日期:2006-6-25 编号:GS1.0 +Teamgeist+Teamgeist 协同办公系统协同办公系统 概要设计说明书概要设计说明书 变更记录变更记录 日期版本变更说明作者 2006-6-231.0初始版本王正韬、赵伟楠 签字确认签字确认 系统模块对应章节对应部门负责人签字 目目 录录 1引言引言5 1.1编写目的5 1.2背景5 1.3基线5 1.4范围5 1.5定义5 1.6参考资料5 2总体设计总体设计5 2.1概述5 2.1.1功能描述5 2.1.2运行环境6 2.1.3开发环境6 2.2设计思想7 2.2.1系统构思7 2.2.2关键技术与算法8 2.2.3关键数据结构9 2.3人工处理过程9 3系统功能设计系统功能设计9 3.1个人办公9 3.1.1日程安排9 4系统数据结构设计系统数据结构设计14 4.1说明14 4.2数据结构14 4.3数据结构与系统元素的关系14 5接口设计接口设计14 5.1用户接口14 5.2外部接口14 6运行设计运行设计15 6.1系统初始化15 6.2运行控制15 6.3系统结束15 7系统出错处理设计系统出错处理设计15 7.1出错信息15 7.2补救措施15 8系统维护设计系统维护设计16 8.1检测点的设计16 8.2检测专用模块的设计16 9尚待解决的问题尚待解决的问题16 1 引言引言 1.1 编写目的编写目的 本说明书目的在于明确说明系统各功能模块划分及其实现方式,指导开发人员进行编 码。 本说明书的预期读者为:项目经理,开发工程师,测试经理以及测试设计人员。 1.2 背景背景 待开发软件系统的名称:协同办公平台 此软件系统任务提出者:客户 此软件系统任务开发者:开发小组 此软件系统任务用户:客户公司的办公人员 1.3 基线基线(可略可略) 协同办公平台需求分析说明书 v1.1(本文档编写时要参考的文档) 1.4 范围范围 系统包括的范围:个人办公、系统管理 1.5 定义定义 无 1.6 参考资料参考资料 协同办公平台需求说明书_V1.1 协同办公系统项目计划_V1.0 2 总体设计总体设计 2.1 概述概述 2.1.1功能描述功能描述 系统包括的范围:个人办公、系统管理 2.1.2运行环境运行环境 软件环境软件环境 分类分类名称名称版本版本语种语种 操作系统Windows Server2003简体中文 操作系统的附加功能无 数据库平台IBM DB28.1简体中文 数据库平台补丁无 应用平台IBM WebSphere5.0简体中文 应用平台补丁无 客户端软件MS IE6.0简体中文 硬件环境硬件环境 服务器服务器最低配置最低配置推荐配置推荐配置 1CPU:P4 2.0G1CPU:P4 2.8G Mem:512MMem:2G 应用和数据 库服务器 HD:40GHD:120G 2.1.3开发环境开发环境 服务器软件环境服务器软件环境 分类分类名称名称版本版本语种语种 操作系统Windows Server2003简体中文 操作系统的附加功能无 数据库平台IBM DB28.1简体中文 数据库平台补丁无 应用平台IBM WebSphere5.0简体中文 应用平台补丁无 版本控制系统Cvs6.0简体中文 客户端软件MS IE6.0简体中文 分类名称版本语种 服务器硬件环境服务器硬件环境 服务器服务器最低配置最低配置推荐配置推荐配置 1CPU:P4 2.0G1CPU:P4 2.8G Mem:512MMem:2G 应用服务器、 数据库服务 器 HD:40GHD:120G 开发机器软件环境开发机器软件环境 分类分类名称名称版本版本语种语种 操作系统Windows Server2003简体中文 操作系统的附加功能 数据库平台IBM DB28.1简体中文 应用平台IBM WebSphere5.0简体中文 开发平台Eclipse3.0英文 MY Eclipse3.8.4英文开发平台插件 Vss 插件1.6.1英文 客户端软件MS IE6.0简体中文 开发机器硬件环境开发机器硬件环境 分类分类最低配置最低配置推荐配置推荐配置 1CPU:P4 2.0G1CPU:P4 2.8G Mem:512MMem:2G 开发机器 HD:40GHD:120G 2.2 设计思想设计思想 2.2.1系统构思系统构思 本系统采用基于 B/S 架构实现。应用 MVC 设计模式的思想,对整个系统进行功能 层次划分,大体分为三个层次Model、Controller、View. Model 主要包括了数据库物力存储、数据库访问更能模块及系统业务逻辑功能模 块。数据库计划采用 oracle 数据库产品。数据库访问接口将采用两种方式实现, 第一种为自主开发数据库直连方式或 jdbc;第二种为采用 Hibernate 实现。 View 主要包括用户界面,其中分为普通用户界面及管理员用户界面。这部分采用 JSP 动态网页技术实现。 Controller 的作用是沟通和协调 M 和 V,实现显示与后台处理业务的分离,既保 证了后台的安全性、稳定性,又保证了显示层的简洁与高效。此部分计划采用 Servlet 技术实现。 后台数据库与业务逻辑部分是系统开发的重点,进一步对业务逻辑进行模块化细 分,大体可以分为 11 个功能模块,分别是:登录认证模块、个人信息管理模块、名片 管理模块、日程安排模块、在线信息模块、待办事项模块、个人文件夹模块、公司通 讯录管理模块、部门管理模块、角色管理模块、会议管理模块。其中会议管理模块为 选作部分,因此在这里暂时列为要实现的功能,具体是否实现依据时间而定。后台数 据库分为物理数据库部分和数据库访问接口部分。系统功能模块结构层次图如下: 数据库 数据库访问接口 个人办公 个人信息管理 名片管理 日程安排 在线信息 个人文件夹 登陆认证 系统管理 公司通讯录 角色管理 部门管理 待办事项 会议管理 控制器 个人办公界面系统管理界面 由于本系统开发时间有限,结合开发组内部人员的技术掌握程度,考虑不使用相对较 难的技术,在项目原型开发阶段使用 JSP+Servlet+JavaBean 的技术组合。根据项目运行状 况在考虑是否使用 Struts 技术和 Hibernate 技术。 在数据库开发方面考虑到性能方面的一些要求:同时 200 个用户在线使用,因此在数 据库访问接口方面要进行连接对象的管理,如使用对象池。 由于本系统潜在用户数量较大,对于 B/S 结构的系统服务器压力就相应很大,因此为 保证服务器能够足以承受实际运行当中的压力,发挥良好的性能,决定本系统服务器部分 采用 tomcat 服务器软件。 2.2.2关键技术与算法关键技术与算法 JSP 动态网页开发技术动态网页开发技术 JSP(Java Server Pages)是一种动态网页技术标准。 它用 JAVA 语言作为脚本语 言的,JSP 网页为整个服务器端的 JAVA 库单元提供了一个接口来服务于 HTTP 的应用 程序。它的优点在于: 对于用户界面的更新,其实就是由 Web Server 进行的,所以给人的感觉更新很快。 所有的应用都是基于服务器的,所以它们可以时刻保持最新版本。 客户端的接口简单,对于各种应用易于部署、维护和修改。 2.3 人工处理过程人工处理过程 说明在本系统的运行过程中不得不包含的人工处理过程(若有的话) 。指出该处理过程在系 统中的前后相关的功能及操作。该过程出现的原因,输入、输出、处理过程。 2.3.1数据库死机数据库死机 可能的原因:访问量过大、感染病毒、运行时间过长、负载量过大 处理过程:由管理员恢复数据库 2.3.2数据丢失数据丢失 可能的原因:管理员的误操作、感染病毒 处理过程:由管理员手动恢复数据 输入:恢复指令或具体的数据 2.3.3公司部门管理公司部门管理 原因:公司的部门变更 处理过程:由管理员改变旧的部门树状结构 输入:新的部门结构体系 2.3.4公司通讯录公司通讯录 原因:公司内部人员资料的变更 处理过程:由管理员修改旧的资料 输入:新的员工资料 2.3.5密码管理密码管理 原因:员工忘记自己的密码 处理过程:由管理员查询申请人的现有密码或直接修改其密码并告知 输入:员工的新密码 输出:员工的原有密码 3 系统功能设计系统功能设计 3.1 个人办公功能个人办公功能 本功能为员工日常办公常用功能,包括个人信息维护、日程安排、名片夹、通讯录、 上传下载网络文件,并且能够查看个人的待办工作、已办工作、催办工作。当个人忘记密 码时,由其通过电话向系统管理员询问密码。 3.1.1 个人信息管理子功能个人信息管理子功能 允许员工修改自己的个人信息,包括中文名、英文名、密码、自我介绍、兴趣爱好、 性别、办公电话、家庭电话、移动电话、传真、QQ、MSN。 员工可以通过两个途径查询他人提供的公开的个人信息: 1、 通过组织机构和姓名检索,查询他人的个人信息 2、 通过组织树选择相关人员,查询他人的个人信息 3.1.2 名片管理子功能名片管理子功能 员工可对自己的名片夹进行管理,可设置私有或共享,可直接点击发邮件 名片夹的属性包括:姓名、性别、单位、部门、职务、办公室、国家、省份、城市、 邮编、地址、电子邮件、工作电话、传真、手机、共享属性、备注 以上各项中姓名、电子邮件、名片分类为必填选项,性别可做成单选按扭 3.1.3 日程安排子功能日程安排子功能 用户可进行读者设置、代办设置、日程安排、综合查询和日历查看 1、日程内容包括:事项、发生地点、开始日期、开始时间(选择) 、结束时间(选择) 、 日程内容、是否外出(选择) 、备注。 员工可对日程进行增加、删除、修改。 员工可查询某日和某月的日程安排,将查询结果按条目列出,用户可点击查看详细 的日程内容。 2、读者设置: 员工在组织树中选择人员,赋予他们阅读自己日程的权限。 员工可查询拥有阅读自己日程权限的所有人员。 员工可以取消其他用户阅读自己日程的权限。 3、代办设置 员工在组织树中选择人员,赋予他们修改自己日程的权限。 员工可查询拥有修改自己日程权限的所有人员。 员工可以取消其他用户修改自己日程的权限。 4、综合查询 用户可模糊给出日程内容中各项的部分数据,进行检索,找出所有符合查询条件 的日程条目,并可以在条目上点击,展开该日程的具体内容。 5、日历查询 员工通过此功能查看日历 3.1.4 在线信息子功能在线信息子功能 利用系统短消息功能发送的通知。包括收件箱、草稿箱、已发送。 1、 收件箱 包括:发信人、时间、标题、内容、是否已阅。 信息的是否已阅属性默认值是否,当用户打开该信息是,系统自动将此属性改为 是。在用户登录时,如有该属性为否的信息,则系统提示用户有新消息。 用户可对收件箱内的信息进行查阅具体内容、回复和删除操作。 2、 草稿箱 包括:收信人、时间、标题、内容、是否已经发送 在用户将草稿箱内的信息发送出去的同时,系统将是否已经发送属性改为是(此 属性默认值为否) 。并同时将本信息转存入“已发送” 。 用户可对草稿箱中的信息进行查阅具体内容、修改、发送、删除的操作。 3、 已发送 包括:收信人、时间、标题、内容 用户可对已发送中的信息进行查阅具体内容、删除的操作。 4、 查询功能 以上三个文件夹中都包含查询的功能 查询未阅留言 点击直接列出所有未阅留言,方便用户查看未阅信息。 查询所有留言(根据用户提出的条件) 用户可以给出要查询的字段,并选择查询范围(所有信箱、收件箱、草稿箱、 已发送) ,系统给出所有符合条件的信息。 3.1.5 待办事项子功能待办事项子功能 包括工作提醒、收到留言、日程安排,给出条目时,将以上内容按时间顺序列出,方 便用户了解自己要做的工作。 1、 工作提醒 包括:标题、时间、内容 每页十条显示。 本功能是为用户提供随笔记事功能,记录自己要做的工作并在查阅待办事项时做 出提醒。用户可对工作提醒中的内容进行添加、删除的操作。 2、 收到留言 格式同在线信息的子功能收件箱,首页只显示五条记录(按时间顺序排列) 。更多 的留言需跳转到收件箱处理。 3、 日程查询 格式同日程安排子功能的日程查询,首页只显示五条记录(按时间顺序排列) 。更 多的日程需跳转到收件箱处理。 3.1.6 个人文件夹管理子功能个人文件夹管理子功能 在服务器上提供个人文件夹;文件夹大小由系统管理员设定;个人可将文件上传 至个人文件夹中;个人文件夹可由使用者设置共享功能。 文件夹的属性包括名称、描述。 1、 新建 可在文件夹下新建子文件夹,也可向目录下上传文件。 2、 更改 可选择一个文件夹,修改其名称和描述。 3、 删除 可选择一个文件夹,删除该文件夹及其下的文件。 4、 共享 可选择一个文件夹,将其设置为共享。 3.1.7 公司通讯录查询子功能公司通讯录查询子功能 员工可以查询公司通讯录并导出到 Excel 文件 1、 查询公司通讯录 录入查询条件,系统给出符合条件的通讯录条目 通过树状组织结构查询 2、 导出公司通讯录 员工可以将查询到的人员通讯录导出到 Excel 文件中,利用 Excel 的另存为功能 保存为 CSV 或 TXT 等格式文件。 3.2 系统管理功能系统管理功能 3.2.1 部门管理子功能部门管理子功能 系统管理员可修改部门名称及层次结构,进行对部门的增加和删除操作 3.2.2 公司通讯录管理子功能公司通讯录管理子功能 系统管理员可修改通讯录中的各项信息,其树状结构依照部门管理子功能中的修改 结果。 3.2.3 角色管理子功能角色管理子功能 系统管理员可添加、删除、修改角色列表中的内容,并可制定员工的角色属性。 3.3 个人及系统管理的公用功能个人及系统管理的公用功能 3.3.1 登录功能登录功能 员工与系统管理员的登录页面不同,系统要求登录者提供帐号、密码、验证码,并 进行身份确认及登录结果页面导向。 4 系统数据结构设计系统数据结构设计 4.1 说明说明 在实现时将各个功能及其属性进行封装、抽象成类,以便系统内部更加方便、高效的处理 业务逻辑总产生的大量数据。 4.2 数据结构数据结构 名称标识符数据项 用户(包 括管理员) EmployeeInfoId、中文名、英文名、密码、自我介绍、兴趣爱好、性别、 办公电话、家庭电话、移动电话、传真、QQ、MSN、部门 id 组织机构DepartmentInfo部门 id、电话、类型、属性、经理 id 日程安排Schedule标题、开始日期、开始时间、结束时间、结束日期、内容、 外出、状态 名片Namecard姓名、性别、单位、部门、职务、办公室、国家、省份、城 市、邮编、地址、电子邮件、工作电话、传真、手机、共享 属性、备注、类型 待办事项Notes标题、内容 文件夹Folders内容描述、存储地址 信息Messages标题、内容 4.3 数据结构与系统元素的关系数据结构与系统元素的关系 数据结构名称对应模块 用户(包括管理员)个人信息管理、角色管理、登录 组织机构部门管理、公司通讯录 日程安排日程管理 名片名片管理 待办事项待办事项 文件夹个人文件夹 信息在线信息 5 接口设计接口设计 5.1 用户接口用户接口 5.1.1 个人信息管理界面个人信息管理界面 信息管理信息管理 输入操作:用户输入自己的个人信息,包括中文名、英文名、自我介绍、兴趣爱好、 性别、办公电话、家庭电话、移动电话、传真、QQ、MSN。 输出操作:系统给出当前的用户信息内容,供用户修改。 输入操作通过界面进行。以上内容除性别用单选扭显示外,其他都用文本框列出。 信息查询信息查询 输入操作:用户输入检索信息,内容为个人信息中任意一个或几个字段的内容。 输出操作:符合查询条件的用户条目,点击可查看具体的用户个人信息。 输入操作通过界面进行,以文本框的形式输入。 5.1.2 名片管理界面名片管理界面 输入操作:用户可修改名片的属性,包括姓名、性别、单位、部门、职务、办公室、 国家、省份、城市、邮编、地址、电子邮件、工作电话、传真、手机、共享属性、备 注。 输出操作:同输入操作的内容,供用户修改。 输入操作通过界面进行。以上内容除性别用单选扭显示外,其他都用文本框列出。 5.1.3 日程安排日程安排 日程管理界面日程管理界面 输入操作:用户可修改日程的事项、发生地点、开始日期、开始时间(选择) 、结束 时间(选择) 、日程内容、是否外出(选择) 、备注。 输出操作:同输入操作的内容,供用户修改 输入操作通过界面进行,有选择标识的用下拉框显示,没有此标识的用文本框表示。 读者设置界面读者设置界面 输入操作:输入给予或取消他人阅读自己日程的权限。 输出操作:输出组织树供用户选择人员 输出有权限阅读用户日程的人员名单 输入操作通过界面进行,用复选框表示。 代办设置界面代办设置界面 输入操作:输入给予或取消他人修改自己日程的权限。 输出操作:输出组织树供用户选择人员 输出有权限修改用户日程的人员名单 输入操作通过界面进行,用复选框表示。 综合查询综合查询 输入操作:输入查询的条件,内容可包括日程属性中的部分内容。 输出操作:输出所有符合查询条件的日程条目。 输入操作通过页面进行,用文本框表示。 日历查询日历查询 输入操作:用户选择要查询的年份及月份 输出操作:输出用户所选月份的日历 输入操作通过页面进行,用下拉框选择。 5.1.4 在线信息界面在线信息界面 收件箱收件箱 输入信息:查阅具体内容、回复和删除操作。 输出信息:信息的发信人、时间、标题、内容、是否已阅属性。 输入信息通过页面进行,用按钮方式输入操作命令。 草稿箱草稿箱 输入信息:查询具体内容、修改、发送、删除操作。 输出信息:收件人、时间、标题、具体内容、是否已经发送。 输入信息通过页面进行,操作用按钮实现,修改内容靠文本框实现。 已发送已发送 输入信息:查阅具体内容、删除操作。 输出信息:收件人、时间、标题、内容。 输入信息通过页面进行,靠按钮实现。 查询页面查询页面 输入信息:查询未阅留言命令、查询条件、查询范围、开始查询命令。 输出信息:所有符合查询条件的留言条目。 输入信息通过页面进行。查询未阅留言命令、开始查询命令用按钮实现,查询条件 用文本框录入,查询范围用下拉框选择。 5.1.5 待办事项页面待办事项页面 此页面默认为工作提醒列表 输入信息:查询最近日程、查询最近留言、查询工作提醒具体内容命令 输出信息:工作提醒条目(每页十行显示) 输入信息通过页面进行。查询最近日程和查询最近留言用超级链接实现,查询工作提 醒具体内容通过条目上的超级链接实现。 工作提醒子页面工作提醒子页面 输入信息:查询具体内容命令。 输出信息:工作提醒的标题、时间、内容。 输入信息通过页面进行,命令通过条目上的超级链接实现。 收到留言子页面收到留言子页面 输入信息:查询更多留言命令。 输出信息:留言的发信人、时间、标题、内容、是否已阅属性,以每页五行显示。 输入信息通过页面进行,命令通过超级链接实现。 日程查询子页面日程查询子页面 输入信息:查询更多日程命令。 输出信息:日程的事项、发生地点、开始日期、开始时间(选择) 、结束时间(选择) 、 日程内容、是否外出(选择) 、备注,以每页五行显示。 输入信息通过页面进行,命令通过超级链接实现。 5.1.6 个人文件夹管理页面个人文件夹管理页面 输入信息:上传、删除、共享、新建文件夹命令 输出信息:文件夹的树状结构、文件夹描述 输入:上传通过读取数据文件方式实现 其他命令通过页面进行,由按钮实现。 5.1.7 部门管理页面部门管理页面 输入信息:修改、新建、删除操作 输出信息:部门的树状结构图 输入信息通过页面进行,命令通过按钮实现。 5.1.8 公司通讯录管理页面公司通讯录管理页面 输入信息:修改、新建、删除命令、及通讯录中的各项具体信息。 输出信息:部门的树状结构图及通讯录中的各项具体信息。 输入信息通过页面进行,命令通过按钮实现,通讯录中的各项具体信息通过文本框实 现。 5.1.9 角色管理页面角色管理页面 输入信息:添加、删除、修改命令 输出信息:原有的角色列表。 输入信息通过页面进行,命令通过按钮实现。 5.1.10登录页面登录页面 输入信息:帐号、密码、确认登陆、重置命令。 输出信息:验证码。 输入信息通过页面进行,命令通过按钮实现,其他通过文本框实现。 5.1.11修改密码功能修改密码功能 员工页面员工页面 输入信息:原有密码、新密码、新密码重复、确认修改命令、重置命令。 输出信息:修改是否成功信息 输入通过输入信息通过页面进行,命令通过按钮实现,其他通过文本框实现。 管理员页面管理员页面 输入信息:新密码、新密码重复、确认修改命令、重置命令。 输出信息:原有密码、修改是否成功信息 输入通过输入信息通过页面进行,命令通过按钮实现,其他通过文本框实现。 5.2 外部接口外部接口 说明本系统同外界的所有接口,包括与硬件、各支持软件之间的接口关系。指出输入、输 出方,接口数据的特点等。 外部接口输入方输出方接口数据 系统用户界面使用者系统系统运行结果 浏览器系统软件客户端浏览器系统运行结果 6 运行设计运行设计(可略)(可略) 6.1 系统初始化系统初始化 系统初始化过程: 数据库启动 成功启动? 应用服务器启动 成功 系统部署 初始化成功 成功启动? 失败 成功 成功部署 成功 初始化失败 失败 失败 数据库服务器进程启动,服务器为进 程分配内存,数据库进行初始化操作 应用服务器进程启动,服务器为进程 分配内存,服务器进行初始化操作 系统软件部署进服务器,服 务器为软件分配资源 6.2 运行控制运行控制 模块代码对照表: 模块代码模块名称 1 登录认证模块 2 个人信息管理 3 名片管理模块 4 日程安排模块 5 在线信息模块 6 待办事项模块 7 个人文件夹模块 8 公司通讯录管理模块 9 部门管理模块 10 角色管理模块 11 数据库访问接口 运行控制表: 外部控制 所历经模 块 资源占用情况安全控制方式 维护个人信 息 2、11内存数据库事务 个人信息管理 查看他人信 息 2、11内存数据库事务 名片分类3、11内存数据库事务 个人名片维 护 3、11内存数据库事务 名片管理 查看共享名 片 3、11内存数据库事务 代办设置4、11内存数据库事务 读者设置4、11内存数据库事务 日程安排4、11内存 数据库事务、冲突检 查 综合查询4、11内存数据库事务 日程管理 日历查看4、11内存数据库事务 草稿箱5、11内存数据库事务 已发送5、11内存数据库事务 未阅信息5、11内存数据库事务 在线信息 全部留言5、11内存数据库事务 待办事项清 单 6、11内存数据库事务 收到留言清单6、11内存数据库事务待办事项 到期日程安排 清单 6、11内存数据库事务 维护个人文件

温馨提示

  • 1. 本站所有资源如无特殊说明,都需要本地电脑安装OFFICE2007和PDF阅读器。图纸软件为CAD,CAXA,PROE,UG,SolidWorks等.压缩文件请下载最新的WinRAR软件解压。
  • 2. 本站的文档不包含任何第三方提供的附件图纸等,如果需要附件,请联系上传者。文件的所有权益归上传用户所有。
  • 3. 本站RAR压缩包中若带图纸,网页内容里面会有图纸预览,若没有图纸预览就没有图纸。
  • 4. 未经权益所有人同意不得将文件中的内容挪作商业或盈利用途。
  • 5. 人人文库网仅提供信息存储空间,仅对用户上传内容的表现方式做保护处理,对用户上传分享的文档内容本身不做任何修改或编辑,并不能对任何下载内容负责。
  • 6. 下载文件中如有侵权或不适当内容,请与我们联系,我们立即纠正。
  • 7. 本站不保证下载资源的准确性、安全性和完整性, 同时也不承担用户因使用这些下载资源对自己和他人造成任何形式的伤害或损失。

评论

0/150

提交评论