05EOMS第三版技术规范网管告警派单接口规范V300924.docx

1、05EOMS第三版技术规范网管告警派单接口规范V300924中国移动通信企业标准QB-W-XXX-2008中国移动电子运维系统技术规范（第三版）网管告警派单接口规范（征求意见稿）版本号 3.0.02008年 月 发布 2008年 月 实施中国移动通信集团公司 发布版权声明本文档版权由中国移动通信集团公司所有。未经本公司书面许可，任何单位和个人不得以任何形式摘抄、复制本文档的部分或全部，并以任何形式传播。版本修订记录版本发布日期修订说明V0.1.02004年5月征求意见稿V1.0.02004年7月根据各省公司反馈意见对0.1版本进行了修订，形成1.0.0版本。主要修改内容包括：1)补充互联范围2

2、)补充接口性能指标3)明确由网管系统负责对闪断告警进行处理4)网管系统以XML格式封装、以FTP方式传送，向EOMS系统上报各类网络资源和KPI数据V1.1.02005年8月1)修订7.2.1节，对WebService技术约定进行了修订和补充2)补充7.3节内容，详细说明网络资源和KPI接口方式3)新增附录C，详细说明总部系统网络KPI接口的具体要求V1.2.02008年3月1)告警接收操作增加了几个参数2)增加了工单状态同步服务3)对各接口的返回值做了调整，满足返回工单号等功能要求4)手工派单流程做了调整5)明确了故障工单查询接口V3.02008年8月1)按照告警标准化要求增加了告警参数2)

3、去掉KPI接口3)调整了部分接口内容的描述前言中国移动电子运行维护系统(后文简称EOMS系统)是由中国移动通信集团公司建设，用于实现中国移动通信集团公司网络运行维护生产流程电子化管理的系统。中国移动EOMS系统与各网管系统互联接口的实施将有助于提高故障工单流程的自动化程度，加强故障工单派发的及时性、准确性，并有助于实现EOMS系统与各网管系统间信息的透明交换。网管告警派单接口规范应中国移动EOMS系统与网管系统互联接口建设的需要而制定。本规范规定了中国移动EOMS系统和各网管系统互联的接口业务需求、接口数据规范、接口参考技术方案(Web Service/SOAP、FTP、XML)等内容。本规范

4、适用于集团公司EOMS系统与集团公司网管系统互联接口的实施，以及省公司EOMS系统与省公司网管系统互联接口的实施。EOMS系统与网管系统互联接口的承建方需满足本规范中的业务需求，严格遵循本规范中的接口数据规范，并在无特殊情况下采用本规范所提供的参考技术方案。本规范由中国移动通信集团公司提出并归口。本规范由中国移动通信集团公司负责解释。目录1 适用范围 42 规范性引用文件 43 术语与缩略语 44 总则 55 接口流程 55.1 手工派单流程 55.2 自动派单流程 66 接口定义 76.1 EOMS提供的WS接口服务 86.1.1 告警信息传送服务(InterSwitchAlarm) 86.

5、1.2 EOMS用户鉴权服务(EomsAuthentication) 106.2 网管提供的WS接口服务 116.2.1 工单状态同步服务(SheetStateSync) 116.3 界面集成接口 126.3.1 手工派单界面集成 126.3.2 工单查询界面集成 127 接口要求 127.1 告警自动派单规则 127.2 告警派单要求 137.3 接口安全技术要求 147.3.1 接口安全设计目标与内容 147.3.2 不同层面的接口安全措施 147.3.3 接口安全性要求 14适用范围网管告警派单接口规范适用于指导中国移动集团公司EOMS系统与网管系统互联接口的开发和测试，是EOMS系统与

6、网管系统互联建设的主要依据。本规范规定了中国移动EOMS系统和各网管系统互联的接口业务需求、接口数据规范、接口技术参考方案(Web Service/SOAP、FTP、XML)等内容。EOMS系统与网管系统互联接口的承建方必须满足本规范中的业务需求，严格遵循本规范中的接口数据规范，并在无特殊情况下采用本规范所提供的参考技术方案。规范性引用文件下列文件中的条款通过本规范的引用而成为本规范的条款。凡是注日期的引用文件，其随后所有的修改单(不包括勘误的内容)或修订版均不适用于本规范，然而，鼓励根据本规范达成协议的各方研究是否可使用这些文件的最新版本。凡是不注日期的引用文件，其最新版本适用于本规范。1

7、EOMS第三版技术规范2 话务网管系统技术规范3 数据网管系统技术规范4 传输网管系统技术规范术语与缩略语下列缩略语适用于本规范：缩略语缩略语全称含义EOMSElectric Operation Maintenance System电子运行维护系统HTTPHyper Text Transport Protocol超文本传输协议WSWeb ServicesWeb服务NSNaming Space命名空间SOAPSimple Object Access Protocol简单对象访问协议WSDLWeb Service Definition LanguageWeb服务定义语言XMLeXtensible

8、Markup Language可扩展标记语言总则中国移动EOMS系统与各网管系统互联接口的实施将有助于提高故障工单流程的自动化程度，加强故障工单派发的及时性、准确性，并有助于实现EOMS系统与各网管系统间信息的透明交换。中国移动EOMS系统与网管系统的互联，包括与话务网管、数据网管、传输网管、动力环境监控等系统的互联。接口流程手工派单流程说明：1） 网管系统负责提供EOMS用户登录界面，以便在派单前针对该网管用户进行EOMS系统用户鉴权。网管系统调用EOMS系统提供的用户鉴权服务进行用户鉴权。2） 手工派单流程由网管系统发起，网管系统先调用“告警接收操作(newAlarm)”接口生成工单，获取

9、工单号，采用HTTP GETPOST方式调用EOMS系统的派单网页，并将网管告警数据信息工单号提供给EOMS系统，具体格式如：http:/派单页面url?sheetNo=工单号。告警数据信息具体内容参见6.1.1节，此外网管系统还需将用户标识提供给EOMS系统。3） EOMS系统负责提供派单页面，并将网管系统送来的告警信息填入故障工单的相应字段中。网管人员使用EOMS系统的派单网页完成派单过程。EOMS系统中最终应将派单是否成功的信息如果工单状态有变化，应该通过工单状态同步接口通知提供给网管系统。自动派单流程1) 告警派单网管系统负责进行告警是否派单的判定，并调用EOMS系统提供的“告警接收”

10、接口服务，将需要派单的告警信息送入EOMS系统。注意，由网管系统负责进行告警是否派单的判定，只有需要自动派发工单的告警才送到EOMS系统中，应由网管负责对闪断告警进行相应延时处理。当EOMS系统接收到需要派单的告警时，自动生成故障工单，并根据角色细分规则进行工单派发。注意，由EOMS系统负责生成故障工单，网管系统不参与故障工单的生成，以减少当故障工单发生变化时的影响范围。2) 工单状态同步当工单状态发生变化时，EOMS调用告警系统工单状态同步服务，告警系统修改相关告警的工单状态。3) 告警状态同步当告警状态发生变化时，告警系统调用EOMS告警同步服务，EOMS修改相关工单的告警状态，并记录告警

11、清除时间。4) 工单查询告警系统可随时调用EOMS工单查询界面集成服务。接口定义网管告警派单接口采用Web Service/SOAP技术。各接口的详细信息统一使用“opDetail”参数，“opDetail”以XML封装，格式如下： /详细信息 /记录内容 /字段内容 /字段中文名 /字段英文名 /字段内容 中可包括多个部分，中可包括多个部分。如果没有详细信息，则仅存“”。网管告警派单接口包括以下服务：服务名称中文名称服务说明提供方InterSwitchAlarm告警信息传送服务用于接收告警及告警同步信息EOMSSheetStateSync工单状态同步服务用于接收故障工单状态变化信息网管Eom

12、sAuthenticationEOMS用户鉴权服务用于用户鉴权EOMSEOMS提供的WS接口服务告警信息传送服务(InterSwitchAlarm)连通测试 (isAlive)说明：网管系统在调用EOMS系统相应服务模块中其他接口方法之前，可利用此服务调用判断对方当前服务是否已经部署完毕，以确定所调用的方法当前是否可以正常服务。服务名称：InterSwitchAlarm接口方法：isAlive输入参数：Null(无)输出参数：isAliveResult(string类型。为空表示相应服务可用，非空表示该服务当前出现问题，错误返回信息用相应明文进行说明)告警接收 (newAlarm)说明：EOM

13、S系统提供该接口服务用于接收需要自动或手工派发故障工单的告警信息。服务名称：InterSwitchAlarm接口方法：newAlarm输入参数：参数名称长度中文名称说明serSupplierstring(16)服务提供方命名形如：省市代码_系统名称serCallerstring(16)服务调用方命名形如：省市代码_系统名称callerPwdstring(32)口令/callTimestring(20)服务调用时间/opDetailString详细信息参见“详细信息约定”输出参数：输出为一个字符串，格式为“sheetNo=工单号;errList=错误描述”。如果派单成功：“工单号”不为空串，“错

14、误描述”为空串；如果派单失败，“工单号”为空串，“错误列表”为错误描述。约定“sheetNo=”和“errList=”不管派单成功与否都必须有，只是值可以为空串。opDetail详细信息约定：字段英文名类型(长度)字段中文名说明alarmIdstring(80)网管告警流水号网管系统简称_告警IDalarmStaIdstring(80)网管告警ID/oriAlarmIdstring(40)原始告警号/alarmTitlestring(400)告警标题/alarmCreateTimestring(20)告警产生时间/NeTypestring(20)设备类型传编码，参见中国移动电子运维系统技术规范

15、（第三版）编码技术规范中的网络分类alarmVendorstring(32)设备厂家传名称，例如“爱立信”，总部和各省自行定义选择项，网管和eoms厂家保持同步equipTypestring(40)设备型号/neNamestring(32)网元名称/alarmLevelstring(20)告警级别梳理后网管定义的告警级别（四级），一级告警传“1”，二级告警传“2”，依此类推。alarmTypestring(20)告警逻辑分类传明文alarmSubTypestring(20)告警逻辑子类传明文alarmProvincestring(8)告警省份省份编码参见中国移动电子运维系统技术规范（第三版）编

16、码技术规范，如“BJ”alarmRegionstring(64)告警地市传名称，例如“石家庄”，网管和eoms厂家保持同步alarmLocationstring(100)告警定位/alarmDetailstring(3000)告警描述告警对设备的影响；告警对业务的影响；告警正文；createTypestring(1)工单创建类型0:自动派单1:手工派单senderstring(16)派单人用于手工派单；自动派单时，该字段为空告警同步 (syncAlarm)说明：当已派发了故障工单的网管告警的状态发生变化时，网管系统调用EOMS系统提供的接口服务，同步两个系统中的告警状态，并给出告警清除时间。服

17、务名称：InterSwitchAlarm接口方法：syncAlarm输入参数：如下表所示参数名称参数类型中文名称说明serSupplierstring(16)服务提供方命名形如：省市代码_系统名称serCallerstring(16)服务调用方命名形如：省市代码_系统名称callerPwdstring(32)口令/callTimestring(20)服务调用时间/opDetailString详细信息参见“详细信息约定”输出参数：输出为字符串。格式为“sheetNo=工单号;errList=错误描述”。如果调用成功，则sheetNo不为空串为该告警对应的工单号、errList为空串；如果调用失败

18、，则如果该告警在电子运维系统中不存在对应的工单则sheetNo为空串，errList为错误描述。约定“sheetNo=”和“errList=”不管调用成功与否都必须有，只是值可以为空串。opDetail详细信息约定：字段英文名类型(长度)字段中文名说明alarmIdstring(80)网管告警ID网管系统简称_告警IDalarmStatusInteger(2)告警状态1：自动清除；2：手工清除； clearTimestring(20)告警清除时间/EOMS用户鉴权服务(EomsAuthentication)连通测试 (isAlive)同6.1.1.1EOMS用户登录鉴权 (eomsAuthen

19、tication)说明：EOMS系统提供该接口服务以供网管系统对EOMS系统用户进行鉴权服务名称：EomsAuthentication接口方法：eomsAuthentication输入参数：如下表所示参数名称参数类型中文名称说明serSupplierstring(16)服务提供方命名形如：省市代码_系统名称serCallerstring(16)服务调用方命名形如：省市代码_系统名称callerPwdstring(32)口令/callTimestring(20)服务调用时间/opDetailString详细信息详细信息，参见“详细信息约定”输出参数：errList(string类型。空串表示调用

20、成功，并且该用户的帐户名与密码均正确，并且该用户具有派发故障工单权限。非空串表示认证失败或调用失败。若认证失败，其值为“用户名错”或“用户密码错”或“该用户无派发故障工单权限”；若调用失败，其值为错误描述。)opDetail详细信息约定：字段英文名类型(长度)字段中文名说明userNamestring(20)EOMS用户名称/userPasswordstring(20)EOMS用户密码/网管提供的WS接口服务工单状态同步服务(SheetStateSync)连通测试(isAlive)同6.1.1.1工单状态同步(syncSheetState)说明：当已派发了故障工单的网管告警相对应的工单流转发生

21、状态变化时，EOMS系统调用网管系统提供的接口服务，同步两个系统中的工单状态。服务名称：SheetStateSync接口方法：syncSheetState输入参数：如下表所示参数名称参数类型中文名称说明serSupplierstring(16)服务提供方命名形如：省市代码_系统名称serCallerstring(16)服务调用方命名形如：省市代码_系统名称callerPwdstring(32)口令/callTimestring(20)服务调用时间/opDetailString详细信息详细信息，参见“详细信息约定”输出参数：输出为字符串。格式为“alarmID=网管系统简称_告警ID;errLi

22、st=错误内容”。如果调用成功，则alarmID不为空串，为该工单对应的告警号、errList为空串；如果调用失败，则alarmID为空串，errList为错误描述。约定“alarmID=”和“errList=”不管调用成功与否都必须有，只是值可以为空串。opDetail详细信息约定：字段英文名类型(长度)字段中文名说明alarmIdstring(80)网管告警ID网管系统简称_告警IDsheetNostring(80)EOMS工单IDsheetStatusstring(32)工单状态草稿、待受理、处理中、处理完成、已归档、作废statusTimestring(20)状态时间/界面集成接口手工

23、派单界面集成手工派发是指网管用户在告警界面中人工确定是否要由该告警派发故障工单，并人工核查派单信息，派发工单。1） 网管系统负责提供EOMS用户登录界面，以便在派单前针对该网管用户进行EOMS系统用户鉴权。网管系统调用EOMS系统提供的用户鉴权服务进行用户鉴权。2） 手工派单流程由网管系统发起，网管系统先调用“告警接收(newAlarm)”接口，将告警数据传送给EOMS系统，由EOMS生成工单，并将工单号返回给网管系统。网管系统根据工单号，采用HTTP GET方式调用EOMS系统的派单页面，具体格式如：http:/派单页面url?sheetNo=工单号&userName=用户名。3） EOMS

24、系统负责提供派单页面，并将网管系统送来的告警信息填入故障工单的相应字段中。网管用户使用EOMS系统的派单页面完成派单过程。EOMS系统最终应将派单是否成功信息通过工单状态同步接口反馈给网管。此后，工单状态如有变化，也应通过工单状态同步接口通知网管系统。工单查询界面集成在网管系统的告警监视界面中，对于已派发故障工单的告警，可以由某告警查询其相关的故障工单信息。故障工单查询页面由EOMS系统提供，由网管系统调用，其实现机制类似网管系统调用EOMS系统的派单页面，采用HTTP GET方式调用EOMS系统的查看网页，并将工单号提供给EOMS系统，具体格式如：http:/工单查询页面url?sheetN

25、o=工单号。接口要求告警自动派单规则告警自动派单规则由网管系统制定，用户可自行定义。网管系统应能够根据网管告警信息项“设备类型”、“网元名称”、“告警类型”、“告警级别”、“告警标题”、“告警描述特征字串”、“告警历时”中某几项或全部项进行“自动派单告警”定义。网管系统根据己方系统的自动派单规则自动判定当前告警是否需要自动派单，如果需要，则将相应的告警信息以规范的格式通过标准接口传送给EOMS系统，由EOMS系统生成相应的故障工单。告警派单要求网管系统需满足以下要求：1) 网管系统要对已派工单的告警进行标识，避免重派。2) 网管系统应负责对“闪断”告警进行处理(如在派单规则中加一定时延处理)，

26、以避免向EOMS系统发送大量无效告警。 3) 网管系统应负责对因工程或割接等原因产生的告警进行屏蔽，以避免向EOMS系统发送大量无效告警。EOMS系统需满足以下要求：4) 对于告警派发的故障工单，告警的状态为“清除”时，EOMS系统才允许相应故障工单“归档”。5) EOMS系统应在故障工单中标识出“自动派单”和“手工派单”。6) 凡在网管系统中涉及到需要对工单进行查询或操作的，尽量引用EOMS系统的工单查询或操作界面，避免由各个网管系统重复开发类似的界面，并可避免当工单发生变化时，各个网管系统需同步进行相应的修改。如在网管告警手工派单时，由网管系统调用EOMS系统的派单界面，而不是由网管系统重

27、复开发派单界面。基本技术要求：7) 在本规范中，如无特殊说明，时间类字段的数据格式均为：“YYYY-MM-DD H24:MI:SS”。8) 接口实现必须使用SOAP协议，接口描述必须使用WSDL语言。9) 接口实现必须符合SOAP协议V1.1版本规范，高版本SOAP协议必须保证与1.1版本的兼容性。10) 接口实现必须至少支持SOAP 在HTTP V1.0协议上的传输。11) 接口实现必须符合WSDL语言V1.1版本规范，高版本WSDL语言必须保证与1.1版本的兼容性。12) 接口描述必须至少支持WSDL在SOAP V1.1协议上的绑定。13) 接口提供商必须提供接口定义文件(WSDL)下载，

28、建议提供URL使用Web方式实时提供。14) 接口实现必须支持WS-I Basic Profile V1.0(or Higher)互联互通协议。现阶段不考虑接口安全因素。针对WSDL基于SOAP的绑定方式，必须满足：绑定(binding)和操作(operation)的风格(style)必须满足：style=“document”；消息体的呈现方式必须满足：use=“literal”。15) 在应用层采用GB2312编码方式。接口安全技术要求接口安全设计目标与内容接口安全设计的目标是防止非法程序对系统接口的非法访问。接口安全设计可包括以下几个方面的内容：1) 网络控制在网络层面对来访程序进行一定的控制，保证来访程序来自于可靠地址。2) 数据机密性对接口传输的数据进行加密/解密，确保数据在传输过程中不被窃听。3) 数据完整性对接口传输的数据进行完整性检查，确保数据在传输过程中不被篡改。4) 授权与鉴权提供对来访程序的相应的用户/口令、权限分配管理功能。当来访程序访问系统接口时，首先对来访程序进行鉴权，检查来访程序的用户名/口令以及是否拥有对所访问接口程序的访问权限。5) 审计管理提供接口日志管理功能，包括接口访问日志的记录、查询/检索、备份、删除、示警等。不同层面的接口安全措施为保证系统接口的安全，可在不同层面实施安全