Interface Specifi ation Product Family: data Colle tion and Analysis Platforms Product: GEO interface Release: 6.5 Approval date: 16-Dec-201
Nokia Solutions and Networks is continually striving to reduce the dverse environmental effects of its produ products cts and servi services ces.. We wou would ld like like to to encou encoura rage ge you you as as our our cust customers and users to join us in working towards a cleaner, cleaner, safer environment. environment. Please recycle product packaging and follow the recommendations recommendations for for power use and proper proper disposal disposal of our producs and their components. If you should have questions regarding our Environmental Policy or any of the environmental services we offer offer,, ple please ase contac contactt us us at at Noki Nokia a Sol Solut utio ions ns and Netwo Network rks s for for ad itional information.
��� ��������� ������������� ��������� � ���� ����� ��������� �� ��������� ��� ������ ��������� ������������ �������� ���
1 (14)
Table of Contents Overview ....................................................................................................................................................... 3
1 1.1
2
GEO location solution .............................................................................................................................................. 3
GEO Interface ............................................................................................................................................... 4 2.1
Connection interface escription .............................................................................................................................. 4 2.1.1 Openin the connection ..................................................................................................................... 5 2.1.2 Start/st p monitoring ......................................................................................................................... 5 2.1.3 Overload handling ............................................................................................................................. 5 Message format desc iption ..................................................................................................................................... 5
2.2
3
Message types and formats .......................................................................................................................... 6 3.1 3.2 3.3 3.4 3.5 3.6 3.7 3.8 3.9 3.10 3.11 3.12 3.13 3.14 3.15
Message Format (Ge -> Emil) ................................................................................................................................ 6 Message types (Geo - Emil)..................................................................................................................................... 6 Connect (Geo -> Emil) .................................................................................... ......................................................... 6 Header format (Emil - Geo) .................................................................................................................................... 6 Message types (Emil > Geo)................................................................................................................................... 7 Connection Ack (Mes age Emil -> Geo) .................................................................................................................. 8 SRB Ticket (message) .................................................................................... ......................................................... 8 RAB Ticket (message) .................................................................................... ......................................................... 9 3.8.1 RAB Ti ket Type................................................................................................................................ 9 Packet Ticket (messa e).......................................................................................................................................... 9 Throughput Ticket ........................................................................................... ......................................................... 9 Failure Source Type ........................................................................................ ....................................................... 11 String Type...................................................................................................... ....................................................... 11 RRC Paging Type ........................................................................................... ....................................................... 11 CchAdmit Type ............................................................................................... ....................................................... 11 L3 Messages................................................................................................... ....................................................... 12
Contact: Contact your local
okia Solutions and Networks support
Summary of changes: 16-Dec-2013
1.4
��� ��������� ������������� ��������� � ���� ����� ��������� �� ��������� ��� ������ ��������� ������������ �������� ���
2 (14)
1
OVERVIEW This docum nt describes the message interface from R C to a GEO location server. Emil server takes care of data collection and analysis. Messages are then forwarded to GEO application as defined in the foll wing chapters.
Picture 1. O erall architecture of the GEO Interface. Actual GEO location software is provided by usually pro ided by 3rd party vendors, which can receive necessary data through GE Interface. For the solu ion, following Sales Items are needed for th SW
TSS3101 (3G) L3 Data Collector (Megamon)
TSS3104 (3G) GEO Interface
•
•
For the solu ion, following HW items are needed. These items are included in new RNC d liveries from RN6.0 onwards. Cabling soluti n is needed in order to connect L3 Data Collector to RNC.
RNC3 86 MEGAMON CABLE & PANEL SET RN 450 A-CAB
RNC3 87 MEGAMON CABLE & PANEL SET RN 450 B-CAB
RNC3 88 MEGAMON CABLE & PANEL SET RN 2600 A-CAB
RNC3 89 MEGAMON CABLE & PANEL SET RN 2600 B-CAB
•
•
•
•
Additionally, IP-switch and PC/Server is needed to run t e solution. In the ordering tools NSN has a recommended solution for the HW. •
OEM NC0001-1.0 RNC DATA COLLECTOR HW HP
•
OEM NC0003-1.0 RNC DATA COLLECTOR SER VICES
Above listed HW will be automatically proposed while or ering the solution through the CSP.
1.1
GEO locati n solution GEO location solution provides tools to better understan network behavior and how the users move and interact in the network. Sp cific events and their location can be shown in a map. This also helps in netw rk optimization. The solution pro ides support to the following items. Know here your customers are Know hat services they use • •
��� ��������� ������������� ��������� � ���� ����� ��������� �� ��������� ��� ������ ��������� ������������ �������� ���
3 (14)
• • • • •
2
Know hat devices they use Measure the quality they experience Identif traffic hot-spots Impro e performance Down to building accuracy
GEO INTERFACE GEO interfa e provides data that is needed to build the EO solution. Emil server (Megamon and Emil together) passes through pr -defined set of messages ith a header that helps putting related mess ges together. Picture below show the simplified structure how the data is streamed to GEO server.
Picture 2. Simplified structure of the GEO interface The interfac is implemented through a TCP/IP socket on port number 12345 on the EMIL server. It is the responsibility of the GEO cli nt to connect to the server, identify itself and receive messages.
2.1
Connection interface description A connectio (TCP/IP socket) is created between the cli nt and Emil server to control the onitoring session and transfer the data required. Emil server will be as server role.
Picture 3. Principle of command procedure handling
��� ��������� ������������� ��������� � ���� ����� ��������� �� ��������� ��� ������ ��������� ������������ �������� ���
4 (14)
2.1.1
Opening the connection GEO client an connect to Emil server by sending a Connect message to dedicated I port and address. If Emil server accepts the connection, it acknowledges t e connection with a Connection ck message.
2.1.2
Start/stop monitoring After conne tion is established, Emil server starts to sen data automatically thus there is not a separate “Start” for message send starting. When the S cket is closed Emil server stops sending da a. There is no buffer in Emil serv r, thus after the connection is closed all me saging from the RNC will be lost.
2.1.3
Overload handling In the RNC Interface, when the computer load in the RN increases up to 70%, some f the less important messages are discarde . This overload situation is i ternally indicated to Emil server. Emil server indicates overload to GEO client ith an “OverLoadStart” message on the interface. When the o erload situation in the RNC has ended, Emil server indicates overload en on GEO Interface with an “OverLoadEnd” essage on the interface. Overload in GEO interface can be detected by GEO clie t itself by following sequence n mber sent by Emil server. If sequence is br ken, that means that some mess ges are lost, indicating most possibly overload on the interface.
2.2
Message format description The interfac is implemented through a TCP/IP socket on a dedicated port number. It is the responsibility of the GEO client to conn ct to the Emil server and receive messages from it. The Emil se ver will drop messages if the client connecti n is unable to keep up. Dropped messages are signified by a missing mess ge sequence numbers.
��� ��������� ������������� ��������� � ���� ����� ��������� �� ��������� ��� ������ ��������� ������������ �������� ���
5 (14)
3
MESSAGE YPES AND FORMATS Following chapters describe the GEO interface message types and formats used.
3.1
3.2
Message F rmat (Geo -> Emil) Name Length
Type UInt16
MessageT ype
Uint16
Message types (Geo - Emil) Message number 1
3.3
Message Name Connect
Descriptio Connect m ssage
Type Int32[4] StringType
Descripti n Indicate v rsion Free Text tring
Connect (Geo -> Emil)
Name Version Text
3.4
Descriptio Length of the message in bytes including the header Message type
Header for at (Emil -> Geo) Name Sequenc Number
Type UInt64
Timestamp Call identifier
UInt64 UInt64
Message ype Length
UInt16 UInt16
��� ��������� ������������� ��������� � ���� ����� ��������� �� ��������� ��� ������ ��������� ������������ �������� ���
Descripti n The sequ nce number, starting at 0 and wrapping back round to 0 at 2^64 - 1. The client can detect missing messages by missing sequence numbers. See timestamp. Unique id ntifier for the call. This is an arbitrary v lue that is guaranteed to be unique on the particular RNC for the duration of the RRC connection. The type f the message Length of the message contents in bytes
6 (14)
Message
Byte[]
The conte ts of the message
Timestamp: The value represents dates and times with values ranging from 12:00:00 mi night, January 1, 0001 Anno Domini (Com on Era) through 11:59:59 P. ., December 31, 9999 A.D. (C.E.) . The val e is measured in 100-nanose ond units and a particular date is the numb r of 100nanoseconds since 12:00 midnight, January 1, 0001 A.D. (C.E.). Byte order: The byte order of the protocol is Little-endian for all values unless otherwise s ecified.
3.5
Message types (Emil -> Geo) The message container includes one of the following me ssages (Emil -> Geo) Message Message Name Descriptio number 1 ConnectionAck Connection Acknowledge 2 Status Status Indicator 3 OverLoadStart Megamon i entering an overload condition a d records are being discarded 4 OverLoadEnd Megamon has left the overload condition a d records are no longer being discarded 5 RNC name RNC name (stringType) 10 RRC_UL_DCCH RRC Uplink DCCH Message via Iub (ASN.1 Bin ry) 11 RRC_DL_DCCH RRC Downlink DCCH Message via Iub (ASN.1 Bin ry) 12 RRC_UL_CCCH RRC Uplink CCCH Message via Iub (ASN.1 Bin ry) 13 RRC_DL_CCCH RRC Downlink Message via Iub (ASN.1 Binary) 14 RRC_UL_DCCH_IU RRC Uplink DCCH Message via Iu (ASN.1 Bin ry) 15 RRC_DL_DCCH_IU RRC Downlink DCCH Message via Iu (ASN.1 Bin ry) 16 RRC_UL_DCCH_IUR RRC Uplink DCCH Message via Iur (ASN.1 Bin ry) 17 RRC_DL_DCCH_IUR RRC Downlink DCCH Message via Iur (ASN.1 Bin ry) 18 Propagation Delay Propagatio delay data 19 RRC_Paging See RRC_ aging 20 NBAP_UL NBAP Uplink Message (ASN.1 Binary) 21 NBAP_DL NBAP Dow link Message (ASN.1 Binary) 24 RANAP_UL RANAP Uplink Message (ASN.1
��� ��������� ������������� ��������� � ���� ����� ��������� �� ��������� ��� ������ ��������� ������������ �������� ���
7 (14)
3.6
25
RANAP_DL
26
RNSAP_OUT
27
RNSAP_IN
28
NAS_UL
29
NAS_DL
32
AsciiData
34
Internal
50 51 54 60 61 63 64
SrbTicket RabTicket PacketDataTicket CallStart CallEnd ThroughputTicket CchAdmit
Connection Ack (Message Emil -> Geo) Name Version Text RNC statu RNC statu
3.7
Binary) RANAP Do nlink Message (ASN.1 Binary) RNSAP Message Towards DRNC (ASN.1 Bin ry) RNSAP Message Backwards DRNC (ASN.1 Bin ry) Direct Tran fer Uplink NAS Messages (see 3gpp 4.301) Direct Tran fer Uplink NAS Messages (see 3gpp 4.301) Used for special cases where script generate messages (StringType) Used for R C internal notice (StringType) See SRB ti ket See RAB ti ket See Packet ticket Call start in icator Call end ind icator See Throughput ticket See CchAdmit description
Type Int32[4] StringType StringType Int
Description Indicate ve sion Free Text string Status des ription 1 = Discon ected 2 = Reconnect 3 = Conne ted
SRB Ticket (message) Name Phase
Type UInt8
Status
UInt8
Failure source
FailureSourceType
��� ��������� ������������� ��������� � ���� ����� ��������� �� ��������� ��� ������ ��������� ������������ �������� ���
Descriptio 1 = Setup 2 = Access 3 = Active 4 = Releas 1 = Succes 2 = Fail See failure ource type
8 (14)
3.8
3.8.1
3.9
3.10
RAB Ticket (message)
Name Number of RABs RAB Ticke RAB Ticket Type
Type UInt8
Descriptio Number of AB within ticket
RabTicketType[]
See RAB ti ket type
Name Phase
Type UInt8
Status
UInt8
Fail Sourc RAB Type
FailureSourcceType UInt8
Description 5 = Setup 6 = Access 7 = Active 8 = Releas 1 = Success 2 = Fail See failure source type 1 = CS voice 2 = CS data 3 = PS data
Packet Ticket (message)
Name Status
Type UInt8
Failure Source
FailureSourceType
Description 1 = Success 2 = Failed See Failur Source Type
Throughpu Ticket Name AMR DL
Type Uint32
AMR DL
Uint32
CS Conv
L
Uint32
��� ��������� ������������� ��������� � ���� ����� ��������� �� ��������� ��� ������ ��������� ������������ �������� ���
Description The amount of MAC-d PDU AMR data in SRNC in the downlink direction measured uring the measurement interval. The amount of MAC-d PDU AMR data in SRNC in the uplink direction measured uring the measurement interval. The amount of MAC-d PDU CS conversati nal data in SRNC in the downlink direction measured during the
9 (14)
CS Conv
L
Uint32
CS Strea
L
Uint32
CS Strea
L
Uint32
PS Strea
L
Uint32
PS Strea
L
Uint32
Intera DL
Uint32
Intera UL
Uint32
Bgr DL
Uint32
Bgr UL
Uint32
CS Voice S DSCH DL
Uint32
��� ��������� ������������� ��������� � ���� ����� ��������� �� ��������� ��� ������ ��������� ������������ �������� ���
measurem nt interval. The amount of MAC-d PDU CS conversati nal data in SRNC in the uplink direction measured during the measurem nt interval. The amount of MAC-d PDU CS streaming ata in SRNC in the downlink direction measured during the measurem nt interval. The amount of MAC-d PDU CS streaming ata in SRNC in the uplink direction measured during the measurem nt interval. The amount of MAC-d PDU PS streaming ata in SRNC in the downlink direction measured during the measurem nt interval. The amount of MAC-d PDU PS streaming ata in SRNC in the uplink direction measured during the measurem nt interval. The amount of MAC-d PDU Interactive data in SR C in downlink direction measured uring the measurement interval. This counter includes pure Rel99 DCH connections, HS-DSCH downlink return channel and E-DCH. The amount of MAC-d PDU Interactive data in SR C in uplink direction measured uring the measurement interval. This counter includes pure Rel99 DCH connections, HS-DSCH uplink return channel and E-DCH. The amount of MAC-d PDU Backgroun data in SRNC in downlink direction measured during the measurem nt interval. This counter includes pure Rel99 DCH connections, HS-DSCH ownlink return channel and E-DCH. The amount of MAC-d PDU Backgroun data in SRNC in uplink direction measured during the measurem nt interval. This counter includes pure Rel99 DCH connections, HS-DSCH plink return channel and EDCH. The amount of MAC-d PDU AMR data for HS-DS H DL.
10 (14)
CS Voice S DSCH UL
Uint32
The amount of MAC-d PDU AMR data for HS-DS H UL.
Values in the counters are Bytes Transferred in the meas rement period. Measuremen period is every 20 seconds or every time w en handover is occurred.
3.11
Failure Source Type
Name Fail Sourc
3.12
Type UInt16 ASCII8[length]
Descriptio Length of the string Text data
RRC Pagin Type Name Domain_in
3.14
Descriptio 1 = BTS 2 = Radio I/ F 3 = Ue 4 = Iu 5 = Iur 8 = Transmission 9 = pre-em tion 10 = Admis ion control 11 = Handover control 12 = other
String Type
Name Length Text
3.13
Type UInt8
Type UInt8
Descriptio 1 = cs-dom in 2 = ps-dom in
Type Uint16
Descriptio Indicate Cell Id when Ue enter to the
CchAdmit ype Name Cell id
��� ��������� ������������� ��������� � ���� ����� ��������� �� ��������� ��� ������ ��������� ������������ �������� ���
11 (14)
network via fach channel.
3.15
L3 Messag s
These messages will pass to the GEO system in ASN.1 binary format. Protocol RRC DL RRC DL RRC DL RRC DL RRC DL RRC DL RRC DL RRC DL RRC DL RRC DL RRC DL RRC DL RRC DL
Message ActiveSetUpdate CellUpdateConfirm HandoverFromUTRANComman -GSM HandoverFromUTRANComman -CDMA2000 MeasurementControl PagingType2 PhysicalChannelReconfiguration RadioBearerReconfiguration RadioBearerRelease RadioBearerSetup RrcConnectionRelease SignallingConnectionRelease TransportChannelReconfiguratio
RRC UL RRC UL RRC UL RRC UL RRC UL RRC UL RRC UL RRC UL RRC UL RRC UL RRC UL RRC UL RRC UL RRC UL RRC UL RRC UL RRC UL RRC UL RRC UL
ActiveSetUpdateComplete ActiveSetUpdateFailure CellChangeOrderFromUTRANFa ilure HandoverToUTRANComplete MeasurementControlFailure MeasurementReport PhysicalChannelReconfiguration omplete PhysicalChannelReconfiguration ailure RadioBearerReconfigurationCom plete RadioBearerReconfigurationFailure RadioBearerReleaseComplete RadioBearerReleaseFailure RadioBearerSetupComplete RadioBearerSetupFailure RrcConnectionReleaseComplete RrcConnectionSetupComplete" SignallingConnectionReleaseIndication TransportChannelReconfiguratio Complete TransportChannelReconfiguratio Failure
NBAP_DL NBAP DL
RadioLinkSetupRequest RadioLinkReconfigurationPrepar
��� ��������� ������������� ��������� � ���� ����� ��������� �� ��������� ��� ������ ��������� ������������ �������� ���
12 (14)
NBAP UL NBAP UL
RadioLinkRestoreInd RadioLinkFailureInd
RANAP
All call related RANAP messages, except DT messages
RNSAP
All call related RNSAP messages
��� ��������� ������������� ��������� � ���� ����� ��������� �� ��������� ��� ������ ��������� ������������ �������� ���
13 (14)
Disclaimer The informatio in this document is subject to change without notice nd describes only the product define in the introduction of this documentation. This documentation is intended for the use of Nokia S lutions and Networks customers only for the purpose of the agreement under which the document is submitted, and no part of it may be used, repr duced, modified or transmitted in ny form or means without the prior written permission of Nokia Solutions and Networks. The documentation has been prepared to be used by prof ssional and properly trained person el, and the customer assumes full responsibility when using it. Nokia Solutions and Networks elcomes customer comments as part of t he process f continuous development and improvem nt of the documentation. The informatio or statements given in this documentation concernin the suitability, capacity, or performanc of the mentioned hardware or software products are iven “as is” and all liability arising in conn ction with such hardware or software products shall be defined conclusively and finally in a sep rate agreement between Nokia Solutions and Networ s and the customer. However, Nokia Solutions and Networks has made all reasonable eff rts to ensure that the instructions co tained in the document are adequate and free of mat rial errors and omissions. Nokia Solution and Networks will, if deemed necessary by Nokia Solutions and Networks, explain issues which may not be covered by the document. Nokia Solution and Networks will correct errors in this documentation as soon as possible. IN NO EVENT WILL NOKIA SOLUTIONS AND NETWORKS BE LIABL FOR ERRORS IN THIS DOCUMENTA ION OR FOR ANY DAMAGES, INCLUDING BUT N T LIMITED TO SPECIAL, DIRECT, INDI ECT, INCIDENTAL OR CONSEQUENTIAL OR ANY LOSSES, SUCH AS BUT NOT LIMITED TO LOSS OF PROFIT, REVENUE, BUSINESS INTE RUPTION, BUSINESS OPPORTUNIT OR DATA,THAT MAY ARISE FROM THE USE OF HIS DOCUMENT OR THE INFORM TION IN IT. This documentation and the product it describes are considered prot cted by copyrights and other intellectual property rights according to the applicable laws. NSN is a trademark of Nokia Solutions and Networks. Nokia is a regi tered trademark of Nokia Corporation. Other product names mentioned in this document may e trademarks of their respective owners, and they are mentioned for identification purpose only. Copyright © 2013 Nokia Solutions and Networks. All rights reserved.
��� ��������� ������������� ��������� � ���� ����� ��������� �� ��������� ��� ������ ��������� ������������ �������� ���
14 (14)
