myipphonemipp软件产品设计说明.docx
《myipphonemipp软件产品设计说明.docx》由会员分享，可在线阅读，更多相关《myipphonemipp软件产品设计说明.docx（28页珍藏版）》请在冰豆网上搜索。
myipphonemipp软件产品设计说明
myipphone-mipp软件产品设计说明
MyIPPhone-MIPP软件产品
设计说明书
〔版本号V1.0〕
上海中铁通信信号测试
2020年05月
文件修订记录
版本
章节名称
修订内容
修订日期
修订人
批准人
1、引言
1.1.MIPP软件产品的定位/范畴
MyIPPhone软件产品简称为MIPP
1.2.产品开发依据/来源
1.3.术语
2、MIPP软件产品设计输入
2.1.需求与功能对应清单
软件需求说明书，指明软件需求说明书的相关部分，应将需求说明书中的用例清单复制到本文档中，并说明与功能之间的关系〔与第4章中功能编号相对应〕。
用例编号
用例名称
优先级别
对应功能编号
UC001
UC001-001
UT002
2.2.硬件运行平台
需要用到的外部硬件设备，及其对本系统的约束或接口要求。
2.3.软件运行环境
与本系统有交互的软件类型以及导致的约束条件。
可能的类型有数据库治理系统、第三方提供的API、驱动程序、软构件库〔包括控件、标准类库、标准函数〕。
2.4.本系统有接口关系的其它系统的资料
3、设计概述
3.1.概要设计方法和工具
整个设计所采纳的方法〔是面向对象设计依旧结构化设计〕、以及使用到的相应技术和工具〔例如OMT、Rose、Visio〕
公司举荐OO方法，设计工具为ROSE系列产品
第四章以后部分适用于面向对象设计方法，假如使用结构化设计方法可对设计模型进行修改。
3.2.系统的体系结构
例如客户/服务器结构
4、总体设计
4.1.系统架构
4.1.1.系统部署图〔UML〕
用部署图说明系统结构的静态部署视图，即说明分布、交付和安装的物理系统，展现对运行时处理节点以及其中构件的配署。
描述系统硬件的物理拓扑结构（包括网络布局和构件在网络上的位置），以及在此结构上执行的软件〔即运行时软构件在节点中的分布情形〕。
4.1.2.设备清单
序号
设备名称
数量
型号和规格
4.1.3.软件架构
4.1.3.1.软件构件〔组件〕图
用构件图展现一组构件〔组件〕之间的组织和依靠，用于对原代码、可执行的公布、物理数据库和可调整的系统建模。
4.1.3.2.接口说明
描述构件〔组件〕之间的接口关系。
4.1.3.3.类图
提供整个系统的类模型。
假如模型过大，按照可行的标准把它划分成小块，例如能够把客户端和服务器端的类模型分开成两个图表述。
4.1.3.4.类清单
编号
类名
与之相关的类
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、等级不够的系统给予驳回
4.2.1.3.UML图表〔可使用时序图/状态图/活动图描述〕
4.2.2.调度
4.2.2.1.主事件流
点击会议功能
1、决策者选择会议的方式
2、决策者选择组呼会议
a）选呼会议
3、系统呼叫小组中的第一部话机
4、被叫话机一定时刻内接听
b〕被叫话机无人接听
5、系统自动以次呼叫小组中其它话机
6、系统自动把呼通的话机加入会议
7、会议成功
c〕加入其它
8、查看会议参加的人数
9、退出会议
其他事件流
a）选呼会议
1、通过话机列表界面，选择话机号码
2、点击会议
3、主事件流的第三步
b）被叫话机无人接听
1、断掉呼叫
2、系统自动呼叫第二部话机
3、主事件流进入第四步
c）加入其它
1、点击加入按钮
2、输入加入的号码
3、系统呼叫成功后，自动加入会议
4、主事件流转入第七步
UML图表〔可使用时序图/状态图/活动图描述〕
广播
4.2.2.2.主事件流
选择广播
1、选择广播的话机终端
2、选择广播的方式
3、广播语音
a）使用原有的语音文件
b）文本输入所要广播的内容
4、终端接收语音
4.2.2.3.其他事件流
a〕使用原有的语音文件
1、选择语音文件
2、进入主事件流的第四步
b〕文本输入所要广播的内容
1、输入文字
2、文字转换成语音
3、进入主事件流的第四步
4.2.2.4.UML图表〔可使用时序图/状态图/活动图描述〕
指令公布平台
4.2.2.5.主事件流
1、输入指令等级
2、选择是否加密
3、输入指令内容
a）选择指令模板
4、数据库储备数据指令内容
5、选择把文字转成语音
6、语音文件储备到服务器中
7、信息公布到终端
8、终端接收信息
4.2.2.6.其他事件流
a）选择指令模板
1、选择差不多有的指令模板
2、进入主事件流的第四步
4.2.2.7.UML图表〔可使用时序图/状态图/活动图描述〕
信息上报
4.2.2.8.主事件流
上报信息
1、输入上报信息的方式，信息上报的等级，批阅信息的人
2、输入上报信息
a）使用上报信息的模板
3、将输入上报信息加入模板
4、点击提交上报信息
5、储备上报的信息
6、批阅人查收
7、进入指令公布事件流程
其他事件流
a）使用上报信息的模板
1、选择也有的信息
2、事件进入主事件流第四步
UML图表〔可使用时序图/状态图/活动图描述〕
图形化调度台
4.2.2.9.主事件流
进入图形化调度台
1、显示分布状态图
2、选择某站点
3、系统显示与站点相关所有，其中包括站点、故障检修、操纵中心的
4、系统显示的差不多信息
5、选择调度的功能
6、进入调度流程
4.2.2.10.其他事件流
UML图表〔可使用时序图/状态图/活动图描述〕
用户分级治理
4.2.2.11.主事件流
用户分级治理
1、登陆系统后系统验证用户等级
2、依照用户等级，显示用户信息
a）验证失败
3、设置用户权限
b〕设置用户等级
4、权限回收
5、权限暂停
6、权限接管
7、权限修改
8、系统提示用户权限设置会显现的后果，请用户确认是否要续继操作
9、权限设置成功/失败
其他事件流
a〕验证失败
1、请用户确认输入信息
2、系统提示用户等级或权限不够
b〕设置用户等级
1、提高或者降低用户等级
2、系统提示用户等级差不多被提高
UML图表〔可使用时序图/状态图/活动图描述〕
数据日志
4.2.2.12.主事件流
进入数据日志
1、系统显示最新的十条信息
a）历史信息
b）事件回放
2、用户选中某条信息
3、系统显示此信息的明细
4.2.2.13.其他事件流
a）历史信息
1、输入查询日期
2、系统显示信息日期范畴内的信息
3、进入主事件注的第二步
b）事件回放
1、选择回放的时刻
2、选择回放的频率
3、播放日志信息
4.2.2.14.UML图表〔可使用时序图/状态图/活动图描述〕
4.3.接口设计
4.3.1.用户界面
4.3.2.硬件接口
4.3.3.软件接口
4.3.3.1.调度
A、Conference多方会议
PublicStringconference〔Stringreqid,StringorgNum,StringOrgPwd,String[]dets〕
参数说明：
参数
描述
Reqid
要求的ID号
OrgNum
组织会议的IP号码
OrgPwd
IP的密码
dets
会议参加人的所有号码，最多不超过16方
返回值：
Publicclassstate｛
PrivateStringid;//标识
PrivateStringstate;//状态
PrivateStringfunctionID;//使用的功能ID
｝
State为01：
成功
11：
身份验证不通过
21：
要求参数不合法
31：
被系统拒绝
41：
服务器错误
51：
要求号码个数超过最大限制
接口调用流程图：
访问的URL：
crscs-testcenter/conference.shtml?
wsdl
B、Call〔〕呼叫
Publicvoidcall〔Stringreqid,StringorgNum,Stringcalled〕
参数
描述
Reqid
要求的ID号
OrgNum
组织会议的IP号码
OrgPwd
IP的密码
called
被叫人的号码
返回值：
Publicclassstate｛
PrivateStringid;//标识
PrivateStringstate;//状态
PrivateStringfunctionID;//使用的功能ID
｝
State为01：
成功
11：
身份验证不通过
21：
要求参数不合法
31：
被系统拒绝
41：
服务器错误
接口调用流程图：
访问的URL：
crscs-testcenter/call.shtml?
wsdl
4.3.3.2.信息日志
A：
Record调用语音文件
PublicStringgetRecord〔Stirngreqid,Stringuserid，Stringnumber,StringfromDate,StringtoDate〕
参数描述：
参数
描述
ReqID
要求的ID号
User
用户的ID
User
终端设备号
FromDate
开始时刻
Todate
终止时刻
Publicclassstate｛
PrivateStringid;//标识
PrivateStringstate;//状态
PrivateStringfunctionID;//使用的功能ID
｝
State为01：
成功
11：
身份验证不通过
21：
要求参数不合法
31：
被系统拒绝
41：
服务器错误
成功后返回值格式如下：
节点名
类型
说明
Record
根节点
此消息为语音信息
SerialID
子节点
语音文件流水号
Channel
子节点
通道号码
VoiceTime
子节点
语音时长
VoiceStartTime
子节点
语音开始时刻
VoiceEndTime
子节点
语音终止时刻
VoiceUrl
子节点
语音文件所在位置
Remake
子节点
备注
State
子节点
状态
例：
192001015962
78200
05:
31
crscs-testcenter.cn/192001015962.mp3
20200110121054
20200110121352
语音文件为语音广播
成功
失败后返回格式如下
101001
参数不合法
UML流程图
B：
Video调用视频文件
PublicStringgetVideo〔Stirngreqid,Stringuserid，Stringnumber,StringfromDate,StringtoDate〕
参数描述：
参数
描述
ReqID
要求的ID号
User
用户的ID
Number
终端设备号
FromDate
开始时刻
Todate
终止时刻
Publicclassstate｛
PrivateStringid;//标识
PrivateStringstate;//状态
PrivateStringfunctionID;//使用的功能ID
｝
State为01：
成功
11：
身份验证不通过
21：
要求参数不合法
31：
被系统拒绝
41：
服务器错误
成功后返回值格式如下：
节点名
类型
说明
Video
根节点
此消息为语音信息
SerialID
子节点
语音文件流水号
Number
子节点
通道号码
videoTime
子节点
语音时长
videoStartTime
子节点
语音开始时刻
videoEndTime
子节点
语音终止时刻
videoUrl
子节点
语音文件所在位置
Remake
子节点
备注
State
子节点
状态
例：
192001015962
78200
05:
31
crscs-testcenter.cn/192001015962.mp3
20200110121054
20200110121352
此消息为视频文件
成功
失败后返回格式如下
101001
参数不合法
UML流程图
C：
Text调用指令信息
请参考A，B接口
4.3.4.通信接口
4.4.数据结构设计
4.4.1.数据结构〔标识符〕
结构属性
结构名称
逻辑标识
物理标识
结构类型
储备模式
储备介质
访问模式
读/写方式
记录标识
记录长度
4.4.2.数据结构2〔标识符〕
4.5.系统安全设计
4.5.1.系统安全
[1、系统安全操纵和物理爱护措施；]
[2、用户身份鉴别机制；]
[3、用户对系统的访问权限和范畴。
]
4.5.2.数据安全
[1、数据用户身份鉴别；]
[2、访问主体、访问对象的操纵策略和实现方法；]
[3、数据加密方法。
]
4.5.3.后备与复原
[1、系统后备；]
[2、数据后备；]
[3、系统复原；]
[4、数据复原。
]
4.5.4.出错处理
[1、出错情形；]
[2、出错信息输出形式、信息含义、处理方法；]
[3、出错失效的后备措施。
]
5、模块命名规那么
提示模块设计人员确定本软件的模块命名规那么〔例如类、函数、变量等〕，确保模块设计文档的风格与代码的风格保持一致。
能够从机构的编程规范中摘取或引用〔假如存在的话〕。
升级会员 