TSP Lab	SgaSS7_L4 - The SS7 interface handler	SgaSS7_L4

The SS7 interface handler module
`("SgaSS7_L4")`

Features

Acts as an active element of the SS7 network
Receives queries with input parameters via TCP/IP from remote modules
Transfers queries to the SS7 network
Sends received answers with output parameteres to the remote modules
Can handle SendRoutingInfoForSM, ForwardSM/Submit, ForwardSM/Deliver, AnyTimeInterrogation and CancelLocation MAP operations
Configurable IP address and TCP port for connection(s) of remote module for the secure operation

Basic operation

Handles Sga47 SS7 interface card
Maintains mid-level SS7 functions (SLTM, SNM, etc.)
Logs queries and responses
Provides simple statistical data and logging on the operation
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 occurance of text in log window
	Details		Detail level of logging (Off, Normal, Detailed, or Debug)
[SS7]
	A: Allow MTP2 auto-connecting	(left-side )	Allows automatic (re-)connecting to the MSC on SS7 channel A
	A: Disconnect MTP2 now		Immediately disconnects SS7 channel A
	B: Allow MTP2 auto-connecting	(right-side )	Allows automatic (re-)connecting to the MSC on SS7 channel B
	B: Disconnect MTP2 now		Immediately disconnects SS7 channel B
[Connection]
	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	(ScrollLock, or )	Allows automatic scrolling of the log screen
	Show connections	(Ctrl-Tab)	Show the connection screen
	Save settings		Saves actual settings into the configuration (`SgaSS7_L4.ini`) file
[DSP Debug]
	Show DSP debug info for SS7(A) now		Shows debug information for SS7 channel A in the status line of the program window
	Show DSP debug info for SS7(B) now		Shows debug information for SS7 channel B in the status line of the program window
	Clear debug info line		Clears the debug information from the status line of the program window

Status-line of SS7 links

PCM: status of the PCM frame in the receiver connection (its color is gray in normal works, red refers to error)
MTP2: SS7/MTP2 status of the connection (its color is gray in normal works, red refers to error)
SS: SS7/MTP2 status, its color is red until SS7/SCCP/SST message is recived, after that it is gray
bps: LSSU and MSU bits received in the last second
permil: idle time of the given program thread in the last second (ms)
BEGIN/END: The number of TCAP BEGIN sent and END messages received
MSU's buffered for Tx: The number of MSU's buffered for transmitting
Error counters:
- pcm: number of PCM disconnections
- mtp2: number of SS7/MTP2 disconnections
- dsp: number of communication errors between DSPs of the Sga47 card and the program
- msu: received an uninterpretable or misaddressed MSU (wrong Point Code)
- tcap: number of wrong TCAP messages

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 connection)
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: ID of active MAP transaction
[op]: MAP operation code
MSISDN/IMSI: Transaction related MSISDN or IMSI

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 last request received from client
	Reply "Software mailfunctioning"		Answers received request with "Software mailfunctioning" cause value (-3)
	Zero counters of this connection		Zeros `Request` and `Answer` counters for this connection
	Send a test MSU for this connection		(Not available in this version)

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!)
[SGA-47 Card]
	wBaseAddress	0xD800	The I/O address of the SGA-47 Card, selected with DIP switches
	sMTP2ObjectFile	MTP2_47 (+00 dB 120 Ohm).obj	The file name of the DSP program
[RemoteRequest]	This section may contain 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.
	127.0.0.1	Allowed	Client with this IP address can connect to the SgaS7_L4 module
	wTCPPort	3000	Portnumber, where the remote modules can connect
	bSuppressDisconnectTrap	True	When it is true traps on disconnecting connections are supressed
[SS7]
	bSS7AAllowMTP2AutoConnect	True	(Refer to the `[SS7]/A: Allow MTP2 auto-connecting` menu item!)
	bSS7BAllowMTP2AutoConnect	True	(Refer to the `[SS7]/B: Allow MTP2 auto-connecting` menu item!)
[SS7 Advanced]
	bEmergencyMTP2Startup	False	Uses or not "Emergency" mode on making up SS7/MTP2 connection
	bySS7ATimeSlot	1	SS7 Time slot on the link A
	bySS7BTimeSlot	1	SS7 Time slot on the link B
	wSS7ARemotePointCode	201	The otherside SS7 device point code on link A
	wSS7BRemotePointCode	201	The otherside SS7 device point code on link B
	wSS7LocalPointCode_NI2	13	Local point code, when NI parameter is 2 in SCCP layer
	wSS7LocalPointCode_NI3	200	Local point code, when NI parameter is 3 in SCCP layer
	szSS7LocalGT	36309489931F	The SS7 Global Title of the module (ClgPA/GT in this module initiated BEGIN messages)
	szSS7FakeGT	36309489931F	This value will be used as the originating SC-address in SRI4SM and ForwardSM BEGIN messages (sm-rp-OA)
	szSS7gsmSCFAddress	36309489931F	The gsmSCFAddress field in the Invocation of AnyTimeInterrogation will be set with this value
	dwRequestValiditySec	900	The module is waiting until this time for the answer for an SS7 request
	wMaxConcurrentConnectionCount	25	Maximum number of connections made by remote modules
	wThreadPeriod	100	Time period when idle threads are given CPU time slice (given in milliseconds)
	bDontAbortAtAbort	False	If True the incoming TCAP/ABORT answer immediately causes sending of an abort for the correspondig client request. If False the module will wait the preset time-out (`dwRequestValiditySec` irrespectively of the ABORT answer.
	bySS7smsSCTSTZ	0x00	TimeZone of ServiceCenter parameter (TP-SCTS/TZ) can be adjusted. (Its value is interpreted as specified in GSM 03.40; can be set either as decimal or hexadecimal, defaults to 0x00. bySS7smsSCTSTZ=999 is treated as "set ForwardSM/Deliver/SCTS/TZ field automatically".)
[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)

Checking Sga47 card

On the back of the Sga47 card a LED signs the state of connected PCM. (The lower LED is the relevant one, the other is indifferent, without reference its state)
Right after the PC power up, the led is uninitialized, it is in random state and its color has no meaning. After the SgaSS7_L4 program has initialized the card, the meanings of LED are the followings:

no light - there is no PCM signal on the cable at all
red - PCM signal is OK on direction 0, but no PCM on direction 1 (on the user interface of the program the A side PCM is grey, the B side is red)
green - PCM signal is OK on direction 1, but no PCM on direction 0 (on the user interface of the program the A side PCM is red, the B side is grey)
amber - PCM signal is OK on both directions (on the user interface of the program boh of the PCMs are grey)

SNMP trap list

UID	Type	Text	Remarks	To Do
If `bAlternateTrapUID` is set to TRUE
9	CEA	`'Sga-SS7/L4 v1.07' module is started.`	Send a welcome message; indication of module start-up
9	CRI	`'Sga-SS7/L4 v1.07' module has been shut down by operator.`	Send a farewell warning message; indication of module shut-down	Start the `'Sga-SS7/L4 v1.07'` module
90	CEA	`SS7(A)/MTP2 connection is up.`
90	CRI	`SS7(A)/MTP2 connection has died.`	Connection is down; indicating MTP problem at either end	Check if the point codes are correct or the other side device works properly
90	CRI	`SS7(A)/MTP2 connection has died. (operator)`	Connection is down; operator cut the line at MTP level	Set `A:MTP2` auto-connecting to be true (`[SS7]/A: Allow MTP2 auto-connecting` menuitem)
90	CRI	`SS7(A)/MTP2 connection has died. (PCM also)`	Connection is down; indicating PCM problem	Check that PCM connection is correct
91	CEA	`SS7(B)/MTP2 connection is up.`
91	CRI	`SS7(B)/MTP2 connection has died.`	Connection is down; indicating MTP problem at either end	Check if the point codes are correct or the other side device works properly
91	CRI	`SS7(B)/MTP2 connection has died. (operator)`	Connection is down; operator cut the line at MTP level	Set `B:MTP2` auto-connecting to be true (`[SS7]/B: Allow MTP2 auto-connecting` menuitem)
91	CRI	`SS7(B)/MTP2 connection has died. (PCM also)`	Connection is down; indicating PCM problem	Check that PCM connection is correct
92	INF	`TCP connection #... is up.`
92	ERR/CEA	`Received ... bytes of illegible request on TCP connection #... - dropping connection.`	Illegal request has been received	Check if the remote module works properly or the TCP connection is reliable. Possibly an illegal connection was made up.
92	ERR/CEA	`Received request on TCP connection #... with bad MagicCode - dropping connection.`	Illegal request has been received	Check if the remote module works properly or the TCP connection is reliable. Possibly an illegal connection was made up.
92	ERR/CEA	`Received ... bytes of illegible request(SMS) on TCP connection #... - dropping connection.`	Illegal request has been received	Check if the remote module works properly or the TCP connection is reliable. Possibly an illegal connection was made up.
92	ERR/CEA	`Received request(SMS) on TCP connection #... with bad MagicCode - dropping connection.`	Illegal request has been received	Check if the remote module works properly or the TCP connection is reliable. Possibly an illegal connection was made up.
92	ERR/CEA	`TCP connection #... closed by the remote side.`	Only if INI/[RemoteRequest]/bSuppressDisconnectTrap=False When the remote module shuts the connection down
92	ERR/CEA	`TCP connection #... closed by operator.`	Only if INI/[RemoteRequest]/bSuppressDisconnectTrap=False When the operator disconnects using `Disconnect this connection` menuitem
93	WAR	`Answer (for [[OPERATION_CODE]] [MSISDN]) timed-out on TCP connection #...`	No CEA is related When an answer does not arrive or arrive later than `INI/[SS7 Advanced]/dwRequestValiditySec`	Check parameters of the request
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 formatted properly
95	CRI	`No more TCP connections are available.`	No CEA is related More than `INI/[SS7 Advanced]/wMaxConcurrentConnectionCount` connection try to be established	Increase value of that configuration entry
If `bAlternateTrapUID` is set to FALSE
0	INF	`'Sga-SS7/L4 v1.07' module is started.`	Send a welcome message; indication of module start-up
0	WAR	`'Sga-SS7/L4 v1.07' module has been shut down by operator.`	Send a farewell warning message; indication of module shut-down	Start the 'Sga-SS7/L4 v1.07' module
0	INF	`SS7(A/B)/MTP2 connection is up.`	Connection A/B is up for the very first time; subsequent ones are indicated with the corresponding CEA
++N	CRI	`SS7(A/B)/MTP2 connection has died.`	Connection A/B is down; indicating MTP problem at either end	Check the SS7 connection
++N	CRI	`SS7(A/B)/MTP2 connection has died. (operator)`	Connection A/B is down; operator cut the line at MTP level	Try to set MTP2 auto-connecting to be true to enable the connection (`[SS7]/(A\|B): Allow MTP2 auto-connecting` menuitem)
++N	CRI	`SS7(A/B)/MTP2 connection has died. (PCM also)`	Connection A/B is down; indicating PCM problem	Check that PCM connections are correct
++N	CEA	`SS7(A/B)/MTP2 connection has died.`	When connection A/B is up after a down
0	INF	`TCP connection #... is up.`	Given TCP connection is up for the very first time; subsequent ones are indicated with the corresponding CEA
++N	ERR	`TCP connection #... closed by the remote side.`	Given TCP connection is down; other side closed the connection
++N	ERR	`TCP connection #... closed by operator.`	Given TCP connection is down; operator closed the connection
N	CEA	`TCP connection #... closed.`	TCP connection #... is up after a down
++N	CRI	`No more TCP connections are available.`	All available connections have already been in use; a new one has just been refused	Check and increase value of `INI/[SS7 Advanced]/wMaxConcurrentConnectionCount` entry
++N	ERR	`Received ... bytes of illegible request on TCP connection #... - dropping connection.`	Illegal request has been received	Check if the remote module works properly or the TCP connection is reliable. Possibly an illegal connection was made up.
++N	WAR	`Answer (for [[OPERATION_CODE]] [MSISDN]) timed-out on TCP connection #....`	TCAP dialog with MAP operation has not finished within the time-out interval (`INI/[SS7 Advanced]/dwRequestValiditySec`)	Check parameters of the message

Version history

v1.23

(c) INI/[SS7 Advanced]/bySS7smsSCTSTZ is loaded (and logged) at start-up time.
(n) INI/[SS7 Advanced]/bySS7smsSCTSTZ=999 is treated as "set ForwardSM/Deliver/SCTS/TZ field automatically".
(n) Optional MSC GT contents of ATI/Loc answers are also decoded.
(n) ATI/Loc requests can also be sent based on IMSI.
(c) More robustness against bogus SMS contents (in SubmitSM/DeliverSM-FromFile mode).

v1.22

(n) SS7/SCCP/TCAP/END/Reject reply results in immediate TCP/IP answer; reject cause is logged, a return value of 1000 (decimal) is sent.

v1.21

(c) Handles FNR result field with a maximum of 20-digits.

v1.20

(n) INI/[RemoteRequest] may contain IP address entries (see example) as a white list; those that are not listed will get barred (refused) silently, i.e., w/o trap, but still logged. (just like in "GyUSSD-Gw")
(c) INI/[RemoteRequest]/sIPAddress entry became obsolete.
(c) Improved SS7 MSU retransmission queue.
(c) More robust DSP-communication problem handling.
(c) Slightly more logging of miscellaneous MSU's (CBD and CBA).

v1.19

(n) TP-SCTS / TZ can be adjusted on-the-fly (used to be 0x00).
(n) INI/[SS7 Advanced]/bySS7smsSCTSTZ (its value is interpreted as specified in GSM 03.40; can be set either as decimal or hexadecimal, defaults to 0x00).

v1.18

(n) Captions contain hardware base address of the SGA-47 card (e.g., [D8000]) for easy module selection.
(c) SS7/SCCP/UDTS reply results in immediate TCP/IP answer.
(c) SS7/SCCP/TCAP/ABORT reply can optionally result in immediate TCP/IP answer. (UDTS and ABORT replies are honored with a return value of 1000, decimal)
(n) INI/[SS7 Advanced]/bDontAbortAtAbort; defaults to "False", logged at start-up.
(n) SCCP/UDTS and TCAP/ABORT cause values (P-Abort and U-Abort as well) are extracted and logged along with the corresponding warning message; see accompanying doc for interpretation details.
(n) Alphanumeric sender is implemented for ForwardSM/Deliver messages; MSISDN_A (szSMOrigNum) should be preceded with a '~' character; proper encoding (8-->7 bit packing) is done automatically, applied character set is based on the actual value of dwMagicCode; a minimum of 0 and a maximum of 11 characters can be given, as specified in GSM 03.40; NoA_A (bySMOrigNoA) should usually be set to 0xD0 (more precisely: 1|101|xxxx binary, where xxxx denotes the required Numbering Plan field).

v1.17

(c) Maximum count of remote connections is raised from 25 to 200.

v1.16

(n) Optionally, textual SMS contents can be given within the SMS file as is intended to be sent, i.e., with the GSM 03.38 alphabets.
- still remains a zero terminated string
- 8-->7 encoding is kept
- character 0x80 is replaced with 0x00
- dwMagicCode should be incremented by 2
- applies for both cases of ForwardSM (i.e., Submit and Deliver)
(n) Presence of optional SAI-Present tag is handled (actually skipped).

v1.15

(c) If the (used-2-B-unused) stSMSFileExt.bySMDestNoA field is set to 0xFF in case of a ForwardSM/Deliver (from file) operation, then SCCP/ClgPA/GT is replaced with stSMSFileExt.szSMDestNum. (Note that sm-RP-OA remains untouched.)

v1.14

(c) Absence of optional VLR-Number tag is ignored.
(c) Absence of optional MSC-Number tag is ignored.
(n) Presence of optional Location-Number tag is handled (actually skipped).

v1.13

(c) CurrentLocation is requested with LocationInfo queries in ATI commands.
(n) SubscriberState=NetDetNotReachable answer for ATI commands is decoded in details.
(c) If AgeOfLocation tag is omitted from the LocationInfo answer of an ATI command then AgeOfLocation is set to 0xFFFF.
(c) If CurrentLocationRetrieved is set in the LocationInfo answer of an ATI command then AgeOfLocation is set to 0.
(c) If LocationInformation is completely omitted from an ATI answer then all of MCC, MNC, LAC, and CI are set to zero.

v1.12

(f) ForwardSM / Deliver (from file) extracted length information of SM_RP_UI/TP-OA field from recipient's address (instead of the sender's).

v1.11

(n) Requests SubscriberState as well as LocationInfo in ATI requests; interprets both answers.

v1.10

(c) IP address of each connection is displayed in the connections' window (instead of the former MSISDN field).

v1.09b

(c) IP connections utilize the TCP Keep-Alive facility.
(f) Visual decoding of AnyTimeInterrogation / (Westel-specific) FNR-Query invocation operation was not correct.

v1.08

(f) Visual decoding of SendRoutingInfoForSM invocation operation was not correct.

v1.07

(c) ATI/FNR sets CagPA/SSN=8(MSC) instead of former 252(SCP).
(c) ATI/FNR fakes FNR query as SubscriberState instead of former LocationInformation.

v1.06

(n) Implements ForwardSM / Submit MAP operation.
(n) Implements AnyTimeInterrogation (ATI) MAP operation for FNR queries (T-Mobile method).
(c) No longer checks SM-RP-PRI against being 0xFF ("true") when decoding SendRoutingInfoForSM invocation. (Note that it was always set to "true" when sending.)
(f) ATI MAP operation for location queries had a bogus length octet in the SubscriberIdentity tag if MSISDN there were not of 11 (or 12) digits.

v1.05

(c) SCCP/CadPA/NoA field can be set (instead of the TT field) for the AnyTimeInterrogation(ATI)/Invocation operation.
(c) "No more TCP connections are available." became a CRI error (used to be marked as ERR).
(c) Empty ATI end is forwarded as MAP error 99.
(c) Subsystem Multiplicity Indicator is no longer checked against being 0 in the SNM/SSA MSU.
(n) "Forget pending request" can be sent remotely (also acting as a connection "keep-alive" test).
(n) INI/[RemoteRequest]/bSuppressDisconnectTrap; defaults to "False", logged at start-up.
(c) Default values are displayed in TCP request if requested so (used to be indicated as "99").
(f) bAlternateTrapUID is implemented for TCP connection related traps.

v1.04

(c) Slightly different handling of sockets in ForwardSM (from file) operation.

v1.03

(n) Added ForwardSM (from file) operation.

v1.02

(n) Added ForwardSM/Deliver, AnyTimeInterrogation (ATI), and CancelLocation operations.
(n) INI/[SS7 Advanced]/sSS7gsmSCFAddress (Required for the ATI operation only.)
(n) Clear key (NumPad-5) clears highlight (selection) in either window.
(c) Operation field in the answer is filled even if MAP dialogue resulted in an error.

v0.95

(c) Can handle IMSI's with any reasonable length. (Used to require 15 or 16 digits.)
(n) Shift-ESC combination minimizes application window.
(f) Logging of operation parameters is trimmed to the proper length.

v0.94

(c) Requires the optionally filled NI, DPC, and TT fields for SRI4SM requests.
(Compatible with Sga-WM Nachrichter v1.05 and SgaSS7/L4 tester v1.01.)
(c) Uses NI=3 level point codes, too.
(c) INI/[SS7 Advanced]/wSS7LocalPointCode is renamed as wSS7LocalPointCode_NI2.
(n) INI/[SS7 Advanced]/wSS7LocalPointCode_NI3; logged at start-up.

v0.93

(n) Faking with SMSC GT for SRI4SM requests.
(n) INI/[SS7 Advanced]/sSS7FakeGT; logged at start-up.

v0.92

(c) Trailing 'F' are trimmed from HLR GT and MSISDN fields in SRI4SM requests.
(f) MSISDN and SCAddress fields are no longer limited to 7 digits in SRI4SM_Inv MSU's.

v0.91

The SS7 interface handler module("SgaSS7_L4")