企业即时通需求规格说明书.doc

企业即时通产品需求规格说明书- 17 -机构图标企业即时通产品需求规格说明书文件状态： 草稿 正式发布 正在修改文件标识：Hands-On-企业即时通-RD-PRS当前版本：1.0作 者：完成日期：2006-5-20机构公开信息版 本 历 史版本/状态作者参与者起止日期备注草稿：1.02006-5-18至2006-5-20新建 目 录 0. 文档介绍40.1 文档目的40.2 文档范围40.3 读者对象40.4 参考文档40.5 术语与缩写解释51. 产品介绍62. 产品面向的用户群体63. 产品应当遵循的标准或规范64. 产品范围65. 产品中的角色66. 产品的功能性需求76.0 功能性需求分类76.1 用例图86.2 用例描述107. 产品的非功能性需求177.1 用户界面需求177.2 软硬件环境需求187.3 产品质量需求180. 文档介绍0.1 文档目的本文档主要针对企业信使软件的使用环境与功能提出具体的要求，同时它还将作为该产品设计与开发的重要参考依据。0.2 文档范围本文档包含以下几部分：1.产品介绍2.产品面向的用户群体3.产品应当遵循的标准或规范4.产品的范围5.产品中的角色4.产品的功能性需求5.产品的非功能性需求6.需求确认0.3 读者对象本文档的读者范围包括：1.需求提供方具体责任人2.开发方的项目经理、系统分析设计人员、测试人员0.4 参考文档提示：列出本文档的所有参考文献（可以是非正式出版物），格式如下：标识符 作者，文献名称，出版单位（或归属单位），日期例如：SPP-PROC-PP SEPG，需求开发规范，机构名称，日期0.5 术语与缩写解释缩写、术语及符号解 释Corperation Messager企业即时通软件的英文名称IPInternet Protocol 的缩写网络协议TCPTransmission Control Protocol的缩写传输控制协议UDPUser Datagram Protocol 的缩写用户数据报协议1. 产品介绍企业即时通（Corperation Messager）软件是一款供企业或公司内部使用的网络聊天工具，主要用于员工之间的即时通信与交流。它主要由服务器端程序和客户端程序两部分组成，整体采用Java平台进行开发并实现，用户数据选用Microsoft SQL Server 2000进行统一管理。2. 产品面向的用户群体企业即时通软件（Corperation Messager）主要是提供给拥有公司内部网络的企业使用。它不仅使公司员工之间的交流变的方便快捷，还充分利用了内网资源，保证了内部信息的安全。3. 产品应当遵循的标准或规范本产品的使用是建立在互联网标准通信协议之上的，其中支持的协议主要包括：IP协议、TCP协议、UDP协议。4. 产品范围企业即时通（Corperation Messeger）是专门提供给拥有企业内网的公司使用的一款即时通讯工具。由于是企业内部使用，为了保证用户身份的有效性，所有用户的基本信息统一由该软件的服务器端程序进行管理，客户端程序不向用户提供申请注册功能。所以，该软件不适合在公开的Internet上使用。5. 产品中的角色角色名称职责描述服务器系统管理员登录软件，启动、停止服务器，维护公司信息，维护部门信息，维护用户基本信息客户端用户登录软件，发送、接收消息，维护个人信息，查看好友信息6. 产品的功能性需求6.0 功能性需求分类功能类别功能名称、标识符描述用户登录用户登录Client_Login根据用户填写的服务器IP和端口号发送连接请求。连接成功后登录数据库，服务器对用户的身份进行验证。用户信息维护用户信息维护Client_UserInfoManagement将用户修改后的基本信息及更新请求发送至服务器，服务器收到更新用户信息的请求，将数据库中的数据更新，然后返回提示信息。聊天聊天Client_Chat提交发送信息，服务器将收到的消息转发给指定用户。显示接收到的消息。查看好友信息查看好友信息Client_FindFriendInfo向服务器发送查找好友信息的请求，显示好友的信息维护聊天记录清除聊天记录Client_ClearChatRecord清除本地的聊天记录导出聊天记录Client_ExportChatRecord将本地的聊天记录导出到文本文件中重新登录重新登录Client_LogOut注销，重新登录客户端程序启动服务启动服务Server_StartUp自动设置服务器端套接字，启动服务后监听客户端的请求，同时显示连接状态和接收请求的信息。停止服务停止服务Server_Stop向客户端发送消息，关闭服务器端的套接字，断开与客户端的连接，显示服务器状态。查看服务器配置信息查看服务器配置信息Server_Configuration显示服务器端的IP地址和端口号查看在线人员详细信息查看在线人员详细信息Server_Oline显示当前在线人员的详细信息公司基本信息维护更新公司基本信息Server_UpdCorpInfo向服务器发送更新公司信息的请求，更新公司的基本信息部门信息维护增加部门信息Server_AddDeptInfo填写新增部门信息，向服务器发送增加部门信息的请求，增加一个新部门删除部门信息Server_DelDeptInfo向服务器发送删除部门信息的请求，删除部门的基本信息更新部门信息Server_UptDeptInfo向服务器发送更改部门信息的请求，更改部门的基本信息增加用户的基本信息Server_AddUserBasInfo填写新用户信息，向服务器发送增加用户信息的请求，增加一个新用户用户基本信息维护删除用户的基本信息Server_DelUserBaseInfo向服务器发送删除用户信息的请求，删除用户的基本信息更新用户的基本信息Server_UpdUserBaseInfo向服务器发送更改用户信息的请求，更改用户的基本信息初始化用户的密码Server_InitUserPwd向服务器发送更改用户信息的请求，将用户的密码作初始化处理6.1 用例图6.1.1 企业即时通客户端图6-1 企业即时通客户端用例图6.1.2 企业即时通客户端维护聊天记录子用例图6-2 企业即时通客户端维护聊天记录子用例图6.1.3 企业即时通服务器端图6-3 企业即时通服务器端用例图6.1.4 企业即时通服务器端部门信息维护子用例图6-4 企业即时通服务器端部门信息维护子用例图6.1.5 企业即时通服务器端用户基本信息子用例图6-5 企业即时通服务器端用户基本信息子用例图6.2 用例描述1. 用户登录1.0 用例名称：用户登录客户端功能：用于与服务器建立连接，连接成功后登录服务器。1.1 简要说明：本用例的功能主要向服务器发送连接请求，并向服务器提供验证所需要的用户名和密码。1.2 事件流：1.2.1 基本流：1 用户填写用户名、密码、服务器IP地址、端口号。2 用户请求登录。3 客户端程序检查用户填写的内容是否合法（具体要求请参照1.3 特殊需求），如果未通过检查，则转向备选流1。4 客户端程序向服务器发送连接请求，如果出现连接超时，转向备选流2。5 服务器接收请求，连接成功。6 服务器验证用户名和密码，如果验证没有通过，转向备选流3。7 验证通过，显示客户端程序主窗体。8 用户执行其它操作将退出本用例。1.2.2 备选流：1.2.2.1 备选流1：1 如果客户端检查没有通过，比如没有输入用户名，应提示“用户名不能为空！”，如果输入的用户名超过了指定的列数，应提示“用户名的列数不能超过x列！”，诸如上面的提示均是有效提示。2 用户返回基本流1。1.2.2.2 备选流2：1 如果用户请求连接超时，将返回“服务器连接超时，请与网络管理员联系！”的消息。2 用户返回基本流1。1.2.2.3 备选流3：1 如果用户身份没有通过服务器验证，将返回“用户名或者密码有误！”的消息。2 用户返回基本流1。1.3 特殊需求：1 用户名字符的位数：8-10，必填。2 密码字符的位数：6-10，必填，并以掩码“*”显示。3 IP地址由数字和“.”组成,格式为xxx.xxx.xxx.xxx,共15位,xxx的范围：0-255，必填，4 端口号为数字，范围80009999，必填。1.4 前置条件：1 以合法身份登录操作系统，启动客户端软件。1.5 后置条件:1 用户登录成功,显示客户端主窗体。2 用户信息维护2.0 用例名称：用户信息维护客户端功能：可以通过此功能更新用户的详细信息。2.1 简要说明：本用例的功能向服务器提交更新用户信息的请求，完成用户信息的更新操作。2.2 事件流：2.2.1基本流：1 填写用户基本信息，包括：昵称、密码、确认密码、真实姓名、性别、常用电话、Email、来自、头像、个人资料。2 用户请求更新个人信息3 客户端程序对用户的输入项进行检查（具体要求请参照2.3 特殊需求），检查通过后将更改后的用户信息提交给服务器。如果没有通过检查，转向备选流1。4 服务器接收用户提交的更新请求，执行数据更新业务，完成用户个人信息的更新。若更新操作失败，转向备选流2。5 客户端显示“您的信息已经更新成功！”消息，关闭当前窗体。6 用户执行其它操作将退出本用例。2.2.2 备选流：2.2.2.1 备选流 1：1 如果用户填写的信息没有通过客户端程序的验证，将显示诸如“您输入的XXX的YY有误，请重新输入！”的提示消息，例如“您输入的用户名的位数有误！”，或者“确认密码与密码不符，请检查！”，“昵称不能为空！”以上均为有效的提示信息。2 用户返回基本流1。2.2.2.2 备选流 2：1 如果服务器执行更新操作失败，将显示“用户信息更新操作失败！”的提示消息。2 用户返回基本流1。2.3 特殊需求：1 昵称字符的位数：8-10，必填。2 密码字符的位数：6-10，必填，以掩码“*”显示。3 密码确认字符的位数：6-10，必填，以掩码“*”显示。4 真实姓名字符的位数：1-10，必填。5 性别默认值为男，必填。6 头像默认值default.gif。2.4 前置条件：1 客户端与服务器端已经建立起连接，用户以合法身份进行登录，打开客户端的主窗体。2 用户请求更新个人信息。2.5 后置条件1 服务器更新用户信息成功，显示更新后的用户信息。3 聊天3.0 用例名称：聊天客户端功能，可以通过此功能与其他用户进行在线即时通信。3.1 简要说明：本用例是客户器端软件的核心，用户通过本功能提供的窗体与其他用户进行实时通讯。3.2 事件流：3.2.1 基本流：3.2.1.1 基本流1：1 用户请求与某个在线用户聊天。2 用户向服务器发送消息。3 聊天信息发送至服务器。如果发送失败，转向备选流1。4 用户执行其它操作将退出本用例。3.3.2 备选流：3.3.2.1 备选流 1：1 客户端程序显示提示信息“您的消息转发超时，请重新发送！”。2 返回基本流2。3.3 特殊需求：1 用户不能发送空信息。3.4 前置条件：1 客户端与服务器端保持正常连接状态。3.5 后置条件：1 聊天双方可以正常通信。4 查看好友信息5 维护聊天记录6 重新登录7启动服务器服务7.0 用例名称：Server_Startup中文名称：启动服务器服务服务器端功能：可以通过此功能启动服务器。7.1 简要说明：本用例的功能是启动服务器服务，侦听客户端发送的请求，响应客户端请求。7.2 事件流：7.2.1 基本流：1 运行服务器端程序。2 获取本地IP地址，从本地配置文件中读取端口号，如果读取失败转向备选流1。3 设置服务器配置信息。4 弹出服务器端主窗体，工具栏上“启动服务”按钮的状态应为禁用。5 菜单栏中“启动服务”菜单状态应为禁用。6 服务器端主窗体的标题栏应改为“服务器已经启动”。7 服务器启动成功，进入侦听状态，等待客户端发送的请求。7.2.2 备选流：7.2.2.1 备选流1：1 如果从本地配置文件读取不到端口信息或本地配置文件不存在等，将显示诸如“服务器程序配置出错，服务器启动失败，请于管理员联系！”的提示消息。2 服务器启动程序自动关闭。7.3 特殊需求：无7.4 前置条件：运行服务器端应用程序。7.5 后置条件：服务器启动成功。 8 停止服务9 查看服务器配置信息10查看在线人员详细信息11公司基本信息维护12 部门信息维护12.0 用例名称：Server_ManageDepartment中文名称：部门信息维护服务器端功能：可以通过此功能更新部门信息。12.1 简要说明：本用例的功能是向服务器端提交更新部门信息的请求，完成部门信息的更新操作。12.2 事件流：12.2.1 基本流： 1 用户选择菜单信息维护(M)部门信息(D)菜单项。2 系统显示所有部门信息列表。3 用户可以选择要操作的部门。4 系统显示该部门的部门名称、部门描述信息。5 用户可能执行如下的操作：5.1 用户选择添加操作，系统执行添加部门信息子流；5.2 用户选择删除操作，系统执行删除部门信息子流；5.3 用户选择修改操作，系统执行修改部门信息子流；6 用户选择其他操作的时候，系统结束此用例。1 添加部门信息子流1.1 系统显示“添加部门信息”窗体。1.2 用户可能进行下面两种操作：1.2.1 用户选择取消，返回基本流5。1.2.2 用户输入部门信息，并确认操作，如果输入信息不符合要求则转向备选流1。1.3 系统保存新部门的信息，并提示“部门信息添加成功！”。1.4 返回基本流5。2 删除部门信息子流2.1 系统显示用户所选择的部门信息。2.2 用户点击“删除”操作。2.3 系统检查用户所选择的部门下面是否有员工，可能两种情况：2.3.1 部门下有员工，提示用户是否连同员工信息一同删除。2.3.2 部门下没有员工，则直接删除该部门，如果删除失败转向备选流2。2.4 系统删除用户指定的部门，并提示“部门信息删除成功！”。2.5 返回基本流53 修改部门信息子流3.1 系统显示用户要修改的部门信息。3.2 用户输入要修改的部门信息，并确认操作。3.3 系统则提示用户是否确认修改。3.4 用户可以进行下面两种操作：3.4.1 用户选择取消，返回基本流5。3.4.2 用户确认修改，系统则提交修改信息，如果输入的信息不符合则转向备选流2。3.5 系统更新部门信息完毕后提示“部门信息更新成功！”。3.6 返回基本流5。12.2.2 备选流：12.2.2.1 备选流 1：1 用户输入的部门信息不符合要求，则系统可以提示下面的信息：“您输入的XXX列数有误，请检查！”，“部门名称不能为空！”等等，上面的提示信息均为有效信息。2 用户确认后返回到添加部门信息子流1.1，焦点定位至输入有误的文本框，同时清空该文本框的内容。3 如果部门信息添加失败，则系统向用户提示“部门信息添加失败，请与系统管理员联系！”。4 用户确认后返回基本流5。12.2.2.2 备选流 2：1 如果部门信息删除失败，系统向用户提示“部门信息删除失败，请与系统管理员联系！”。2 用户确认后返回基本流5。12.2.2.3 备选流3：1 用户输入的要修改的部门信息不符合要求，则系统提示用户输入的信息要符合系统要求，具体实例请参考备选流 1的步骤1。2 用户确认后返回到修改部门信息子流3.13 如果部门信息更新失败，则系统向用户提示“部门信息修改失败，请与管理员联系”的信息。4 用户确认后返回基本流5。12.3 特殊要求：1 添加部门信息时部门名称不能为空。2 修改部门信息时部门名称不能为空。12.4 前置条件：1服务器必须启动，用户才能进入本用例做以上操作。12.5 后置条件：1部门信息添加或修改完毕以后，在“部门信息维护”窗体中显示更新后的部门信息。 13 用户基本信息维护7. 产品的非功能性需求7.1 用户界面需求需求名称详细要求窗体显示位置_1除客户端主窗体之外，所有窗体初次启动时在屏幕位置居中窗体显示位置_2客户端主窗体初次显示位置在屏