OSSJ Trouble Ticket Client Interface Description

(1)

DN70206078

Issue 3-1-1 en © Nokia Siemens Networks 1 (19)

Nokia Siemens Networks NetAct™ 7

OSS Trouble Ticket API v. 3.1.1

Interface Description

DN70206078

Draft

(2)

The information in this document is subject to change without notice and describes only the product defined in the introduction of this documentation. This documentation is intended for the use of Nokia Siemens Networks customers only for the purposes of the agreement under which the document is submitted, and no part of it may be used, reproduced, modified or transmitted in any form or means without the prior written permission of Nokia Siemens Networks. The documentation has been prepared to be used by professional and properly trained personnel, and the customer assumes full responsibility when using it. Nokia Siemens Networks welcomes customer comments as part of the process of continuous development and improvement of the documentation.

The information or statements given in this documentation concerning the suitability, capacity, or performance of the mentioned hardware or software products are given “as is” and all liability arising in connection with such hardware or software products shall be defined conclusively and finally in a separate agreement between Nokia Siemens Networks and the customer. However, Nokia Siemens Networks has made all reasonable efforts to ensure that the instructions contained in the document are adequate and free of material errors and omissions. Nokia Siemens Networks will, if deemed necessary by Nokia Siemens Networks, explain issues which may not be covered by the document. Nokia Siemens Networks will correct errors in this documentation as soon as possible. IN NO EVENT WILL NOKIA SIEMENS NETWORKS BE LIABLE FOR ERRORS IN THIS DOCUMENTATION OR FOR ANY DAMAGES, INCLUDING BUT NOT LIMITED TO SPECIAL, DIRECT, INDIRECT,

INCIDENTAL OR CONSEQUENTIAL OR ANY LOSSES, SUCH AS BUT NOT LIMITED TO LOSS OF PROFIT, REVENUE, BUSINESS INTERRUPTION, BUSINESS OPPORTUNITY OR DATA,THAT MAY ARISE FROM THE USE OF THIS DOCUMENT OR THE INFORMATION IN IT.

This documentation and the product it describes are considered protected by copyrights and other intellectual property rights according to the applicable laws.

The wave logo is a trademark of Nokia Siemens Networks Oy. Nokia is a registered trademark of Nokia Corporation. Siemens is a registered trademark of Siemens AG.

Other product names mentioned in this document may be trademarks of their respective owners, and they are mentioned for identification purposes only.

(3)

Contents

1

About this document

This document specifies an interface to integrate NetAct with a trouble ticket system. After integration, you can create, modify, view, or close trouble tickets from Monitoring Desktop.

The prerequisite for the integration is that the trouble ticket system supports the OSS/J X.790 extension for Trouble Ticket API v1.2. See Interoperability for more prerequisites.

(6)

2

Overview

This chapter provides an overview of the OSS/J Trouble Ticket API.

2.1 Introduction

A trouble ticket system (TTS) is a tool to support the trouble resolution process. It enables you to resolve troubles detected by NetAct FM Platform. With the help of a trouble ticket (TT), the progress of the trouble resolution is tracked.

To ease the trouble resolution process, it is beneficial to integrate FM Platform and the trouble ticketing system in a way that data, alarms and managed objects, for example, can be exchanged between the two systems. The OSS/J Initiative has specified the OSS/J Trouble Ticket API. FM communicates with the trouble ticket system using OSS/J X.790 Extension for Trouble Ticket API v 1.2.

The biggest portion of the OSS/J Trouble Ticket API is specified in the industry standard OSS/J Trouble Ticket API. This document defines the context in which NetAct FM uses the trouble ticket client interface. Furthermore, it specifies how the Nokia Siemens Networks alarms and managed objects are mapped to the corresponding OSS data structures.

(7)

Overview

2.2 Context of the interface

FM Platform communicates with the trouble ticket system through the OSS/J X.790 Extension for Trouble Ticket API v1.2. FM Platform is the client and the trouble ticket system is the server with respect to the OSS/J Trouble Ticket API.

NetAct Base system FM Platform

Trouble Ticket System OSS TTIF TT Client

Figure 1. Context of the OSS/J Trouble Ticket Interface

2.3 Features

The features of the OSS/J Trouble Ticket APIare explained in detail in the industry standard OSS/J Trouble Ticket API. Here is a brief overview on the use cases where Monitoring Desktop uses the OSS/J Trouble Ticket API:

(8)

 The user selects one or more alarms or managed objects in the

GUI and creates a trouble ticket containing these entities (these entities become attached to the trouble ticket).

 Attach to Trouble Ticket

 The user wants to attach one or several managed objects or

alarms to an open trouble ticket.

 Detach from Trouble Ticket

 The user wants to detach one or several managed objects or

alarms from an open trouble ticket.

 Modify Trouble Ticket

 The user wants to either modify the attributes of a trouble ticket or

detach or attach managed objects or alarms.

2.4 Interoperability

The OSS/J Trouble Ticket APIprovides J2EE/EJB-d interfaces for creating, querying, updating, closing, and escalating trouble tickets. Interfaces and mechanisms are also provided for trouble ticket notification management. The Trouble Ticket API is part of the OSS/J Initiative.

The OSS/J Trouble Ticket Client Interface follows the interaction patterns defined by the OSS/J Initiative and described in the OSS through Java J2EE Design Guidelines.

The connection from the client to the server can be accomplished using three different connection methods:

1. Java value type (JVT) session beans: This is an EJB type of connection that utilises session and entity beans being part of the client software. It requires J2EE libraries on the client machine to communicate with the J2EE server using the EJB 2.0.

2. XML/JMS-d messaging (XVT): this type of connection uses JMS XML messaging to exchange data between the client and server. It is meant to be a more loosely coupled communication solution as it requires only the JMS part of the J2EE implementation and does not use EJB or Java interfaces. Everything is handled by exchanging well-defined fragments of XML.

(9)

Overview

3. Webservices Integration: This integration profile uses the webservice request from client and server to exchange the data. This type of

integration provides integration of web services into the existing, proven best practices and design patterns already in use.

Monitoring Desktop supports the XML/JMS-d messaging connection method. For more information, see the industry standard OSS/J Trouble Ticket API. XVT is the preferred connection method for loosely coupled systems. The NetAct server and the trouble ticket server are loosely coupled systems.

2.5 XVT

The JMS specification is an API specification (part of J2EE) and does not define the wire protocol. Therefore, JMS providers use proprietary protocols. It is tested that the NetAct FM OSS/J Trouble Ticket Client Interface

interoperates with trouble ticket systems d on the Active MQ

2.5.1 ActiveMQ as JMS provider

NetAct TT Client communicates with TT server through activeMQ.

Configuration for activeMQ is specified through preference file (see, section 3.1).

Note

(10)

Open EMS Suite based system FM Platform ActiveMQ OSS/J TTIF (XVT) TT Client

Trouble Ticket System

OSS/J TTIF (XVT)

(11)

Installing vendor-specific libraries

3

Installing vendor-specific libraries

3.1 Enabling the use of the module

By default, the Net FM TT client does not use a vendor-specific module for the connection to the trouble ticket server. The use of the module is enabled by changing the preferences file entry.

Following section explains procedure to configure preferences file.

Pre-requisite

Trouble Ticket Server is installed which uses Active MQ as JMS provider for messaging service.

1. Login to the NetAct as root user.

2. Copy Pref_system_TroubleTicketConfig.xml from /opt/nokia/oss/conf to /etc/opt/nokia/oss/custom/conf/

3. Edit /etc/opt/nokia/oss/custom/conf/Pref_system_TroubleTicketConfig.xml file.

4. Edit the following values in preference file. <node name="troubleticketclient"> <map> <entry key="troubleticketserverjmsprovider" value="<TT_server_type>" /> </map> </node>

(12)

Where value of the attribute (<TT_server_type>) ”value” can be one of he following:

 other: TT server uses Active MQ as JMS provider.  none: There is no TT integration.

Note:

The default value in the preference file for value is “none”. 5. Edit the following values as per integration.

Example:

tcp://1.2.3.4:61616 6. Save the file.

Note:

It may take few minutes for the changes to take effect.

7. Copy Pref_TroubleTicket_Limit.xml from /opt/nokia/oss/conf to /etc/opt/nokia/oss/custom/conf/

8. Edit following value:

Where troubleSystemDN is a unique value across NetAct system sharing same TT server. For more detail, see section 4.3

9. Close NetAct Monitor. 10. Restart NetAct FM pipe.

Execute the following steps on each App server node of a cluster. a) Check the status by executing the following command:

clustat | grep -i fm_pipe Following is displayed.

service:fm_pipe-<hostname> node1 started b) To disable the pipe instance, execute the following command:

(13)

Installing vendor-specific libraries

clusvcadm -d fm_pipe-<hostname>

c) To enable the the pipe instance execute the following command: clusvcadm -e fm_pipe-<hostname>

Outcome

(14)

4

Mapping

The OSS/J trouble ticket system enables you to attach alarms and managed objects to trouble tickets. This section defines how NetAct FM alarms and managed objects are converted to OSS alarms and objects.

4.1 Mapping the NetAct FMalarm to an OSS alarm

The OSS/J X790 extension to Trouble Ticket API v 1.2 uses the AlarmValue of the OSS/J Shared Alarm specification as specified in the OSS/J Common API 1.5 to related Alarms. The following table shows how the OSS alarm attribute is constructed from the NetAct alarm attributes:

Table 1. OSS fm:AlarmValue attributes

OSS fm:AlarmValue attribute name

NetAct alarm attribute(s) from FM Access Interface or object attribute from CM Core Adaptation

Comment

AlarmRaisedTime ALARM_TIME OriginatingManagedEntity

Key

Abbreviation of the ClassDef the managed object the alarm is targeted to

ManagedObjectInstance Instance of the managed object the alarm is targeted to

(15)

Mapping

NetAct alarm attribute(s) from FM Access Interface or object attribute from CM Core Adaptation Comment SystemDN ALARM_DN AlarmType EVENT_TYPE AlarmKey Concatenation of 1) alarmNumber 2) gid 3) TT client ID 4) dn 5) notificationid 6) alarm time. ProbableCause PROBABLE_CAUSE PerceivedSeverity PERCEIVED_SEVERITY SpecificProblem SPECIFIC_PROBLEM AlarmAckStatus ACK_STATUS

AdditionalText Concatenation of the

following attributes by ‘|’: ADDTTIONAL_INFO_1 ADDTTIONAL_INFO_2 ADDTTIONAL_INFO_3 ADDTTIONAL_INFO_4 ADDTTIONAL_INFO_5 ADDTTIONAL_INFO_6 ADDTTIONAL_INFO_7

(16)

Comment

AlarmSpecificInfo 1. primary alarm

(Identifies whether the alarm is primary) 2. ackUser 3. ackTime (this is the eventTime OFaS attribute for alarm ack

notification) 4. cancelTime (this

is the

eventTime OFaS attribute for alarm cancel notification) 5. additionalText1 6. additionalText2 7. additionalText3 8. additionalText4 9. Controlloing NE

Sequence of alarm attributes in this particular order. Example

<ossj-co-sharedalarm-v1-5:alarmSpecificInfo> <ossj-co-sharedalarm- v1-5:item>true</ossj-co-sharedalarm-v1-5:item> <ossj-co-sharedalarm-v1-5:item>Ack User</ossj-co-sharedalarm-v1-5:item> <ossj-co-sharedalarm-v1-5:item>Ack Time</ossj-co-sharedalarm-v1-5:item> <ossj-co-sharedalarm-v1-5:item>Cancel Time</ossj-co-sharedalarm-v1-5:item> <ossj-co-sharedalarm-v1-5:item>Additional text 1</ossj-co-sharedalarm-v1-5:item> <ossj-co-sharedalarm-v1-5:item>Additional text 3</ossj-co-sharedalarm-v1-5:item> <ossj-co-sharedalarm-v1-5:item>Additional text 4</ossj-co-sharedalarm-v1-5:item> <ossj-co-sharedalarm-v1-5:item>Additional text 2</ossj-co-sharedalarm-v1-5:item> <ossj-co-sharedalarm-v1-5:item>Controlling NE</ossj-co-sharedalarm-v1-5:item> </ossj-co-sharedalarm-v1-5:alarmSpecificInfo>

(17)

Mapping

Comment

AlarmAckStatusAlarm Ack status.

AlarmClearStatusAlarm Alarm status

4.2 Mapping the NetAct managed object to an OSS object

The following table shows how the NetAct alarm attributes are mapped to the OSS alarm attributes:

Table 2. NetAct alarm attributes mapped to OSS alarm attributes

OSS/J Trouble Ticket:SuspectObject attribute

NetAct attribute Comment

SuspectObjectType Concatenation of ‘MO’ and id of the classDef of the managed object

SuspectObjectId Concatenantion of the following separated by the delimiter ‘|’: systemId

global Id

distinguishedName presentationName

When the presentationName is not defined, the following attributes are taken

concatenated by ‘-‘ ID of the classDef of the managed object

instance of the managedObject

(18)

OSS/J Trouble Ticket:SuspectObject attribute

NetAct attribute Comment

FailureProbability This attribute is optional and is

left out.

4.3 Mapping the troubleSystemDN

A trouble ticket system can be integrated to more than one NetAct system. An NetAct system should only query those trouble tickets that are related to its own objects and alarms. To identify to which NetAct system a trouble ticket belongs to the systemId of the NetAct system is mapped to the

(19)

Where to find more information

5

Where to find more information

 User Interface Module API Interface Description

 OSS/J X.790 extension for Trouble Ticket API,

http://ossj-troubleticket-x790.dev.java.net

 OSS/J Trouble Ticket API v 1.2

http://jcp.org/en/jsr/detail?id=91

 OSS/J Common API,