E-mail Alarm Forwarding v. 3.1.

1
Interface Description

DN70136073 Issue 3-1-1 en

© Nokia Siemens Networks

1 (19)

and the customer assumes full responsibility when using it. BUSINESS INTERRUPTION. The information or statements given in this documentation concerning the suitability. Copyright © Nokia Siemens Networks 2012. and they are mentioned for identification purposes only. if deemed necessary by Nokia Siemens Networks. DN70136073 Issue 3-1-1 en © Nokia Siemens Networks 2 (19) . explain issues which may not be covered by the document.Table of Contents The information in this document is subject to change without notice and describes only the product defined in the introduction of this documentation. Nokia Siemens Networks will. Nokia is a registered trademark of Nokia Corporation. capacity. INCLUDING BUT NOT LIMITED TO SPECIAL. BUSINESS OPPORTUNITY OR DATA. Nokia Siemens Networks will correct errors in this documentation as soon as possible. Siemens is a registered trademark of Siemens AG. DIRECT. The wave logo is a trademark of Nokia Siemens Networks Oy. 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. SUCH AS BUT NOT LIMITED TO LOSS OF PROFIT. 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. 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. All rights reserved. Other product names mentioned in this document may be trademarks of their respective owners. Nokia Siemens Networks welcomes customer comments as part of the process of continuous development and improvement of the documentation. The documentation has been prepared to be used by professional and properly trained personnel. and no part of it may be used. However. REVENUE. modified or transmitted in any form or means without the prior written permission of Nokia Siemens Networks. INDIRECT. INCIDENTAL OR CONSEQUENTIAL OR ANY LOSSES. This documentation and the product it describes are considered protected by copyrights and other intellectual property rights according to the applicable laws. IN NO EVENT WILL NOKIA SIEMENS NETWORKS BE LIABLE FOR ERRORS IN THIS DOCUMENTATION OR FOR ANY DAMAGES. reproduced.THAT MAY ARISE FROM THE USE OF THIS DOCUMENT OR THE INFORMATION IN IT.

....................................................................... 5 Context of the interface...................2............................ 10 Alarm attributes ....................................................................................... 16 Example(s) ........................................ 15 Semantics........................................3 4........2........................................................ 19 DN70136073 Issue 3-1-1 en © Nokia Siemens Networks 3 (19) .................................Table of Contents 1 2 2..................................................................1 4 4......................1 4........................................... 4 Overview ................2....................................................................................................................................................... 10 Syntax of the interface . 14 User comments ...5 5 About this document ......................................................................... 5 Introduction.........1 4....2 2............ 7 Information model ....... 15 Configuring NetAct for using the interface.............2 4..............................................................................................3 4.......................................................................... 16 Where to find more information...................2 4.................................................................. 5 Features .................................................................................................................... 10 Alarm description .................................3 3 3........................... 15 E-mail format ....... 8 Interface concepts ..............1 2................................................... 8 Description of the interface ......................................................4 4..................

About this document 1 About this document The E-mail Alarm Forwarding Interface is designed to send e-mails for multiple e-mail recipients using external e-mail sender programs. Configuring external e-mail forwarding clients and servers is outside the scope of this document. DN70136073 Issue 3-1-1 en © Nokia Siemens Networks 4 (19) . This document describes the alarm format for e-mail and also provides references for creating e-mail forwarding rules using the Rule Editor User interface.

the Open Fault Standard Interface (OFaS) and the NetAct alarm structure. The e-mail alarm format specified in this interface is the same to all the recipients. This interface does not address the configuration of external mail servers. 2. NetAct sends each alarm notification in a separate mail.2 Context of the interface The E-mail Alarm Forwarding Interface is part of NetAct.Overview 2 Overview This chapter provides an overview of the alarm format in e-mails. NetAct uses this interface to notify operators through e-mail by sending the alarm details to their e-mail address. You must be familiar with NetAct FM. This interface does not specify how NetAct fetches event information and does not describe the format of e-mail rules. 2. This interface sends e-mails directly using an external mail server configured via the preferences. The alarm forwarding system in NetAct forwards alarms to e-mail accounts using a specific e-mail format.1 Introduction Alarm formats for e-mail described in Section Semantics are used for sending alarms from NetAct. DN70136073 Issue 3-1-1 en © Nokia Siemens Networks 5 (19) . This document is intended for • • • NetAct architects NetAct designers Developers and testers.

Context of the E-mail Alarm Forwarding Interface DN70136073 Issue 3-1-1 en © Nokia Siemens Networks 6 (19) .Overview NetAct-based System FM Platform Email Mediation E-mail Alarm Forwarding interface external email server e-mails Figure 1.

NetAct also sends user comments associated with the alarm. When forwarding an alarm to the e-mail system. When forwarding an alarm to the e-mail system. NetAct also sends an alarm description in the e-mail. Technology ASCII Feature send alarm to email recipients include alarm description in email ASCII include user comments in e-mail ASCII DN70136073 Issue 3-1-1 en © Nokia Siemens Networks 7 (19) .3 Features The following table lists the E-mail Alarm Forwarding features. Table 1: E-mail Alarm Forwarding features Description NetAct sends fault management events to e-mail recipients using the format specified in the interface.Overview 2.

see Open Fault Standard (OfaS) Interface Description.1 Interface concepts Table Alarm attributes lists the attribute names used in this interface. For more information on the OFaS attributes. Alarm attributes Source Alarm Alarm Alarm Alarm Alarm Alarm Alarm Alarm Alarm Alarm Alarm Alarm Alarm Alarm Supported in the current version Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Attribute name specificProblem perceivedSeverity maintenanceRegion siteName siteAddress distinguishedName alarmText eventTime notificationId ackTime ackedBy cancelTime cancelledBy additionalText1 Description Qualification of the fault Severity of the alarm Name of the maintenance region Name of the site Address information of the site Distinguished name of the alarming object. 3.Information model 3 Information model This chapter describes the information model of the interface. Textual description of the fault Time the event was generated Notification id of the fault Time the event was acknowledged The acknowledge user Time the event was cancelled The cancel user Additional information on the fault DN70136073 Issue 3-1-1 en © Nokia Siemens Networks 8 (19) . Table 2.

Information model Attribute name additionalText2 additionalText3 additionalText4 eventType additionalText5 additionalText6 additionalText7 Description Additional information on the fault Further additional information on the fault Further additional information on the fault Type of the event Additional information on the fault Additional information on the fault Further additional information on the fault Source Alarm Alarm Alarm Alarm Alarm Alarm Alarm Supported in the current version Yes Yes Yes Yes Yes Yes Yes DN70136073 Issue 3-1-1 en © Nokia Siemens Networks 9 (19) .

1 Syntax of the interface The interface contains three parts: • • • Alarm attributes Alarm description User comments The following sub-sections define the syntax of each part of the interface. 4. 4.Description of the interface 4 Description of the interface This section describes the individual components of the e-mail format.2 Alarm attributes This section describes the format of the alarm information for different types of alarms. Active alarm The figure 1 describes the representation of various alarm attributes in the email for an active alarm. DN70136073 Issue 3-1-1 en © Nokia Siemens Networks 10 (19) .

Description of the interface Acknowledged alarm The figure 2 describes the representation of various alarm attributes in the email for an acknowledged alarm. Cleared alarm The figure 3 describes the representation of various alarm attributes in the email for a cleared alarm. The distinguishing fields for this alarm are ‘CANCELLED’ and ‘CANCELLED By’ which is the cancel time and cancel user information for a cancelled alarm. 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 Data “\n” Column Number Line 1 Line 2 Line 3 Line 4 Line 5 Line 6 Line 7 Line 8 Line 9 Line 10 Line 11 Line 12 Line 13 Line 14 = A S M S S D S N E A A A A = L E A I I I T O V L D D D = A V I T T S A T E A D D D = R E N E E T R I N R I I I = M R T = = N = U Y A M D U N E R I M = B = E = R = = = = = = = = = = : : “\n” “\n” “\n” “\n” “\n” “\n” “\n” “\n” “\n” “\n” “\n” “\n” “\n” “\n” I E N A T N A D G D C T T C E R E G I O N : : E S S H S E D N A M E : : : I T F T M T T T N E I A Y E N N N T P X A A A I E T L L L O N I D : : : I I I O O O T T T E E E X X X T T T 1 2 3 : : : DN70136073 Issue 3-1-1 en © Nokia Siemens Networks 11 (19) . The distinguishing fields for this alarm are ‘ACKED’ and ‘ACKED By’ which are the ack time and ack user information for an acked alarm respectively.

Description of the interface A A A A “\n” M D D D D D D D D I I I I T T T T I I I I O O O O N N N N A A A A L L L L T T T T E E E E X X X X T T T T 4 5 6 7 : : : : “\n” “\n” “\n” “\n” Line 15 Line 16 Line 17 Line 18 Line 19 << Intentionally Left Blank>> A N P A G E : << Manual Multi Line D A T A M A X O F 5 0 0 C H A R S “\n” U << Intentionally Left Blank>> S E R C O M M E N T S : << User Multi Line C O M M E N T S D A T A M A X O F 5 0 0 CHARS = = = = = = = = = = = = = = = = = = = = = = Figure 1. Alarm format for an active alarm 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 Data “\n” Column Number Line 1 Line 2 Line 3 Line 4 Line 5 Line 6 Line 7 = A S M S S D = L E A I I I = A V I T T S = R E N E E T = M R T = = N = U Y A M D U = M = B = E = R = = = = = = = = = = : : “\n” “\n” “\n” “\n” “\n” “\n” “\n” I E N A T N A D G N E R I C E R E G I O N : : E S S H S E D N A M E : : I N DN70136073 Issue 3-1-1 en © Nokia Siemens Networks 12 (19) .

Alarm format for a cancelled alarm 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 Data “\n” Column Number Line 1 Line 2 Line 3 Line 4 Line 5 = A S M S = L E A I = A V I T = R E N E = M R T = = N = U Y A M = M = B = E = R = = = = = = = = = = : : “\n” “\n” “\n” “\n” “\n” I E N T N A N E C E R E G I O N : : DN70136073 Issue 3-1-1 en © Nokia Siemens Networks 13 (19) .Description of the interface S N A A E A “\n” M T O C C V L A T K K E A R I E E N R T F D D T M E I D C A T I O N I D : : : “\n” “\n” “\n” “\n” “\n” “\n” Line 8 Line 9 Line 10 Line 11 Line 12 Line 13 Line 14 B T T Y Y E P X E T : : : << Intentionally Left Blank>> A N P A G E : << Manual Multi Line D A T A M A X O F 5 0 0 C H A R S “\n” U << Intentionally Left Blank>> S E R C O M M E N T S : << User Multi Line C O M M E N T S D A T A M A X O F 5 0 0 CHARS = = = = = = = = = = = = = = = = = = = = = = = = = Figure 3.

2. The following is the format for the alarm description.1 Alarm description NetAct retrieves the alarm description (man-page) for an alarm as described in FM Basic O&M Metamodel Interface Description. Alarm description in the e-mail is an optional component and an option to select the alarm description is provided in Rule Editor DN70136073 Issue 3-1-1 en © Nokia Siemens Networks 14 (19) .Description of the interface S D S N C C E A “\n” M I I T O A A V L T S A T N N E A E T R I C C N R I T F E E T M A N E I L L D G D C L L T T D U R I E S S H S E D N A M E : : : “\n” “\n” “\n” “\n” “\n” “\n’ “\n” “\n” Line 6 Line 7 Line 8 Line 9 Line 10 Line 11 Line 12 Line 13 Line 14 A E E Y E T D D P X I O N I D : : B E T Y : : : << Intentionally Left Blank>> A N P A G E : << Manual Multi Line D A T A M A X O F 5 0 0 C H A R S “\n” U << Intentionally Left Blank>> S E R C O M M E N T S : << User Multi Line C O M M E N T S D A T A M A X O F 5 0 0 CHARS = = = = = = = = = = = = = = = = = = = = = = = = = 4.

ALARM ATTRIBUTES: <alarm format. 4. The option to select user comments is provided in Rule Editor.2.2 User comments The user comments component in the e-mail is optional. Create rules using Rule Editor. see Chapter Alarm attributes> ALARM DESCRIPTION FOR THIS ALARM: <alarm Description.Description of the interface 4. see Chapter Alarm description> USER COMMENTS FOR THIS ALARM DESCRIPTION: <user comments. text indicating the same will be present.3 Semantics The installation of NetAct configures the email-sending related commands and information in the preferences. There are two steps of e-mail-sending: 1. Rule matching: Upon receiving an alarm which matches the e-mailforwarding rule. see Chapter User comments> 4.2. NetAct fetches all required information for creating the e-mail. DN70136073 Issue 3-1-1 en © Nokia Siemens Networks 15 (19) . In case user comments are not available for the alarm.3 E-mail format This section describes the format for the e-mail.

com’.com" /> <!-.Name of the Mail Server --> <entry key="mailServerName" value="localhost" /> <!-.com --> </map> </node> </node> </map> </root> </preferences> 4.4 Configuring NetAct for using the interface You can configure the mail server you want to use in NetAct in preferences.g.Domain name of From Account --> <entry key="domainName" value="titans.E. username = Admin and domainName = titans.0"> <root type="system"> <map /> <node name="fmcore"> <map /> <!-. 4. Sending to e-mail accounts by forwarding to an external mail server: external mail server details configured in preference data will be used for sending e-mails to specified recipients. When From Address is ‘Admin@titans.xml file.The configuration related to alarm forwarding to email feature--> <node name="emailClient"> <map> <!-. The preferences to be configured for external mail server are explained below and are present in Pref_system_fmcore.Description of the interface 2.User name of From Account --> <entry key="userName" value="Admin" /> <!-.5 Example(s) MAIL FOR AN ACTIVE ALARM: ============================================================ ALARM_NUMBER : 2815 SEVERITY : CRITICAL Maintenance Region : MRName Site Name : SiteName Site Address : H1 DN70136073 Issue 3-1-1 en © Nokia Siemens Networks 16 (19) . <preferences EXTERNAL_XML_VERSION="1.

The system cancels the alarm automatically when the alarm uploading has been finished. The alarm requires no actionsDo not cancel the alarm. the system is uploading active alarms from every BTS in the network.Description of the interface Distinguished Name Started Notification Id Event Type Alarm Text : : : : : PLMN-PLMN/BSC-1 2008-10-10 17:50:56 4 PROCESSING Alarm Text Man Page : RNW ALARM UPLOAD ONGOING18A disturbance has occurred in the radio network alarm system. No Supp. the system is uploading active alarms from every BTS in the network. No Supp. The system cancels the alarm automatically when the alarm uploading has been finished. No Supp. To assure the correct alarm situation in the RNC.The alarm requires no actionsDo not cancel the alarm. User Comments : No User Comments For This Alarm Number ============================================================ MAIL FOR ACKNOWLEDGED ALARM: ============================================================ ALARM_NUMBER : 2815 SEVERITY : ALARM_ACKED Maintenance Region : MRName Site Name : SiteName Site Address : H1 Distinguished Name : PLMN-PLMN/BSC-1 Started : 2008-10-10 17:50:56 Notification Id : 4 Acked : 2008-10-10 17:51:43 Acked By : omc Event Type : PROCESSING Alarm Text : Alarm Text Man Page : RNW ALARM UPLOAD ONGOING18A disturbance has occurred in the radio network alarm system. To assure the correct alarm situation in the RNC.The alarm requires no actionsDo not cancel the alarm. The system cancels the alarm automatically when the alarm uploading has been finished. User Comments : No User Comments For This Alarm Number----------============================================================ MAIL FOR CANCELLED ALARM: ============================================================ ALARM_NUMBER : 2815 SEVERITY : ALARM_CLEARED Maintenance Region : MRName Site Name : SiteName Site Address : H1 Distinguished Name : PLMN-PLMN/BSC-1 Started : 2008-10-10 17:50:56 Notification Id : 4 Cancelled : 2008-10-10 17:52:44 Cancelled by : omc Event Type : PROCESSING Alarm Text : Alarm Text Man Page : RNW ALARM UPLOAD ONGOING18A disturbance has occurred in the radio network alarm system. the system is ploading active alarms from every BTS in the network. DN70136073 Issue 3-1-1 en © Nokia Siemens Networks 17 (19) . To assure the correct alarm situation in the RNC.

Description of the interface User Comments : No User Comments For This Alarm Number ============================================================ DN70136073 Issue 3-1-1 en © Nokia Siemens Networks 18 (19) .

Where to find more information 5 Where to find more information See the following documentation for more information: • • • FM Basic: O&M Metamodel Interface Description Rule Editor help Open Fault Standard (OFaS) Interface Description DN70136073 Issue 3-1-1 en © Nokia Siemens Networks 19 (19) .

Sign up to vote on this title
UsefulNot useful