AITIA ESR Logic - Emergency call notifier Sga-ESR-Logic

The ESR Logic module
("Sga-ESR-Logic")

Table of Contents

Features

Minimum operational requirements

User interface

The main menu

Menu Menuitem Shortcut(s) Meaning
File      
  Reload macro cell info file   Reload macro cell info file specified in INI/[Advanced]/sMacroCellInfoFile
  Reload femto cell info file   Reload femto cell info file specified in INI/[Advanced]/sFemtoCellInfoFile
  Reload eutran cell info file   Reload eutran cell info file specified in INI/[Advanced]/sEutranCellInfoFile
  Reload IMSI2SK table file   Reload IMSI-to-SK table file specified in INI/[Advanced]/sIMSI2SKTableFile
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      
  Enable PSL query Enables VLR look up for coordinates
  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
  Show log Ctrl-Tab, Ctrl-Shift-Tab Shows log screen
  Show location request queue Ctrl-Tab, Ctrl-Shift-Tab Shows processing status of current call notifications
  Save settings   Saves actual settings into the configuration (INI) file

The status windows

Details of request queue window

CDR generation

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

Data files

The ESR-Logic module requires 4 CSV files for the correct operation: a macro cell info file, a femto cell info file, an eutran cell info file and an IMSI-to-SK conversion table file. These files are loaded on module start, and later automatically every day at the preset time, or manually by user request in the menu.

When a data file is loaded, a log file is created. The log file has the name '<data_file_name>.log'.

When a data file set in the INI / [Advanced] / sXXXFile could be loaded successfully then the file is backed-up (copied) to a file named as '<data_file_name>.bak'.

If the data file could not be loaded then the SNMP trap error 'Could not load the most recent XXX file' is generated and the back-up file '<data_file_name>.bak' is loaded. If the back-up files could not be loaded either then the SNMP trap error 'Could not load the backup XXX file' is generated.

The SNMP trap error 'The [macro|femto|eutran] cell info file is out of date' is generated when any of the last loaded cell info files has a date older than specified in the INI file ([CellInfo]/wMaxAgedays).

The format of the files is CSV, where the separator character is actually a semicolon.

Macro cell info file

Each line consists of the following fields:

LAC;CI;coord_X;coord_Y;startAngle;stopAngle;inRadius;outRadius

Femto cell info file

Each line consists of the following fields:

LAC;CI;Address_line1;Address_line2;Address_line3;Address_line4;postcode

E-UTRAN cell info file

Each line consists of the following fields:

TAC;ECI;coord_X;coord_Y;startAngle;stopAngle;inRadius;outRadius

IMSI-to-SK table file

Each line consists of the following fields:

IMSI_prefix;SK

The table is searched linearly from top to bottom, i.e. the first matching IMSI_prefix is considered as the search result.

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!)
  bEnablePSLquery True (Refer to the [Options]/Enable PSL query menuitem!)
[Advanced]      
  wLogDetailLevel 3 (Equals to the listed order; refer to the corresponding menuitem!)
  dwMaxLinesInLogWindow 1000 Number of lines in the log window on screen
  sLogFilesPath C:\Sga-ESR-Logic\LogFiles Path for the log files
  sHTTPLogFilesPath C:\Sga-ESR-Logic\LogFiles Path for the HTTP log files
  sTrapFilesPath C:\Sga-ESR-Logic\TrapFiles Path for the SNMP Trap files to be sent
  sCDRFilesPath C:\Sga-ESR-Logic\CDRFiles Path for the Call Data Record files. This entry is optional: CDR is not generated when the entry is not present.
  sCDRColumnDelimiter ; Delimiter character between values in the CDR
  sMacroCellInfoFile C:\Sga-ESR-Logic\DataFiles\Macro_cell_info.csv Path for the Macro Cell Info file
  sFemtoCellInfoFile C:\Sga-ESR-Logic\DataFiles\Femto_cell_info.csv Path for the Femto Cell Info file
  sEutranCellInfoFile C:\Sga-ESR-Logic\DataFiles\Eutran_cell_info.csv Path for the Macro Cell Info file
  sIMSI2SKTableFile C:\Sga-ESR-Logic\DataFiles\IMSI2SK_table.csv Path for the IMSI-to-SK table file
  bAlternateTrapUID False Allows using fixed UIDs in SNMP traps (See SNMP trap list below for details)
[ESR_SS7]      
  sRemoteIPAddress 127.0.0.1 IP address of Sga-ESR_SS7 module
  wRemoteTCPPort 9068 TCP port where Sga-ESR_SS7 module listens
[ESR_SIP]      
  sRemoteIPAddress 127.0.0.1 IP address of Sga-ESR_SIP module
  wRemoteTCPPort 9068 TCP port where Sga-ESR_SIP module listens
[ESR_SIP2] Optional settings    
  sRemoteIPAddress 127.0.0.1 IP address of the test Sga-ESR_SIP module
  wRemoteTCPPort 9068 TCP port where the test Sga-ESR_SIP module listens
[PSLquery]      
  sRemoteIPAddress 127.0.0.1 IP address of Sga-PSLquery module
  wRemoteTCPPort 9069 TCP port where the query module listens
  wPSLqueryTimeOutMsec 5000 Time out value for PSL requests
[CellInfo]      
  sLoadAtTime 22:00 Reload the cell info files every day at the specified time. Format: HH:MM in local time
  wMaxAgeDays 8 Maximum age of cell info files in days. An SNMP trap message is generated if either of the two cell info files are older than specified here.
[ESR]      
  dwSK 926 Service provider identifier code value for outgoing SOAP content ('sk_d' value). This SK is also used as the 'sk_s' value in case SK of the subscriber could not be derived from the SK list (e.g. for inbound roamers).
  sReportURL1 http://10.20.30.40:8080/ESR112TelephonyService Defines the first target HTTP/SOAP service address and port. This entry is optional if sReportURL2 is set.
Server can be defined by its IP address or a domain name.
Both 'http://' and 'https://' are applicable (for plain and secure HTTP).
  sReportURL2 http://report.server.hu:8080/ESR112TelephonyService Defines the second target HTTP/SOAP service address and port. This entry is optional if sReportURL1 is set.
Server can be defined by its IP address or a domain name.
Both 'http://' and 'https://' are applicable (for plain and secure HTTP).
  wMaxLocRequests 100 Number of maximum number of concurrent location requests (PSL and HTTP requests altogether)
  wHTTPRequestTimeOutMsec 5000 Time out value for HTTP/SOAP requests
  wHTTPMaxTries 2 Defines how many times the module attempts to send a HTTP request
  wHTTPRetryDelayMsec 5000 Defines the interval between HTTP attempts during retrials
  sVoWifiPushText VoWifi hívás SOAP request will contain this text with the IP address and the port number of the user equipment
[SSL]      
  sServerCertFile CertFiles\server-cert.pem Points to a file with the server certificates. This entry is optional.
  sClientCertFile CertFiles\client.pem Points to a file with the client certificate. This entry is optional, expcept when sClientKeyFile is set.
  sClientKeyFile CertFiles\client.pem Points to a file with the client key. This can be the same file as given in sClientCertFile. This entry is optional, expcept when sClientCertFile is set.
  sClientPrivateKeyPassword password Stores the password for the client key. This entry is optional.

Built-in limitations

Program termination

To quit the module gracefully, press the 'Close' button or Alt+F4 keys once, confirm the quit request and wait until the message box with the text 'Ready to quit' appears.

To quit the module immediately press and confirm 'Close' twice. In this case the pending call notifications will be lost.

SNMP trap list

UID Type Text Remarks To Do
If bAlternateTrapUID is set to TRUE
5000 CEA 'Sga-ESR-Logic v1.11' module is started. Send a welcome message; indication of module start-up  
5000 CRI 'Sga-ESR-Logic v1.11' module has been shut down by operator. Send a farewell warning message; indication of module shut-down Start the 'Sga-ESR-Logic v1.11' module
0 INF Connection to 'Sga-ESR_SS7' module is up.    
5001 CRI/CEA Connection to 'Sga-ESR_SS7' module has died. CRI on the connection has died, CEA on it has been restored
Check if the IP connection between the 'Sga-ESR-Logic' and the 'Sga-ESR_SS7' modules is correct or if the module 'Sga-ESR_SS7' is alive
0 INF Connection to 'Sga-PSLquery' module is up.    
5002 CRI/CEA Connection to 'Sga-PSLquery' module has died. CRI on the connection has died, CEA on it has been restored
Check if the IP connection between the 'Sga-ESR-Logic' and the 'Sga-PSLquery' modules is correct or if the module 'Sga-PSLquery' is alive
0 INF Connection to 'Sga-ESR_SIP' module is up.    
5003 CRI/CEA Connection to 'Sga-ESR_SIP' module has died. CRI on the connection has died, CEA on it has been restored
Check if the IP connection between the 'Sga-ESR-Logic' and the 'Sga-ESR_SIP' modules is correct or if the module 'Sga-ESR_SIP' is alive
5010 ERR Call notif from 'nnn' dropped: bad locNum: 'NNNN'. ERR on a badly formatted location number. Check network settings whether the location number contains exactly 10 digits.
5011 ERR Call notif from 'nnn' dropped: Unknown LAC/CI (XXX/YYY). ERR on a LAC/CI which is not in either of the cell info DBs. Check if the databases are up to date.
5012 ERR Call notif from 'nnn' dropped: SOAP request failed. ERR on an unsuccessful HTTP/SOAP request attempt. Check whether the server and the SOAP service are available.
5014 ERR Call notif from 'nnn' dropped: Unknown ECI (YYY). ERR on an ECI which is not in the eutran cell info DB. Check if the database is up to date.
5020 ERR/CEA Could not load the most recent macro cell info file. ERR on the most recent file could not be loaded, CEA on the most recent file has been loaded
Check if the macro cell info file is present, if it is valid and if the corresponding INI file settings are correct
5021 CRI/CEA Could not load the backup macro cell info file. CRI on nor the most recent neither the backup macro cell file could be loaded, CEA on the most recent or the backup file has been loaded
Check if the macro cell info file is present, if it is valid and if the corresponding INI file settings are correct
5022 ERR/CEA The macro cell info file is out of date. ERR on the file is out of date, CEA on the file has been replaced with a current one
Check if the cell macro info file is younger than [CellInfo] / wMaxAgeDays
5030 ERR/CEA Could not load the most recent femto cell info file. ERR on the most recent file could not be loaded, CEA on the most recent file has been loaded
Check if the femto cell info file is present, if it is valid and if the corresponding INI file settings are correct
5031 CRI/CEA Could not load the backup femto cell info file. CRI on nor the most recent neither the backup femto cell file could be loaded, CEA on the most recent or the backup file has been loaded
Check if the femto cell info file is present, if it is valid and if the corresponding INI file settings are correct
5032 ERR/CEA The femto cell info file is out of date. ERR on the file is out of date, CEA on the file has been replaced with a current one
Check if the cell femto info file is younger than [CellInfo] / wMaxAgeDays
5040 ERR/CEA Could not load the most recent IMSI2SK table file. ERR on the most recent file could not be loaded, CEA on the most recent file has been loaded
Check if the IMSI2SK table file is present, if it is valid and if the corresponding INI file settings are correct
5041 CRI/CEA Could not load the backup IMSI2SK table file. CRI on nor the most recent neither the backup femto cell file could be loaded, CEA on the most recent or the backup file has been loaded
Check if the IMSI2SK table file is present, if it is valid and if the corresponding INI file settings are correct
5050 ERR/CEA Could not load the most recent eutran cell info file. ERR on the most recent file could not be loaded, CEA on the most recent file has been loaded
Check if the eutran cell info file is present, if it is valid and if the corresponding INI file settings are correct
5051 CRI/CEA Could not load the backup eutran cell info file. CRI on nor the most recent neither the backup eutran cell file could be loaded, CEA on the most recent or the backup file has been loaded
Check if the eutran cell info file is present, if it is valid and if the corresponding INI file settings are correct
5052 ERR/CEA The eutran cell info file is out of date. ERR on the file is out of date, CEA on the file has been replaced with a current one
Check if the cell eutran info file is younger than [CellInfo] / wMaxAgeDays
If bAlternateTrapUID is set to FALSE
0 INF 'Sga-ESR-Logic v1.11' module is started. Send a welcome message; indication of module start-up  
0 WAR 'Sga-ESR-Logic v1.11' module has been shut down by operator. Send a farewell warning message; indication of module shut-down Start the 'Sga-ESR-Logic v1.11' module
0 INF Connection to 'Sga-ESR_SS7' module is up.    
++N CRI Connection to 'Sga-ESR_SS7' module has died. CRI on the connection has died, CEA on it has been restored
Check if the IP connection between the 'Sga-ESR-Logic' and the 'Sga-ESR_SS7' modules is correct or if the module 'Sga-ESR_SS7' is alive
N CEA Connection to 'Sga-ESR_SS7' module has died. Connection to 'Sga-ESR_SS7' module is up after a down
 
0 INF Connection to 'Sga-ESR_SIP' module is up.    
++N CRI Connection to 'Sga-ESR_SIP' module has died. CRI on the connection has died, CEA on it has been restored
Check if the IP connection between the 'Sga-ESR-Logic' and the 'Sga-ESR_SIP' modules is correct or if the module 'Sga-ESR_SIP' is alive
N CEA Connection to 'Sga-ESR_SIP' module has died. Connection to 'Sga-ESR_SIP' module is up after a down
 
0 INF Connection to 'Sga-PSLquery' module is up.    
++N CRI Connection to 'Sga-PSLquery' module has died. CRI on the connection has died, CEA on it has been restored
Check if the IP connection between the 'Sga-ESR-Logic' and the 'Sga-PSLquery' modules is correct or if the module 'Sga-PSLquery' is alive
N CEA Connection to 'Sga-PSLquery' module has died. Connection to 'Sga-PSLquery' module is up after a down
 
++N ERR Call notif from 'nnn' dropped: bad locNum: 'NNNN'. ERR on a badly formatted location number. Check network settings whether the location number contains exactly 10 digits.
++N ERR Call notif from 'nnn' dropped: Unknown LAC/CI (XXX/YYY). ERR on a LAC/CI which is not in either of the cell info DBs. Check if the databases are up to date.
++N ERR Call notif from 'nnn' dropped: Unknown ECI (YYY). ERR on a ECI which is not in the eutran cell info DB. Check if the database is up to date.
++N ERR Call notif from 'nnn' dropped: SOAP request failed. ERR on an unsuccessful HTTP/SOAP request attempt. Check whether the server and the SOAP service are available.
++N ERR/CEA Could not load the most recent macro cell info file. ERR on the most recent file could not be loaded, CEA on the most recent file has been loaded
Check if the macro cell info file is present, if it is valid and if the corresponding INI file settings are correct
++N CRI/CEA Could not load the backup macro cell info file. CRI on nor the most recent neither the backup macro cell file could be loaded, CEA on the most recent or the backup file has been loaded
Check if the macro cell info file is present, if it is valid and if the corresponding INI file settings are correct
++N ERR/CEA The macro cell info file is out of date. ERR on the file is out of date, CEA on the file has been replaced with a current one
Check if the cell macro info file is younger than [CellInfo] / wMaxAgeDays
++N ERR/CEA Could not load the most recent femto cell info file. ERR on the most recent file could not be loaded, CEA on the most recent file has been loaded
Check if the femto cell info file is present, if it is valid and if the corresponding INI file settings are correct
++N CRI/CEA Could not load the backup femto cell info file. CRI on nor the most recent neither the backup femto cell file could be loaded, CEA on the most recent or the backup file has been loaded
Check if the femto cell info file is present, if it is valid and if the corresponding INI file settings are correct
++N ERR/CEA The femto cell info file is out of date. ERR on the file is out of date, CEA on the file has been replaced with a current one
Check if the cell femto info file is younger than [CellInfo] / wMaxAgeDays
++N ERR/CEA Could not load the most recent IMSI2SK table file. ERR on the most recent file could not be loaded, CEA on the most recent file has been loaded
Check if the IMSI2SK table file is present, if it is valid and if the corresponding INI file settings are correct
++N CRI/CEA Could not load the backup IMSI2SK table file. CRI on nor the most recent neither the backup femto cell file could be loaded, CEA on the most recent or the backup file has been loaded
Check if the IMSI2SK table file is present, if it is valid and if the corresponding INI file settings are correct
++N ERR/CEA Could not load the most recent eutran cell info file. ERR on the most recent file could not be loaded, CEA on the most recent file has been loaded
Check if the eutran cell info file is present, if it is valid and if the corresponding INI file settings are correct
++N CRI/CEA Could not load the backup eutran cell info file. CRI on nor the most recent neither the backup eutran cell file could be loaded, CEA on the most recent or the backup file has been loaded
Check if the eutran cell info file is present, if it is valid and if the corresponding INI file settings are correct
++N ERR/CEA The eutran cell info file is out of date. ERR on the file is out of date, CEA on the file has been replaced with a current one
Check if the cell eutran info file is younger than [CellInfo] / wMaxAgeDays

Version history