AITIA International, Inc.	SIPCall CDR Assembler module	SIPCallAssembler

SIPCall CDR Assembler module
`("SIPCallAssembler")`

Features

SIPCallAssembler is a CDR (Call Data Record) generator module, based on preprocessed SIP (Session Initiation Protocol) messages.
The results could be categorized as "Normal" and "Conference" records. The "Normal" records contain only one call session information. The "Conference" records contain information about the conference setup procedures, and about the invited users into the conferenc call.
The software is able to receive preprocessed SIP messages from the SIPAssembler module, through TCP-based input connection.
The output of the SIPCallAssembler module is also a TCP connection, which connects to the CDRWriter module. The CDRWriter module produces the Sga-system compatible record files.

User interface

The main menu

Menu	Menuitem	Meaning
[File]
	Load state	Load internal states from a previously saved state file.
	Save state	Save internal states to file.
	Log counters	Write counters to log view, into a new line.
	Save counters	Save counters to file.
	Exit	Exit program
Tools
	Start Processing	Start the operation of the module.
	Stop Processing	Stop the operation of the module.
	Clear state	Reset internal states to initial value.
	Flush state	Send messages to output channels from internal buffers.
	Clear counters	Reset counters to 0.
	Settings	Set ini file settings from menu.
	Save settings	Write the current settings into the ini file.
Help
	About	About the Software

Multiple views

SIPCallAssembler has 4 views:

Log
SIPCallAssembler task
Connections
Terminal

"Log" view

If we start the software, the Log view is the default window.
The log level can be set through a drop-down list, the default value is defined in the ini file. If the ini file does not exist (first-start without ini file), the default value is "Normal".
To search in the log entries, there is a text-field next to the drop-down list. The next button applies the text search and shows the next match.

Each entry has a category, which is represented by the following icons:

Information about the operation
Warning: probably unplanned event occurred
Error: unplanned error during operation

"SIPCallAssembler task" view

The "SIPCallAssembler task" window represents call statistics and record opening/closing reason related counters. There are four sections:

Call Statistics
General
Written CDR Statistics

Counters in "Call Statistics" section:

Active calls upstream/downstream: Number of currently active calls, differentiated by the link direction
Active conference calls upstream/downstream: Number of currently active conference calls, differentiated by the link direction

Counters in "General" section:

Current message time: time stamp of the last processed message.
Incoming messages: Number of processed SIP messages.

Counters in "Written CDR Statistics" section:
This section contains the number of closed records, differentiated by the opening and closing reasons. The type of the record (i.e. normal/conference) is also a category factor.

"Connections" view

The "Connections" window shows the current input and output connections. Connections can be configured in the ini file, or in the "Connections" windows. After closing the software, the opened connections are saved to the ini file.

To open an input connection, type one from Connection's URI scheme in the text field, and left click to "Open" button:
To close the incomming or outgoing connection, click on the "Close" button.

Each connection has a statistic counter set.

Counters in an incomming connection: (outgoing connection counters are same)

Channel name: name of the opened connection.
Channel state: state of the connection (Opening, Opened, Suspended).
Channel resource: path to the output module, or the incoming message path.
I/O CPU load: load of the processor core
Formatter CPU load:
Incoming bytes: summarized bytes, which are received/sent.
Incoming messages: summarized number of received sga items.
Buffered messages: number of incoming messages, which are stored in an internal buffer.
Disordered messages: the count of disordered messages.
Dropped messages: the count of dropped messages.
Ill formed messages: the count of Ill formed messages.

Configuration (`SIPAssembler.ini`) file settings

Section	Entry	Example	Meaning
[Counters]
	ClearOnWrite	false	Clear counters after history file written
	HistoryFile	D:\Counters\sipcallassembler.csv	The path of the counter history file.
	HistoryPeriod	15	The counter history file writing period in minutes.
[Input]
	Input definitions. Please visit Connection's URI scheme.	sipassembler=socket-adg://127.0.0.1:4005?listen=1
	RestoreChannels	1	Restores the active channels after restart
	SortingQueueDelay	0	The sorting queue delay in milliseconds
	SortingQueueLength	0	The maximum size of the sorting queue
	SynchronizedIO	0	The input and the output channels will be synchronized
[Log]			Logging related parameters
	LogDetailLevel	1	Stored level for Log message filter. {0-Off,1-Normal,2-Detailed,3-Debug}
	LogFilesPath	d:\LogFiles	Directory used for storing log files.
[Output]			Other output definitions. Please visit Connection's URI scheme.
	RestoreChannels	1	Restores the active channels after restart
	SortingQueueDelay	0	The sorting queue delay in milliseconds
	SortingQueueLength	0	The maximum size of the sorting queue
[RemoteUI]
	TCPHost	127.0.0.1	IP Address for command interface.
	TCPPort	16001	Port for command interface.
[State]
	AutoStart	false	The initial state of the processing
	StateFile	d:\StateFiles\sipcallassembler.state	The path of the state file.
[SIPCallAssembler]
	CallTimeout	10	Call is timed out if no message is received in that many seconds.
	StatWritingTime	15	Stats are written to file in the given intervals.
	CallClosePendingTimeout	500	Call is closed after the given time after TransactionClose event if not reopened.
	StatFilePath	D:\Counters\sipcallstats.csv	Stats are written to this file.
	CounterHistoryFile	d:\StatFiles	Path for the counter statistics file (.csv format).
	WriteCDRToText	0	Write CDR Data to text file.
	StatWritingTimeout	15	Stats are written to file in the given intervals.

Connection's URI scheme

SIPCallAssembler module is able to operate with the following URI-like format:

socket-adg://IPAddress:TCPPort
socket-adg://IPAddress:TCPPort?listen=1
mufi-sga://path\__DATE__.SgaMon\SgaMon__TIME__.sga?mufi=path\Sga-7700&fileheader=false

Version history

v1.1.2

(n) Added call timeout handling
(f) Fixed link names on CDR output

v1.1.1

(c) Interface between sipasm and SIPCallAssembler changed (cause link name attachment)
(f) Fixed empty connection handling

v1.1.0

v1.0.1

(f) Call deletion was missing after call timeout (redmine #1092)

v1.0.0

(f) Special (iOS 14.2) conference call caused incomplete session (and SEH error) (partly redmine #1058)

v0.9.9

(f) Missing/invalid pointer caused frequent SEH error (redmine #1026 and partly redmine #1058)

v0.9.8

First official release

v0.9.4

Pre release version

SIPCall CDR Assembler module("SIPCallAssembler")