TSP Lab	GyUSSDGw_X - The USSD Gateway module - SigTran version	GyUSSDGw_X

The USSD Gateway module - SigTran version`("GyUSSDGw_X")`

Features

Connects to the signaling network through GyX_SCTP interface modules
Receives connections from USSD client modules
Provides USSD Gateway functionality
Handles USSD MAP Phase1 and Phase2 messages and USSD dialogues
Logs queries and responses on different log levels
Provides simple statistical data and logging on the operation
Creates SNMP traps

Basic operation

Receives client connections which tell their own application codes
Forwards the incoming MAP/processUnstructuredSS requests to the proper USSD service clients based on the application code
Forwards the response of the USSD service clients to the MSS/MSC

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)
[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 (in the Connections window)
[Options]
	Auto scroll	(ScrollLock, or )	Allows automatic scrolling of the log screen
	Show log	(Ctrl-Tab)	Show the log screen
	Show connections	(Ctrl-Tab)	Show the connection screen
	Save settings		Saves actual settings into the configuration (GyUSSDGw_X.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
BEGINv1: Number of incoming Phase1 BEGIN messages since the module started
BEGINv2: Number of incoming Phase2 BEGIN messages
CONTv2(Tx|Rx): Number of CONTINUE messages (from application|from MSS)
END: Number of outgoing END messages
Uptime: time elapsed since module has been started up
Err: Error counters
- msu: Number of badly formatted or addressed (e.g. wrong point code) messages
- tcap: Number of messages with incorrect TCAP/TID
- E1: Number of BEGIN messages when the buffer where they are inserted was not free.
- E2: Number of answers from the client side for an unexisting or a closed transaction.
- E3: Number of answers from the client with improper Operation Reference value.
- E5: Number of unexpected CONT messages arrived from MSS (TIDs are not fit)

Details of connections window

ID: Identifier of the connection
Live: This connections is alive if + (there is a connection)
App.ID: The service code of the client
IP Address: IP address of the client connected
Req.Count: Number of received requests
Answ.count: Number of answered requests
Last request: Timestamp of last request
Last answer: Timestamp of last answer

The popup menu of the connections screen

Right-click on a row in the connections screen window to access this menu!

	Menuitem	Shortcut(s)	Meaning
	Disconnect this connection		Disconnects selected client connection
	Zero counters of this connection		Zeros `Request` and `Answer` counters for this connection

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]
	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
[TCP/IP]
	wMaxConcurrentConnectionCount	25	Maximum number of connections made by remote modules
	wLocalTCPPort	3000	Port number, where the remote modules can connect
	127.0.0.1	Allowed	Clients from machine with this IP address can connect to this module. This section may contain more 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.
[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	True	Allows using fixed UIDs in SNMP traps

Logging

The GyUSSDGw_X module creates daily logfiles about its working. The name of the logfile is "GyUSSDGw_X_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

SNMP trap list

Traps can be forwarded to an SNMP Trap Manager by the Sga-Trapper module

.

UID Type Text Remarks To Do
If bAlternateTrapUID is set to TRUE
9 CEA 'GyUSSDGw_X v0.90' module is started. Send a welcome message; indication of module start-up
9 CRI 'GyUSSDGw_X v0.90' module has been shut down by operator. Send a farewell warning message; indication of module shut-down Start the 'GyUSSDGw_X v0.90' module
0 INF GyX: Connection to remote module established. When GyX connection is up first
99 CEA GyX: Connection to remote module established.
99 CRI GyX: Connection to remote module is lost. Check the state of GyX module.
If bAlternateTrapUID is set to FALSE
0 INF 'GyUSSDGw_X v0.90' module is started. Send a welcome message; indication of module start-up
0 WAR 'GyUSSDGw_X v0.90' module has been shut down by operator. Send a farewell warning message; indication of module shut-down Start the 'GyUSSDGw_X v0.90' module
++N INF GyX: Connection to remote module established. When GyX connection is up first
++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

UID	Type	Text	Remarks	To Do
If `bAlternateTrapUID` is set to TRUE
9	CEA	`'GyUSSDGw_X v0.90' module is started.`	Send a welcome message; indication of module start-up
9	CRI	`'GyUSSDGw_X v0.90' module has been shut down by operator.`	Send a farewell warning message; indication of module shut-down	Start the `'GyUSSDGw_X v0.90'` module
0	INF	`GyX: Connection to remote module established.`	When GyX connection is up first
99	CEA	`GyX: Connection to remote module established.`
99	CRI	`GyX: Connection to remote module is lost.`		Check the state of GyX module.
If `bAlternateTrapUID` is set to FALSE
0	INF	`'GyUSSDGw_X v0.90' module is started.`	Send a welcome message; indication of module start-up
0	WAR	`'GyUSSDGw_X v0.90' module has been shut down by operator.`	Send a farewell warning message; indication of module shut-down	Start the 'GyUSSDGw_X v0.90' module
++N	INF	`GyX: Connection to remote module established.`	When GyX connection is up first
++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

Version history

v0.90

(n) Brand new version for SigTran.

The USSD Gateway module - SigTran version("GyUSSDGw_X")