Clear Codes

DN70610364 Issue 6-0

Clear Codes

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 2010/11/16. All rights reserved

Important Notice on Product Safety

Elevated voltages are inevitably present at specific points in this electrical equipment. Some of the parts may also have elevated operating temperatures. Non-observance of these conditions and the safety instructions can result in personal injury or in property damage. Therefore, only trained and qualified personnel may install and maintain the system. The system complies with the standard EN 60950 / IEC 60950. All equipment connected has to comply with the applicable safety standards.

The same text in German: Wichtiger Hinweis zur Produktsicherheit In elektrischen Anlagen stehen zwangslufig bestimmte Teile der Gerte unter Spannung. Einige Teile knnen auch eine hohe Betriebstemperatur aufweisen. Eine Nichtbeachtung dieser Situation und der Warnungshinweise kann zu Krperverletzungen und Sachschden fhren. Deshalb wird vorausgesetzt, dass nur geschultes und qualifiziertes Personal die Anlagen installiert und wartet. Das System entspricht den Anforderungen der EN 60950 / IEC 60950. Angeschlossene Gerte mssen die zutreffenden Sicherheitsbestimmungen erfllen.

DN70610364 Issue 6-0

Clear Codes

Table of Contents
This document has 14 pages. 1 1.1 1.2 1.3 1.4 1.5 1.6 1.7 1.7.1 1.7.2 1.7.3 1.7.4 Clear Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 Introduction to clear codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 Clear codes definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 Internal functions related to clear codes . . . . . . . . . . . . . . . . . . . . . . . . . 7 End-of-selection analysis (EOS) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Mapping of clear codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Grouping of clear codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Clear code information in statistical reports . . . . . . . . . . . . . . . . . . . . . . 10 General principles of field reporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 General principles of traffic observation. . . . . . . . . . . . . . . . . . . . . . . . . 12 Traffic measurements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Load observation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

DN70610364 Issue 6-0

Id:0900d8058053cdc2

Clear Codes

List of Figures
Figure 1 Clearing causes with the same meaning, but different representations . . 9

Id:0900d8058053cdc2

DN70610364 Issue 6-0

Clear Codes

Clear Codes

1 Clear Codes
1.1 Introduction to clear codes
The following areas are covered: general information on the clearing of calls general description of clear codes principles of using clear code information references to instructions to define the software system settings related to clear codes

The reader should be familiar with the basic functions of a telecommunications network and an exchange in a network. The most essential issues are: signalling systems and types in general digit analysis and other analyses use and contents of statistical reports

Clear code documentation To customers, there are four kinds of sources of information that deal with the clear codes in addition to this: Clear Code List The Clear Code List gives detailed information about each clear code in the system. The following details are presented for each single clear code: hexadecimal code number name MML printout meaning effects in an exchange the program block that has detected the clearing additional information about the situation in which the clear code has been set Clear Code Changes The Clear Code Changes lists the clear codes that have been added to or removed from the software package between releases. Furthermore, it lists internal clear codes that have changed between releases. Mapping descriptions Each signalling type has a description of its own, presenting the mapping from signalling-specific clearing causes to internal clear codes and vice versa. The signalling adaptation of clear codes can be studied from the mapping descriptions for both incoming and outgoing signallings. The mapping descriptions are customer-specific. The name of the mapping description is Mapping of External Data.

No operating instructions are covered here. Only references to related operating instructions are given. Operating principles and instructions are presented in detail in the related documentation. For more information, see also the following sections: Clear codes Internal functions related to clear codes

DN70610364 Issue 6-0

Id:0900d8058053cdbf

Clear Codes

Clear Codes

End-of-selection analysis (EOS) Mapping of clear codes Grouping of clear codes Clear code information in statistical reports

1.2

Clear codes definition

A clear code is the identifier code of the reason to clear a call. A clear code may also act as control information in an exchange, ordering the exchange to handle a call in a certain way. Clear Codes are internal information of the system. Signalling specific clearing causes are the corresponding codes outside exchanges, that is, on the connections between exchanges. Main functions of clear codes: to act as reportable information about the functions of a network to act as control information in handling a call An exchange receives a clearing message from the surrounding network, that is, from another exchange. The message identifies the clearing reason. When coming into an exchange, the clearing cause is converted into the corresponding clear code. An exchange discovers a reason to clear a call. It generates a clear code corresponding to the clearing reason.

A clear code can be generated in an exchange in two ways:

When a call is coming from or going to a trunk circuit in an exchange which discovers a reason to clear a call, the exchange has to send the clearing information to other exchanges on the call's route as well. The exchange converts the clear code into a corresponding clearing cause of the signalling used between exchanges, and sends the clearing cause inside a clearing message. In this case, the clearing cause gives to other exchanges the information on how the call has been handled. The exchanges handle the call on the basis of the clearing cause information. Clear codes give information about the performance and trafficability of an exchange, and the whole network. Such information is created and stored in statistical reports, and in CDRs when necessary. The report data and CDRs are transferred from exchanges to external data processing systems for further analyzing. By collecting different reports from exchanges, the network operator is able to create a view of the functionality and performance of a network, and those of each network element. Faults in a network and in network elements can be noticed and localized on the basis of clear code information. To be able to make use of clear code information, a network operator must have clear code information collected from network elements information about the meanings of different clear codes knowledge on situations in which calls can be cleared knowledge on handling a call in a network

Id:0900d8058053cdbf

DN70610364 Issue 6-0

Clear Codes

Clear Codes

Clearing a call Clearing is a sequence of actions in a network to end a call connection or a call attempt. During this process, circuits and other physical resources reserved for a call are released. When all resources have been released, a call is completely cleared. There are several possible reasons to clear a call. Most successful calls between calling subscribers and called subscribers are cleared normally, that is, when the parties close the line in purpose to finish a call. The other possibility is that a call somehow fails, when a call is cleared before the connection is established, or a technical problem in the network during a call causes the need to clear a call. There are also some special functions which may cause the clearing during a call (for example, in some IN services). Some usual reasons to clear a call before the conversation phase: The calling subscriber dials an incorrect digit sequence. Such a target subscriber cannot be found. The called subscriber is busy. The called subscriber does not answer. There are no free circuits leading to the desired destination at a moment. Signalling or transmission medium requirement is not fulfilled.

For a complete list of different reasons to clear a call, see the clear code descriptions in Clear Code List.

1.3

Internal functions related to clear codes

Clear Code-related functions in an exchange, which releases a call: 1. The exchange notices that a call cannot be established, or an active call must be cleared. 2. One of the program blocks handling the call sends a clearing message to other programs of the call control part of the system. 3. Call control analyses the clearing message and the clear code included in the message. 4. On the basis of the clear code, call control searches the control settings defined for the clear code in question. After this, the call will be handled further according to these settings in the system. The result may be, for example, clearing the call, giving an announcement or routing the call to another destination. 5. The exchange sends the clearing information to other exchanges on the route of a call always when possible. 6. The exchange stores the clear code information in statistical reports, if such measurements and reportings have been activated in the exchange. Clear code functions in other exchanges on the route of a call: 1. 2. 3. 4. 5. An exchange receives the clearing cause information from a trunk circuit. The clearing cause is converted into a clear code. The exchange examines the clear code. The exchange releases the connection or changes the handling of the call. The exchange converts the clear code to a clearing cause of the signalling system used in the PCM circuit. The exchange sends the clearing cause information further to the incoming or outgoing direction.

DN70610364 Issue 6-0

Id:0900d8058053cdbf

Clear Codes

Clear Codes

6. The exchange stores the clear code information in statistical reports, if required. An exchange contains several program blocks which may discover the need to clear a call. The DX MSC Observation report (see Section Clear Code information in statistical reports) includes, among other information, the name of the program which first makes the decision to clear a call.

1.4

End-of-selection analysis (EOS)

The ICC programs in the system contain several analysis structures to recognize the destination of a call, and to control the handling of calls in different situations. The analysis which examines the clear codes is called EOS analysis. The principles of EOS analysis are: 1. The EOS analysis receives the clear code related to the clearing of a call. 2. The EOS analysis examines the clear code. 3. As a result of the examination, the EOS analysis gives the information on how the call must be handled further. 4. Call control starts the actions on the basis of the information received from the EOS analysis. The EOS analysis contains the control information for giving the right response to each individual clear code. It is possible to modify the functions of the EOS analysis using MML commands. For further information, refer to End-Of-Selection and Function Analysis Handling, RX Command Group. The result of the EOS analysis can be, for example, one of the following alternatives: The call in question must be cleared. The call is reanalyzed.

For more details of modifying the functions of the EOS analysis, refer to End-Of-Selection and Function Analysis Handling, RX Command Group or Basic Routing Functions.

1.5

Mapping of clear codes

Clearing causes are carried by signalling protocols that are used between exchanges. All connections in one PCM circuit use the same type of signalling. There are several different signalling types in use in different networks. More than one signalling type can be in use in one network. There are also different sets of clearing causes, because each signalling type has a clearing cause set of its own. When an exchange receives a clearing cause from network, the signalling software converts the clearing cause into an internal clear code. When an exchange adapts two different signallings, also the clearing cause has to be adapted as follows: CLEARING CAUSE -> CLEAR CODE -> CLEARING CAUSE The adaptation in the network signalling interface of an exchange is called mapping. Because of different sets of clearing causes in different signallings, the adaptation may reduce the information which is transferred as the original clearing cause. For example, older signalling types do not provide such wide ranges of different clearing causes as

Id:0900d8058053cdbf

DN70610364 Issue 6-0

Clear Codes

Clear Codes

modern ones. One clearing cause of an older signalling type may represent several different clearing causes of a newer signalling. There is a mapping table for each signalling configured in an exchange. A mapping table includes the clearing causes of a signalling type and the corresponding clear codes. The signalling software reads the mapping tables when making an adaptation from clearing cause to an internal clear code. When the clearing information must be sent further in a network, the clear code is mapped to a clearing cause of the signalling system used when sending to network.
SCP INAP SCF INAP SSP SSF/SRF Access Signalling OLE CCF DLE Access Signalling T1184080-97 ISUP SRF IP

ISUP

ISUP

Figure 1

Clearing causes with the same meaning, but different representations

Clearing causes with the same meaning, but different representations (because of different signallings used) are mapped to the same internal clear code. See figure Clearing causes with the same meaning, but different representations above.

1.6

Grouping of clear codes

Clear codes are identified with hexadecimals 0000H - FFFFH. Clear codes are grouped into four main classes: 0000H - 03FFH: normal clearing 0400H - 07FFH: internal congestion 0800H - 0BFFH: external congestion 0C00H - 0FFFH: subscriber errors 1000H - : event codes

Event codes are classified as The first main class, normal clearing, includes all cases which normally do not lead to interruption of a call or a call set-up. This class contains normal calls, and also some error situations that are not caused by the exchanges or the subscribers. The main class, normal clearing, is divided into the following four sub-groups according to the main classification: 0000H - 00FFH: normal clearing / normal clearing normal clearing situations, for example, subscriber busy 0100H - 01FFH: normal clearing / internal congestion clear codes set by charging and statistics and not leading to a release

DN70610364 Issue 6-0

Id:0900d8058053cdbf

Clear Codes

Clear Codes

0200H - 02FFH: normal clearing / external congestion normal clearing situations caused by a congestion outside the exchange, for example, by a congestion on the radio path 0300H - 03FFH: normal clearing / subscriber errors normal congestion caused by the subscriber's facility or equipment

The main class, internal congestion (0400H - 07FFH), includes the cases in which the call or call set-up is interrupted due to a malfunction in the own exchange. Primarily, this class contains clear codes associated with communication between the various computer units and program blocks of an exchange and those associated with the handling of files. The main class, external congestion (0800H -0BFFH), includes all cases in which a call or a call set-up is interrupted by a malfunction outside the exchange in question. Primarily, this class contains clear codes associated with inter-exchange connections. The main class, subscriber error (0C00H - 0FFFH), includes all cases in which a call or a call set-up is interrupted due to a subscriber error, due to a failure in the subscriber's equipment or due to faulty subscriber signalling.

1.7

Clear code information in statistical reports

This chapter gives information about the basic and most important types of statistical functions and reports related to clear codes. All statistical measurements and reports are not explained here. Use of clear codes in statistics Individual clear codes or clear code groups are used in the following functions of the system: traffic observation traffic measurement traffic maintenance supervision detailed charging field reporting load observation

Traffic observation uses individual clear codes. In two observation categories, that is, in destination observation and in the observation of failed calls, the observation can be limited to a certain clear code, for example, 0804H, or to a certain clear code range, for example, 0400H - 07FFH. This means that traffic observation reports are given only on calls that fall into the defined category. In other observation categories, clear codes have no function. Traffic measurement uses the main classes of clear codes. Supervision of the error ratio of circuit groups and control units is part of the maintenance supervision. Here, it is important to distinguish between "normal clearing" and "clearing due to congestion", irrespective of the cause of congestion. The detailed call charging record includes a clear code. The clear code has no effect on the chargeability of a call. In field reporting, individual clear codes and the classification of clear codes in the Services Codes File of the statistics system are used.

10

Id:0900d8058053cdbf

DN70610364 Issue 6-0

Clear Codes

Clear Codes

The Services Codes File can be defined to include eight code groups, which may comprise any clear codes (0000H - 0FFFH). The number of occurrences of the clear codes belonging to these groups are updated, group by group, to the Service Level File. The occurrences of each clear code are also registered in the Service Level File.

1.7.1

General principles of field reporting

The functionality Field Reporting can be used to observe the service level of an exchange. Field reporting produces several types of reports. The following reports contain clear code information among other reporting data: trafficability performance measurement report clear code measurement report, data call clear code measurement report clear code by number destination measurement report clear code group by number destination measurement report, data call clear code group by number destination measurement report signalling-specific clear code measurement report (parts 1 and 2)

For the Trafficability performance measurement report and Clear code group by number destination measurement report, the network operator is allowed to group the clear codes into eight clear code groups. These clear code groups can represent different general types of clearing causes. The grouping of field reporting is separate from the grouping of, for example, traffic measurements (see Traffic Measurements). This gives the operator the possibility to group the clear codes differently for different information needs. Trafficability performance measurement report (binary report 82H) Trafficability performance measurement report gives statistical information about all call attempts of the exchange. The total amount of calls is shown. Also calls answered and not answered are counted separately. The clear codes of call attempts are classified in eight groups. Clear code measurement report (83H), Data call clear code measurement report (131H) Clear code measurement report gives the number of separate clear codes. This information is divided into three parts, on the basis of main call phases in which a call can be cleared. There are three main phases of calls presented in the report: signalling ring speech

The call phase information gives the network operator a more detailed view of, for example, failure situations in a network. Clear code by number destination measurement report (84H) Clear code by number destination measurement report gives the number of separate clear codes for a specific number destination.

DN70610364 Issue 6-0

Id:0900d8058053cdbf

11

Clear Codes

Clear Codes

All clear codes of a specified number destination are grouped on the basis of call phases. The report contents is similar to the clear code report, although the codes are collected only from one destination. This report gives the operator the possibility to check the traffic to any destination separately. This is for help in localizing the failures in the network. Clear code group by number destination measurement report (85H), Data call clear code group by number destination measurement report (130H) Clear code group by number destination measurement report gives the number of clear codes from specified destinations, collected in eight groups that the network operator has defined. Several number destinations can be included in one report. Signalling-specific clear code measurement report, part 1 (88H) Signalling-specific clear code measurement report, part 1 gives the numbers of externalsignalling-specific clear codes used per signalling method on defined circuit groups. The numbers of the clear codes are divided into three groups according to the call phase. Signalling-specific clear code measurement report, part 2 (87H) Signalling-specific clear code report, part 2 gives the numbers of external signallingspecific clear codes used per signalling method on all interfaces. The numbers of the clear codes are divided into three groups according to the call phase. The numbers of the clear codes are divided into three groups according to the call phase.

1.7.2

General principles of traffic observation

Traffic observations are functions to give more detailed information on calls related to a specific observation object. The types of different observations are: circuit observation number destination observation failed calls observation combined observation statistical observation

The clearing reason of a specific call can be seen in the DX MSC Observation report (60H). A traffic observation report gives a full set of information on one call. The report includes, for example, the following information: clear code identifier of the program block which decided to clear the call direction from which the clearing information came to the exchange phase of the call at the clearing moment additional information about the situation in which the clear code has been set

The program identifier is used to localize the program block which has done the clearing decision. One single clear code can be set by different programs. Recognizing the program which made the clearing decision helps in searching a possible fault situation or other problem in an exchange.

12

Id:0900d8058053cdbf

DN70610364 Issue 6-0

Clear Codes

Clear Codes

The direction information helps the operator to localize the place in network, where the traffic fails. Possible directions can be, for example: Subscriber A Subscriber B System MAP SCP tant to limit the wideness of the observation as strongly as possible, to avoid the risk of the STU overload. Set only the necessary objects under observation. Stop the observation always when it is not needed to be active.

g Each type of traffic observation produces a report of each individual call. It is impor-

1.7.3

Traffic measurements
The traffic measurement reports can be used to collect information about the load and the traffic state of the exchange. This information can be used when making plans for the development of the network or exchange configuration. The system provides several different traffic measurement reports. The following reports contain clear code information: circuit group measurement (10H) number destination measurement (11H) control unit measurement (12H) traffic category measurement (14H) direction of call traffic (circuit group to number destination measurement (18H)) direction of call traffic (destination to destination measurement (19H)) UPD measurement (180H) UPD to number destination measurement (181H)

The contents of the reports in different measurements are basically similar when we are speaking about clear codes. Only the traffic category-based measurement and the UPD measurement differ from other measurements. In most traffic measurement reports, the clear codes are divided into four groups. This classification of clear codes is fixed. Clear code groups in traffic measurement reports: Accepted (clear code values 0000H ... 03FFH) Internal failures (clear code values 0400H ... 07FFH) External failures (clear code values 0800 ... 0BFFH) Subscriber failures (clear code values 0C00H ... 0FFFH)

The traffic category measurement (14H) and the UPD measurement (180H) differ from this presented format. In traffic category measurement and UPD measurement, clear codes are divided into eight groups which are defined using the TMH MML command. This grouping can be different from the grouping of field reporting, or it can be the same.

DN70610364 Issue 6-0

Id:0900d8058053cdbf

13

Clear Codes

Clear Codes

1.7.4

Load observation
The load observation provides real-time information on the traffic load and the load in the computer units of the exchange. The following reports contain clear code information about the internal or external failure: Circuit group load observation report (117/75H) Control unit load observation report (118/76H)

For more information, see Load and availability observations in NSS statistics. See Introduction to clear codes.

14

Id:0900d8058053cdbf

DN70610364 Issue 6-0