OSSJ Trouble Ticket Client Interface Description

Nokia Siemens Networks NetAct™ 7

OSS Trouble Ticket API v. 3.1.1 Interface Description DN70206078

DN70206078 Issue 3-1-1 en

© Nokia Siemens Networks

1 (19)

OSS Trouble Ticket API v. 3.1.1

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. Copyright © Nokia Siemens Networks 2011. All rights reserved.

2 (19)


DN70206078 Issue 3-1-1 en

Contents

Contents 1

About this document .............................................................................5

2 2.1 2.2 2.3 2.4 2.5 2.5.1

Overview .................................................................................................6 Introduction ..............................................................................................6 Context of the interface ............................................................................7 Features ...................................................................................................7 Interoperability..........................................................................................8 XVT ..........................................................................................................9 ActiveMQ as JMS provider.......................................................................9

3 3.1

Installing vendor-specific libraries.....................................................11 Enabling the use of the module..............................................................11

4 4.1 4.2 4.3

Mapping ................................................................................................14 Mapping the NetAct FMalarm to an OSS alarm.....................................14 Mapping the NetAct managed object to an OSS object.........................17 Mapping the troubleSystemDN ..............................................................18

5

Where to find more information..........................................................19

DN70206078 Issue 3-1-1 en


3 (19)


4 (19)


DN70206078 Issue 3-1-1 en

About this document

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.

DN70206078 Issue 3-1-1 en


5 (19)


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.

6 (19)


DN70206078 Issue 3-1-1 en

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 TT Client

OSS TTIF Trouble Ticket System

Figure 1.

2.3

Context of the OSS/J Trouble Ticket Interface

Features The features of the OSS/J Trouble Ticket API are 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: 

DN70206078 Issue 3-1-1 en

Create Trouble Ticket (manually) © Nokia Siemens Networks

7 (19)






Attach to Trouble Ticket 



The user wants to detach one or several managed objects or alarms from an open trouble ticket.

Modify Trouble Ticket 

2.4

The user wants to attach one or several managed objects or alarms to an open trouble ticket.

Detach from Trouble Ticket 



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).

The user wants to either modify the attributes of a trouble ticket or detach or attach managed objects or alarms.

Interoperability The OSS/J Trouble Ticket API provides 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:

8 (19)

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.


DN70206078 Issue 3-1-1 en

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

ActiveMQ is not part of NetAct .

DN70206078 Issue 3-1-1 en


9 (19)


Open EMS Suite based system FM Platform TT Client

OSS/J TTIF (XVT) ActiveMQ

OSS/J TTIF (XVT) Trouble Ticket System

Figure 2.

10 (19)

JMS messaging bridge


DN70206078 Issue 3-1-1 en

Installing vendor-specific libraries

3


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. DN70206078 Issue 3-1-1 en


11 (19)


Where value of the attribute () ”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-

node1

started

b) To disable the pipe instance, execute the following command: 12 (19)


DN70206078 Issue 3-1-1 en


clusvcadm -d fm_pipe-

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

Outcome

Trouble Ticket Module is available in the NetAct Monitor.

DN70206078 Issue 3-1-1 en


13 (19)


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

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

14 (19)


Comment

DN70206078 Issue 3-1-1 en

Mapping


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

SystemDN

ALARM_DN

AlarmType

EVENT_TYPE Concatenation of

AlarmKey

Comment

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

DN70206078 Issue 3-1-1 en


15 (19)



AlarmSpecificInfo

16 (19)

NetAct alarm attribute(s) from FM Access Interface or object attribute from CM Core Adaptation 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


Comment

Sequence of alarm attributes in this particular order. Example true Ack User Ack Time Cancel Time Additional text 1 Additional text 3 Additional text 4 Additional text 2 Controlling NE

DN70206078 Issue 3-1-1 en

Mapping


AlarmAckStatusAlarm

Comment

Alarm status

AlarmClearStatusAlarm

4.2

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

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

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

DN70206078 Issue 3-1-1 en


Comment

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 17 (19)


OSS/J Trouble Ticket:SuspectObject attribute

NetAct attribute

FailureProbability

4.3

Comment

This attribute is optional and is left out.

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 troubleSystemDN attribute.

18 (19)


DN70206078 Issue 3-1-1 en

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



DN70206078 Issue 3-1-1 en

OSS/J Common API, http://jcp.org/en/jsr/detail?id=144


19 (19)

OSSJ Trouble Ticket Client Interface Description

Recommend Documents