TSP Lab	SS7MSMS - The SMS receiver	SS7MSMS

The SMS receiver module
`("SS7MSMS")`

Features

Connection via MAP over SS7
Handling up to 50.000 subscribers
Handling up to 10 HLRs
Parallel handling of two different SMS Centers
Possibility of sorting short messages into different directories (max. 10)
Monitoring of SMS list length
Optional incoming short message filtering
Possibility to receive remote LocUpd requests
Automatic Warm Reserve feature (switching two between SGASS7MSMS modules if one of them is down)

Basic operation

Maintains mid-level SS7 functions (SLTM, SNM, etc.)
Handles connections with the HLR and the SMSC using MAP (Phase 1 or Phase 2) protocol over SS7
Executes periodic Location Update procedures with the HLR(s)
Receives and acknowledges SMS delivery on SS7/MAP protocol
Creating CDR files hourly
Handles connections with the SMSC interface using SMPP, UCP or SS7 protocol
Logs HLR and SMSC responses
Provides simple statistical data and logging on the operation of the SGA-MSMS System
Sends SNMP traps (heart beats and failure notifications) to the Network Operating Center (NOC) or Network Management System
Performs self maintenance functions to ensure system integrity

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-connectiong	(left-side )	Allows automatic (re-)connecting to the MSC on SS7 channel A
	A: Disconnect MTP2 now		Immediately disconnects SS7 channel A from the MSC
	B: Allow MTP2 auto-connectiong	(right-side )	Allows automatic (re-)connecting to the MSC on SS7 channel B
	B: Disconnect MTP2 now		Immediately disconnects SS7 channel B from the MSC
[Subscribers]
	Auto-send UpdLoc's	(Ctrl-A, or )	Allows automatical sending the Update Location MSUs of the active subscribers
	Send PurgeMS for all active	(Ctrl-P)	Sends MAP/PurgeMS MSUs to the HLR with the corresponding identifier for the all subscribers
	Import list from file		Refreshes the list of the subscribers from the `Subscribers.lst` file
	Export list to file		(Not available in this version)
	Zero SM counter of all subscribers		Resets all short message counters to zero
[Options]
	Auto scroll	(ScrollLock, or )	Allows automatic scrolling of the log screen
	Show log	(Ctrl-Tab)	Shows the log screen
	Show subscriber list	(Ctrl-Tab)	Shows the subscriber list screen
	Save settings		Saves actual settings into the configuration (`SS7MSMS.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

The colors of the subscriber list screen

gray: not active (so no periodic LocUpd is performed)
purple: UpdLoc is in progress, TID in hexadecimal
red: there has been no successful UpdLoc; or there has been a CancelLoc or a PurgeMS
yellow: last successful UpdLoc was earlier, than INI/[SS7]/dwLocUpdValiditySec
black: OK

The popup menu of the subscriber list screen

Right-click on the subscriber list screen window to access this menu!

	Menuitem	Shortcut(s)	Meaning
	Change active state of this subscriber		(Not available in this version)
	Zero SM counter of this subscriber		Resets short message counter for the selected subscriber
	Update Location for this subscriber		Sends MAP/UpdLoc MSU to HLR for the selected subscriber
	Purge this subscriber from HLR		Sends MAP/PurgeMS MSU with the selected subscriber identifier to the HLR
	Forget pending UpdLoc (or PurgeMS) request of this subscriber		Cancels pending UpdLoc (or PurgeMS) request of this subscriber at TCAP level
	Create test SM for this subscriber		(Not available in this version)

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 / MTP1 and MTP2 status of the connection (its color is gray in normal works, red refers to error)
currently used transfer speed
The number of transmitted and the number of acknowledged MAP/UpdLoc MSU's
The number of received and the number of acknowledged MAP/ForwardSM MSU's
The number of MSU's buffered for transmitting

The bottom status-line

Uptime: time elapsed since module has been started up

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)

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
[SGA-47 Card]
	wBaseAddress	0xD800	The I/O address of the SGA-47 Card, selected with DIP switches
	sMTP2ObjectFile	Mtp2_120.obj	The file name of the DSP program
[SS7]
	bSS7AAllowMTP2AutoConnect	True	(Refer to the `[SS7]/A: Allow MTP2 auto-connectiong` menu item!)
	bSS7BAllowMTP2AutoConnect	True	(Refer to the `[SS7]/B: Allow MTP2 auto-connectiong` menu item!)
	bySS7ReturnMAPError	13	Error code value returned in the TCAP END ForwardSM_Result MSU when an incoming short message is refused due to filter settings.
[SS7 Advanced]
	bEmergencyMTP2Startup	False	MTP2 Emergency Startup
	bySS7ATimeSlot	1	SS7 Time slot on the link A
	bySS7BTimeSlot	1	SS7 Time slot on the link B
	wSS7ARemotePointCode	201	It defines the SS7 Point Codes of the operator's HLRs on A channel
	wSS7BRemotePointCode	201	It defines the SS7 Point Codes of the operator's HLRs on B channel
	wSS7LocalPointCode	200	The SS7 Point Code of the SGA-MSMS system
	szSS7LocalGlobalTitle	36309489931F	The SS7 Global Title of the SGA-MSMS system
	dwLocUpdValiditySec	900	Refresh time for periodical Location Update
	wThreadPeriod	100	Time period when idle threads are given CPU time slice (given in milliseconds)
[Subscribers]
	bAutosendLocupds	False	(Refer to the `[Subscribers]/Auto-send UpdLoc's` menu item!)
	sListFile	Subscribers.lst	Specifies the file that contains subscriber data
[RemoteRequest2]
	sIPAddress	192.168.0.111	IP address of the remote station from where the subscriber list can be reloaded. Default value is 0 means no IP address restriction.
	wUDPPort	1968	Port where the remote loader module can be connected. Default is 0 wich means off.
[Options]
	bAutoScroll	True	(Refer to the `[Options]/Auto scroll` menu item!)
[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
	sSMSPathNN	c:\Sga-MSMS\SMSFiles_00	The NN can vary between 00 and 99. It defines the paths for storing the received short messages in SMS files.
	sLogFilesPath	c:\Sga-LogFiles\MSMS1	Path for the LOG files
	sTrapFilesPath	c:\Sga-Trapper\Traps	Path for the SNMP Trap files to be sent
	bAcceptRemoteLocUpdRequests	True	Allows accepting remote locatation update request from the client program
	dwSMSPathNNLimit	5000	The NN can vary between 00 and 99. It defines the maximal number of SMS files in the corresponding directory (-1 means unlimited).
	bAlternateTrapUID	False	Allows using fixed UIDs in SNMP traps (See SNMP trap list below for details)
	bExtendedSMSFile	True	If it is TRUE extended SMS files are generated (including SMSC GT)
[SMSCConfigFiles]			This section contains entries for identifying SMSC configuration files, used in `subscriber.lst` file.
	SMSCCfg1	f:\work\Sga-MSMS\Sga-MSMS\My_SMSC_Config_001.txt	The `SMSCCfg1` is an example, any string can be used instead it. This entry name can be used in the `subscriber.lst` file in the 5th column for referring to the correspoding configuration file.
[ANumberConfigFiles]			This section contains entries for identifying A number configuration files, used in `subscriber.lst` file.
	ANumCfg1	f:\work\Sga-MSMS\Sga-MSMS\My_ANumber_Config_001.txt	The `ANumCfg1` is an example, any string can be used instead it. This entry name can be used in the `subscriber.lst` file in the 6th column for referring to the correspoding configuration file.
[WarmReserve]			About WarmReserve feature see the corresponding part of this document
	sIPAddress	11.22.33.44	IP address of the reserve Sga-MassSMS system
	wUDPPort	1971	UDP port on the reserve Sga-MassSMS system
	dwTimeOutSec	90	If the sum of UpdLocAck+FwdSMRx on the other side does not increase in this period the local side will switch "Auto-send UpdLoc's" ON
	bIAmTheReserve	True	If it is TRUE and the correspondig sum from the remote side after the time-out increases the local side will switch "Auto-send UpdLoc's" OFF
[IMSIPref=OPPref]			This section is for IMSIPref<--->MGTPref translation (BEGIN/UpdLoc, BEGIN/PurgeMS, and CONT/empty MSU's are addressed with IMSI-based MGT instead of HLR's DPC)

The subscriber list

The SMS recepient can be described here by its IMSI and MSISDN numbers
The list can contain both active and inactive entries
The message sorting to different directories can be descripted here
Input message filtering can be descripted here
Cyclic digits to be concatenated to BNumber also can be descripted here
Every line ends with ;

An example line of the file: + 216702780080055F 36708770055123456 0 SMSCCfg1 ANumCfg1 0 ;

Parameter No.	Value	Example	Meaning	Remarks
1	+ `\|` -	+	Set enables or disables the subscriber entry
2	`<`nnnnnnnnnnnnnnnF`>`	216304001110951F	The IMSI number of the subscriber
3	`<`nnnnnnnnnnn`>`	36309700007	The MSISDN number of the subscriber
4	0 `..` 9	1	Specifies the HLR of the subscriber (Refers to `[SS7]/wSS7RemotePointCodeX` value from the `SS7MSMS.ini` file)
5	`[SMSCConfigFiles]/SMSCCfgEntry`	SMSCCfg1	Specifies a SMSC configuration file for message filtering. (Refers to a file described with an entry in `SS7MSMS.ini/[SMSCConfigFiles]` section)	only from version 2.00 [TEST#006]
6	`[ANumberConfigFiles]/ANumCfgEntry`	ANumCfg1	Specifies an A number configuration file for message filtering and storing into directories. (Refers to a file described with an entry in `SS7MSMS.ini/[ANumberConfigFiles]` section)	only from version 2.00 [TEST#006]
7	0 `..` 9	1	indicates number of cyclic digits to be concatenated to BNumber	only from version 2.00 [TEST#004]

The SMSC configuration files

Specifies filters based on SMSC number filtering
The messages can be accepted, rejected or deleted
On delete the received message deleted immediately
Every line ends with ;
The result of the examination indicated in the ch8CauseForTermination in the CDR files

Example lines of the file:

36209300098 REJECT ;

3620930* ACCEPT ;

Parameter No.	Value	Example	Meaning	Remarks
1	`<SMSCNumber>`	3620930*	Specifies a SMSC number	Can contain wildcards as `'.'`, `'?'` and `''` The `'.'` mathces zero or one character, the `'?'` matches one character and `''` matches zero or more character.
2	`ACCEPT \| REJECT \| DELETE`	REJECT	On `ACCEPT` the message will be accepted, on `REJECT` the receiving of the message will be rejected and on `DELETE` the message will be immediately deleted.

The A number configuration files

Specifies filters based on A number filtering
The messages can be accepted, rejected or deleted
On delete the received message deleted immediately
On accepting, the destination directory for sorting the messages into different directories also can be descripted here
Every line ends with ;
The result of the examination indicated in the ch8CauseForTermination in the CDR files

Example lines of the file:

3630?3?0?98 REJECT ;

362093034* ACCEPT 99 ;

36209300097 DELETE ;

Parameter No.	Value	Example	Meaning	Remarks
1	`<ANumber>`	3630?3?0?98	Specifies a A number	Can contain wildcards as `'.'`, `'?'` and `''` The `'.'` mathces zero or one character, the `'?'` matches one character and `''` matches zero or more character.
2	`ACCEPT \| REJECT \| DELETE`	REJECT	On `ACCEPT` the message will be accepted, on `REJECT` the receiving of the message will be rejected and on `DELETE` the message will be immediately deleted.
3	`00 .. 99`	12	This parameter appears only with `ACCEPT`, and specifies the directory where the short messages of the subscriber will be stored (Refers to `[Advanced]/sSMSPathXX` value from the `SS7MSMS.ini` file)

Automatic Location Update feature

Sends Location Update to the HLR periodically
It prevents the messages waiting in the SMSC when the SS7 path brakes down
It prevents from registering the subscriber in an another VLR, as automatically re-sends UpdLoc MSU to the HLR in case a CancelLocation MSU received
Periodic UpdateLocation is sent for the last updated active, if its validity has timed out

Remote Location Update feature

It is possible to execute locatation update from a remote client if INI/[Advanced]/bAcceptRemoteLocUpdRequests enabled
Only the IMSIs defined in the subscribers.lst file can be used
Only authenticated users can use remote location update

Creating CDR files

Creates files hourly contain information for billing

Monitoring of SMS list length

The number of stored short messages can be limited
On case the limit exceeded, the program can reply "sm_DeliveryFailure"/"MemoryCapacityExceeded"

The automatic WarmReserve feature

Required entries in the INI file (with sample settings):
Note that while sIPAddress and bIAmTheReserve entries can be changed at any time during the normal operation (they are 'read on-the-fly'), wUDPPort and dwTimeOutSec entries should be set before module start-up.
If wUDPPort is set (and the given port is not unavailable), then the following rules will apply:
- WarmReserve info packets are sent to the remote party in every 10 seconds, containing the sum of UpdLocAck+FwdSMRx for both signaling links;
- if the corresponding sum from the remote site does not increase within dwTimeOutSec seconds, then local side will switch "Auto-send UpdLoc's" ON; event is logged and an appropriate ERR trap is issued;
- if the corresponding sum from the remote site subsequently (i.e., after a time-out) increases, then event is logged, CEA trap is issued, and if bIAmTheReserve is set to 'True' then local side will switch "Auto-send UpdLoc's" OFF.

SNMP trap list

UID	Type	Text	Remarks	To Do
If `bAlternateTrapUID` is set to TRUE
9	CEA	`'[MAINCAPTION]' module is started.`	Send a welcome message
9	CRI	`'[MAINCAPTION]' module has been shut down by operator.`	Send a farewell WARning message	Start the `'[MAINCAPTION]'` module
90	CEA	`SS7(A)/MTP2 connection is up.`
90	CRI	`SS7(A)/MTP2 connection has died.`		Check that PCM connection is correct
90	CRI	`SS7(A)/MTP2 connection has died. (operator)`		Check that PCM connection is correct
90	CRI	`SS7(A)/MTP2 connection has died. (PCM also)`		Check that PCM connection is correct
91	CEA	`SS7(B)/MTP2 connection is up.`
91	CRI	`SS7(B)/MTP2 connection has died.`		Check that PCM connection is correct
91	CRI	`SS7(B)/MTP2 connection has died. (operator)`		Check that PCM connection is correct
91	CRI	`SS7(B)/MTP2 connection has died. (PCM also)`		Check that PCM connection is correct
92	CRI	`UpdLoc attempt failed 5 times for subscriber '#IMSI#'.`		???
92	CEA	`UpdLoc attempt succeeded for subscriber '#IMSI#'.`
93	CRI	`Permanently could not open SMS files for writing.`	tried to create SMS file 25 times, but all attempts failed	Check if there are SMS file in the path defined in the configuration file
93	CRI	`Failed to create an(y) SMS file.`	generating temporary file name for SMS file failed	Check if the settings are correct in the `SS7MSMS.INI` configuration file or if there is the diretory where the SMS files have to be placed
94	WAR	`Received an unexpected MSU, or its format is unknown.`		?????
If `bAlternateTrapUID` is set to FALSE
0	INF	`'[MAINCAPTION]' module is started.`	Send a welcome message
0	WAR	`'[MAINCAPTION]' module has been shut down by operator.`	Send a farewell WARning message	Start the '[MAINCAPTION]' module
0	INF	`SS7(A/B)/MTP2 connection is up.`	when connection A/B is up first
++N	CRI	`SS7(A/B)/MTP2 connection has died.`		Check that PCM connection is correct
++N	CRI	`SS7(A/B)/MTP2 connection has died. (operator)`		Check that PCM connection is correct
++N	CRI	`SS7(A/B)/MTP2 connection has died. (PCM also)`		Check that PCM connection is correct
N	CEA	`SS7(A/B)/MTP2 connection has died.`	when connection A/B is up after a down
++N	CRI	`Permanently could not open SMS files for writing.`	tried to create SMS file 25 times, but all attempts failed	Check if there are SMS file in the path defined in the configuration file
++N	CRI	`Failed to create an(y) SMS file.`	generating temporary file name for SMS file failed	Check if the settings are correct in the `SS7MSMS.INI` configuration file or if there is the diretory where the SMS files have to be placed

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 GyEIR application 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 both of the PCMs are grey)

The SMS receiver module("SS7MSMS")