OA协同办公系统概要设计说明书.doc

编写：日期： 审核：日期： 日期： 受控状态：是 发布版次： 日期： 编号： 协同办公系统协同办公系统 概要设计说明书概要设计说明书 变更记录变更记录 日期版本变更说明作者 签字确认签字确认 系统模块对应章节对应部门负责人签字 1 引言4 1.1 编写目的4 1.2 背景4 1.3 基线4 1.4 范围4 1.5 定义4 1.6 参考资料4 2 2 总体设计总体设计.5 2.1 概述5 2.1.1 功能描述.5 2.1.2 运行环境.5 2.1.2.1 软件环境 5 2.1.2.2 硬件环境 5 2.1.3 开发环境.5 2.1.3.1 服务器软件环境 5 2.1.3.2 服务器硬件环境 6 2.1.3.3 开发机器软件环境 6 2.1.3.4 开发机器硬件环境 7 2.2 设计思想7 2.2.1 系统构思.7 2.2.2 关键技术与算法.7 2.2.2.1 运用 Hibernate 框架访问数据库 7 2.2.2.2 运用 Ajax 技术实现系统用户的登录 8 2.2.2.3 分页显示 9 2.2.2.4 文件上传和下载 9 2.2.2.5 验证码 9 2.2.2.6 密码加密 9 2.2.2.7 数据库连接池技术 10 2.2.2.8 防止多用户登录 10 2.2.2.9 报表导入导出 10 2.2.2.10 多功能编辑框 11 2.3 人工处理过程.11 3 3 系统功能设计系统功能设计.11 3.1 个人办公11 3.1.1 个人信息.11 3.1.2 名片夹.12 3.1.3 公司通讯录.13 3.1.4 在线信息.13 3.1.5 日程安排.15 3.1.6 待办事项.16 3.1.7 个人文件夹.17 3.2 会议管理18 3.2.1 会议室管理.18 3.2.2 会议管理.19 3.3 系统管理19 3.3.1 组织管理.20 4 4 系统数据结构设计系统数据结构设计.21 4.1 说明21 4.2 数据结构21 4.3 数据结构与系统元素的关系23 7 7 系统出错处理设计系统出错处理设计.23 7.1 出错信息23 7.2 补救措施24 1 1 引言引言 1.11.1 编写目的编写目的 本说明书目的在于详细说明系统各功能的功能及其实现方式，指导程序员进行编码。 本说明书的预期读者为：项目经理，系统分析员，系统设计人员，开发工程师，测试经 理以及测试设计人员等。 1.21.2 背景背景 待开发系统的名称：OA 协同办公系统 此软件系统任务提出者： 此软件系统任务开发者： 此软件系统任务用户： 1.31.3 基线基线 OA 协同办公系统需求分析说明书 v1.0 1.41.4 范围范围 系统包括的范围:个人办公、会议管理和系统管理。 1.51.5 定义定义 系统管理员：是指在系统中具有最高权限的员工。他能够改变系统中任意员工的相关信 息，如个人信息，通讯录，名片夹，会议室使用记录,在线信息状况等。 员工：是指在系统中拥有普通权限的人员。该人员所能处理的事物有：个人信息的完善， 名片夹的管理，通讯录的更新，在线信息的提醒，会议室的使用情况的查看以及相应报表的 到处等。 经理：是指在系统中拥有较高权限的员工。该人员不仅能处理普通员工所能处理的事物， 还能处理如会议室的申请，会议室的管理等事物。 权限管理：是指在系统中用户为了保护自己的隐私，对某些信息项的公开程度加以限制 的行为。具体的有：日程安排中读者设置和代办设置，共享名片夹中共享名片夹的设置，个 人文件夹中共享文件夹的设置等 1.61.6 参考资料参考资料 在编写此次的概要说明书时，参考了以下一些资料：协同办公平台需求说明书, 软件工程需求说明书（样例），软件工程需求说明书的写法等。 2 2 总体设计总体设计 2.12.1 概述概述 2.1.12.1.1 功能描述功能描述 “OA 协同办公”系统共有以下三个大的功能模块：个人办公、会议管理，会议管理。 个人办公模块包括：个人信息，日程安排，名片夹，公司通讯录，待办事项，在线信息， 个人文件夹，会议管理。 会议管理模块包括：会议室管理，会议管理。 系统管理模块包括：组织管理。 2.1.22.1.2 运行环境运行环境 2.1.2.12.1.2.1 软件环境软件环境 名称名称版本版本语种语种 操作系统 Windows Server2003 简体中文 操作系统的附 加功能 SP4 简体中文 数据库平台 Oracle 9i9i 简体中文 应用平台 Tomcat5.5 简体中文 客户端软件 MS IE8 简体中文 2.1.2.22.1.2.2 硬件环境硬件环境 服务器服务器最低配置最低配置推荐配置推荐配置 CPU：P4 2.0G CPU：P4 2.8G Mem：1GMem：2G HD ：40GHD ：120G 应用和数据库服 务器 1CPU：P4 2.0G1CPU：P4 2.8G Mem ：512MMem ：1G HD ：80GHD ：120G 邮件服务器 2.1.32.1.3 开发环境开发环境 2.1.3.12.1.3.1 服务器软件环境服务器软件环境 分类分类名称名称版本版本语种语种 操作系统 操作系统的附加功能 数据库平台 Oracle 10g 简体 中文 数据库平台补丁 应用平台 应用平台补丁 版本控制系统 Win-cvsV1.4.4. 英语 目录服务系统 邮件系统 客户端软件 2.1.3.22.1.3.2 服务器硬件环境服务器硬件环境 服服 务务 器器 最低配置最低配置推荐配置推荐配置 CPU:Intel2 酷睿 2 双核 E8600 MEM:芝奇 6GB DDR3 1600(F3-12800C HD：西部数据 2TB/7200/32M*5 CPU:Intel 酷睿 2 四核 Q9400 MEM: 海盗船 6GB DDR3 2000 三通道 HD:西部数据 2TB/7200/串口 *5 CPU:Intel 酷睿 2 双核 E8600 MEM:海盗船 6GB DDR3 2000 三通道 HD: 西部数据 2TB/7200/32M*5 CPU:Intel 酷睿 2 四核 Q9650 MEM: 威刚 6G DDR3 2133X V2.0 HD:西部数据 2TB/7200/串口 *5 应用 服务 器 数据 库服 务器 邮件 服务 目录 服务 器 CPU: Intel 酷睿 2 双核 E8200 MEM:海盗船 6GB DDR3 2000 三通道 HD 希捷 1.5TB/7200/32M *6 CPU:Intel 酷睿 2 双核 E8200 MEM: 芝奇 6GB DDR3 1600(F3-12800C HD: 希捷 1.5TB/7200/32M *6 CPU:Intel 酷睿 2 双核 E8600 MEM: 威刚 6G DDR3 2133X V2.0 HD:西部数据 2TB/7200/32M*5 CPU:Intel 酷睿 2 双核 E8600 MEM: 海盗船 6GB DDR3 2000 三通道 HD:西部数据 2TB/7200/32M*5 2.1.3.32.1.3.3 开发机器软件环境开发机器软件环境 分分 类类 名称名称版版 本本 语种语种 操 作 系 统 Windows Server 2003sp2 简体中文 数 据 库 平 台 Oracle 10g 简体中文 开 发 工 具 Myeclipse+Tomcat6.5 英语 2.1.3.42.1.3.4 开发机器硬件环境开发机器硬件环境 分分 类类 最低配置最低配置推荐配置推荐配置 开 发 工 具 CPU：奔腾 4 2.0 MEM: DDR2 512M HD : 希捷 80G/5400 CPU ：奔腾 4 2.8 MEML: DDR 1G HD : 希捷 80G/5400 2.22.2 系统系统功能模块划分功能模块划分 根据对客户需求的理解，系统功能划分为如图 1 所示： 图 1 系统功能模块划分 3 3 系统功能设计系统功能设计 3.13.1 个人办公个人办公 本模块中的主要功能是实现公司员工的日常办公，其中包括个人信息维护、日程安排、 名片夹、通讯录，对个人的待办工作、已办工作、催办工作的查看等。当个人忘记密码时， 由其通过电话向系统管理员询问密码。 3.1.13.1.1 个人信息个人信息 该模块为员工提供包括密码、自我介绍、兴趣爱好、联系方式等个人信息维护的功能。 此模块包含的功能有：个人信息维护、查看他人信息。员工利用该功能可以维护系统允许个 人维护的信息。其中自我介绍、联系方式和兴趣爱好会被公开给整个公司。 C le rkU IPersonalInfoU IPerInfoD BO Login() C hoseU I() U pdateSelfIn fo() Q ueryElseInfo () R etu rnT oU I() R etu rnT oU I() R etu rnT oC lerk() R etu rnT oC lerk() 图 9 个人信息时序图 3.1.23.1.2 名片夹名片夹 该功能模块主要是用于员工对自己的通讯录进行管理。主要的功能有设置私有或共享， 可直接点击发邮件等。该模块包含的下一次的功能模块有：名片夹分类、个人名片夹、查看 共享名片夹。 名片夹分类模块的主要功能是员工对自己的名片夹进行维护。包含的操作有：名片夹分 类清单、添加名片夹分类、修改名片夹分类、删除名片夹分类。 R etu rnToU I() C le rk U I C la ssifyBSC ard C la ssifyBSD BO Login() C hoseU I() AddC lass() D eleteC lass() R etu rnToU I() R etu rnToC lerk() R etu rnToU I() R etu rnToC lerk() AlterClass() R etu rnToC lerk() ListC lass() R etu rnToU I() R etu rnToC lerk() 图 10 名片夹分类时序图 个人名片夹模块的主要功能是员工维护自己的联系人。包含的操作有：查询名片、添加 名片、修改名片、删除名片、查看名片。 查看共享名片夹模块的主要功能是员工在共享名片夹中录入条件查询所有别人共享的名 片，并可以选择一个名片查看其细节，但是不能进行修改。此功能包含的操作有：查询名片、 查看名片。 图 11 共享名片时序图 3.1.33.1.3 公司通讯录公司通讯录 该模块的主要功能是让系统管理员维护整个公司的组织机构和联系方式以及公司人员查 询通讯录并导出到 Excel 文件。此功能涉及到的模块有：查询通讯录和导出通讯录。 图 12 公司通讯录时序图 图 13 类图 3.1.43.1.4 在线信息在线信息 该模块的主要功能是利用系统短消息功能发送的通知。当用户点击在线信息后，弹出新 窗口显示该信息的详细内容；在查看信息的页面可以选择已阅；对于已阅的在线信息不再显 示。包含的功能有：草稿箱、已发送、未阅留言、全部留言。 图 14 在线信息类图 草稿箱模块的主要功能是保存自己起草的还没有发送出去的短信息。包含的操作有：新 建留言、修改留言、删除留言、查询留言。 ClerkUIDraftBoxUIDraftSavedDraftBoxDBO Login() ChangeUI() ReturnToUI() ReturnToUI() ReturnToClerk() ReturnToUI() ReturnToClerk() ReturnToUI() ReturnToClerk() AddMessage() SendDraft() ReturnToClerk() QueryBox() AlterMessage() SendDraft() DeleteMessage() SendDraft() 图 15 草稿箱时序图 已发送模块的主要功能是保存自己起草的已经发送出去的短信息。包含的操作有：查询 留言、删除留言 未阅留言模块的主要功能是列出系统或其他用户发送给自己 d 的还没有阅读的短信息。 包含的操作有：查询留言、查看留言、回复留言、删除留言。 ClerkUIDraftBoxUIDraftSavedDraftBoxDBOUnreadUIAnotherClerk Login() ChoseUI() SendToMessage() SendDraft() SendMessage() SendForm() Login() QueryUnreadMes() SeeUnreadMes() RevertMessage() DeleteMessage() ReturnUnreadMes() ReturnUnreadMes() ReturnChangedMs() ReturnChangedMes() 图 16 未阅留言时序图 全部留言模块的主要功能是列出系统或其他用户发送给自己的全部短信息。包含的操作 有：查询留言、查看留言、回复留言、删除留言。 ClerkUIDraftBoxUIDraftSavedMessageBoxDBOWholeLeaveMessageUI()AnotherClerk() Login() ChoseUI() SendToMessage() SendDraft() Login() QueryLMes() ReturnMs() SeeLMes() ReturnMs() RevertLMes() ReturnMs() DeleteMes() ReturnMs() 图 17 全部留言时序图 3.1.53.1.5 日程安排日程安排 日程安排当前用户给自己或授权代办的人安排日程。对于已经安排的日程，可以进行编 辑和删除。可以根据日期查询某一天的安排，也可以查询某一个月中有安排的日期。 此功能包含的操作有：添加安排、删除安排、修改安排、查询一天安排、按月查看安排。 ClerkUIJourneyPlanUICommissionUIJourneyPlayDBOArrangedPlanUI Login() ChangeUI() ChangeT oCommissionUI() LicensedT o() ReturnToMes() ReturnToMes() ReturnToMes() ChangeUI() ChangePlan() ReturnToMes() ReturnTomes() ReturnToMes() ReturnToMes() 图 18 日程安排时序图 3.1.63.1.6 待办事项待办事项 列出所有传送给当前用户但该用户尚未签收处理的工作、收到留言、日程安排.待办事 项模块包括的功能有：待办工作清单、收到留言清单、到期日程安排清单。 待办工作清单。列示出来源于流程处理中的待办工作。工作流的催办信息发送到待办工 作中。按日期从新到旧的顺序排列。首页上只显示 5 条记录，更多的记录需进入待办工作总 清单进行处理。对于工作流类的处理事务，用户可以点击待办工作名称进入具体的工作处理 页面。此功能包含的操作有：工作台待办工作清单、待办工作总清单、新增待办工作、删除 待办工作。 NewTaskUnFinishTaskUIUnFinishTaskDBOBigUnFinishTaskUIClerkFinityUnFiniTaskUI SendNewTask() SendMessage() SendBigMessage() SendFinityMes() SendMessage() DeleteMessage() SendMessage() SendMessage() InformTo() AddMessage() SendMessage() InformTo() QueryMessage() SendMessage() InformTo() 图 19 待办事项时序图 收到留言清单。列示出别人发给自己的留言清单。按日期从新到旧的顺序排列。首页上 只显示 5 条记录，更多的记录需进入留言清单中进行处理。 NewLiveMessageLiveMessageUI LiveMessageDBO BigLiveMessageUI FinityLiveMessageUI Clerk SendNewMessage() SendMessage() SendBigLiveMes() SendFinityLiveMes() SendMessage() SeeMessage() SendMesage() SendMessage() InformTo() 图 20 留言时序图 到期日程安排清单。 列示出来源于日程安排中的到期日程安排。按日期从新到旧的顺 序排列。首页上只显示 5 条记录，更多的记录需进入日程安排模块中进行处理。 OverduePlanOverduePlanUIOverduePlanDBOBigOverduePlanUIFinityOverduePlanUIClerk SendOverduePlan() SendMessage() SendBigOverduePlan() SendFinityOverduePlan() SendMessage() SeeOverduePlan() SendMesage() SendMessage() InformTo() 图 21 到期日程时序图 3.1.73.1.7 个人文件夹个人文件夹 在服务器上提供个人文件夹；文件夹大小由系统管理员设定；个人可将文件上传至个人 文件夹中；个人文件夹可由使用者设置共享功能。 此模块包含的功能有：我的文件夹、共享目录。 ClerkController FolderUI FolderDBO PersonalFolderDBO Login() DefineSize() SendMessage() SendMessage() SendMessage() Login() UploadFiles() SendMessage() SendMessage() SendMessage() Login() ChangePurview() SendMessage() SendMessage() SendMessage() 图 22 个人文件夹时序图 3.23.2 会议管理会议管理 会议发起人能够查询到别的系统的会议室的安排情况，以便发起网络会议。由管理员对 会议室进行管理，员工使用会议室时进行预约，由管理员统一安排。并且提供对会议通知发 布和会议记录提交功能 3.2.13.2.1 会议室管理会议室管理 包括设施分类维护、会议室设施管理、会议室管理、会议室预定审批和会议室使用报表 功能。 图 23 会议室管理类图 人 人 人 人 人 : 人 人 人 人 人 : 人 人 人 人 人 : 人 人 人 : DB bookRoom( ) agree( ) updRoomState( ) startMeet( ) update( ) 图 24 会议室管理时序图 3.2.23.2.2 会议管理会议管理 会议组织者对会议和会议记录进行维护。与会者可以查询会议并查看会议记录。 人 人 人 人 : 人 人 人 人 人 : 人 人人 人 : DB startMeet( ) addMeet( ) Notice update( ) 图 25 会议管理时序图 3.33.3 系统管理系统管理 系统管理员进行后台管理的模块，包括组织管理、安全控制。 图 26 系统管理时序图 图 27 系统管理类图 3.3.13.3.1 组织管理组织管理 本模块维护是对集团或区域公司的组织结构、角色划分、人员信息的功能。包括部门维 护、角色维护、员工信息维护。 图 30 组织管理类图 Operation : adminaddStaff : staffaddRole : roledistributePriv : privilege setSid( ) setRoleId( ) setPrivId( ) getPrivid() getRoleId( ) getSid 图 31 组织管理时序图 4 4 系统数据结构设计系统数据结构设计 4.14.1 说明说明 在面向对象的设计方法中，数据也可以作为一个对象来处理，如果数据附属于某一对象， 可以将其纳入该对象的属性管理之中。所以在面向对象的设计过程中，对数据的设计是在对 对象的设计过程中完成的。 4.24.2 数据结构数据结构 列名类型可否为空说明 员工基本信息表（实体） ID IntNokey 主题vchar（20）No 正文vchar（20）Yes 时间dateno 员工表 工号intnokey 姓名vchar(20)no 所属部门vchar(20)no 部门职位vchar(20) 年龄vchar(20)no 性别vchar(20)no 办公电话intno 移动电话int no Email vchar(20)yes 地址vchar(20)yes 个性简介vchar(20)yes 密码表 工号intnokey 密码intno 会议室表 id intnokey 名称vchar(20)no 详细信息vchar(20)no 申请会议室表 id intnokey 开始时间dateno 结束时间dateno 申请工号vchar(20)no 状态码vchar(20)no 备注vchar(20)yes 会议室状态表 typeid vchar(20)nokey 状态vchar(20)no 申请会议表 id Int nokey 发起工号vchar(20)no 开始时间dateno 结束时间dateno 会议室 idvchar(20)no 主题vchar(20)no 状态码vchar(20)no 正文clubno 会议通知表 会议 idintnokey 工号vchar(20)no 部门表 id intnokey 部门名称vchar(20)no 角色表 id intnokey 所属部门 idintno 角色名称vchar(20)no 共享文件夹设置表 id intnokey 共享工号intno 文件存储表 工号intnokey 文件名vhcar(20)no 文件内容clobyes 文件夹信息表 工号intnokey 已使用大小vchar（20）no 通讯录表 id intnokey 姓名vchar(20)no 性别vchar(20)no