GEO Interface
Interface Specification
Nokia Siemens Networks NWS TS / System and Solution Support
© Nokia Siemens Networks Networks
1 (15)
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 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 customer comments as part of the process of continuous development and improvement of the documentation. The information or statements given in this documentation 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. All rights reserved.
2 (15) © Nokia Siemens Networks Networks
Contents
Contents
Summary of document changes: Ver.
Date
Author
Description
v.1.0
06.04.2011
NWS NW S
First version
3 (15) © Nokia Siemens Networks Networks
1
Overview This document describes the message interface from RNC 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 following chapters.
Picture 1. Overall architecture of the GEO Interface.
Actual GEO location software is provided by usually provided by 3rd party vendors, which can receive necessary data through GEO Interface. For the solution, following Sales Items are needed for the SW •
RNC3372 L3 Data Collector (Megamon)
•
RNC3393 GEO Interface
For the solution, following HW items are needed. These items are included in new RNC deliveries from RN6.0 onwards. Cabling solution is needed in order to connect L3 Data Collector to RNC. •
RNC3386 MEGAMON CABLE & PANEL SET RNC450 A-CAB
•
RNC3387 MEGAMON CABLE & PANEL SET RNC450 B-CAB
•
RNC3388 MEGAMON CABLE & PANEL SET RNC2600 A-CAB
•
RNC3389 MEGAMON CABLE & PANEL SET RNC2600 B-CAB
Additionally, IP-switch and PC/Server is needed to run the solution. In the ordering tools NSN has a recommended solution for the HW. •
OEMRNC0001-1.0 RNC DATA COLLECTOR HW HP
•
OEMRNC0003-1.0 RNC DATA COLLECTOR SERVICES
Above listed HW will be automatically proposed while ordering the solution through the CSP.
Page 4 of 15
1.1
GEO location solution GEO location solution provides tools to better understand network behavior and how the users move and interact in the network. Specific events and their location can be shown in a map. This also helps in network optimization. The solution provides support to the following items. • Know where your customers are • Know what services they use • Know what devices they use use • Measure the quality they experience experience • Identify traffic hot-spots • Improve performance • Down to building accuracy accuracy
Page 5 of 15
2
GEO Interface GEO interface provides data that is needed to build the GEO solution. Emil server (Megamon and Emil together) passes through pre-defined set of messages with a header that helps putting related messages together. Picture below shows the simplified structure how the data is streamed to GEO server.
Picture 2. Simplified structure of the GEO interface
The interface is implemented through a TCP/IP socket on port number 12345 on the EMIL server. It is the t he responsibility of the GEO client to connect to the server, identify itself and receive messages.
2.1
Connection interface description A connection (TCP/IP socket) is created between the client and Emil server to control the monitoring session and transfer the data required. Emil server will be as server role. Client
Emil server Connect Connection ack
Picture 3. Principle of command procedure handling 6 (15) © Nokia Siemens Networks Networks
2.1.1
Opening the connection GEO client can connect to Emil server by sending a Connect message to dedicated IP port and address. If Emil server accepts the connection, it acknowledges the connection with a Connection Ack message.
2.1.2
Start/stop monitoring After connection is established, Emil server starts to send data automatically thus there is not a separate “Start” for f or message send starting. When the Socket is closed Emil server stops sending data. There is no buffer in Emil server, thus after the connection is closed all messaging from the RNC will be lost.
2.1.3
Overload handling In the RNC Interface, when the computer load in the RNC increases up to 70%, some of the t he less important messages are discarded. This overload situation is internally indicated to Emil server. Emil server indicates overload to GEO client with an “OverLoadStart” message on the interface. When the overload situation in the RNC has ended, Emil server indicates overload end on GEO Interface with an “OverLoadEnd” message on the interface. Overload in GEO interface can be detected by GEO client itself by following sequence number sent by Emil server. If sequence is broken, that means that some messages are lost, indicating most possibly overload on the interface.
2.2
Message format description The interface is implemented through a TCP/IP socket on a dedicated port number. It is the responsibility of the GEO client to connect to the Emil server and receive messages from it. The Emil server will drop messages if the client connection is unable to keep up. Dropped messages are signified by a missing message sequence numbers.
Page 7 of 15
3
Message types and formats Following chapters describe the GEO interface message types and formats used.
3.1
3.2
3.3
Message Format (Geo -> Emil) Name
Type
Description
MessageType
Uint16
Message type
Length
UInt16
Length of the message in bytes including the header
Message types (Geo - Emil) Message number
Message Name
Description
1
Connect
Connect message
Connect (Geo -> Emil) Name
Type
Description
Version
Int32[4]
Indicate version
Text
StringType
Free Text string
8 (15) © Nokia Siemens Networks Networks
3.4
Header format (Emil -> Geo) Name
Type
Description
SequenceNum ber
UInt64
The sequence number, starting at 0 and wrapping back round to 0 at 2^64 - 1. The client can detect missing messages by missing sequence numbers.
Timestamp
UInt64
See timestamp.
Call identifier
UInt64
Unique identifier for the call. This is an arbitrary value that is guaranteed to be unique on the particular RNC for the duration of the RRC connection.
MessageType
UInt16 UInt 16
The type of the message
Length
UInt16
Length of the message contents in bytes
Message
Byte[]
The contents of the message
Timestamp: The Timestamp: The value represents dates and times with values ranging from 12:00:00 midnight, January 1, 0001 Anno Domini (Common Era) through 11:59:59 P.M., December 31, 9999 A.D. (C.E.) . The value is measured in 100-nanosecond units and a particular date is the number of 100nanoseconds since 12:00 midnight, January 1, 0001 A.D. (C.E.). Byte order: The order: The byte order of the protocol is Little-endian for all values unless otherwise specified.
3.5
Message types (Emil -> Geo) The message container includes one of the following messages (Emil -> Geo) Message number
Message Name
Description
1
ConnectionAck
Connection Acknowledge
2
Status
Status Indicator
3
OverLoadStart
Megamon is entering an overload Page 9 of 15
condition and and records records are being being discarded 4
OverLoadEnd
Megamon has left the overload condition and records are no longer being discarded
5
RNC name
RNC name (stringType)
10
RRC_UL_DCCH
RRC Uplink DCCH Message via Iub (ASN.1 Binary)
11
RRC_DL_DCCH
RRC Downlink DCCH Message via Iub (ASN.1 Binary)
12
RRC_UL_CCCH
RRC Uplink CCCH Message via Iub (ASN.1 Binary)
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 Binary)
15
RRC_DL_DCCH_IU
RRC Downlink DCCH Message via Iu (ASN.1 Binary)
16
RRC_UL_DCCH_IUR
RRC Uplink DCCH Message via Iur (ASN.1 Binary)
17
RRC_DL_DCCH_IUR
RRC Downlink DCCH Message via Iur (ASN.1 Binary)
18
Propagation Delay
Propagation delay data
19
RRC_Paging
See RRC_Paging
20
NBAP_UL
NBAP Uplink Message (ASN.1 Binary)
21
NBAP_DL
NBAP Downlink Message (ASN.1 Binary)
24
RANAP_UL
RANAP Uplink Message (ASN.1 Binary)
25
RANAP_DL
RANAP Downlink Message (ASN.1 Binary)
26
RNSAP_OUT
RNSAP Message Towards DRNC (ASN.1 Binary)
27
RNSAP_IN
RNSAP Message Backwards DRNC (ASN.1 Binary) 10 (15)
© Nokia Siemens Networks Networks
3.6
28
NAS_UL
Direct Transfer Uplink NAS Messages (see 3gpp 24.301)
29
NAS_DL
Direct Transfer Uplink NAS Messages (see 3gpp 24.301)
32
AsciiData
Used for special cases where script generate messages (StringType)
34
Internal
Used for RNC internal notice (StringType)
50
SrbTicket
See SRB ticket
51
RabTicket
See RAB ticket
54
PacketDataTicket
See Packet ticket
60
CallStart
Call start indicator
61
CallEnd
Call end indicator
Connection Ack (Message Emil -> Geo) Name
Type
Description
Version
Int32[4]
Indicate version
Text
StringType
Free Text string
RNC status
StringType
Status description
RNC status
Int
1 = Disconnected 2 = Reconnect 3 = Connected
3.7
Packet Ticket (message) Name
Type
Description
Status
UInt8
1 = Success 2 = Failed
Failure Source
FailureSourceType
See Failure Source Type
Page 11 of 15
3.8
SRB Ticket (message) Name
Type
Description
Phase
UInt8
1 = Setup 2 = Access 3 = Active 4 = Release
Status
UInt8
1 = Success 2 = Fail
Failure source
3.9
3.10
FailureSourceType
See failure source type
RAB Ticket (message) Name
Type
Description
Number of RABs
UInt8
Number of RAB within ticket
RAB Ticket
RabTicketType[]
See RAB ticket type
RAB Ticket Type Name
Type
Description
Phase
UInt8
5 = Setup 6 = Access 7 = Active 8 = Release
Status
UInt8
1 = Success 2 = Fail
Fail Source
FailureSourcceType See failure source type
RAB Type
UInt8
1 = CS voice 2 = CS data 12 (15)
© Nokia Siemens Networks Networks
3 = PS data
3.11
Failure Source Type Name
Type
Description
Fail Source
UInt8
1 = BTS 2 = Radio I/F 3 = Ue 4 = Iu 5 = Iur 8 = Transmission 9 = pre-emption 10 = Admission control 11 = Handover control 12 = other
3.12
3.13
String Type Name
Type
Description
Length
UInt16
Length of the string
Text
ASCII8[length]
Text data
Name
Type
Description
Domain_ind
UInt8
1 = cs-domain
RRC Paging Type
2 = ps-domain
Page 13 of 15
3.14
L3 Messages These messages will pass to the GEO system in ASN.1 binary format.
Protocol
Message
RRC DL
ActiveSetUpdate
RRC DL
CellUpdateConfirm
RRC DL
HandoverFromUTRANCommand-GSM HandoverFromUTRANC ommand-GSM
RRC DL
HandoverFromUTRANCommandHandoverFromUTRANCommandCDMA2000
RRC DL
MeasurementControl
RRC DL
PagingType2
RRC DL
PhysicalChannelReconfiguration PhysicalChannelReco nfiguration
RRC DL
RadioBearerReconfiguration
RRC DL
RadioBearerRelease
RRC DL
RadioBearerSetup
RRC DL
RrcConnectionRelease
RRC DL
SignallingConnectionRelease
RRC DL
TransportChannelReconfiguration TransportChannelRecon figuration
RRC UL
ActiveSetUpdateComplete
RRC UL
ActiveSetUpdateFailure
RRC UL
CellChangeOrderFromUTRANFailure
RRC UL
HandoverToUTRANComplete HandoverToUTRANCo mplete
RRC UL
MeasurementControlFailure
RRC UL
MeasurementReport
RRC UL
PhysicalChannelReconfigurationComplete PhysicalChannelReconfigurationComplete
RRC UL
PhysicalChannelReconfigurationFailure PhysicalChannelReconfigurationFailure
RRC UL
RadioBearerReconfigurationComplete RadioBearerReconfigurationCo mplete
RRC UL
RadioBearerReconfigurationFailure
RRC UL
RadioBearerReleaseComplete 14 (15)
© Nokia Siemens Networks Networks
RRC UL
RadioBearerReleaseFailure RadioBearerReleaseF ailure
RRC UL
RadioBearerSetupComplete
RRC UL
RadioBearerSetupFailure
RRC UL
RrcConnectionReleaseComplete RrcConnectionReleaseC omplete
RRC UL
RrcConnectionSetupComplete" RrcConnectionSetupCompl ete"
RRC UL
SignallingConnectionReleaseIndication SignallingConnectionReleas eIndication
RRC UL
TransportChannelReconfigurationComplete TransportChannelRec onfigurationComplete
RRC UL
TransportChannelReconfigurationFailure TransportChannelRec onfigurationFailure
NBAP_DL
RadioLinkSetupRequest
NBAP DL
RadioLinkReconfigurationPrepare RadioLinkReconfigurationPrep are
NBAP UL
RadioLinkRestoreInd
NBAP UL
RadioLinkFailureInd
RANAP
All call related RANAP messages, except DT messages
RNSAP
All call related RNSAP messages
Page 15 of 15
