TSP Lab	CIMDSMS - The SMS Sender (via CIMD over TCP/IP)	CIMDSMS

The SMS Sender module (CIMD version)
`("CIMDSMS")`

Features
Basic operation
User interface
Logging
Configuration
White list feature
Periodic test SMS feature
SNMP alarm list
Built in limitations
Version history
Remote Control by CIMDSMS_UDP software ("CIMDSMS_UDP")

Features

Connection via CIMD over TCP/IP
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 GSM system specific limits and resolution
Periodical test SMS to keep connections alive
8-bit accented character encoding
Optional 0x20 offset in CIMD parameter 033
Handles 032 (UDH) parameter even if 033 (UD) exists
Can receive short messages: both 7-bit (character-based) and 8-bit (binary) SMS and can also receive SMS with UDH
Can receive message 20 (Deliver message operation request)
Answers message 70 (Deliver message response)
Handles 026 (IMSI) and 028 (SMSC Address) parameters
Decodes optional 069 (ex-028) parameter (SMSC GT)
Reads both standard and extended (with SMSC GT) SMS files
Optional remote controlability via UDP commands

Basic operation

Maintains CIMD connections to SMSC(s); every second one to an SMSC specified with CIMDSMS.ini/[SMSC]/{sIPAddress1,wTCPPort1} as CIMDSMS.ini/[SMSC]/{sUserID1,sPassword1}, and all others to the same or to another SMSC specified with CIMDSMS.ini/[SMSC]/{sIPAddress2,wTCPPort2} as CIMDSMS.ini/[SMSC]/{sUserID2,sPassword2}.
Scans CIMDSMS.ini/[Advanced]/sSMSPath directory periodically for input; i.e., SMS files to be sent.
Uses CIMDSMS.ini/[SMSC]/sLocalMSISDN1 (or CIMDSMS.ini/[SMSC]/sLocalMSISDN2) for ANumber (sender) if not explicitly given in SMS file.
If input is available then sends on first idle CIMD connection.
Sends a test Short Message to CIMDSMS.ini/[SMSC]/{byTestSMS_NoA,sTestSMS_MSISDN} (with a validity of 5 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 right-side )	Allow periodical loading of `INI/[Advanced]/sSMSPath`
	Allow auto-connect to SMSC	(Ctrl-S, or left-side )	Allow automatic (re-)connecting to the SMSC
	Process waiting SM requests	()	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 well-known guy 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 hilited (prefetched) Short Message back to `INI/[Advanced]/sSMSPath`
	Simply forget this SMSC request		Simply forget the hilited (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 CIMD-based version.)
	Terminate this connection gracefully		Disconnect the hilited SMSC connection in the normal way
	Abort this connection immediately (!!!BRUTAL!!!)		Disconnect the hilited 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
SMSC Rx indicates the count of the short messages received. 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.

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 (CIMDSMS.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]
	sUserID1	LoGiNnAmE	CIMD connection username, for even (every second) connections
	sUserID2	lOgInNaMe	CIMD connection username, for odd (every other) connections
	sPassword1	PaSsWoRd	CIMD connection password, for even (every second) connections
	sPassword2	pAsSwOrD	CIMD connection password, for odd (every other) connections
	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
	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
	bAllowAutoReadInput	True	(Refer to the corresponding menuitem!)
	dwSMSCMaxWaitingRequests	40	Size of the pre-fetch queue
	bAllowAutoConnect	False	(Refer to the corresponding menuitem!)
	wSMSCAutoConnectIntervalSec	5	Retry interval for CIMD 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
	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
	sAdCPrefix	00	Adjustable AdC prefix for SubmitSM (03) operations. It's appended to the recipient MSISDN (B number) of the short message.
	sAdCPrefixNumA	00	Adjustable Source Address Code prefix for SubmitSM (03) operations, parameter 023 (Originating address). It's appended to the sender MSISDN (A number) of the short message. (Defaults to "", i.e., empty string, for compatibility; logged at start-up)
	wSMSCTimeOutSec	5	If SMSC answer time on active connections reaches this value then the request is repeated.
[RemoteRequest2]
	sIPAddress	127.0.0.1	IP address of station where from UDP commands will be sent. (An optional station restriction can be set with this parameter for remote controlling)
	wUDPPort	1968	UDP port where the remote control connection will be accepted (Setting to zero means disable remote control feature)
[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	c:\Sga-CIMD\SMSFiles	Path for the SMS files to be sent
	sWhiteListFile	c:\Sga-CIMD\WhiteList.txt	Path and filename for the White List file to be applied
	sTrapFilesPath	c:\Sga-CIMD\TrapFiles	Path for the SNMP Trap files to be sent
	sLogFilesPath	c:\Sga-CIMD\LogFiles	Path for the LOG files
	sSMSNOKPath	c:\Sga-CIMD\SMSFiles_NOK	Optionally the program puts the short messages into this directory which not sent successfully, if defined (not an empty string). [Its default value is empty]
	sSMSOKPath	c:\Sga-CIMD\SMSFiles_OK	Optionally the program puts the short messages into this directory which are sent successfully, if defined. (Defaults to "" (i.e., do not store result), for compatibility reason.)
	sCaption	Buli Loui	Alternative caption text for easy distinguishing amongst multiple instances of this module
	bRetryIfFailedDuringSending	False	Retry strategy if transmission fails during the actual sending: If enabled, the program will trying to send the message continously. If disabled, the program tries to send the message only once. If it fails, moves the message to the `[Advanced] / sSMSNOKPath` (if defined), or forgets it.
	bAlternateTrapUID	False	Allows using fixed UIDs in SNMP traps (See SNMP trap list below for details)
	bSubmitSCTSFieldIn060	False	If true, sending SCTS (SMSC-Time-Stamp) parameter is enabled
	bApply0x20Offset	False	If true, optional 0x20 offset in CIMD parameter 033 is enabled
	bSubmitSMSCGTFieldIn069	False	If true, sending SMSCGT field parameter is enabled
	sSMSRxPath	c:\data\SMS_Rx	Path for SMS's received

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 5 minutes.

SNMP trap list

Type (UID)	Text	Remarks	To Do
If `bAlternateTrapUID` is set to TRUE
CEA(5)	`'[MAINCAPTION]' module is started.`
CRI(5)	`'[MAINCAPTION]' module has been shut down by operator.`		Start the `'[MAINCAPTION]'` module
ERR(50) / CEA(50)	`At least one SMSC connection has died.`	ERR on one or more connection has died, CEA on it has been restored.	Check if the IP connection is correct between the MSMS and the SMSC or if the SMSC is alive
CRI(51) / CEA(51)	`All SMSC connections have died.`	CRI if all connection has died, CEA on at least one has been restored.	Check if the IP connection is correct between the MSMS and the SMSC or if the SMSCs are alive
CRI(52)	`Failed to create an(y) SMS file into '[PATH]'.`	No CEA is related.	Check if the '[PATH]' is valid, or there is enough space on the harddisk.
CRI(52)	`Permanently could not open SMS files for writing in '[PATH]'.`	No CEA is related.	Check if the '[PATH]' is valid, or there is enough space on the harddisk.
If `bAlternateTrapUID` is set to FALSE
CEA(0)	`'[MAINCAPTION]' module is started.`
CRI(0)	`'[MAINCAPTION]' module has been shut down by operator.`		Start the `'[MAINCAPTION]'` module
INF(0)	`SMSC connection #[ConnectionNumber] is up.`
ERR(++N) / CEA(N)	`SMSC connection #[ConnectionNumber] has died.`	ERR on one or more connection has died, CEA on it has been restored.	Check if the IP connection is correct between the MSMS and the SMSC or if the SMSC is alive
CRI(++N) / CEA(N)	`All SMSC connections have died.`	CRI if all connection has died, CEA on at least one has been restored.	Check if the IP connection is correct between the MSMS and the SMSC or if the SMSCs are alive
CRI(++N)	`Failed to create an(y) SMS file into '[PATH]'.`	No CEA is related.	Check if the '[PATH]' is valid, or there is enough space on the harddisk.
CRI(++N)	`Permanently could not open SMS files for writing in '[PATH]'.`	No CEA is related.	Check if the '[PATH]' is valid, or there is enough space on the harddisk.
CRI(++N)	`Permanently could not open SMS files for writing in '[PATH]'.`	No CEA is related.	Check if the '[PATH]' is valid, or there is enough space on the harddisk.

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.
Validity Period cannot exceed 100 days

Version history

v2.08

(n) Handles escaped characters, too.

v2.07

(n) Reconnection in case of failed Submit is optional, based on Parameter 900 (Error Code)
(n) INI/[Simply Drop SMS For These Error Codes] (see example)

v2.06

(n) 16-bit protocol error code for Submit operation is written back into the SMSFile placed in the SMSNOKPath; SMSFile / Byte#30 = LOBYTE(ErrorCode900), SMSFile / Byte#52 = HIBYTE(ErrorCode900); 0xFFFF is used if sending failed due to a TCP error; Originating and Destination MSISDN's are truncated down to 19 digits (used to be 20) in this case.

v2.05

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

v2.04

(n) SMS with Alphanumeric Originating Address in the sender field can also be submitted.
(c) Parameter 027 is used instead of 023 if source address starts with tilde ('~') character in the SMS file (as well as if it is set via INI/[SMSC]/sLocalMSISDN1 and sLocalMSISDN2).

v2.03

(n) INI/[Advanced]/sSMSOKPath (defaults to "" (i.e., do not store result), for compatibility reason)
(c) Slightly different encoding (for '$' and '@' characters) when INI/[Advanced]/bApply0x20Offset is set to True.
(n) "Failed to create an SMS file" error message now contains the path as well.
(c) Can handle zero-length-text ("033:") messages.

v2.02

(c) Slightly different encoding (basically, for the Greek characters) when INI/[Advanced]/bApply0x20Offset is set to True.
(n) Adjustable Source Address Code prefix for SubmitSM (03) operations, parameter 023 (Originating address).
(n) INI/[SMSC]/sAdCPrefixNumA (defaults to "", i.e., empty string, for compatibility; logged at start-up)

v2.01

(n) Remote controlability via UDP commands
(n) Start-up log contains section names according to the listed INI entries
(n) INI/[RemoteRequest2]/sIPAddress (optional station restriction)
(n) INI/[RemoteRequest2]/wUDPPort (setting to zero means disable)

v2.00

(n) New feature: capability to receive short messages
- Can receive both 7-bit (character-based) and 8-bit (binary) SMS
- Can also receive SMS with UDH
- Creation date of the SMS file is set to TP-SCTS (Submit time)
(n) Can receive message 20 (Deliver message operation request)
(n) Answers message 70 (Deliver message response)
(n) Handles 026 parameter (IMSI)
(n) Handles 028 parameter (SMSC Address)
(n) Shift-ESC combination minimizes application window
(n) "Process waiting SM requests" item in the SMSC menu may also be invoked with the Ctrl-P key combination
(n) INI/[Advanced]/sSMSRxPath (defaults to "c:\data\SMS_Rx")
(n) New traps: "Failed to create an(y) SMS file into XXXXXX." and "Permanently could not open SMS files for writing in XXXXXX.", where XXXXXX is INI/[Advanced]/sSMSRxPath; TrapUID=52 if INI/[Advanced]/bAlternateTrapUID is set to True
(c) SMSC waiting queue request count has a fixed size box in the status bar
(c) SMSC Rx in the status bar now indicates the count of the short messages received; used to indicate the SMSC response count
(n) SMSC Connections' window now also indicates the count of the short messages received (while the given connection is up and idle)
(f) CPU usage indicator used to show only 1/30 of the real usage

v1.12

(c) Parameter tag 028 is changed for 069
(c) INI/[Advanced]/bSubmitSMSCGTFieldIn028 is changed for bSubmitSMSCGTFieldIn069
(c) Decodes optional 069 (ex-028) parameter (SMSC GT)
(n) Unload feature is available for extended SMS files as well

v1.11

(n) Reads both standard and extended (with SMSC GT) SMS files
(n) INI/[Advanced]/bSubmitSMSCGTFieldIn028 (defaults to False, logged on start-up)
(n) Traps about SMSC connections include INI/[Advanced]/sCaption (first 35 chars), if bAlternateTrapUID=TRUE
(n) Traps about SMSC connections include INI/[Advanced]/sCaption (first 25 chars) + IP_Address + TCP_Port, if bAlternateTrapUID=FALSE

v1.10

(c) 8-bit accented character encoding (if bApply0x20Offset is set to false)

v1.09

(n) 0x20 offset in CIMD parameter 033 becomes optional.
(n) INI/[Advanced]/bApply0x20Offset (logged on start-up; defaults to TRUE to provide backward compatibility).
(c) Omits CIMD parameter 023 if Sender MSISDN is neither directly (in the SMS file) nor indirectly (in the INI file) is given for a particular SMS
(c) Default Sender MSISDN (if none is explicitly given in SMS file) becomes an empty string.

v1.08

(c) No KeepAlive is sent while a recent SMS is pending
(c) No SMS is sent while a recent KeepAlive is pending
(f) Last SMS might have stuck if sent during a pending KeepAlive that subsequently failed

v1.07

(n) SCTS (SMSC-Time-Stamp) can optionally be submitted in a 060 parameter
(n) INI/[Advanced]/bSubmitSCTSFieldIn060 (defaults to False, logged on start-up)
(n) Creation date and time of SMS file is set to that of SCTS field when being unloaded

v1.06

(c) Handles 032 (UDH) parameter even if 033 (UD) exists

v1.05

(n) Parameter 033 is used (instead of 032 and 034) if indicated bits of DCS are set as shown in any of the following cases:

v1.04

(n) Sends periodic "Alive?" (40) requests, and awaits proper response (90)

v1.03

(n) Handles 032 parameter (User Data Header, UDH)

v1.02

(n) Handles SMS files containing binary data (DCS other than zero)
(n) Transmits 030 parameter if Data Coding Scheme (DCS) is not zero
(n) Transmits SMS contents as hexadecimal in 034 parameter if Data Coding Scheme (DCS) is not zero
(n) Transmits 052 parameter if Protocol Identifier (PID) is not zero
(n) Optionally unloads SMS file that the SMSC connection failed with into separate directory
(n) INI/[Advanced]/sSMSNOKPath (defaults to "" (i.e., do not unload), for compatibility reason)
(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")
(f) UCPSMS: Periodic test message has "CIMD" in its text (used to refer to "SMPP")

v1.01

(n) Alternatively, SNMP trap UID's with fix codes (see doc for details)
(n) INI/[Advanced]/bAlternateTrapUID (defaults to 'False')

v1.00

(n) Adjustable Destination Address Code prefix for SubmitSM (03) operations
(n) INI/[SMSC]/sAdCPrefix (defaults to "00")
(f) Message Packet Numbers are handled on a per connection basis

v0.92

(n) Handles junk received from SMSC
(n) Handles validity period setting

v0.91 (v0.90)

Initial release

Remote Control by CIMDSMS_UDP software

Basic Operation

This utility connects to the remote CIMDSMS
Parameter can be one of the followings:
- 141 = SMSC / AllowAutoConnect_YES
- 142 = SMSC / AllowAutoConnect_NO
- 148 = SMSC / TerminateAllConnectionsGracefull
- 150 = SMSC / AbortAllConnectionsImmediately
Possible responses:
- ERROR in CIMDSMS_UDP v1.00: Could not determine INI file name correctly.
- ERROR in CIMDSMS_UDP v1.00: IP connection is not available.
- ERROR in CIMDSMS_UDP v1.00: UDP/IP connection is not available.
- ERROR in CIMDSMS_UDP v1.00: Remote IP address "cimdsms1.pgsm.uh" could not be resolved.
- ERROR in CIMDSMS_UDP v1.00: Failed to send request to "cimdsms1.pgsm.hu:1968".
- CIMDSMS_UDP v1.00: Request for importing the subscriber list has successfully been sent to "cimdsms1.pgsm.hu:1968".

Configuration (CIMDSMS_UDP.ini) file settings

Section	Entry	Example	Meaning
[Advanced]
	sRemoteIPAddress	127.0.0.1	IP address of the station where the CIMDSMS modul runs
	wRemoteUDPPort	1968	Port where the remote CIMDSMS module waits for connection to remote control

Version history

v1.00

(n) It is actually brand-new!

The SMS Sender module (CIMD version)("CIMDSMS")

Table of Contents

Features

Basic operation

User interface

The main menu

The popup menu of the SMSC waiting queue

The popup menu of the SMSC connection status window

The bottom status-line

Logging

Configuration (CIMDSMS.ini) file settings

The white list feature

Periodic test SMS feature

SNMP trap list

Built-in limitations

Version history

Remote Control by CIMDSMS_UDP software

Basic Operation

Configuration (CIMDSMS_UDP.ini) file settings

Version history

The SMS Sender module (CIMD version)
`("CIMDSMS")`