Figure 2-4 Interconnection process of the XML NBI
Step Description
1 Start the JMS message middleware.
2 Start the Web Service middleware.
3 Establish a connection.
4 Connect to the JMS message middleware.
5 Sent a request message.
6 Return a response message.
7 Report an alarm.
l Scenario 1: System startup process 1. Start the JMS message middleware.
2. Start the Web Service middleware.
3. Connect the JMS message middleware to the U2000.
l Scenario 2: User's subscription to a notification
1. Connect the OSS to the JMS message middleware.
2. The OSS subscribes the desired notification.
l Scenario 3: Alarm reporting
1. The U2000 reports an alarm to the JMS message middleware.
2. The OSS receives the alarm that is forwarded by the JMS message middleware.
l Scenario 4: Call of common interfaces 1. The OSS sends a request message.
2. The U2000 returns a response message.
l Scenario 5: Call of coarse granularity interfaces 1. The OSS sends a request message.
2. The U2000 returns a message to the FTP server and upload the progress information.
3. After the file transfer is complete, the U2000 sends a completion notification to the OSS.
2.3 Sample Flow
The following section describes how to query all the current alarms on the NMS.
Context
NOTE
When integrating with the XML NBI, you can compile the WSDL file to an API interface file, which simplifies the operation of code integration.
Procedure
1 Find the interface definition corresponding to the current alarms in the AlarmRetrievalHttp.wsdl file, as shown below.
<wsdl:operation name="getActiveAlarms">
<soap:operation soapAction="getActiveAlarms" style="document"/>
<wsdl:input>
<soap:header message="tns:getActiveAlarmsRequest" part="mtopHeader"
use="literal"/>
<soap:body parts="mtopBody" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:header message="tns:getActiveAlarmsResponse" part="mtopHeader"
use="literal"/>
<soap:body parts="mtopBody" use="literal"/>
</wsdl:output>
<wsdl:fault name="getActiveAlarmsException">
<soap:fault name="getActiveAlarmsException" use="literal"/>
</wsdl:fault>
</wsdl:operation>
2 Find the data type definition of the request message in the AlarmRetrievalMessages.xsd file, as shown below.
<xsd:element name="getActiveAlarmsRequest">
<xsd:annotation>
<xsd:documentation>
<p>Request message structure of the getActiveAlarms operation</p>
<p>This operation returns (to the requesting OS) a specified subset of the active alarms known to the target OS. The target OS returns all alarms satisfying the filter constraints of the requesting OS. This operation can only be directed to a top-level OS and not to a subordinate OS.</p>
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="filter" type="tns:ActiveAlarmFilterType" minOccurs="0">
<xsd:annotation>
<xsd:documentation>
<p>Defines the subset of the set of active alarms known to the target OS that are to be returned to the requesting OS.</p>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
3 Find the definition of the response message in the AlarmRetrievalMessages.xsd file, as shown below.
<xsd:element name="getActiveAlarmsResponse" type="alm:AlarmListType">
<xsd:annotation>
<xsd:documentation>
<p>Response message structure of the getActiveAlarms operation</p>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
4 Construct the following XML message according to the data type definition of the request and send the XML message to the XML NBI through HTTP.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:v1="http://www.tmforum.org/mtop/fmw/xsd/hdr/v1" xmlns:v11="http://
www.tmforum.org/mtop/rtm/xsd/ar/v1" xmlns:v12="http://www.tmforum.org/mtop/fmw/
xsd/nam/v1" xmlns:v13="http://www.tmforum.org/mtop/nra/xsd/com/v1"
xmlns:v14="http://www.tmforum.org/mtop/nra/xsd/prc/v1">
<soapenv:Header>
<v1:header>
<v1:security>admin:u2000u2000</v1:security>
<v1:communicationPattern>MultipleBatchResponse</v1:communicationPattern>
<v1:communicationStyle>RPC</v1:communicationStyle>
<v1:requestedBatchSize>20</v1:requestedBatchSize>
<v1:batchSequenceNumber>1</v1:batchSequenceNumber>
</v1:header>
</soapenv:Header>
<soapenv:Body>
<v11:getActiveAlarmsRequest>
</v11:getActiveAlarmsRequest>
</soapenv:Body>
</soapenv:Envelope>
5 Receive the following XML message from the XML NBI and parse the message according to the data type definition of the response message.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:v1="http://www.tmforum.org/mtop/fmw/xsd/hdr/v1" xmlns:v11="http://
www.tmforum.org/mtop/rtm/xsd/ar/v1" xmlns:v12="http://www.tmforum.org/mtop/fmw/
xsd/nam/v1" xmlns:v13="http://www.tmforum.org/mtop/nra/xsd/com/v1"
xmlns:v14="http://www.tmforum.org/mtop/nra/xsd/prc/v1">
<soapenv:Header>
<v1:header>
<v1:security>admin:u2000u2000</v1:security>
<v1:communicationPattern>MultipleBatchResponse</v1:communicationPattern>
<v1:communicationStyle>RPC</v1:communicationStyle>
<v1:requestedBatchSize>20</v1:requestedBatchSize>
<v1:batchSequenceNumber>1</v1:batchSequenceNumber>
</v1:header>
</soapenv:Header>
<soapenv:Body>
<v11:getActiveAlarmsRequest>
</v11:getActiveAlarmsRequest>
</soapenv:Body>
</soapenv:Envelope>
----End
3 Deploying and Configuring the XML NBI
About This Chapter
This chapter describes how to deploy and configure the U2000 XML NBI. It includes the following information:
3.1 Overview
This topic describes the background information and the terms involved in the process of deploying and configuring the northbound interface.
3.2 Configuration Requirements
U2000 XML NBI and the U2000 server run on the same PC or Sun workstation, any additional configuration is not required. But to enable the XML NBI, you must purchase the license for the corresponding functions.
3.3 Logging in to the Client of the NMS Maintenance Suite
After you log in to the client of the NMS Maintenance Suite, you can maintain the U2000 by using the NMS Maintenance Suite, including deploying the U2000 and configuring the instance of the northbound interface.
3.4 Checking the XML NBI Status
After check the license and ensure it is support XML functions, you need to check the current status of XML NBI, and deploy the XML NBI according the status.
3.5 Deploying the XML NBI for the First Time
By default, the XML NBI is not installed during the installation of U2000 server. To enable the XML NBI, you need to add the XML NBI the XML NBI component first, then add the XML NBI instance.
3.6 Configuring the XML NBI
In order to enable the XML NBI, even though you have installed XML NBI component, you need configure the XML parameters accord to NMS planning. Also, you can modify the parameters by configuring XML NBI again. Generally, general parameters are mandatory and advanced items are optional but the default values are recommended. Every advanced item is independent and you need not set the parameters.
3.1 Overview
This topic describes the background information and the terms involved in the process of deploying and configuring the northbound interface.