中国联通OSS专业综合网管系统与电子运维系统间接口技术规范.docx
《中国联通OSS专业综合网管系统与电子运维系统间接口技术规范.docx》由会员分享,可在线阅读,更多相关《中国联通OSS专业综合网管系统与电子运维系统间接口技术规范.docx(69页珍藏版)》请在冰豆网上搜索。
中国联通OSS专业综合网管系统与电子运维系统间接口技术规范
QB/CU
中国联通公司企业标准
2007-××-××实施
中国联通公司发布
2007-××-××发布
中国联通OSS/专业综合网管系统与电子运维系统间接口技术规范
ChinaUnicomOSS/TechnocalSpecificationfortheInterfacebetweenProfessionalIntegratedNetworkManagementSystemandE-OMS
(V1.0)
目次
目次I
前言III
中国联通OSS/专业综合网管系统与电子运维系统间接口技术规范1
1适用范围1
2规范性引用文件1
3术语与缩略语1
3.1术语定义1
3.2缩略语1
4接口位置1
5接口功能需求1
5.1E-OMS作业计划子系统与专业综合网管系统接口1
5.2E-OMS运行调度子系统与专业综合网管系统接口5
6接口技术约定7
6.1互联协议7
6.2技术约定7
6.3服务映射8
6.4服务概述9
6.5服务定义9
6.6服务调用10
7接口服务定义1
7.1E-OMS作业计划子系统接口服务定义1
7.2E-OMS运行调度子系统接口服务定义3
7.3专业综合网管系统接口服务定义8
附 录 A(规范性附录)各类代码表14
A.1错误代码表14
A.2总部/省份/城市代码表14
A.3系统代码表22
A.4时间格式约定22
附 录 B(资料性附录)Filter的约束建议23
B.1改进的filter的BNF范式23
B.2优先关系24
附 录 C(资料性附录)专业综合网管系统与E-OMS接口服务WSDL映射26
C.1E-OMS作业计划子系统侧服务定义26
C.1.1巡检作业接口服务26
C.1.2配置数据接口服务26
C.2E-OMS运行调度子系统侧服务定义26
C.2.1故障工单接口服务26
C.2.2配置数据接口服务26
C.3专业综合网管系统侧服务定义26
C.3.1巡检作业接口服务26
C.3.2配置数据接口服务26
前言
《中国联通OSS/专业综合网管系统与电子运维系统间接口技术规范》是为了进一步将E-OMS系统与其他系统互联,实现跨系统的数据共享和满足自动信息交互的需求的前提下制定的互联接口规范。
本规范中的专业综合网管系统包括:
GSM综合网管系统、CDMA综合网管系统、传输综合网管系统以及其他各类专业网管系统和监测系统等;本规范定义接口技术要求属于通用内容,适用于各专业综合网管与电子运行维护系统(后文均简称为E-OMS系统)互联。
E-OMS与其他系统互联接口包括以下内容:
1)中国联通OSS/电子运维与综合资源管理系统间接口技术规范
2)中国联通OSS/专业综合网管系统与电子运维系统间接口技术规范
附录A为规范性附录,附录B、附录C为资料性附录。
本规范由中国联通运行维护部提出
本规范由中国联通技术部归口
本规范起草单位:
中国联通运行维护部、北京邮电大学
本规范的修改和解释权属中国联合通信有限公司
中国联通OSS/专业综合网管系统与电子运维系统间接口技术规范
适用范围
本规范适用于中国联通专业综合网管系统与电子运行维护系统(E-OMS)之间的互联。
本部分规范规定了中国联通专业综合网管系统与电子运行维护系统(E-OMS)互联采用接口业务流程、接口功能需求、接口功能映射、接口服务定义和接口数据内容,并规范了部分接口数据命名格式和编码方式。
本接口规范适用于指导专业综合网管系统与E-OMS系统横向互联接口的开发和测试,是专业综合网管系统与E-OMS系统互联建设的主要依据。
本接口规范不涉及专业综合网管系统和E-OMS系统内部自身的相关业务和技术实现。
此外,为满足安全和接口稳定的需求以及后期统计和审核的需要,部端和省端系统均需提供详细的接口日志功能,以实时记录接口上的所有操作情况。
规范性引用文件
下列文件中的条款通过本规范的引用而成为本规范的条款。
凡是注日期的引用文件,其随后所有的修改单(不包括勘误的内容)或修订版均不适用于本规范,然而,鼓励根据本规范达成协议的各方研究是否可使用这些文件的最新版本。
凡是不注日期的引用文件,其最新版本适用于本规范。
[1]QB/CU124-2007中国联通OSS/综合资源管理系统与传输综合网管系统间接口技术规范
术语与缩略语
3.1术语定义
无。
3.2缩略语
以下缩略语适用于本规范:
缩略语
缩略语全称
含义
E-OMS
ElectricOperationMaintenanceSystem
电子运行维护系统
HTTP
HyperTextTransportProtocol
超文本传输协议
NS
NamingSpace
命名空间
SOAP
SimpleObjectAccessProtocol
简单对象访问协议
WSDL
WebServiceDefinitionLanguage
Web服务定义语言
XML
eXtensibleMarkupLanguage
可扩展标记语言
接口位置
本规范所定义的中国联通专业综合网管系统与E-OMS系统管理接口互联结构如图1 所示:
专业综合网管与E-OMS系统互联结构图
接口功能需求
E-OMS作业计划子系统与专业综合网管系统接口
接口流程图
E-OMS作业计划子系统与专业综合网管系统接口流程图
接口功能需求
巡检作业
巡检作业接口是通过关联智能巡检中的巡检作业,实现作业计划完成情况的自动填写。
作业计划中作业大纲要求的作业内容、作业对象(对应作业计划中的网元)、作业周期可以与巡检任务内容相对应。
接口的前提要求:
智能巡检侧的作业对象、作业内容、执行周期、结果文件需兼容作业计划侧作业内容,可由人工或其他方式设置对应,接口不支持巡检任务的直接设置。
巡检作业接口支持E-OMS作业计划子系统通过两种方式获得巡检结果,并实现作业计划执行结果的自动填写,如下:
1)定时轮询请求查询方式
2)结果订购,周期性返回方式
查询巡检任务信息
E-OMS作业计划子系统通过与专业综合网管系统接口查询已开启的巡检任务的信息,包括巡检内容、巡检对象、巡检周期、每次巡检开始执行时间等巡检信息,从而明确作业大纲的执行时间计划和作业结果。
输入
指定查询条件
——巡检项目、巡检对象、巡检周期
指定返回信息
——返回符合条件的巡检任务唯一标识、开始执行时间、巡检周期、巡检对象、巡检内容
输出
返回任务信息
——符合条件、指定返回的巡检任务信息或失败原因
失败原因:
——巡检项目不存在;
——巡检对象不存在;
——巡检周期不合法,在合法周期范围外;
——指定返回的信息不合法
查询巡检结果信息
E-OMS作业计划子系统通过与专业综合网管系统接口查询已开启的巡检任务的执行结果信息,包括巡检任务标识、巡检结果产生时间段、子项目结果列表等信息,从而明确作业大纲的作业执行结果。
输入
指定查询条件
——巡检任务标识、巡检结果产生时间段、子项目列表
指定返回信息
——巡检任务标识、巡检结果产生时间段、子项目列表
输出
返回任务结果信息
——符合条件、指定返回的巡检任务结果信息或失败原因
失败原因:
——指定标识不存在
——指定时间段无结果
——指定的结果项目不存在
定购巡检任务结果
E-OMS作业计划子系统通过与专业综合网管系统接口订购已开启的巡检任务的执行结果信息,包括巡检任务标识、巡检结果产生时间、子项目结果列表等信息。
输入
指定订购条件
——巡检任务标识
指定周期性返回信息
——巡检任务标识、巡检结果产生时间、子项目列表
输出
返回信息
——订购唯一标识或失败原因
失败原因:
——指定标识不存在
返回巡检结果文件
针对E-OMS作业计划子系统通过与专业综合网管系统接口对巡检结果的订购,专业综合网管系统通过接口周期性返回巡检结果信息,包括巡检任务标识、巡检结果产生时间、子项目结果列表等信息。
输入
无
输出
返回信息
——巡检任务标识、巡检结果产生时间、子项目结果列表
撤消巡检结果订购
针对E-OMS作业计划子系统通过与专业综合网管系统接口对巡检结果的订购,E-OMS作业计划子系统通过接口撤消指定订购。
订购撤消后,不再返回结果。
输入
指定信息
——订购唯一标识
——订购系统标识
输出
返回信息
——撤消成功或失败原因
失败原因:
——指定订购标识不存在
——指定订购标识与订购系统不匹配
订购任务撤消通知(O)
针对E-OMS作业计划子系统通过与专业综合网管系统接口对巡检结果的订购,如果巡检系统撤消订购结果对应的巡检任务,则任务结果订购自动撤消;撤消成功后,通过接口向E-OMS作业计划子系统发送撤消通知。
输入
通知信息
——订购唯一标识
——订购结果对应巡检任务唯一标识
——撤消原因
输出
无
配置数据(O)
根据OSS总体规划,E-OMS所需求的数据统一通过与综合资源管理系统接口获得。
但在前期综合资源管理系统未建设的情况下,为保证E-OMS的正常运行,在过渡阶段,将配置数据需求纳入专业综合网管系统与E-OMS的接口功能需求,并作为可选要求。
同步配置数据
E-OMS可通过与专业综合网管系统接口请求同步大数据量的配置数据;专业综合网管系统也可以通过接口向E-OMS主动同步配置数据。
E-OMS通过数据同步功能使系统内的动态配置数据与专业综合网管系统保持同步一致,以满足各个专业的调度需求。
接口上的配置数据同步一般适用于以下情况:
1)当双方系统建立管理连接时;
2)当双方系统出现通信失败并且恢复后;
3)当专业综合网管系统出现系统故障并且恢复后;
4)当专业综合网管系统发生大粒度资源更新后;
查询配置数据
除了支持大数据量的数据同步外,E-OMS可通过与专业综合网管系统接口直接查询较小范围内的配置数据,如指定范围的资源实例标识,指定范围和指定属性的资源属性信息等:
——接口应支持根据资源的关系对指定范围的资源实例标识进行查询;
——接口应支持对一个或多个资源对象的指定属性值进行查询。
数据变更通知
当专业综合网管系统维护的配置数据发生变更时,应通过与E-OMS的接口向E-OMS发送相应的配置数据变更通知,如配置创建通知、配置删除通知、配置属性值改变通知等。
通知中包含具体的资源变更信息,如对象实例、配置变更类型、配置属性取值等。
当配置数据改动范围较大,需要通过大数据量方式传送时,该专业综合网管系统应通过接口发起配置数据同步。
E-OMS运行调度子系统与专业综合网管系统接口
接口流程图
E-OMS运行调度子系统与专业综合网管系统接口流程图
接口功能需求
故障工单
接收告警信息
专业综合网管系统生成重大告警,通过与E-OMS运行调度子系统接口向E-OMS运行调度子系统自动派发,在E-OMS侧生成故障工单。
自动生成的故障工单处于草稿状态,待电子运维人员人工确认后调度处理。
输入
告警信息
输出
无
告警清除通知
对已派发给E-OMS运行调度子系统的重大告警,如果该告警在网管侧被清除(自动或手动),综合网管系统需向E-OMS调度子系统发送告警清除通知,进行状态同步。
输入
告警清除信息
输出
无
接收故障信息
E-OMS运行调度子系统接收专业综合网管系统派发的故障信息,以生成故障工单进行调度。
自动生成的故障工单处于草稿状态,待电子运维人员人工确认调度处理。
输入
故障信息
输出
无
配置数据(O)
根据OSS总体规划,E-OMS所需求的数据统一通过与综合资源管理系统接口获得。
但在前期综合资源管理系统未建设的情况下,为保证E-OMS的正常运行,在过渡阶段,将配置数据需求纳入专业综合网管系统与E-OMS的接口功能需求,并作为可选要求。
同步配置数据
E-OMS可通过与专业综合网管系统接口请求同步大数据量的配置数据;专业综合网管系统也可以通过接口向E-OMS主动同步配置数据。
E-OMS通过数据同步功能使系统内的动态配置数据与专业综合网管系统保持同步一致,以满足各个专业的调度需求。
接口上的配置数据同步一般适用于以下情况:
5)当双方系统建立管理连接时;
6)当双方系统出现通信失败并且恢复后;
7)当专业综合网管系统出现系统故障并且恢复后;
8)当专业综合网管系统发生大粒度资源更新后;
查询配置数据
除了支持大数据量的数据同步外,E-OMS可通过与专业综合网管系统接口直接查询较小范围内的配置数据,如指定范围的资源实例标识,指定范围和指定属性的资源属性信息等:
——接口应支持根据资源的关系对指定范围的资源实例标识进行查询;
——接口应支持对一个或多个资源对象的指定属性值进行查询。
数据变更通知
当专业综合网管系统维护的配置数据发生变更时,应通过与E-OMS的接口向E-OMS发送相应的配置数据变更通知,如配置创建通知、配置删除通知、配置属性值改变通知等。
通知中包含具体的资源变更信息,如对象实例、配置变更类型、配置属性取值等。
当配置数据改动范围较大,需要通过大数据量方式传送时,该专业综合网管系统应通过接口发起配置数据同步。
接口技术约定
互联协议
专业综合网管系统与E-OMS系统互联采用基于SOAP协议的Web服务调用方式实现。
技术约定
为保证不同厂家不同实现方式的接口间调用的互联互通,本节将对具体接口实现过程作出如下约定。
1.规范及版本约定
1)整个接口消息基于XML语言,必须符合XMLV1.0(2ndEditionorHigher)规范和XMLSchema(1stEditionorHigher)规范。
2)接口实现必须使用SOAP协议,接口描述必须使用WSDL语言;
3)接口实现方必须向接口调用方提供本端服务的WSDL文件,建议使用WebURL方式实时提供;
4)接口实现必须符合SOAP协议V1.1版本规范,高版本SOAP协议必须保证与1.1版本的兼容性;
5)接口实现必须至少支持SOAP在HTTPV1.0协议上的传输;
6)接口实现必须符合WSDL语言V1.1版本规范,高版本WSDL语言必须保证与1.1版本的兼容性;
7)接口描述必须至少支持WSDL在SOAPV1.1协议上的绑定。
8)接口实现必须支持WS-IBasicProfileV1.0(orHigher)互联互通协议。
2.Web语义约定
1)E-OMSNS约定形式:
E-OMS作业计划子系统NS约定:
"
E-OMS运行调度子系统NS约定:
"
其中[]内的内容将被实际调用中被具体名称替换。
2)专业综合网管系统的NS约定为以下形式:
a)CDMA综合网管系统的NS约定:
"[服务名称]"
b)GSM综合网管系统的NS约定:
"[服务名称]"。
c)传输综合网管系统的NS约定:
"[服务名称]"。
d)[总部/省份代码]见A.2
3)针对SOAP在HTTP协议上的传输,WSDL基于SOAP的绑定中SOAPOperation的soapAction字段约定为以下形式:
“[当前NS]”+“/”+“[接口方法名]”。
其中[]内的内容将被实际调用中被具体名称替换。
例:
北京E-OMS作业计划子系统调用北京传输网综合网管系统的“巡检作业服务(InspectionService)”的“查询巡检任务信息操作(InqrInspTask)”,服务调用的soapAction字段内容应指定为:
"
4)针对WSDL基于SOAP的绑定方式,必须满足以下约定:
a)绑定(binding)和操作(operation)的风格(style)必须满足:
style=”document”;
b)消息体的呈现方式必须满足:
use=”literal”。
3.编码约定
1)接口实现的SOAP消息的消息头和消息体的编码方式,必须使用符合SOAPV1.1规范中规定的编码方式,即
encodingStyle=”http:
//schemas.xmlsoap.org/soap/encoding/”
2)接口实现的HTTP层编码方式以及对附件信息封装必须使用GB2312编码方式;
服务映射
专业综合网管系统与E-OMS作业计划子系统接口服务映射
A端系统:
E-OMS作业计划子系统
Z端系统:
专业综合网管系统
接口功能需求与接口服务的映射关系如下表所示:
接口功能需求
方向
接口服务
接口操作
接口服务
服务提供方
巡检作业
查询巡检任务信息
A->Z
查询巡检任务信息
巡检作业接口
专业综合网管系统
查询巡检结果信息
A->Z
查询巡检结果信息
巡检作业接口
专业综合网管系统
订购巡检任务结果
A->Z
订购巡检任务结果
巡检作业接口
专业综合网管系统
返回巡检任务结果
Z->A
返回巡检任务结果
巡检作业接口
E-OMS作业计划子系统
撤消巡检结果订购
A->Z
撤消巡检结果订购
巡检作业接口
专业综合网管系统
巡检任务撤消通知
Z->A
巡检任务撤消通知
巡检作业接口
E-OMS作业计划子系统
配置数据
同步配置数据
A->Z
Z->A
见规范性引用文件[1]资源数据接口服务定义
查询配置数据
A->Z
数据更新通知
Z->A
专业综合网管系统与E-OMS运行调度子系统接口服务映射
A端系统:
E-OMS运行调度子系统
Z端系统:
专业综合网管系统
接口功能需求与接口服务的映射关系如下表所示:
接口功能需求
方向
接口服务
接口操作
接口服务
服务提供方
故障工单
接收告警信息
Z->A
接收告警信息
故障工单接口
E-OMS运行调度子系统
告警清除通知
告警清除通知
接收故障信息
接收故障信息
配置数据
同步配置数据
A->Z
Z->A
见规范性引用文件[1]资源数据接口服务定义
查询配置数据
A->Z
数据更新通知
Z->A
服务概述
现阶段总部及各省E-OMS作业计划子系统互联接口中所定义的服务,按服务提供方和服务功能的不同划分为6个。
接口服务的基本信息如下表所示:
服务提供方
服务名称
服务描述
接口功能
所在章节
E-OMS作业计划子系统
巡检作业接口服务
InspectService
该服务用于专业综合网管向E-OMS作业计划子系统返回订购的巡检结果、巡检任务撤消通知
返回巡检任务结果
7.1.1.2
巡检任务撤消通知
7.1.1.3
配置数据接口服务
见规范性引用文件[1]资源数据接口服务定义
--
E-OMS运行调度子系统
故障工单接口服务FaultFormSercive
该服务用于专业综合网管系统向E-OMS运行调度子系统自动派发故障工单
接收告警信息
7.2.1.2
告警清除通知
7.2.1.3
接收故障信息
7.2.1.4
配置数据接口服务
见规范性引用文件[1]资源数据接口服务定义
--
--
专业综合网管系统
巡检作业接口服务InspectionService
该服务用于其他系统向专业综合网管系统查询巡检任务信息、巡检结果信息、订购/撤消订购巡检任务结果
查询巡检任务信息
7.3.1.2
查询巡检结果信息
7.3.1.3
订购巡检任务结果
7.3.1.4
撤消巡检结果订购
7.3.1.5
配置数据接口服务
见规范性引用文件[1]资源数据接口服务定义
--
--
服务定义
本节描述的接口服务定义只涉及抽象服务定义,即只涉及抽象的数据类型(type)、接口操作(operation)和接口类型(portType),而不涉及具体的服务位置(port)、服务绑定信息(binding)。
在以下服务定义和参数说明中,如无特殊说明,均遵循以下原则:
1)本节中,string表示字符串类型(xsd:
string),int表示整数类型(xsd:
int),date表示日期类型(xsd:
date);出现的其它类型为用户自定义类型,需在WSDL文档定义中给出相应的模式约束;
2)本节中,M表示Mandatory(必须的),O表示Optional(可选的),MC表示Mandatory,Conditional(如果出现则必须存在)。
可选参数的值(Value)可以为空(Nil),但相应的XMLTag必须出现。
3)本节中所规定的SOAPFault中错误代码(FaultCode)的取值均参见附录A.1 。
服务调用
对于接口服务调用,建议调用双方遵守以下业务准则:
1)建议系统在调用对方系统相关服务前,先调用对方接口提供的IsAlive方法确定所需服务是否正常。
E-OMS作业计划子系统与专业综合网管系统接口
巡检作业接口服务流程
巡检作业接口服务流程
配置数据接口服务流程
见规范性引用文件[1]资源数据接口服务定义
E-OMS运行调度子系统与专业综合网管系统接口
故障工单接口服务流程
故障工单接口服务流程
配置数据接口服务流程
见规范性引用文件[1]资源数据接口服务定义。
接口服务定义
E-OMS作业计划子系统接口服务定义
巡检作业接口服务
调用测试操作(IsAlive)
●所属接口服务(service):
InspectionService
●所属接口类型(portType):
InspectionServicePortType
●接口操作名称(operation):
IsAlive
●操作消息模式(implicitoperationType):
request-response-operation
●接口操作描述(documentation):
该操作用于服务调用方判断服务提供方服务是否可用。
●输入参数(inputmessagepart):
如下表所示
参数名称
参数类型
参数含义
限定
serSupplier
string
服务提供方,为E-OMS作业计划子系统。
取值参见A.3 。
M
serCaller
string
服务调用方,为专业综合网管系统。
取值参见附录A.3 。
M
●输出参数(outputmessagepart):
如下表所示
参数名称
参数类型
参数含义
限定