myipphone-mipp软件产品设计说明.doc

1 31 My IP Phone MIPP 软件产品软件产品 设计说明书设计说明书 版本号版本号 V 1 0 上海中铁通信信号测试有限公司上海中铁通信信号测试有限公司 2010 年年 05 月月 2 31 I 31 文件修订记录文件修订记录 版本章节名称修订内容修订日期修订人批准人 I 31 目目 录录 1引言引言 3 1 1MIPP 软件产品的定位 范围 3 1 2产品开发依据 来源 3 1 3术语 3 2MIPP 软件产品设计输入软件产品设计输入 4 2 1需求与功能对应清单 4 2 2硬件运行平台 4 2 3软件运行环境 4 2 4本系统有接口关系的其它系统的资料 4 3设计概述设计概述 5 3 1概要设计方法和工具 5 3 2系统的体系结构 5 4总体设计总体设计 6 4 1系统架构 6 4 1 1系统部署图 UML 6 4 1 2设备清单 6 4 1 3软件架构 6 4 2功能设计 7 4 2 1功能 1 7 4 3接口设计 7 4 3 1用户界面 7 4 3 2硬件接口 7 4 3 3软件接口 7 4 3 4通信接口 7 4 4数据结构设计 7 4 4 1数据结构 标识符 7 4 4 2数据结构 2 标识符 8 4 5系统安全设计 8 4 5 1系统安全 8 4 5 2数据安全 8 4 5 3后备与恢复 8 4 5 4出错处理 8 5模块命名规则模块命名规则 9 2 31 1 引言引言 1 1 MIPP 软件产品的定位软件产品的定位 范围范围 My IP Phone 软件产品简称为 MIPP 1 2 产品开发依据产品开发依据 来源来源 1 3 术语术语 3 31 2 MIPP 软件产品设计输入软件产品设计输入 2 1 需求与功能对应清单需求与功能对应清单 软件需求说明书 指明软件需求说明书的相关部分 应将需求说明书中的用例清单复制到本 文档中 并说明与功能之间的关系 与第 4 章中功能编号相对应 用例编号用例名称优先级别对应功能编号 UC001 UC001 001 UT002 2 2 硬件运行平台硬件运行平台 需要用到的外部硬件设备 及其对本系统的约束或接口要求 2 3 软件运行环境软件运行环境 与本系统有交互的软件类型以及导致的约束条件 可能的类型有数据库管理系统 第三方提 供的 API 驱动程序 软构件库 包括控件 标准类库 标准函数 2 4 本系统有接口关系的其它系统的资料本系统有接口关系的其它系统的资料 4 31 3 设计概述设计概述 3 1 概要设计方法和工具概要设计方法和工具 整个设计所采用的方法 是面向对象设计还是结构化设计 以及使用到的相应技术和工具 例如 OMT Rose Visio 公司推荐 OO 方法 设计工具为 ROSE 系列产品 第四章以后部分适用于面向对象设计方法 如果使用结构化设计方法可对设计模型进行修改 3 2 系统的体系结构系统的体系结构 例如客户 服务器结构 5 31 4 总体设计总体设计 4 1 系统架构系统架构 4 1 1 系统部署图 系统部署图 UML 用部署图说明系统结构的静态部署视图 即说明分布 交付和安装的物理系统 展现对运行时处理节点以及 其中构件的配署 描述系统硬件的物理拓扑结构 包括网络布局和构件在网络上的位置 以及在此结构上执行的软 件 即运行时软构件在节点中的分布情况 4 1 2 设备清单设备清单 序号设备名称数 量型号和规格 4 1 3 软件架构软件架构 4 1 3 1 软件构件 组件 图软件构件 组件 图 用构件图展现一组构件 组件 之间的组织和依赖 用于对原代码 可执行的发布 物理数 据库和可调整的系统建模 6 31 应 急 通 讯 指 挥 决 策 平 台 业务功能层 信息采集平台 调度指令平台 图形化调度台 电话广播 数据日志 用户分级管理 电话会议 数据层 运营站点资料 维修 保卫数 据 调度视频 录 音 文字资料 地图数据资料 DB ORALCE 4 1 3 2 接口说明接口说明 描述构件 组件 之间的接口关系 4 1 3 3 类图类图 提供整个系统的类模型 如果模型过大 按照可行的标准把它划分成小块 例如可以把客户 端和服务器端的类模型分开成两个图表述 4 1 3 4 类清单类清单 编号类名与之相关的类 7 31 4 2 功能设计功能设计 4 2 1 调度功能调度功能 4 2 1 1 主事件流主事件流 决策者进入图形化指挥台后 选中某一个电话时 1 系统显示此站点的名称 负责人 电话号码 电话终端状态及站点视频图像 2 系统显示功能按钮呼叫 强拆 强插 转接 挂断 保持 继续 3 电话的状态为空闲时 呼叫按钮可用 其它按钮不可用 4 决策者点击呼叫 5 系统控制与决策者绑定的话机 呼叫选中的电话 6 呼叫成功后 正常通话 a 呼叫失败 7 通话时 挂断 转接 保持 继续 按钮由不可用 转为可用 挂断后结束通话 用例结束 b 转接 c 保持 继续 d 强拆或强插 4 2 1 2 其他事件流其他事件流 a 呼叫失败 1 重拨电话 转入主事件第六步 2 将呼叫转入手机 或者座机 转入主事件第六步 3 挂断电话 b 转接 1 系统提示用户输入转接号码 2 转入主事件流的第五步 c 保持 继续 1 系统暂停通话 但不断掉通话 2 点击继续 可以正常通话 d 强拆或强插 1 系统验证决策者的等级 2 等级高的决策者 可以强插拆或强掉正在通话的电话 3 转入主事件流的第六步 4 等级不够的系统给予驳回 8 31 4 2 1 3 UML 图表图表 可使用时序图可使用时序图 状态图状态图 活动图描述活动图描述 调度电话 电话状态呼叫空闲 通话 通话中是否成功是 否 是否转接 是 通话结束 输入电话号码 强拆 强插 用户等级 强拆 强插成功强拆 强插失败 低 高 外拨 通话策略 放弃转入手机 座机 重拨 4 2 2 电话调度电话调度 4 2 2 1 主事件流主事件流 点击电话会议功能 1 决策者选择电话会议的方式 2 决策者选择组呼会议 a 选呼会议 3 系统呼叫小组中的第一部话机 4 被叫话机一定时间内接听电话 b 被叫话机无人接听 5 系统自动以次呼叫小组中其它话机 6 系统自动把呼通的话机加入会议 7 电话会议成功 c 加入其它电话 8 查看会议参加的人数 9 退出会议 9 31 其他事件流其他事件流 a 选呼会议 1 通过话机列表界面 选择话机号码 2 点击电话会议 3 主事件流的第三步 b 被叫话机无人接听 1 断掉呼叫 2 系统自动呼叫第二部话机 3 主事件流进入第四步 c 加入其它电话 1 点击加入按钮 2 输入加入的电话号码 3 系统呼叫成功后 自动加入电话会议 4 主事件流转入第七步 10 31 UML 图表图表 可使用时序图可使用时序图 状态图状态图 活动图描述活动图描述 电话调度 选择会议方式 组呼选呼 是否使用已经 定义的小组 定义新的小组 IP电话呼叫其 中一部电话 否 是选择电话 是否接听 IP电话以次呼 叫其它电话 是 否电话会议结束 加入电话会议查看会议列表加入其它电话退出 发送语音 短信调度通知 否 是终端接收是 广播广播 4 2 2 2 主事件流主事件流 选择广播 1 选择广播的话机终端 2 选择广播的方式 3 广播语音 11 31 a 使用原有的语音文件 b 文本输入所要广播的内容 4 终端接收语音 4 2 2 3 其他事件流其他事件流 a 使用原有的语音文件 1 选择语音文件 2 进入主事件流的第四步 b 文本输入所要广播的内容 1 输入文字 2 文字转换成语音 3 进入主事件流的第四步 4 2 2 4 UML 图表图表 可使用时序图可使用时序图 状态图状态图 活动图描述活动图描述 电话广播 发送广播信息 终端接收语音 是 选择要发送广播的 终端设备 输入文字 TTS转换 使用语音文件直接语音 输入文件 12 31 指令发布平台指令发布平台 4 2 2 5 主事件流主事件流 1 输入指令等级 2 选择是否加密 3 输入指令内容 a 选择指令模板 4 数据库存储数据指令内容 5 选择把文字转成语音 6 语音文件存储到服务器中 7 信息发布到终端 8 终端接收信息 4 2 2 6 其他事件流其他事件流 a 选择指令模板 1 选择已经有的指令模板 2 进入主事件流的第四步 13 31 4 2 2 7 UML 图表图表 可使用时序图可使用时序图 状态图状态图 活动图描述活动图描述 指令发布 选择指令等级 可选加密 输入指令 是否选择 指令模板 选择指令模板 否 是 指令转成语音 是否 TTS文字语音转 换 否 是 存贮语音文件 存储指令数据 是 发布到终端 终端接收指令 信息上报信息上报 4 2 2 8 主事件流主事件流 上报信息 1 输入上报信息的方式 信息上报的等级 审阅信息的人 2 输入上报信息 a 使用上报信息的模板 3 将输入上报信息加入模板 4 点击提交上报信息 5 存储上报的信息 6 审阅人查收 7 进入指令发布事件流程 14 31 其他事件流其他事件流 a 使用上报信息的模板 1 选择也有的信息 2 事件进入主事件流第四步 UML 图表图表 可使用时序图可使用时序图 状态图状态图 活动图描述活动图描述 信息上报 上报文本 信息等级 审阅人 是否使用 信息模板 是 否 信息内容 是否加入 信息模板 否上报信息 将信息内容 加入模板 是 审阅人查收 审阅人回复 上报视频上报图片 存储信息 15 31 图形化调度台图形化调度台 4 2 2 9 主事件流主事件流 进入图形化调度台 1 显示电话分布状态图 2 选择某站点 3 系统显示与站点相关所有电话 其中包括站点电话 故障检修电话 控制中心的电话 4 系统显示电话的基本信息 5 选择调度电话的功能 6 进入调度流程 16 31 4 2 2 10 其他事件流其他事件流 UML 图表图表 可使用时序图可使用时序图 状态图状态图 活动图描述活动图描述 图形化决策台 电话分布 状态图 调度一部 电话 调用远端视频 使用电话调度 进入调度流程 是否是IP电话 显示终端 状态 显示电话 基本信息 是 是否有相关 视频设备 是 显示运营 故障检修 控制中心的电话 选择站点 用户分级管理用户分级管理 4 2 2 11 主事件流主事件流 用户分级管理 1 登陆系统后系统验证用户等级 2 根据用户等级 显示用户信息 a 验证失败 17 31 3 设置用户权限 b 设置用户等级 4 权限回收 5 权限暂停 6 权限接管 7 权限修改 8 系统提示用户权限设置会出现的后果 请用户确认是否要续继操作 9 权限设置成功 失败 其他事件流其他事件流 a 验证失败 1 请用户确认输入信息 2 系统提示用户等级或权限不够 b 设置用户等级 1 提高或者降低用户等级 2 系统提示用户等级已经被提高 18 31 UML 图表图表 可使用时序图可使用时序图 状态图状态图 活动图描述活动图描述 设置等级设置权限 用户分级管理 验证用户 等级 显示用户信息 低失败 高 提高等级降低等级 权限回收 权限暂停 权限接管 权限修改 用户确认操作 系统显示成功 失败 数据日志数据日志 4 2 2 12 主事件流主事件流 进入数据日志 1 系统显示最新的十条信息 a 历史信息 b 事件回放 2 用户选中某条信息 19 31 3 系统显示此信息的明细 4 2 2 13 其他事件流其他事件流 a 历史信息 1 输入查询日期 2 系统显示信息日期范围内的信息 3 进入主事件注的第二步 b 事件回放 1 选择回放的时间 2 选择回放的频率 3 播放日志信息 4 2 2 14 UML 图表图表 可使用时序图可使用时序图 状态图状态图 活动图描述活动图描述 数据日志 选择 所需信息 历史信息 实时信息 输入查询条件 数据日志列表 响应最新信息 事件回放 是 选中数据日志 系统显示本条记录 的详细信息 是否回放本天 日志 选择回播放频率 系统播放日志信息 20 31 4 3 接口设计接口设计 4 3 1 用户界面用户界面 4 3 2 硬件接口硬件接口 4 3 3 软件接口软件接口 4 3 3 1 4 3 3 1 电话调度 A Conference 电话多方会议 Public String conference String reqid String orgNum String OrgPwd String dets 参数说明 参数描述 Reqid请求的 ID 号 OrgNum组织电话会议的 IP 电话号码 OrgPwdIP 电话的密码 dets会议参加人的所有号码 最多不超过 16 方 返回值 Public class state Private String id 标识 Private String state 状态 Private String functionID 使用的功能 ID State 为 01 成功 11 身份验证不通过 21 请求参数不合法 31 被系统拒绝 41 服务器错误 51 请求号码个数超过最大限制 接口调用流程图 21 31 访问URL 请求电话会议方法 输入相关参数 服务器验证 服务号码验证 密码验证 参数验证 权限验证 拒绝会议 是否通过 组织会议 访问的 URL www crscs conference shtml wsdl B Call 电话呼叫 Public void call String reqid String orgNum String called 参数描述 Reqid请求的 ID 号 OrgNum组织电话会议的 IP 电话号码 OrgPwdIP 电话的密码 called被叫人的号码 返回值 Public class state Private String id 标识 Private String state 状态 Private String functionID 使用的功能 ID State 为 01 成功 11 身份验证不通过 21 请求参数不合法 31 被系统拒绝 41 服务器错误 接口调用流程图 22 31 访问URL 请求电话呼叫方法 输入相关参数 服务器验证 服务号码验证 密码验证 参数验证 权限验证 拒绝呼叫 是否通过 呼叫电话 是否 访问的 URL www crscs 4 3 3 2 4 3 3 2 信息日志 A Record 调用语音文件 Public String getRecord Stirng reqid String userid String number String fromDate String toDate 参数描述 参数描述 ReqID请求的 ID 号 User用户的 ID User终端设备号 FromDate开始时间 Todate结束时间 Public class state Private String id 标识 Private String state 状态 Private String functionID 使用的功能 ID 23 31 State 为 01 成功 11 身份验证不通过 21 请求参数不合法 31 被系统拒绝 41 服务器错误 成功后返回值格式如下 节点名类型说明 Record根节点此消息为语音信息 SerialID子节点语音文件流水号 Channel子节点通道号码 VoiceTime子节点语音时长 VoiceStartTime子节点语音开始时间 VoiceEndTime子节点语音结束时间 VoiceUrl子节点语音文件所在位置 Remake子节点备注 State子节点状态 例 192001015962 78200 05 31 www crscs 20100110121054 20100110121352 语音文件为语音广播 成功 失败后返回格式如下 101001 参数不合法 UML 流程图 24 31 Webserivce访问语 音文件 输入调用语音文件 的参数 服务器验证 返回 XML 是否通过验证 系统 拒绝 服务ID号验证 用户ID号验证 参数验证 权限验证 B Video 调用视频文件 Public String get Video Stirng reqid String userid String number String fromDate String toDate 参数描述 参数描述 ReqID请求的 ID 号 User用户的 ID Number终端设备号 FromDate开始时间 Todate结束时间 Public class state Private String id 标识 Private String state 状态 Private String functionID 使用的功能 ID State 为 01 成功 11 身份验证不通过 21 请求参数不合法 31 被系统拒绝 41 服务器错误 成功后返回值格式如下 节点名类型说明 Video根节点此消息为语音信息 SerialID子节点语音文件流水号 Number子节点通道号码 videoTime子节点语音时长 vi