TSP Lab	Sga-ESR_SS7 - The CAMEL trigger handler module	Sga-ESR_SS7

The CAMEL trigger handler module
`("Sga-ESR_SS7")`

Features

Connects to the signaling network using SCTP/IP connection via the SigTran interface module
Acts as an active element of the SS7 network
Receives CAP/InitialDP triggers from MSC's
Sends back a CAP/Connect or a Continue (based on settings) to the MSC
Triggers for allowed numbers are forwarded towards the ESR-Logic module
Calls for not allowed numbers will be not forwarded only a CAP/Continue will be sent
In SIM-less cases (when the CallingNumber is on the INI/[MSC GTs] list) the module answers the trigger with a CAP/Connect using INI/[Camel Connect]/byNoA as the GenericNumber/Nature of address indicator and a generated Unique Caller ID as the GenericNumber/Address signal.
Creates CDRs
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 occurrence of text in log window
	Details		Detail level of logging (Off, Normal, Detailed, or Debug)
[Options]
	Auto scroll	()	Allows automatic scrolling of the log screen
	Flush counters		Dump status line counter into log
	Flush & reset counters		Dump status line counter into log and clear them
	Save settings		Saves actual settings into the configuration (`Sga-ESR_SS7.ini`) file

The bottom status-line

GyX: Status of the connection to the signaling interface module (its color is gray in normal works, red refers to error)
- bps: Current transfer speed
- Rx OK/Fail: All received right and failed messages
- Tx OK/Fail: All transmitted right and failed messages
SS7
- InitialDP_Rx: Number of received InitialDP messages
- Continue_Tx: Number of emitted Continue messages
- Connect_Tx: Number of emitted Connect messages
  - msu: Number of incoming messages out of the sequence
  - tcap: Number of incoming messages with wrong syntax or not properly formatted
ESR
- Forwarded: Number of forwarded call triggers
- Lost: Number of call triggers that are not forwarded due to some error
Uptime: Time elapsed since module has been started up

CDR generation

The module creates a CDR entry on each InitialDP. One CDR file is opened for each calendar day. The name of the CDR is "Sga-ESR_SS7_CDR_YYYYMMDD.csv" reflecting the day when it is created.

DateTime (GMT): Timestamp of the current call given in GMT
ClgPA_GT: Value of Global title address in SCCP/Calling party address parameter
OTID: Transaction ID of the transaction
IMSI: IMSI of the caller (in case of SIM-less calls it is XXX)
CallingParty: MSISDN of the subscriber (InitialDP/callingPartyNumber)
CalledParty: Called number value (InitialDP/calledPartyNumber or calledPartyBCDNumber)
RedirectingParty: Redirecting number value (InitialDP/RedirectingPartyID)
LocationNumber: Location number value (InitialDP/LocationNumber)
CallReference: CallReferenceNumber value (InitialDP/CallReferenceNumber)
BearerCapability: Information transfer capability value of InitialDP/bearerCapability field
Result: Result of the transaction
- CUE (IMSI exists): There was an IMSI in the trigger and it was answered with a CAP/Continue.
- CUE (not an ESR): There Called number is not listed as an ESR number and the module answered it with a CAP/Continue.
- CON (04|11292620000002): SIM-less case. A CAP/Connect was answered with the quoted Nature of address indicator and Unique Caller ID.

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!)
[SS7 over GyX]			Settings for GyX connection
	sRemoteIPAddress	127.0.0.3	IP address of GyX_SCTP module
	wRemoteTCPPort	9068	TCP port of GyX_SCTP
	wConnectRetryDelaySec	3	Period of attempts to reconnect
[ESR Logic]			Settings for ESR-Logic connection
	sRemoteIPAddress	127.0.0.3	IP address of GyX_SCTP module
	wLocalTCPPort	3000	Port number, where the remote modules can connect
	bSuppressDisconnectTrap	False	When it is true no traps raised on disconnecting of ESR-Logic connection
[ESR Numbers]			Only listed numbers are allowed to go through the ESR locationing process. These settings are loaded on-the-fly The required format is: "112 = General Emergency Number". Note: Some text has to be written on the right side.
	112	General Emergency Number	This number is allowed
	105	Ambulance	This number is also allowed
[MSC GTs]			List of MSCs' GT for SIM-less call detection. These settings are loaded on-the-fly
	36709990001	MSC1	Right-side value is mandatory but ignored
	36709990002	MSC2	Right-side value is mandatory but ignored
[Camel Connect]			These settings are loaded on-the-fly
	byNoA	0x04	The Nature of Address value for the generated unique caller ID in the CAP/Connect message.
	szUniqueID_SKBK	9262	This number is used as the first four digits of the generated unique caller ID in case of SIM-less call. First three digits refer to Vodafone.HU, last digit refers to the particular ESR machine.
	byCounterDigits	7	Number of digits of the unique ID can be adjusted. The minimum value is 1, the maximum value is 9. Note: Set it to a value that will cover the possible number of IMSI-less calls a day.
	byGenericNumberScreeningIndicator	3	The "Screening Indicator" field's value in the CAP/Connect message. Possible values: 0 = "user provided, not verified" 1 = "user provided, verified and passed" 2 = "user provided, verified and failed" 3 = "network provided" (default)
[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)
	sCDRFilesPath	d:\CDRFiles	Path for the CDR's

SNMP trap list

UID	Type	Text	Remarks	To Do
If `bAlternateTrapUID` is set to TRUE
9	CEA	`'Sga-ESR_SS7 v0.92' module is started.`	Send a welcome message; indication of module start-up
9	CRI	`'Sga-ESR_SS7 v0.92' module has been shut down by operator.`	Send a farewell warning message; indication of module shut-down	Start the `'Sga-ESR_SS7'` module
0	INF	`GyX: Connection to remote module established.`		Connection to GyX module is established for the first time
99	CEA	`GyX: Connection to remote module established.`
99	CRI	`GyX: Connection to remote module is lost.`		Check the state of GyX module.
92	INF	`TCP connection: Up.`	ESR-Logic module has connected.
92	ERR	`TCP connection: Closed by the remote side.`	The connection is closed.	Check if the remote module works properly or the TCP connection is reliable.
92	CEA	`TCP connection: Closed (i.e., up again).`	The connection is restored.	After a previous connection has been closed.
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
199	CRI	`Received a call to "NNN", which is not an ESR number.`	No CEA is related The CalledPartyNumber in the incoming trigger is not listed in INI/[ESR Numbers] section.	Check the signalling routing and/or INI/[ESR Numbers] section.
If `bAlternateTrapUID` is set to FALSE
0	INF	`'Sga-ESR_SS7 v0.92' module is started.`	Send a welcome message; indication of module start-up
0	WAR	`'Sga-ESR_SS7 v0.92' module has been shut down by operator.`	Send a farewell warning message; indication of module shut-down	Start the 'Sga-ESR_SS7' module
0	INF	`GyX: Connection to remote module established.`		Connection to GyX module is established for the first time
++N	CRI	`GyX: Connection to remote module is lost.`		Check the state of GyX module.
N	CEA	`GyX: Connection to remote module established.`	When GyX connection is up after a disconnection
++N	INF	`TCP connection: Up.`	ESR-Logic module has connected.
++N	ERR	`TCP connection: Closed by the remote side.`	The connection is closed.	Check if the remote module works properly or the TCP connection is reliable.
N	CEA	`TCP connection: Closed (i.e., up again).`	The connection is restored.	After a previous connection has been closed.
++N	CRI	`Received a call to "NNN", which is not an ESR number.`	No CEA is related The CalledPartyNumber in the incoming trigger is not listed in INI/[ESR Numbers] section.	Check the signalling routing and/or INI/[ESR Numbers] section.

Version history

v1.01

(n) New INI entry: [Camel Connect]/byGenericNumberScreeningIndicator

v1.00

(c) Unique caller ID is now adjustable long.
(n) New INI entry: [Camel Connect]/byCounterDigits (loaded on-the-fly)
(c) Unique caller ID is restarted daily.

v0.97

(c) SS7 file writing feature is removed.
(c) [Advanced]/sSS7FilesPath entry is no longer used.

v0.96

(c) SIM-less call indication changed.

v0.95

(c) SIM-less calls are detected by checking CallingNumber in the INI/[MSC GTs] list.
(n) New INI section: [MSC GTs]. Entries are loaded on-the-fly.

v0.94

(c) Short IMSIs' are also handled.

v0.93

(c) When the CalledPartyBCDNumber is to long then it is logged by an "Unexpected MSU" text and a Continue is sent.
(c) Now in alarms "ESR-Logic" is placed instead of "TCP connection".
(c) The "INAP" texted is changed to "CAP" in the log.

v0.92

First official release.

The CAMEL trigger handler module("Sga-ESR_SS7")