概要设计说明书v1.0(范版)

1、文档可自由编辑打印编写：王正韬、赵伟楠日期：2006 年 6 月23 日审核：日期：批准：日期：受控状态：是 发布版次：1.0日期：2006-6-25编号：GS1.0+Teamgeist+Teamgeist 协同办公系统协同办公系统概要设计说明书概要设计说明书文档可自由编辑打印变更记录变更记录日期版本变更说明作者2006-6-231.0初始版本王正韬、赵伟楠签字确认签字确认系统模块对应章节对应部门负责人签字文档可自由编辑打印目目 录录1引言引言.51.1编写目的.51.2背景.51.3基线.51.4范围.51.5定义.51.6参考资料.52总体设计总体设计.52.1概述.52.1.1功能描述.

2、52.1.2运行环境.62.1.3开发环境.62.2设计思想.72.2.1系统构思.72.2.2关键技术与算法.82.2.3关键数据结构.92.3人工处理过程.93系统功能设计系统功能设计.93.1个人办公.93.1.1日程安排.94系统数据结构设计系统数据结构设计.144.1说明.144.2数据结构.144.3数据结构与系统元素的关系.145接口设计接口设计.145.1用户接口.145.2外部接口.146运行设计运行设计.156.1系统初始化.156.2运行控制.156.3系统结束.157系统出错处理设计系统出错处理设计.157.1出错信息.157.2补救措施.158系统维护设计系统维护设计

3、.168.1检测点的设计.16文档可自由编辑打印8.2检测专用模块的设计.169尚待解决的问题尚待解决的问题.16文档可自由编辑打印1 引言引言1.1 编写目的编写目的本说明书目的在于明确说明系统各功能模块划分及其实现方式，指导开发人员进行编码。本说明书的预期读者为：项目经理，开发工程师，测试经理以及测试设计人员。1.2 背景背景待开发软件系统的名称：协同办公平台此软件系统任务提出者：客户此软件系统任务开发者：开发小组此软件系统任务用户：客户公司的办公人员1.3 基线基线（可略可略）协同办公平台需求分析说明书 v1.1（本文档编写时要参考的文档）1.4 范围范围系统包括的范围：个人办公、系统管

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简体中文硬件环境硬件环境服务器服务器

5、最低配置最低配置推荐配置推荐配置1CPU：P4 2.0G1CPU：P4 2.8GMem：512MMem：2G应用和数据库服务器HD：40GHD：120G2.1.3开发环境开发环境服务器软件环境服务器软件环境分类分类名称名称版本版本语种语种操作系统Windows Server2003简体中文操作系统的附加功能无数据库平台IBM DB28.1简体中文数据库平台补丁无应用平台IBM WebSphere5.0简体中文文档可自由编辑打印应用平台补丁无版本控制系统Cvs6.0简体中文客户端软件MS IE6.0简体中文分类名称版本语种服务器硬件环境服务

6、器硬件环境服务器服务器最低配置最低配置推荐配置推荐配置1CPU：P4 2.0G1CPU：P4 2.8GMem：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简体中文开发机

7、器硬件环境开发机器硬件环境分类分类最低配置最低配置推荐配置推荐配置1CPU：P4 2.0G1CPU：P4 2.8GMem：512MMem：2G开发机器HD：40GHD：120G2.2 设计思想设计思想2.2.1系统构思系统构思本系统采用基于 B/S 架构实现。应用 MVC 设计模式的思想，对整个系统进行功能层次划分，大体分为三个层次Model、Controller、View.Model 主要包括了数据库物力存储、数据库访问更能模块及系统业务逻辑功能模块。数据库计划采用 oracle 数据库产品。数据库访问接口将采用两种方式实现，第一种为自主开发数据库直连方式或 jdbc；第二种为采用 Hibe

8、rnate 实现。文档可自由编辑打印View 主要包括用户界面，其中分为普通用户界面及管理员用户界面。这部分采用JSP 动态网页技术实现。Controller 的作用是沟通和协调 M 和 V，实现显示与后台处理业务的分离，既保证了后台的安全性、稳定性，又保证了显示层的简洁与高效。此部分计划采用Servlet 技术实现。后台数据库与业务逻辑部分是系统开发的重点，进一步对业务逻辑进行模块化细分，大体可以分为 11 个功能模块，分别是：登录认证模块、个人信息管理模块、名片管理模块、日程安排模块、在线信息模块、待办事项模块、个人文件夹模块、公司通讯录管理模块、部门管理模块、角色管理模块、会议管理模块。

9、其中会议管理模块为选作部分，因此在这里暂时列为要实现的功能，具体是否实现依据时间而定。后台数据库分为物理数据库部分和数据库访问接口部分。系统功能模块结构层次图如下：数据库数据库访问接口个人办公个人信息管理名片管理日程安排在线信息个人文件夹登陆认证系统管理公司通讯录角色管理部门管理待办事项会议管理控制器个人办公界面系统管理界面由于本系统开发时间有限，结合开发组内部人员的技术掌握程度，考虑不使用相对较难的技术，在项目原型开发阶段使用 JSP+Servlet+JavaBean 的技术组合。根据项目运行状况在考虑是否使用 Struts 技术和 Hibernate 技术。在数据库开发方面考虑到性能方面的

10、一些要求：同时 200 个用户在线使用，因此在数据库访问接口方面要进行连接对象的管理，如使用对象池。由于本系统潜在用户数量较大，对于 B/S 结构的系统服务器压力就相应很大，因此为保证服务器能够足以承受实际运行当中的压力，发挥良好的性能，决定本系统服务器部分采用 tomcat 服务器软件。文档可自由编辑打印2.2.2关键技术与算法关键技术与算法JSP 动态网页开发技术动态网页开发技术JSP(Java Server Pages)是一种动态网页技术标准。 它用 JAVA 语言作为脚本语言的，JSP 网页为整个服务器端的 JAVA 库单元提供了一个接口来服务于 HTTP 的应用程序。它

11、的优点在于：对于用户界面的更新，其实就是由 Web Server 进行的，所以给人的感觉更新很快。所有的应用都是基于服务器的，所以它们可以时刻保持最新版本。客户端的接口简单，对于各种应用易于部署、维护和修改。2.3 人工处理过程人工处理过程说明在本系统的运行过程中不得不包含的人工处理过程（若有的话） 。指出该处理过程在系统中的前后相关的功能及操作。该过程出现的原因，输入、输出、处理过程。2.3.1数据库死机数据库死机可能的原因：访问量过大、感染病毒、运行时间过长、负载量过大处理过程：由管理员恢复数据库2.3.2数据丢失数据丢失可能的原因：管理员的误操作、感染病毒处理过程：由管理员手动恢复数据输

12、入：恢复指令或具体的数据2.3.3公司部门管理公司部门管理原因：公司的部门变更处理过程：由管理员改变旧的部门树状结构输入：新的部门结构体系2.3.4公司通讯录公司通讯录原因：公司内部人员资料的变更处理过程：由管理员修改旧的资料输入：新的员工资料2.3.5密码管理密码管理原因：员工忘记自己的密码处理过程：由管理员查询申请人的现有密码或直接修改其密码并告知输入：员工的新密码输出：员工的原有密码文档可自由编辑打印3 系统功能设计系统功能设计3.1 个人办公功能个人办公功能本功能为员工日常办公常用功能，包括个人信息维护、日程安排、名片夹、通讯录、上传下载网络文件，并且能够查看个人的待办工作、已办工作、

13、催办工作。当个人忘记密码时，由其通过电话向系统管理员询问密码。3.1.1 个人信息管理子功能个人信息管理子功能允许员工修改自己的个人信息，包括中文名、英文名、密码、自我介绍、兴趣爱好、性别、办公电话、家庭电话、移动电话、传真、QQ、MSN。员工可以通过两个途径查询他人提供的公开的个人信息：1、 通过组织机构和姓名检索，查询他人的个人信息2、 通过组织树选择相关人员，查询他人的个人信息3.1.2 名片管理子功能名片管理子功能员工可对自己的名片夹进行管理，可设置私有或共享，可直接点击发邮件名片夹的属性包括：姓名、性别、单位、部门、职务、办公室、国家、省份、城市、邮编、地址、电子邮件、工作电话、传真

14、、手机、共享属性、备注以上各项中姓名、电子邮件、名片分类为必填选项，性别可做成单选按扭3.1.3 日程安排子功能日程安排子功能用户可进行读者设置、代办设置、日程安排、综合查询和日历查看1、日程内容包括：事项、发生地点、开始日期、开始时间（选择） 、结束时间（选择） 、日程内容、是否外出（选择） 、备注。员工可对日程进行增加、删除、修改。员工可查询某日和某月的日程安排，将查询结果按条目列出，用户可点击查看详细的日程内容。2、读者设置：员工在组织树中选择人员，赋予他们阅读自己日程的权限。员工可查询拥有阅读自己日程权限的所有人员。员工可以取消其他用户阅读自己日程的权限。3、代办设置员工在组织树中选择

15、人员，赋予他们修改自己日程的权限。员工可查询拥有修改自己日程权限的所有人员。员工可以取消其他用户修改自己日程的权限。4、综合查询文档可自由编辑打印用户可模糊给出日程内容中各项的部分数据，进行检索，找出所有符合查询条件的日程条目，并可以在条目上点击，展开该日程的具体内容。5、日历查询员工通过此功能查看日历3.1.4 在线信息子功能在线信息子功能利用系统短消息功能发送的通知。包括收件箱、草稿箱、已发送。1、 收件箱包括：发信人、时间、标题、内容、是否已阅。信息的是否已阅属性默认值是否，当用户打开该信息是，系统自动将此属性改为是。在用户登录时，如有该属性为否的信息，则系统提示用户有新消息。用户可对收

16、件箱内的信息进行查阅具体内容、回复和删除操作。2、 草稿箱包括：收信人、时间、标题、内容、是否已经发送在用户将草稿箱内的信息发送出去的同时，系统将是否已经发送属性改为是（此属性默认值为否） 。并同时将本信息转存入“已发送” 。用户可对草稿箱中的信息进行查阅具体内容、修改、发送、删除的操作。3、 已发送包括：收信人、时间、标题、内容用户可对已发送中的信息进行查阅具体内容、删除的操作。4、 查询功能以上三个文件夹中都包含查询的功能查询未阅留言点击直接列出所有未阅留言，方便用户查看未阅信息。查询所有留言（根据用户提出的条件）用户可以给出要查询的字段，并选择查询范围（所有信箱、收件箱、草稿箱、已发送）

17、 ，系统给出所有符合条件的信息。3.1.5 待办事项子功能待办事项子功能包括工作提醒、收到留言、日程安排，给出条目时，将以上内容按时间顺序列出，方便用户了解自己要做的工作。1、 工作提醒包括：标题、时间、内容每页十条显示。本功能是为用户提供随笔记事功能，记录自己要做的工作并在查阅待办事项时做出提醒。用户可对工作提醒中的内容进行添加、删除的操作。2、 收到留言格式同在线信息的子功能收件箱，首页只显示五条记录（按时间顺序排列） 。更多的留言需跳转到收件箱处理。3、 日程查询格式同日程安排子功能的日程查询，首页只显示五条记录（按时间顺序排列） 。更文档可自由编辑打印多的日程需跳转到收件箱处理。3.1

18、.6 个人文件夹管理子功能个人文件夹管理子功能在服务器上提供个人文件夹；文件夹大小由系统管理员设定；个人可将文件上传至个人文件夹中；个人文件夹可由使用者设置共享功能。文件夹的属性包括名称、描述。1、 新建可在文件夹下新建子文件夹，也可向目录下上传文件。2、 更改可选择一个文件夹，修改其名称和描述。3、 删除可选择一个文件夹，删除该文件夹及其下的文件。4、 共享可选择一个文件夹，将其设置为共享。3.1.7 公司通讯录查询子功能公司通讯录查询子功能员工可以查询公司通讯录并导出到 Excel 文件1、 查询公司通讯录录入查询条件，系统给出符合条件的通讯录条目通过树状组织结构查询2、 导出公司通讯录员

19、工可以将查询到的人员通讯录导出到 Excel 文件中，利用 Excel 的另存为功能保存为 CSV 或 TXT 等格式文件。3.2 系统管理功能系统管理功能3.2.1 部门管理子功能部门管理子功能系统管理员可修改部门名称及层次结构，进行对部门的增加和删除操作3.2.2 公司通讯录管理子功能公司通讯录管理子功能系统管理员可修改通讯录中的各项信息，其树状结构依照部门管理子功能中的修改结果。3.2.3 角色管理子功能角色管理子功能系统管理员可添加、删除、修改角色列表中的内容，并可制定员工的角色属性。文档可自由编辑打印3.3 个人及系统管理的公用功能个人及系统管理的公用功能3.3.1 登录功能登录功能

20、员工与系统管理员的登录页面不同，系统要求登录者提供帐号、密码、验证码，并进行身份确认及登录结果页面导向。4 系统数据结构设计系统数据结构设计4.1 说明说明在实现时将各个功能及其属性进行封装、抽象成类，以便系统内部更加方便、高效的处理业务逻辑总产生的大量数据。4.2 数据结构数据结构名称标识符数据项用户（包括管理员）EmployeeInfoId、中文名、英文名、密码、自我介绍、兴趣爱好、性别、办公电话、家庭电话、移动电话、传真、QQ、MSN、部门id组织机构DepartmentInfo部门 id、电话、类型、属性、经理 id日程安排Schedule标题、开始日期、开始时间、结束时间、结束日期、

21、内容、外出、状态名片Namecard姓名、性别、单位、部门、职务、办公室、国家、省份、城市、邮编、地址、电子邮件、工作电话、传真、手机、共享属性、备注、类型待办事项Notes标题、内容文件夹Folders内容描述、存储地址信息Messages标题、内容4.3 数据结构与系统元素的关系数据结构与系统元素的关系数据结构名称对应模块用户（包括管理员）个人信息管理、角色管理、登录组织机构部门管理、公司通讯录日程安排日程管理名片名片管理待办事项待办事项文档可自由编辑打印文件夹个人文件夹信息在线信息 5 接口设计接口设计5.1 用户接口用户接口5.1.1 个人信息管理界面个人信息管理界面 信

22、息管理信息管理输入操作：用户输入自己的个人信息，包括中文名、英文名、自我介绍、兴趣爱好、性别、办公电话、家庭电话、移动电话、传真、QQ、MSN。输出操作：系统给出当前的用户信息内容，供用户修改。输入操作通过界面进行。以上内容除性别用单选扭显示外，其他都用文本框列出。 信息查询信息查询输入操作：用户输入检索信息，内容为个人信息中任意一个或几个字段的内容。输出操作：符合查询条件的用户条目，点击可查看具体的用户个人信息。输入操作通过界面进行，以文本框的形式输入。5.1.2 名片管理界面名片管理界面输入操作：用户可修改名片的属性，包括姓名、性别、单位、部门、职务、办公室、国家、省份、城市

23、、邮编、地址、电子邮件、工作电话、传真、手机、共享属性、备注。输出操作：同输入操作的内容，供用户修改。输入操作通过界面进行。以上内容除性别用单选扭显示外，其他都用文本框列出。5.1.3 日程安排日程安排 日程管理界面日程管理界面输入操作：用户可修改日程的事项、发生地点、开始日期、开始时间（选择） 、结束时间（选择） 、日程内容、是否外出（选择） 、备注。输出操作：同输入操作的内容，供用户修改文档可自由编辑打印输入操作通过界面进行，有选择标识的用下拉框显示，没有此标识的用文本框表示。 读者设置界面读者设置界面输入操作：输入给予或取消他人阅读自己日程的权限。输出操作：输

24、出组织树供用户选择人员 输出有权限阅读用户日程的人员名单输入操作通过界面进行，用复选框表示。 代办设置界面代办设置界面输入操作：输入给予或取消他人修改自己日程的权限。输出操作：输出组织树供用户选择人员 输出有权限修改用户日程的人员名单输入操作通过界面进行，用复选框表示。 综合查询综合查询输入操作：输入查询的条件，内容可包括日程属性中的部分内容。输出操作：输出所有符合查询条件的日程条目。输入操作通过页面进行，用文本框表示。 日历查询日历查询输入操作：用户选择要查询的年份及月份输出操作：输出用户所选月份的日历输入操作通过页面进行，用下拉框选择。5.1.4

25、在线信息界面在线信息界面 收件箱收件箱输入信息：查阅具体内容、回复和删除操作。输出信息：信息的发信人、时间、标题、内容、是否已阅属性。输入信息通过页面进行，用按钮方式输入操作命令。文档可自由编辑打印 草稿箱草稿箱输入信息：查询具体内容、修改、发送、删除操作。输出信息：收件人、时间、标题、具体内容、是否已经发送。输入信息通过页面进行，操作用按钮实现，修改内容靠文本框实现。 已发送已发送输入信息：查阅具体内容、删除操作。输出信息：收件人、时间、标题、内容。输入信息通过页面进行，靠按钮实现。 查询页面查询页面输入信息：查询未阅留言命令、查询条件

26、、查询范围、开始查询命令。输出信息：所有符合查询条件的留言条目。输入信息通过页面进行。查询未阅留言命令、开始查询命令用按钮实现，查询条件用文本框录入，查询范围用下拉框选择。5.1.5 待办事项页面待办事项页面此页面默认为工作提醒列表输入信息：查询最近日程、查询最近留言、查询工作提醒具体内容命令输出信息：工作提醒条目（每页十行显示）输入信息通过页面进行。查询最近日程和查询最近留言用超级链接实现，查询工作提醒具体内容通过条目上的超级链接实现。 工作提醒子页面工作提醒子页面输入信息：查询具体内容命令。输出信息：工作提醒的标题、时间、内容。输入信息通过页面进行，命令通过条目上的超级链接实

27、现。 收到留言子页面收到留言子页面输入信息：查询更多留言命令。输出信息：留言的发信人、时间、标题、内容、是否已阅属性，以每页五行显示。输入信息通过页面进行，命令通过超级链接实现。文档可自由编辑打印 日程查询子页面日程查询子页面输入信息：查询更多日程命令。输出信息：日程的事项、发生地点、开始日期、开始时间（选择） 、结束时间（选择） 、日程内容、是否外出（选择） 、备注，以每页五行显示。输入信息通过页面进行，命令通过超级链接实现。5.1.6 个人文件夹管理页面个人文件夹管理页面输入信息：上传、删除、共享、新建文件夹命令输出信息：文件夹的树状结构、文件夹描述输入：上传通

28、过读取数据文件方式实现 其他命令通过页面进行，由按钮实现。5.1.7 部门管理页面部门管理页面输入信息：修改、新建、删除操作输出信息：部门的树状结构图输入信息通过页面进行，命令通过按钮实现。5.1.8 公司通讯录管理页面公司通讯录管理页面输入信息：修改、新建、删除命令、及通讯录中的各项具体信息。输出信息：部门的树状结构图及通讯录中的各项具体信息。输入信息通过页面进行，命令通过按钮实现，通讯录中的各项具体信息通过文本框实现。5.1.9 角色管理页面角色管理页面输入信息：添加、删除、修改命令输出信息：原有的角色列表。输入信息通过页面进行，命令通过按钮实现。5.1.10登录页面登录页面输入信息：帐号

29、、密码、确认登陆、重置命令。输出信息：验证码。输入信息通过页面进行，命令通过按钮实现，其他通过文本框实现。文档可自由编辑打印5.1.11修改密码功能修改密码功能员工页面员工页面输入信息：原有密码、新密码、新密码重复、确认修改命令、重置命令。输出信息：修改是否成功信息输入通过输入信息通过页面进行，命令通过按钮实现，其他通过文本框实现。管理员页面管理员页面输入信息：新密码、新密码重复、确认修改命令、重置命令。输出信息：原有密码、修改是否成功信息输入通过输入信息通过页面进行，命令通过按钮实现，其他通过文本框实现。5.2 外部接口外部接口说明本系统同外界的所有接口，包括

30、与硬件、各支持软件之间的接口关系。指出输入、输出方，接口数据的特点等。外部接口输入方输出方接口数据系统用户界面使用者系统系统运行结果浏览器系统软件客户端浏览器系统运行结果6 运行设计运行设计（可略）（可略）6.1 系统初始化系统初始化系统初始化过程：文档可自由编辑打印数据库启动成功启动？应用服务器启动成功系统部署初始化成功成功启动？失败成功成功部署成功初始化失败失败失败数据库服务器进程启动，服务器为进程分配内存，数据库进行初始化操作应用服务器进程启动，服务器为进程分配内存，服务器进行初始化操作系统软件部署进服务器，服务器为软件分配资源6.2 运行控制运行控制模块代码对照表：模块代码模块名称1登

31、录认证模块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内存数据库事务待办事项