TSP Lab	SGA-Diameter_ProvideLocation - The Diameter Provide-Location query module	SGA-Diameter_ProvideLocation

The Diameter Provide-Location query module
`("SGA-Diameter_ProvideLocation")`

Features
User interface
Logging
Configuration
SNMP alarm list
Version history

Features

Connects to the signaling network using SCTP/IP connection
Acts as an active element of the 4G network
Receives query requests from Provide-Location query clients
Sends Diameter/Provide-Location-Request messages to the given MME
Forwards result to the Provide-Location query clients
Logs queries and responses
Provides simple statistical data and logging on the operation
Optionally records transmitted and received Diameter messages into binary (SGA) files (contains only Diameter protocol layer!)
Creates SNMP traps

User interface

The main menu

Menu	Menuitem	Shortcut(s)	Meaning
[Log]
	Find line containing...	(Ctrl-F)	Finds text in log window
	Find next matching line	(F3)	Finds next occurrence of text in log window
	Details		Detail level of logging (Off, Normal, Detailed, or Debug)
[SCTP associations]
	A: Allow auto-connecting	(left-side )	Allows automatic (re-)connecting to the SCTP server on association A
	A: Shutdown now!		Immediately disconnects association A
	B: Allow auto-connecting	(right-side )	Allows automatic (re-)connecting to the SCTP server on association B
	B: Shutdown now!		Immediately disconnects association B
[TCP connections]
	Disconnect all active ones		Shutting down of all active connections
	Zero counters of all connections		Request and answer counters of connections will be cleared (on the Connections window)
[Options]
	Auto scroll	()	Allows automatic scrolling of the log screen
	Show log	(Ctrl-Tab)	Show the log screen
	Show the TCP connections	(Ctrl-Tab)	Show the TCP connection screen
	Save settings		Saves actual settings into the configuration (`SGA-Diameter_ProvideLocation.ini`) file

Status-line of associations

SCTP: Status of the association. It becomes grey after the successful SCTP/INIT.
- Idle (red) → There is no SCTP association established
- Connecting.../Disconnecting... (yellow) → Connecting/disconnecting state, tries to connect or disconnect to or from the server
- Connected (grey) → SCTP association is established
bps: Message bits received in the last second
PEER: Status of the Diameter connection
- red → There is no Diameter connection, Diameter/Capabilities-Exchange-Request message is not yet answered
- grey → Diameter/Capabilities-Exchange-Answer message arrived
CER/CEA: The number of transmitted and received Capabilities-Exchange-Request and Capabilities-Exchange-Answer messages on the SCTP interface
DPR/DPA: The number of transmitted and received Disconnect-Peer-Request and Disconnect-Peer-Answer messages on the SCTP interface
PLR/PLA: The number of transmitted and received Provide-Location-Request and Provide-Location-Answer messages on the SCTP interface
Error counters:
- sctp: Number of SCTP disconnections
- dsp: Number of communication errors between the interface card and the program
- pdu: Received an uninterpretable or misaddressed PDU
PDU's buffered for Tx: The number of PDU's buffered for transmitting

The bottom status-line

Uptime: time elapsed since module has been started up

Details of connections window

ID: Identifier of the connection
Alive: This connections is alive if + (there is a connection)
IP Address: IP address of the client
Req.count: Number of received requests
Answ.count: Number of answered requests
Last request: Timestamp of last request
Last answer: Timestamp of last answer
Active TID: Transaction ID of the request
[op]: Requested operation

The popup menu of the connections screen

Right-click on a row on the connections screen window to access this menu!

	Menuitem	Shortcut(s)	Meaning
	Disconnect this connection		Disconnects selected client connection
	Forget pending request		Forgets current request
	Reply "Error (-1)"		Sends an error to the client
	Zero counters of this connection		Zeros `Request` and `Answer` counters for this connection
	Send a test PDU for this connection		(Not available in this version)

Logging

The module creates daily logfiles about its working. The name of the logfile is "Modulename_YYYYMMDD.log" reflecting the day when it is created.
The module can write information into the logfile and onto the screen with several detail levels set by the [Log]/Details menu item. The logging level can be:

Off (0) - warnings/errors are only reported (minimal logfile size and CPU usage)
Normal (1) - information about normal operation are also written into the logfile/screen
Detailed (2) - every received and sent signaling messages are logged
Debug (3) - hexadecimal information of messages is recorded (largest logfile and CPU usage)
Debug, no screen (4) - it puts the same logging information into the logfiles as the Debug level, while the screen is not used to avoid the peaks in CPU usage

Status line counters are logged in every fifteen minutes irrespectively of logging level actually set.

The different colors of log entries have different meanings:

Code Color Usage
0 Black Compact data record
1 Red Errors
2 Green Open/close output file/stream
3 Blue Open/close input file/stream
4 Yellow Warnings
5 Light Gray Detailed data (debug info)
6 Dark Grey Detailed data (user info)
7 Purple Operator intervention;
Errors with emphasis

Code	Color	Usage
0	Black	Compact data record
1	Red	Errors
2	Green	Open/close output file/stream
3	Blue	Open/close input file/stream
4	Yellow	Warnings
5	Light Gray	Detailed data (debug info)
6	Dark Grey	Detailed data (user info)
7	Purple	Operator intervention; Errors with emphasis

Configuration (INI) file settings

Section	Entry	Example	Meaning
[Position]
	iLeft	140	Position of the program module on the display screen
	iTop	72	Position of the program module on the display screen
	iWidth	995	Position of the program module on the display screen
	iHeight	694	Position of the program module on the display screen
[Options]
	bAutoScroll	True	(Refer to the `[Options]/Auto scroll` menu item!)
[SCTP]
	wAutoConnectIntervalSec	2	Period for automatic connection of SCTP associations
	bAllowAutoConnectAtStartup_A	True	(Refer to the `[SCTP]/A: Allow auto-connecting` menu item!)
	bAllowAutoConnectAtStartup_B	True	(Refer to the `[SCTP]/B: Allow auto-connecting` menu item!)
	sLocalIPAddress#N	10.0.123.10	Local IP addresses for SCTP connections. If more IP addresses are listed then multiple paths are used in associations (MultiHoming). N runs from 0 to 9.
	sRemoteIPAddress_A#1, sRemoteIPAddress_A#2	10.0.123.20, 10.0.123.21	Alternative IP addresses of the SCTP server A.
	sRemoteIPAddress_B#1, sRemoteIPAddress_B#2	10.0.124.20, 10.0.124.21	Alternative IP addresses of the SCTP server B.
	wRemoteSCTPPort_A	2905	SCTP port of the SCTP server A
	wRemoteSCTPPort_B	2905	SCTP port of the SCTP server B
	wLocalSCTPPort	2905	Optional parameter if the SCTP server sticks to a given port. Normally, it should not be used.
	byClientServerMode	0	0 = ClientOnly (actively tries to connect to the remote SCTP peer) 1 = ServerOnly (receives connection attempts from an SCTP peers) 2 = Bisex (combined mode)
	wHeartbeatIntervalSec	10	SCTP/HEARTBEAT period
	dwMaxRTOmsec	15000	Retransmission time-out value in milliseconds
	dwMaxRetransmitsPerInit	3	Maximum number of retransmission for INIT chunks
	dwMaxRetransmitsPerAssociation	9	Maximum number of retransmissions per association
	dwMaxRetransmitsPerPath	4	Maximum number of retransmissions per path
	dwDelayedACKmsec	50	Defines the delay in millisec used during delayed acknowledgement algorithm
	byIPfieldDSCP	16	Default value of DSCP field of IP protocol level can be overwriten by this value. Please note: this feature should also be enabled in Windows operating system by modifying the related registry entry!
[Diameter]
	sOriginHost	DEVEMELOC	Used in Diameter request messages as Origin-Host AVP
	sOriginRealm	epc.mnc070.mcc216.3gppnetwork.org	Used in Diameter request messages as Origin-Realm AVP
	sHostIPaddress	10.0.1.110	GMLC's IP address
	dwVendorID	39991	AITIA's vendor ID registered at IATA
[Diameter/PLR]
	sLCSclientName	devemeloc	Used in Diameter/PLR messages as LCS-Name-String AVP.
	byLCSclientType	0	Used in Diameter/PLR messages as LCS-Client-Type AVP. Possible values: 0 = "Emergency-Services", 1 = "ValueAdded-Services", 2 = "Plmn-Operator-Services", 3 = "Lawful-Intercept-Services"
	byPriority	0	Used in Diameter/PLR messages as LCS-Priority AVP. Possible values: 0 = "Highest-Priority", 1 = "Normal-Priority"
	byHorizontalAccuracy	15	Optional. Used in Diameter/PLR messages as Horizontal-Accuracy AVP. Bits 6-0 corresponds to Uncertainty Code defined in 3GPP TS 23.032.
	byVerticalRequested	1	Optional. Used in Diameter/PLR messages as Vertical-Requested AVP. Possible values: 0 = "Not requested", 1 = "Requested"
	byVelocityRequested	1	Optional. Used in Diameter/PLR messages as Velocity-Requested AVP. Possible values: 0 = "Not requested", 1 = "Requested"
	bySupportedGADshapes	127	Optional. Used in Diameter/PLR messages as Supported-GAD-Shapes AVP. Bits 6-0 shall indicate the supported Shapes defined in 3GPP TS 23.032: ellipsoidPoint (0) ellipsoidPointWithUncertaintyCircle (1) ellipsoidPointWithUncertaintyEllipse (2) polygon (3) ellipsoidPointWithAltitude (4) ellipsoidPointWithAltitudeAndUncertaintyElipsoid (5)
[RemoteRequest]			Settings for AAR-Logic connection
	byMaxConcurrentConnectionCount	4	Maximum number of allowed clients
	wLocalTCPPort	3000	Port number, where the remote modules can connect
	dwTimeOutSec	60	Time-out value for Diameter requests
	bSuppressDisconnectTrap	True	When it is true traps on disconnecting TCP connection are suppressed
	127.0.0.1	Allowed	Client with this IP address can connect to the SGA-Diameter_ProvideLocation module This section may contain more IP address entries as a white list; those that are not listed will get barred (refused) silently, i.e., w/o trap, but still logged.
[SGAfiles]			Entries in this section are reloaded once per every second. sSigLinkID entry may consist of two characters. sFileNamePrefix entry (as well as the contents of sFilesPath entry) is considered when opening an SGA file. Leave (or change) sFilesPath entry empty not to write PDUs into file.
	sFilesPath	D:\SS7Files	Path for SGA files
	sFileNamePrefix	GyX_SCTP	File name prefix to distinguish between SS7 files created by different GyX_SCTP modules concurrently.
	sSigLinkID	HR	Two character long link ID to identify the messages.
[Advanced]
	wLogDetailLevel	3	(Equals to the listed order; refer to the `[Log]/Details` menu item!)
	dwMaxLinesInLogWindow	1000	Number of lines in the log window on screen
	sLogFilesPath	d:\LogFiles	Path for the LOG files
	sTrapFilesPath	d:\TrapFiles	Path for the SNMP Trap files to be sent
	bAlternateTrapUID	False	Allows using fixed UIDs in SNMP traps (See SNMP trap list below for details)
	wThreadPeriod	20	Time period when idle threads are given CPU time slice (given in milliseconds)

SNMP trap list

UID	Type	Text	Remarks	To Do
If `bAlternateTrapUID` is set to TRUE
9	CEA	`'SGA-Diameter/ProvideLocation v0.92' module is started.`	Send a welcome message; indication of module start-up.
9	CRI	`'SGA-Diameter/ProvideLocation v0.92' module has been shut down by operator.`	Send a farewell warning message; indication of module shut-down.	Start the `'SGA-Diameter/ProvideLocation'` module.
0	INF	`SCTP(A\|B) association is up.`	Connection A/B is up for the very first time
90	CRI	`SCTP(A\|B) association has died. (shutdown)`	Connection is down; The other side has sent an SCTP/SHUTDOWN message.	Check if the SCTP server is working and the connection parameters are set properly.
90	CRI	`SCTP(A\|B) association has died. (operator)`	Connection is down. Operator has executed the `[SCTP]/Shutdown now!` menu item.	Set SCTP(A) auto-connecting to be true (`[SCTP]/A: Allow auto-connecting` menu item).
90	CRI	`SCTP(A\|B) association has died. (lost)`	The SCTP server has become unreachable (there is no ACK for SCTP/HEARTBEAT).	Check if the SCTP server is alive and the IP connection is working properly.
93	WAR	`TCP connection #NNN: Answer PLR("IMSI") timed-out. (TID=NNNNNNNN)"`	There was no answer for a PLR within the `INI/[RemoteRequest]/dwTimeOutSec` value.	Check the Diameter routes and the requested node or set a higher time-out value.
94	WAR	`Received an unexpected MSU, or its format is unknown.`	Badly formatted MSU or the of the arrived MSU is not recognized.	Check if the MSU traffic directed to this device is addressed and formatted properly.
If `bAlternateTrapUID` is set to FALSE
0	CEA	`'SGA-Diameter/ProvideLocation v0.92' module is started.`	Send a welcome message; indication of module start-up.
0	WAR	`'SGA-Diameter/ProvideLocation v0.92' module has been shut down by operator.`	Send a farewell warning message; indication of module shut-down.	Start the 'SGA-Diameter/ProvideLocation' module.
++N	CRI	`SCTP(A\|B) association has died. (shutdown)`	Connection is down; The other side has sent an SCTP/SHUTDOWN message.	Check if the SCTP server is working and the connection parameters are set properly.
++N	CRI	`SCTP(A\|B) association has died. (operator)`	Connection A/B is down because the operator has executed the `[SCTP]/Shutdown now!` menu item.	Try to set auto-connecting to be true to enable the connection (`[SCTP]/(A\|B): Allow auto-connecting` menuitem).
++N	CRI	`SCTP(A\|B) association has died. (lost)`	The SCTP server has become unreachable (there is no ACK for SCTP/HEARTBEAT).	Check if the SCTP server is alive and the IP connection is working properly.
N	CEA	`SCTP(A\|B) association has died.`	When connection A/B is up after a down. Ceasing for the corresponding "SCTP(A/B) ASP Traffic has died." alarms.
++N	WAR	`TCP connection #NNN: Answer PLR("IMSI") timed-out. (TID=NNNNNNNN)"`	There was no answer for a PLR within the `INI/[RemoteRequest]/dwTimeOutSec` value.	Check the Diameter routes and the requested node or set a higher time-out value.

Version history

v0.92

First official release.

The Diameter Provide-Location query module("SGA-Diameter_ProvideLocation")

Table of Contents