TSP Lab	S1APHARWriter - S1AP location information collector module for HAR system	S1APHARWriter

S1AP location information collector module for HAR system
`("S1APHARWriter")`

Basic operation
Generated HAR events
User interface
Configuration

Basic operation

Processes deciphered and extended S1AP/NAS messages received from NASDecipher module
Creates HAR events files in MUFI format for the current message if it has EUTRAN Cell Identifier, and (valid) IMSI

Generated HAR events

The following HAR events are generated by S1AP and NAS messages

Location Update: S1AP/PathSwitchRequest, S1AP/HandoverNotify, NAS/Tracking area update request, NAS/Tracking area update complete
Attach: NAS/Attach Request, NAS/Attach Complete
Detach: NAS/Detach Request
SMS: NAS/Uplink NAS transport
Data Service: NAS/Service Request header, NAS/Extended Service Request if Service Type = "packet services via S1"
CSFB call: NAS/Extended Service Request if Service Type != "packet services via S1"
Bearer activation (earlier VoLTE Call Initiation): NAS/Activate dedicated EPS bearer context accept
Bearer deactivation (earlier VoLTE Call Termination): NAS/Deactivate EPS bearer context accept
Other: Any other (uplink) NAS messages (eg. NAS/Authentication Response, NAS/Identification Response, Activate default EPS bearer context accept, ...)

User interface

The main menu

Menu	Menuitem	Shortcut(s)	Meaning
[File]		Alt+F
	Log counters		Saves counters into log file
	Save counters		Saves counters into CSV file
	Exit		Exit
[Tools]		Alt+T
	Start processing		Enable data processing
	Stop processing		Disable processing
	Clear counters		Reset counters to zero
	Settings		Set INI file settings from menu
	Save settings		Save current settings into the INI file
[Help]		Alt+H
	Help		Unused
	About		Show information about the program

HAR Writer tab

This tab shows the statistics for the incoming messages/events.

Counters in HARWriter tab

HAR Writer Diagnostics

Current message time: Timestamp of the currently processed message
Processing speed: Ratio of 1 sec message time interval and real time used for its processing.
Mapping errors: Messages with event mapping error
Ignored events (ECI missing): (Dropped) Messages/events without cell information
Ignored events (IMSI missing): (Dropped) Messages/events without IMSI
Missing common info: Missing extended message information on channel
S1AP NAS decoder unknown errors: Messages with non specific decoding error
Unknown EMM security headers: Messages with unknown EMM security header
S1AP NAS decoder valid: NAS messages without decoding error
S1AP NAS incomplete messages: Incomplete NAS messages
S1AP NAS ciphered messages: Ciphered NAS messages
S1AP NAS decoder unsure IMSI: (Dropped) Messages with unsure IMSI
S1AP HAR entries written: All the HAR events written to file

Incoming events

Attach: Number of Attach events / event speed
Detach: Number of Detach events / event speed
Location Update: Number of Location Update events / event speed
Data Service: Number of Service Request events / event speed
Short Message: Number of SMS events / event speed
CSFB Call: Number of CSFB call events / event speed
VoLTE call initiation: Number of Bearer activation (earlier VoLTE call init) events / event speed
VoLTE call termination: Number of Bearer deactivation (earlier VoLTE call end) events / event speed
Other HAR events: Number of Other events / event speed

HAR Writer

Invalid connections: Number of invalid connections

Connections tab

This tab shows the status of communications channels.

This view shows the currently used inputs and outputs. Both input and output can be defined in INI file before starting the program, as well as during operation. Details of connections can be collapsed and expanded using the "expand" triangle button at the right up corner of the connections.

Parts of "Connections" tab

"New connection" button (): opens the 'Create connection' dialogue window
"Recent connections" button (): opens the list of the recently used connections
- "Clear history" button (): clears the recently used connections list
- "Copy list" button (): copies history to clipboard
Connection list: contains defined connections
- Connection state indicator
- "Remove connection" button (): closes and drops the connection (button is active when processing is disabled)
- Details can be collapsed and expanded using the triangle button at the right of the connections.

Connections of S1APHARWriter

Input connection: The input of this module is a TCP connection from the NASDecipher module.

Connection management

A new input connection can be added while processing state is inactive.
An output connection can be added anytime during the operation. Note: S1APHARWriter module does not use any output connection.
A connection
- can be a new one created by pressing the "New connection" button or
- can be added a previously used one from the history list.
Connections can be removed using "Remove connection" button while processing is disabled.

Terminal tab

This tab shows the terminal window where predefined commands can be sent to the HARWriter application.

Configuration (SgaHARWriter.ini) file settings

Section	Entry	Example	Meaning
[Counters]
	ClearOnWrite	0	Clear counters after history file written
	HistoryFile	d:\HARWriter\History	The path of the counter history file
	HistoryPeriod	15	The counter history file writing period in minutes
[Log]
	LogFilesPath	d:\LogFiles	Directory used for storing log files.
	LogDetailLevel	Normal	Stored level for Log message filter. (Off, Normal, Detailed, Debug)
[Input]			Format: <inputname>=<directory>\|<path>\|<ip:port>\|<port>\|<uri>
	RestoreChannels	0	Restores the active channels after restart
	SortingQueueDelay	0	The sorting queue delay in milliseconds
	SortingQueueLength	0	The maximum size of the sorting queue
	StoragePointerFilePath	d:\InputFiles	Path for optional storage pointer files (Sga-7700.xxx)
	SynchronizedIO	0	The input and the output channels will be synchronized (or not)
[Output]			Format: <outputname>=<path>\|<ip:port>\|<port>\|<uri>
	RestoreChannels	0	Restores the active channels after restart
	SortingQueueDelay	0	The sorting queue delay in milliseconds
	SortingQueueLength	0	The maximum size of the sorting queue
[RemoteUI]			Command interface related parameters
	TCPHost	127.0.0.1	IP Address for command interface.
	TCPPort	16000	Port for command interface.
[S1APHARWriterMapping]			S1AP HAR writer entry event code mapping
	ATT_EventCode	50	HAR event code used for Attach events.
	CSFBC_EventCode	51	HAR event code used for CSFB call events.
	DS_EventCode	52	HAR event code used for Data Service events.
	DT_EventCode	53	HAR event code used for Detach events.
	LU_EventCode	54	HAR event code used for Location Update events.
	OT_EventCode	55	HAR event code used for Other events.
	SM_EventCode	56	HAR event code used for SMS events.
	VCI_EventCode	57	HAR event code used for Bearer activation events (earlier VoLTE call initiation).
	VCT_EventCode	58	HAR event code used for Bearer deactivation events (earlier VoLTE call termination).
[S1APHARWriterRuntime]			S1AP HAR writer parameters
	HAROutputBaseName	Sga-9001	Multi file output base name
	HAROutputDir	d:\UTISender\input	Multi file output directory name
	canSplitBlock	0	Multi file output can split block
	maxFileSizeMB	1000	Multi file output file maximum size (MB)
	minFileLifetimeSec	900	Multi file output minimum lifetime (sec)
[State]			State loading/saving related parameters
	AutoStart	0	The initial state of the processing

S1AP location information collector module for HAR system("S1APHARWriter")

Table of Contents