1、 接口项目需求说明书(技术资料，注意保密) 深圳市神州通在线科技有限公司 Page 1 of 31即时通讯系统软件需求规格说明书文件标识： 神州通在线-即时通讯系统-需求规格说明书当前版本： 11作 者： 邓炜文件状态： 草稿 正式发布 正在修改 完成日期： 2011 年-7 月-13 日接口项目需求说明书(技术资料，注意保密) 深圳市神州通在线科技有限公司 Page 2 of 31变更历史日期 版本 修改内容 修改人 备注2011/7/13 V1.0 即时通讯系统软件需求规格说明书 邓炜2011/7/15 V1.1 即时通讯系统软件需求规格说明书 邓炜审核历史日期 版本 说明 审核人 备注接
2、口项目需求说明书(技术资料，注意保密) 深圳市神州通在线科技有限公司 Page 3 of 31目录引言 .3编写目的 .3背景 .3文档读者 .3文档内容 .3参看资料 .31 任务概述 41.1 任务目标 .41.2 运行环境 .42 实现功能 .42.1 用户管理系统 .42.2 系统结构 .63 总体功能需求 .63.1 功能划分 .63.2 默认操作约束 .63.3 默认操作流程 .73.3.1 用户登录 73.3.2 系统信息管理 83.3.3 个人信息管理模块 133.3.4 文字聊天模块 183.3.5 语音功能模块 .223.3.6 视频功能模块 25接口项目需求说明书(技术资
3、料，注意保密) 深圳市神州通在线科技有限公司 Page 4 of 31引言编写目的此需求说明书为即时通讯系统定义明确的需求，为该系统的详细设计、开发工作提供依据，为项目设计人员、开发人员、使用人员和其他相关人员对系统实现的功能达成统一的认识提供一个明确的书面说明。本文档的内容，大部分是对即时通讯流程的一些阐述。背景待开发的软件系统的名称：即时通讯系统软件项目的用途：用于商业公司软件项目的范围：系统涉及企业的内部文字即时通讯本项目的任务提出者：神州通集团开发者：神州通在线科技有限公司目标用户：商业企业文档读者本文档的读者为即时通讯系统开发人员、测试人员、实施人员以及相关领导，如下：XXXXXXX
4、XXXXXXXXXXX文档内容文档名称：即时通讯系统需求设计说明书文档内容：系统描述即时通讯系统的框架及功能参看资料接口项目需求说明书(技术资料，注意保密) 深圳市神州通在线科技有限公司 Page 5 of 311 任务概述1.1 任务目标方便企业内部的沟通联系，防止 QQ，MSN 等即时通讯软件中的娱乐成分影响工作。即时通讯系统能完成点对点的即时通讯，信息在企业内部的广播，以及建立群聊天室进行文字会议。1.2 运行环境服务器：Windows 2003 Server数据库：Oracle基础平台：.Net Framework 4.0浏览器插件：silverlight接口项目需求说明书(技术资料，
5、注意保密) 深圳市神州通在线科技有限公司 Page 6 of 312 实现功能2.1 用户管理系统 用户管理功能 用户注册 用户登陆 用户信息查询 普通用户查询个人信息 管理员查询全部信息 用户信息修改 普通用户修改个人信息 管理员修改全部信息 用户删除（管理员） 添加新用户2.即时通信功能 端对端短信发送2.2 聊天记录查询 短信群发功能 端对端的文件发送 端对端的视频发送 消息广播流程描述：接口项目需求说明书(技术资料，注意保密) 深圳市神州通在线科技有限公司 Page 7 of 312.2 系统结构 系统包括两种终端：服务器端、客户端 服务器承担客户端获取机器列表、查询机器 IP 等服务
6、，也是群聊的服务器 客户端和客户端之间，客户端和服务器之间可以点对点进行通信 一个局域网内服务器只能启动一个关键通讯模式说明：客户端与客户端私聊发送信息用户打开首页注 册 / 登陆普通用户 管理员管理个人资料 即时通信操作 用户信息管理普通用户增加用户修改用户删除用户查询用户修改个人信息查询个人信息聊天记录查询传输文件短信群发收发短信消息广播视频聊天接口项目需求说明书(技术资料，注意保密) 深圳市神州通在线科技有限公司 Page 8 of 31客户端 1 客户端 2从服务器端获取信息客户端 服务器注：获取信息是需要应答的。用户管理信息返回应答接口项目需求说明书(技术资料，注意保密) 深圳市神州
7、通在线科技有限公司 Page 9 of 313 总体功能需求3.1 功能划分根据业务需求和系统功能分为以下几个部分： 文字即时通讯 管理员可以添加删除人员 本人修改密码 实名显示公司所有员工 广播消息于公司全体成员 发起多人的文字聊天室 本地通讯记录保存于数据库，可以查询本人的通讯记录3.2 默认操作约束 增加删除成员（需要权限）3.3 默认操作流程3.3.1 用户登录用例图图 3.3 登录用例图接口项目需求说明书(技术资料，注意保密) 深圳市神州通在线科技有限公司 Page 10 of 31用例分析用户在使用本系统前必须进行资格核查，包括系统管理员。核查的内容包括：用户 ID 和密码。在通过
8、用户身份验证之后，系统将初始化该用户的基本信息（例如更新用户状态为上线、留言提示等） 。3.3.1.1 用户登录基本流程用户输入用户名、密码，然后点击登录按钮。用户登录系统后，会根据当前用户类别，如一般用户、管理员，显示不同的界面。在稍后的操作中，根据用户类型控制权限。分支流程1. 如果用户没有输入用户名，系统将显示一条错误消息，指出错误并提示用户输入用户名;2. 如果用户没有输入密码，系统将显示一条错误消息，指出错误并提示用户输入密码;3. 如果用户输入的用户名未被注册，系统提示用户输入的用户名不存在。4. 如果用户输入的用户名密码错误，系统将显示一条错误消息，指出错误并提示用户输入正确的用
9、户名和密码;时序图图 3.4 登录顺序图3.3.2 系统信息管理用例图接口项目需求说明书(技术资料，注意保密) 深圳市神州通在线科技有限公司 Page 11 of 31图 3.6 系统管理用例图用例分析该功能模块主要实现对系统的管理，阐明了管理员的权限及操作，实现了后台对客户端数据及信息的管理。其功能包括发布系统公告，添加新来职员信息，修改老员工的信息以及删除离职员工的所有信息，同时管理员可以实现对自己密码信息的修改。（1）发送系统公告基本流程管理员需要发布最新公告时，点击公告发送按钮进入公告发送窗口，输入需要发送的公告，点击发送按钮，该消息即可群发给每个用户。分支流程1、如果没有输入信息，直
10、接点击发送。系统会提示错误，请求输入信息。2、如果用户在线则可以马上接收到公告。3、若用户离线，则该公告储存到数据库，等用户上线时系统将自动将数据库中的公告发送给用户。活动图接口项目需求说明书(技术资料，注意保密) 深圳市神州通在线科技有限公司 Page 12 of 31图 3.7 公告发送活动图（2）添加用户基本流程管理员为新来职员创建新的用户 ID，管理员点击添加按钮，输入新用户的基本信息，然后点击确认按钮，系统立即把所填信息保存至数据库中，从而实现了用户的添加。分支流程1. 如果添加信息时出现用户 ID 相同，则系统提示该用户已存在，同时清除文本框中已填写的内容。2. 添加用户信息时如果
11、员工的关键信息未填写（如员工号，部门等信息） ，系统将会提示信息应填写完整。顺序图图 3.8 用户添加顺序图接口项目需求说明书(技术资料，注意保密) 深圳市神州通在线科技有限公司 Page 13 of 31（3）查看用户资料基本流程当需要查看某个职员信息时，管理员可以通过点击查看按钮进入查看界面，根据关键信息搜索目标用户，选中该用户后点击确定，即可显示该用户的所有信息。 分支流程1. 如果未搜到该用户，系统将提示该用户不存在。2. 如果搜索的信息与需要查找的用户信息不相符，则退出用户信息窗口，重新按其他关键词搜索。顺序图图 3.9 资料查询顺序图（4）修改用户资料基本流程当管理员需要修改某个员
12、工的信息时，打开用户资料界面，找到需要修改的文本框，删除原有信息，填写上最新消息，修改完毕后点击确定按钮，提交给系统。分支流程1. 如果管理员试图修改用户关键信息（如职员 ID 号，职员姓名等） ，系统会提示修改失败。2. 如果修改用户的部门信息时，输入的部门在系统中不存在，提示修改无效，要求管理员重新输入用户部门名称。3. 如果修改用户的职位信息时，输入的职位在系统中不存在，提示修改无效，要求管理员重接口项目需求说明书(技术资料，注意保密) 深圳市神州通在线科技有限公司 Page 14 of 31新输入用户部门名称。顺序图图 3.10 资料修改顺序图（5）删除用户：基本流程管理员需要删除某个
13、员工的信息时，打开用户删除窗口，选中离职员工点击删除，即可实现用户删除。分支流程1. 如果管理员选择验证对话框中的“取消”按钮，则退出验证对话框，管理员可以继续选择其他需删除的用户。接口项目需求说明书(技术资料，注意保密) 深圳市神州通在线科技有限公司 Page 15 of 31图 3.11 用户删除顺序图（6）修改密码基本流程管理员进入修改管理员密码窗口后，首先输入原有密码，再重新输入两次新密码，两次新密码需保持一致，修改完点击“确定”按钮提交最新密码信息。分支流程1. 如果原有密码输入错误，则系统提示错误，同时清除文本框中的已输入的内容。2. 如果原有密码输入正确，而两次输入的新密码不一致
14、，则系统提示错误，并清除文本框中的已输入的内容。图 3.12 密码修改顺序图接口项目需求说明书(技术资料，注意保密) 深圳市神州通在线科技有限公司 Page 16 of 31(7)系统管理界面3.3.3 个人信息管理模块用例图图 3.14 个人信息管理用例图用例分析公司职员在个人信息管理中，可以对个人的基本资料进行修改操作，或者补充管理员创建用户时没有填写完整的资料，修改登陆系统的个人密码，查看其他同事的基本资料，还可以根据需求设置自己在系统中的显示状态。(1)修改个人资料基本流程用户点击修改个人资料按钮，系统显示资料修改窗口。用户根据自己的需求编辑个人的资料，完成之后点击提交，系统显示个人资
15、料修改成功窗口。接口项目需求说明书(技术资料，注意保密) 深圳市神州通在线科技有限公司 Page 17 of 31分支流程1. 如果用户修改了无权修改的资料，如用户名、部门、职位等，系统显示操作错误，并提示用户无权进行此项操作。2. 如果用户修改完资料后点击取消，系统不保存修改结果，窗口关闭。3. 如果用户修改完资料后没有进行确认或取消操作，则系统始终显示个人资料修改窗口。顺序图图 3.15 个人修改资料顺序图(2)修改密码基本流程用户点击修改个人密码按钮，系统显示密码修改窗口。用户输入原始密码，然后输入新密码和确认新密码，完成之后点击提交，原始密码正确无误且确认密码和新密码一致，就可以成功修
16、改登陆密码，系统显示个人密码修改成功界面。分支流程1. 如果用户输入的原始密码错误，系统将显示一条错误消息，并提示用户输入正确的原始密接口项目需求说明书(技术资料，注意保密) 深圳市神州通在线科技有限公司 Page 18 of 31码；2. 如果用户输入的确认密码和新密码不一致，系统将显示一条错误消息，并提示用户新密码和确认密码不一致；3. 如果用户修改完密码后点击取消，则系统不保存修改结果并关闭页面。4. 如果用户修改完密码后没有进行确认或取消操作，则系统始终显示密码修改界面。顺序图图 3.16 密码修改顺序图（3）查看用户资料基本流程用户需要查看同事资料时，选择所要查看的同事的资料项，系统
17、显示同事的个人资料页面，但不会显示密码资料。用户查看完毕之后点击关闭，系统关闭该页面。分支流程1. 如果用户在查看同事资料时做编辑操作，系统将提示一条错误消息；2. 如果用户查看完同事资料后没有进行关闭操作，则系统始终显示查看同事资料页面。接口项目需求说明书(技术资料，注意保密) 深圳市神州通在线科技有限公司 Page 19 of 31顺序图图 3.17 用户资料查看顺序图（4）设置状态基本流程用户点击设置状态按钮，系统显示状态设置页面。用户根据自己的需求选择自己在系统中的显示状态，包括在线、离线和隐身三种状态，点击确认后用户将在系统中显示相应的状态。顺序图接口项目需求说明书(技术资料，注意保
18、密) 深圳市神州通在线科技有限公司 Page 20 of 31图 3.18 设置状态顺序图3.3.4 文字聊天模块用例图图 3.20 文字会话模块用例图用例分析用户登录后可以与其他同事进行文字会话。若对方在线，则可以直接接收信息，并回复信息，那么双方就可以进行在线的文字会话。如果对方不在线，可以通过留言的方式，向对方发接口项目需求说明书(技术资料，注意保密) 深圳市神州通在线科技有限公司 Page 21 of 31送信息。在对方登录后，系统会提示对方查看留言。此外，用户与用户之间的文字会话内容保存在本地文件中，方便用户以后查询。如果存储空间已满，只保存最近的信息。用户可以根据需要查询与某位同事
19、的相关历史会话记录。（1）发送信息基本流程用户可以选择任意一位同事进行文字会话。点击与该同事的文字会话按扭，启动文字会话，即打开文字会话框。用户在会话框内输入要发送的信息，然后点击发送按扭就完成了信息的发送。分支流程1如果该同事在线，对方可以直接收到信息。2如果该同事不在线，则信息会以留言的形式发出。3如果用户没有输入任何信息就点击发送按扭，系统将显示一条错误信息，指出错误并提示用户输入信息。4如果用户在对方不在线的情况下发送图片信息，系统将显示一条错误信息，指出错误并提示用户对方不在线，不能发送图片信息。5如果信息发送不成功，则系统提示由于某种原因信息发送不成功，在输入框中的信息仍然存在。6
20、如果发送信息成功后，用户不关闭对话框，则对话框继续保持，但输入框中原有信息消失，输入框为空。（2）接收信息基本流程用户在成功登录后，如果有其他用户发送来的信息或留言，系统会有信息提示音响起，提示用户查看信息。此时用户可以点击相应的信息接收按扭来显示并查看信息，然后用户可以直接进行信息回复。分支流程1如果用户不在线时有其他用户发来信息并未超出规定时间，则用户登录后可点击信息接收按扭来接收并查看信息。2如果留言信息在规定的时间内（如 5 天）未被查看，则相应的信息在用户登录时不会被用户接收到，此信息作废。接口项目需求说明书(技术资料，注意保密) 深圳市神州通在线科技有限公司 Page 22 of
21、31（3）处理历史信息用例分析当用户之间进行文字会话后，系统将对会话内容进行处理，包括将会话内容备份，方便用户以后查询。如果用户启动历史信息查询，根据查询要求，可以导出与相应同事的会话记录。a）备份历史信息基本流程当接收到对方发来的信息时，会显示在会话框内。当会话结束后，还会自动保存一份会话记录在本地文件中。本地发送的信息，除发送给对方外，会话结束后也会自动保存一份在本地文件中。b）查询历史信息基本流程当用户需要进行历史信息查询时，先启动相应文字会话框。然后点击会话记录按扭，系统会从本地文件中调出相应的会话记录并显示或导出为文本文件。分支流程1、 如果用户与同事之间没有进行文字会话，则查询时记
22、录为空。2、 如果用户与同事之间进行了文字会话，但本地文件被破坏或删除，则查询不到相关记录。3、 如果用户与同事之间进行了文字会话，但会话内容在本地文件中被新的会话内容所覆盖，则查询不到相关记录。（4）文字会话活动图接口项目需求说明书(技术资料，注意保密) 深圳市神州通在线科技有限公司 Page 23 of 31图 3.21 文字会话活动图（5）文字会话界面接口项目需求说明书(技术资料，注意保密) 深圳市神州通在线科技有限公司 Page 24 of 313.3.5 语音功能模块用例图图 3.23 语音功能模块总用例图用例分析用户登陆后能够与其他职员进行音频会话。若对方在线并且接受了请求，那么双
23、方就可以进行在线会话，会话期间双方都能够对本次会话进行一些控制（比如说设置静音、调节音量等） ，双方还能够随时终止本次会话。若对方不在线，系统会提示对方不在线，并询问是否音频留言，若接受音频留言建议，则可以通过音频留言操作给对方留言，在对方上线后，系统会提示对方收听留言，对方可以接受或者拒绝收听留言。对于已经收听的留言，服务器不再进行保存。若对方在线，还可以申请给对方播放音频文件，若对方接受请求，则会话双方可以同时听到同一个音频文件的内容。在播放音频文件的过程中，会话双方都可以对本次播放做一些调节，但是调节的效果对另一方是不起作用的。(1)在线会话基本流程当用户希望与其他在线职员进行音频会话时
24、，应点击音频会话按钮，系统发送一个请求给接口项目需求说明书(技术资料，注意保密) 深圳市神州通在线科技有限公司 Page 25 of 31对方，若对方接收请求则双方就可以通话了。通话过程中，双方都可以调节耳机的音量和麦克风的音量。若不想让对方听见你的声音则可以选中静音。分支流程：1、 如果对方不在线，则不能进行在线会话，系统会询问是否进行音频留言。2、如果对方对你的请求不给予响应，则不能进行通话且系统一直处于等待连接状态，但你可以取消请求。4、 如果对方拒绝你的请求，则请求失败，系统返回未请求之前的界面。4、如果连接未建立，则不能进行会话控制（调节音量或者设置静音） ，系统会将音量调节和设置静
25、音按钮设为不可用的。（2）音频留言基本流程当用户希望与其他职员进行音频会话，而对方又不在线的情况下，系统会给出添加音频留言的建议。若接受该建议，则该用户可以开始录制音频留言，录制完毕之后该留言将保存在服务器。在对方上线之后，系统会提示对方收听音频留言，对方用户选择接受来收该听音频留言。分支流程1、如果用户不接受系统的留言建议，则系统不进行音频留言操作。2、如果用户在音频留言的录制中退出，则系统对用户录制的留言不进行保存，系统提示音频留言失败。3、如果用户在录制完音频留言后未经发送就退出，系统会询问是否要发送留言，若不响应系统的询问则该次留言失败。4、如果对方用户在收到系统给出的留言提示后，不对
26、其进行响应（在某个时间段未响应）则系统默认为对方用户拒绝收听该留言。活动图接口项目需求说明书(技术资料，注意保密) 深圳市神州通在线科技有限公司 Page 26 of 31图 3.24 语音留言活动图（3）音频文件播放基本流程用户发送一个播放音频文件的请求给其他在线职员。对方接受该请求则该通道建立。请求方点击“添加播放文件”进行本地音频文件装载，装载完音频文件后，请求方即可点击“播放”按钮来给对方播放音频文件。同时请求方也能够收听到该音频文件的内容。在播放过程中，请求方可以点击相应的按钮来进行快进、调节音量等播放控制。受邀方则只能进行音量调节。在该过程中，双方都可以通过点击退出按钮来结束本次播
27、放。分支流程1、如果受邀方不在线，则不能进行音频文件播放。系统会给出相应的提示后返回。2、如果用户装载的音频文件类型不符合系统规定，则该音频文件无法播放，同时系统提示用户选择正确的类型。3、如果用户是受邀方，且试图添加播放文件，则系统会提示用户没有权限，本次添加操作接口项目需求说明书(技术资料，注意保密) 深圳市神州通在线科技有限公司 Page 27 of 31失败。4、如果用户是受邀方，且试图进行快进、倒退等播放控制，系统将不对其操作进行响应，同时将所有动作复位。顺序图图 3.25 音频播放顺序图（4）界面原型图 3.26 音频原型图3.3.6 视频功能模块用例图接口项目需求说明书(技术资料
28、，注意保密) 深圳市神州通在线科技有限公司 Page 28 of 31图 3.27 视频功能用例图用例分析用户可以在视频会话之前进行视频设置，如调节视频的窗口位置和大小。选中要视频的某位职员后，在其对话框中直接发送请求到对方的客户端，系统会提示对方接受视频请求。若接受请求，则等待视频连接。用户通过设置视频的相关参数可使视频更加流畅，如显示控制、视频参数设置。（1）请求发送基本流程当用户需要进行视频会话时，应先向对方发送视频请求等待对方接收。用户通过点击视频会话按钮，系统弹出视频会话界面，同时系统显示是否取消视频会话。分支流程1.如果对方用户不在线，系统则显示一条信息对方不在线不能接受视频请求，
29、并且请求断开。2.如果对方拒绝视频请求，系统则显示一条信息对方拒绝请求，并且请求断开。3.如果对方不响应请求，则一直等待。4.如果对方退出系统，则显示一条信息对方拒绝请求，并且显示断开。（2）请求接受基本流程接口项目需求说明书(技术资料，注意保密) 深圳市神州通在线科技有限公司 Page 29 of 31当对方请求视频会话时，系统会提示是接受还是拒绝请求，用户可以根据自己的需要来选择。用户点击接受视频按钮，系统则显示一条信息已接受请求，则弹出视频会话对话框，建立连接，开通视频，进行视频会话。分支流程1. 如果用户收到了视频请求并点击拒绝视频按钮，系统则显示一条信息已拒绝请求，并且向请求方发送一个拒绝请求的信息。2. 如果用户既不拒绝也不接受视频请求，系统将一直显示请求信息。3.如果用户关掉文字会话窗口则向请求方发送一个拒绝请求的信息，并退出文字会话框。4.如果用户关闭系统，则系统自动向请求方发送一个拒绝请求的信息。（3）发送/接受请求顺序图接口项目需求说明书(技术资料，注意保密) 深圳市神州通在线科技有限公司 Page 30 of 31图 3.28 视频发送/接受请求顺序图（4）视频会话原型图
