TSP Lab	Sga-SMS - The SMS Sender (via SMPP over TCP/IP)	Sga-SMS

The SMS Sender module (SMPP version)
`("SgaSMS")`

Features

Connection via SMPP over TCP/IP.
Supports SMPP v3.4 specification.
Unlimited number of connections with multiple simultaneous threads.
Parallel handling of two different SMS Centers.
Optional White List feature, with up to 1000 active entries.
Optional Validity Period setting, with a limit of 100 days.
Periodical "enquire_link" message (and optionally test SMS) to "ping" other side to keep connections alive

Basic operation

Maintains SMPP connections to SMSC; every second one to INI/[SMSC]/{sIPAddress1,wTCPPort1,sConnectType1} as INI/[SMSC]/{sConnectID1,sPassword1}, and all others to INI/[SMSC]/{sIPAddress1,wTCPPort1,sConnectType1} as INI/[SMSC]/{sConnectID1,sPassword1}.
Scans INI/[Advanced]/sSMSPath directory periodically for input; i.e., SMS files to be sent.
Uses INI/[SMSC]/sLocalMSISDN1 (or INI/[SMSC]/sLocalMSISDN2) for ANumber (sender) if not explicitly given in SMS file.
If input is available then sends on first idle SMPP connection.
Sends a test Short Message to INI/[SMSC]/{byTestSMS_NoA,sTestSMS_MSISDN} (with a validity of 3 minutes) on connections that are idle for more than 10 minutes.
Reconnects broken SMSC connections.
Sends alarms to Network Operating Center via SNMP.

User interface

The main menu

Menu	Menuitem	Shortcut(s)	Meaning
[Log]
	Find line containing...	(Ctrl-F)	Find text in log window
	Find next matching line	(F3)	Find next occurrence of text in log window
	Details		Detail level of logging (Off, Normal, Detailed, or Debug)
[SMSC]
	Check and load input queue	(Ctrl-L, or left-side )	Allow periodical loading of `INI/[Advanced]/sSMSPath`
	Allow auto-connect to SMSC	(Ctrl-S, or right-side )	Allow automatic (re-)connecting to the SMSC
	Process waiting SM requests	(Ctrl+P, pr )	Send Short Messages that have been loaded in the waiting queue
	Unload SMSC waiting queue		Put all prefetched Short Messages back to `INI/[Advanced]/sSMSPath`
	Forget SMSC waiting queue		Simply forget all prefetched Short Messages
	Terminate all SMSC connections gracefully		Disconnect all SMSC connections in the normal way
	Abort all SMSC connections immediately (!!!BRUTAL!!!)		Disconnect all SMSC connections immediately by breaking low layer sockets
	test: 36309304049		Send a test Short Message to the application developer at +36309304049
[White list]
	Syntax-check list		Check syntax (but do not load) white list file at `INI/[Advanced]/sWhiteListFile`
	Reload list		Reload white list file at `INI/[Advanced]/sWhiteListFile` now
[Options]
	Auto scroll	(ScrollLock, or )	Allow automatic scrolling of the log screen
	Show log	(Ctrl-Tab)	Show log screen
	Show SMSC queues	(Ctrl-Tab)	Show SMSC waiting queue and SMSC connection status window
	Save settings		Save actual settings into the configuration (INI) file

The popup menu of the SMSC waiting queue

Right-click on the SMSC waiting queue window to access this menu!

	Menuitem	Shortcut(s)	Meaning
	Unload this SMSC request		Put the highlighted (prefetched) Short Message back to `INI/[Advanced]/sSMSPath`
	Simply forget this SMSC request		Simply forget the highlighted (prefetched) Short Message

The popup menu of the SMSC connection status window

Right-click on the SMSC connection status window to access this menu!

	Menuitem	Shortcut(s)	Meaning
	Cancel request		(Not available in the SMPP-based version.)
	Terminate this connection gracefully		Disconnect the highlighted SMSC connection in the normal way
	Abort this connection immediately (!!!BRUTAL!!!)		Disconnect the highlighted SMSC connection immediately by breaking its low layer socket

The bottom status-line

Uptime; time elapsed since module has been started up.
Number of Short Messages in the waiting queue.
Brief SMSC connection status. Goes red if no connection exists at all, yellow if at least one is OK and at least one is not, and black if all are OK.

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 corresponding menuitem!)
[SMSC]
	sConnectID1	MY_SMPP_1	SMPP ConnectID, for even (every second) connections (username)
	sConnectID2	MY_SMPP_2	SMPP ConnectID, for odd (every other) connections (username)
	sPassword1	1234567	SMPP connection password, for even (every second) connections
	sPassword2	7654321	SMPP connection password, for odd (every other) connections
	sConnectType1		SMPP ConnectionType, for even (every second) connections (system type)
	sConnectType2		SMPP ConnectionType, for odd (every other) connections (system type)
	sIPAddress1	111.222.33.44	SMSC IP Address, for even (every second) connections
	sIPAddress2	111.222.33.45	SMSC IP Address, for odd (every other) connections
	wTCPPort1	8000	SMSC TCP Port, for even (every second) connections
	wTCPPort2	8000	SMSC TCP Port, for odd (every other) connections
	bBindAsTransceiver1	True	SMSC connections can be bound either as Transmitter or as Transceiver. "True" defines that even connections will be bound as Transceiver. The default is "False" for compatibility reason and makes connections in Transmitter mode.
	bBindAsTransceiver2	True	SMSC connections can be bound either as Transmitter or as Transceiver. "True" defines that odd connections will be bound as Transceiver. The default is "False" for compatibility reason and makes connections in Transmitter mode.
	sLocalMSISDN1	9123456	`ANumber` (sender MSISDN) if left empty in input file, for even (every second) connections
	sLocalMSISDN2	9654321	`ANumber` (sender MSISDN) if left empty in input file, for odd (every other) connections
	byLocalNoA1	0x10	Defines the Type of Number (TON=1) and Numbering Plan Indicator (NPI=0) parameters for even connections Format of the example is hexadecimal as the leading '0x' shows it. '16' for this value means the same but in decimal format.
	byLocalNoA2	0x10	TON=1 and NPI=0 for every other connections
	bAllowAutoReadInput	True	(Refer to the corresponding menuitem!)
	dwSMSCMaxWaitingRequests	40	Size of the pre-fetch queue
	bAllowAutoConnect	False	(Refer to the corresponding menuitem!)
	wSMSCAutoConnectIntervalSec	4	Retry interval for SMPP connections, given in seconds
	wSMSCMaxConcurrentConnections	5	Number of simultaneous threads
	bSMSCProcessWaitingSMRequests	False	(Refer to the corresponding menuitem!)
	dwValidityPeriodSec	3600	Validity period for the short messages, given in seconds
	wSMSCTimeOutSec	5	An SMPP-level time-out is implemented: if the SMSC does not answer the Invoke message (the SMS submit request) within this configured interval (e.g., 5 seconds), then the sender module will abort and rebuild the connection.
	byTestSMS_NoA	0x91	Destination NoA for the periodic test SMS
	sTestSMS_MSISDN	36309123456	Destination MSISDN for the periodic test SMS; leave it empty for not sending any
[Simply Drop SMS For These Error Codes]			Reconnection in case of failed Submit (SUBMIT_SM) is optional, based on the Error Code of returned Command Status value.
	3	Invalid Command ID	If Error Code = 3 then there is no reconnection.
	20	Message Queue Full	If Error Code = 20 then there is no reconnection.
[Advanced]
	wLogDetailLevel	3	(Equals to the listed order; refer to the corresponding menuitem!)
	dwMaxLinesInLogWindow	1000	Number of lines in the log window on screen
	sSMSPath	d:\SMSFiles	Path for the SMS files to be sent
	sSMSNOKPath	d:\SMS_NOK	Short messages, for which sending failed, can be stored in a this directory Defaults to "" (empty string), which means not to store.
	sLogFilesPath	d:\LogFiles	Path for the LOG files
	sWhiteListFile	c:\Sga-SMS\WhiteList.txt	Path and filename for the White List file to be applied
	sTrapFilesPath	d:\TrapFiles	Path for the SNMP Trap files to be sent
	sCaption	SMSC12 Instance 1	Alternative caption text for easy distinguishing amongst multiple instances of this module
	bRetryIfFailedDuringSending	False	Retry strategy if transmission fails during the actual sending

The white list feature

White List is applied if there is at least one active line; otherwise all destinations are *accepted*.
White List Checking is performed when *loading* SMS file, and not when sending the short message itself!
Even empty string can be addressed as destination, allow it as "." in the White List.

Periodic test SMS feature

Sends a test Short Message on connections that are idle for more than 10 minutes.
Disconnects (and automatically reconnects) if sending fails; SNMP Trap is issued.
Validity Period of these messages is set to 3 minutes.
Can be disabled by leaving emtpy the [SMSC]/sTestSMS_MSISDN entry in the configuration file

SNMP Traps

Start-up (INF) trap

INF "SMSC connection #N is up."
ERR "SMSC connection #N has died." (CEA when corresponding connection becomes OK again; CRI instead of ERR when last live connection dies)
INF "'<<INI/[Advanced]/sCaption>>' module is started." ( a welcome INFormation message)
WAR "'<<INI/[Advanced]/sCaption>>' module has been shut down by operator." (a farewell WARning message)

Built-in limitations

No more than INI/[SMSC]/dwSMSCMaxWaitingRequests SM per 333 ms on total.
No more than 1 SM per 333 ms per connection.
No more than 1000 active entries in White List.

Version history

v2.03

(f) Simultaneous disconnections of SMSC connections might have corrupted SMSC connected count.

v2.02

(n) Checking for SMSC answer time-out on active connections
(n) INI/[SMSC]/wSMSCTimeOutSec (defaults to 5 seconds; logged on start-up)

v2.01

(n) Reconnection in case of failed Submit (SUBMIT_SM) is optional, based on the returned Command Status value.
(n) INI/[Simply Drop SMS For These Error Codes]
(c) Returned Command Status value is shown in LOG in case of failed Submit (SUBMIT_SM) operation.

v2.00

(c) SMPP engine is completely redesigned.
(n) Sends periodic ENQUIRE_LINK requests, and awaits proper RESP in turn.
(n) Answers incoming ENQUIRE_LINK requests from SMSC with proper ENQUIRE_LINK_RESP.
(c) SMSC connections can be aborted during the logon process, too.
(c) SMSC connections can be bound either as Transmitter or as Transceiver.
(n) INI/[SMSC]/bBindAsTransceiver1 and bBindAsTransceiver2=False (defaults to "False" for compatibility reason).
(c) Can handle 64-character message_id in SUBMIT_SM_RESP (used to be defined as 8 characters at most in SMPP v3.3).
(n) Sent and received SMPP PDU's can be logged, either at bit-level or with parameters decoded.

v1.09

(n) Handles DCS and PID fields of the SMS files
(n) Short messages, for which sending failed, can be stored in a separate directory
(n) INI/[Advanced]/sSMSNOKPath (defaults to "" (empty string), which means not to store)
(c) INI/[Advanced]/sDataPath is replaced with INI/[Advanced]/sLogFilesPath (defaults to "c:\LogFiles")
(c) INI/[Advanced]/sTrapFilesPath defaults to "c:\TrapFiles" (formerly to "c:\data\traps")
(n) Start-up log contains section names according to the listed INI entries
(c) Can handle zero-length-text messages
(n) Shift-ESC combination minimizes application window
(n) Start-up (INF) trap
(n) "Process waiting SM requests" item in the SMSC menu may also be invoked with the Ctrl-P key combination
(c) SMSC waiting queue request count has a fixed size box in the status bar
(f) CPU usage indicator used to show only 1/30 of the real usage

v1.08

(n) INI/[SMSC]/byLocalNoA1 and INI/[SMSC]/byLocalNoA2 (defaults to 0x11)
(n) byLocalNoA settings are indicated when trying to establish SMSC connection
(c) 20 second checking for test message necessity is no longer indicated (not even in "Debug" log level)

v1.07

(n) Sends a test Short Message (with a validity of 3 minutes) on connections that are idle for more than 10 minutes
(n) INI/[SMSC]/byTestSMS_NoA (defaults to 0x91)
(n) INI/[SMSC]/sTestSMS_MSISDN (defaults to "", which means 'off')
(n) Optionally resends a Short Message if connection fails during sending (used to resend only if connection failed before actually sending)
(n) INI/[Advanced]/bRetryIfFailedDuringSending (defaults to "False")
(c) "SM request: #... Dropped." is not logged if log detail level is "Off"
(f) INI/[SMSC]/wSMSCAutoConnectIntervalSec used to be divided by 3

v1.06

(n) INI/[Advanced]/sCaption for displaying an extended caption for a particular instance of the module

v1.05

(f) Slightly changed the setting of ValidityPeriod
(c) INI/[SMSC]/sLocalMSISDN{1|2} is not reloaded on a per-SM basis (only when SMSC connects)
(c) Handling of SMSC connection status window slightly changed
(f) SMS unload failure-retry-algorithm is fixed
(f) Trap write failure-retry-algorithm is fixed

v1.04

(n) INI/[SMSC]/dwValidityPeriodSec (0 means use SMSC default)
(n) Implements the White List feature
(n) INI/[Advanced]/sWhiteListFile
(n) MENU/"White list"/"Syntax-check list"
(n) MENU/"White list"/"Reload list"
(f) SMS unload failure-retry-algorithm is fixed
(f) Trap write failure-retry-algorithm is fixed

v1.03

(c) If NumberA is NULL then it is set to INI/[SMSC]/sLocalMSISDN{1,2}
(c) Sending INF trap when an SMSC connection is up for the first time; and CEA when recovering further times
(c) Contents of trap files changed to handle the "Unique ID" parameter

v1.02

(c) Origination MSISDN number is no longer checked against being of zero length
(n) Sending traps
- WAR: '"MAINCAPTION"' module has been shut down by operator."
- ERR/CRI/CEA: "SMSC connection #%u has died." // CRI if last connection has died
(n) New INI file entry: INI/[Advanced]/sTrapFilesPath
(f) Multiple file write operations for SMS unloading are canceled

v1.01

(c) Full-speed sending
(c) Log / Details / Off, Normal, Detailed, Debug
(n) SMSC menu / UnloadQueueNow
(n) SMSC waiting queue popup menu / UnloadRequest
(c) Op.ref. is displayed as hexadecimal
(n) SMS files are left on disk while queue is full
(n) Numbering Plan and Type of Number are handled
(n) Tabulator positions are adjusted to provide a nice fit

v1.00

(n) Origination MSISDN number can also be given
(c) File length 192--->216 bytes

To-do list

Perhaps Validity Period setting should be re-evaluated only e.g., once per second, instead of the current per-SMS basis...

Known bugs

No bug is known at present.

The SMS Sender module (SMPP version)("SgaSMS")