Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The file consists of a [Type] and [Options] section required to pre-process the data before it is usable, and a [CallTypes] section which holds the information necessary to extract the call record components from the raw data.

 

 

 

HTML
<p>A template file is a set of instructions telling the system how to
extract the necessary information from the data that is sent from
your PABX (or PABXs).</p>

<p>A sample template is shown here to demonstrate its use.  This example
is not a complete template and should not be used:</p>
Code Block
themeEclipse
'IPBX Demo Template
'Created 13 May 2001
'at 20:14 by JOHNSMITH

Type = TEXT

[Options]

HeaderLike = " DATE ##-???-##*"
HeaderTake = "      xxxxxxxxx"

[CallTypes]

'Outgoing Direct
##-???-## ##:##:## 		???#:##   ###  
aa bbb cc  dd ee ff 	hhhh ii   jjj  
1
HTML
<p>The file consists of a <span class="keyword">Type</span>, any <span class="keyword">Options</span> required to pre-process the data before it is useable, and a <span class="keyword">CallTypes</span> section which holds the information necessary to extract the various call record components from the raw data.</p>

<h2>[Type] Section</h2>

<p>This describes how the information is presented to the software.  This can be one of the following:</p>

<table class="confluenceTable">
	<tbody>
		<tr>
			<th class="confluenceTh">Type</th>
			<th class="confluenceTh">Description</th>
		</tr>
		<tr>
			<td class="confluenceTd"><b>TEXT</b></td>
			<td class="confluenceTd">Denotes that the data consists of plain text subscribing to the ASCII standard.</td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>BCD2.4</b></td>
			<td class="confluenceTd">Binary-coded Decimal values, such as the proprietary format used in the Siemens Realitis PBX.</td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>EXTERNAL</b></td>
			<td class="confluenceTd">Informs the system that the data needs to be passed to another separate application before processing is possible.

<p>This setting also requires the path to the external application to be supplied in the <span class="keyword">[Options]</span> section under the key name <span class="keyword">ExtPPFilename</span>.</p></td>
		</tr>
	</tbody>
</table>


<h2>[Options] Section</h2>

<p>This section contains the various settings to determine what (if any) pre-processing of the raw data is necessary before the individual call record elements can be extracted. Possible options are as follows:</p>

<table class="confluenceTable">
	<tbody>
		<tr>
			<th class="confluenceTh">Option</th>
			<th class="confluenceTh">Description</th>
			<th class="confluenceTh" width=100>Default value</th>
		</tr>
		<tr>
			<td class="confluenceTd"><b>EndTime</b></td>
			<td class="confluenceTd">Informs the call processor that the call time specified is actually the time that the call ended.  This ensures that the duration of the call is subtracted from the given call time to achieve the effect of start time.  All call data stored in the call database assumes that the call time is the time that the call started, not ended.</td>
			<td class="confluenceTd"><span class="keyword">true</span> or <span class="keyword">false</span></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>SubtractAnswerTime</b></td>
			<td class="confluenceTd">Tells the call processor to subtract the answer time from the call's duration.  Use this if the duration of a call includes the answer (or response) time, and you don't want it to.</td>
			<td class="confluenceTd"><span class="keyword">true</span> or <span class="keyword">false</span></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>AddAnswerTime</b></td>
			<td class="confluenceTd">Similar to above, but tells the call processor to add the answer (or response) time to the call duration, if the PBX doesn't include it already.</td>
			<td class="confluenceTd"><span class="keyword">true</span> or <span class="keyword">false</span></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>StartEndDuration</b></td>
			<td class="confluenceTd">This is used when a PBX outputs the call start time and the call end time separately, but issues no duration time.  Because the system requires a call duration, you quote the end time as though it were the duration.  This option then instructs the system to subtract the value specified for call time (elements d, e and f) from the value specified for duration (elements g, h and i) to achieve the correct duration.</td>
			<td class="confluenceTd"><span class="keyword">true</span> or <span class="keyword">false</span></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>Lines</b></td>
			<td class="confluenceTd">Informs the system how many lines make up a call record.  Requires the <span class="keyword">Line1</span> option in order to know how to recognise the first line of a call record.  The pre-processor will then amalgamate all lines of a call record into a single line.</td>
			<td class="confluenceTd"></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>Line1</b></td>
			<td class="confluenceTd">Shows the system how to identify the first line of a call record.  The system then knows how many further lines are necessary before the amalgamation occurs (see <span class="keyword">Lines</span> option, above).</td>
			<td class="confluenceTd"></td>
		</tr>
	</tbody>
</table>


<h2>[CallTypes] Section</h2>

<p>This section contains descriptions for each type
of call - eg. outgoing, incoming answered, incoming abandoned, etc.
- including what that type of call 'looks' like (how the system
identifies a line of PBX data as such), how to extract the call
record elements from the line, and finally a code that pertains to
the particular type of call.</p>

<p>Each type of call consists of three lines (excluding comments), for example:</p>

...

themeEclipse

[Type] Section

This describes how the information is presented to the software. Possible options are described below:

TypeDescription
TEXTDenotes that the data consists of plain text subscribing to the ASCII standard.
BCD2.4Binary-coded decimal values, such as the proprietary format used in the Siemens Realitis PBX.
EXTERNALInforms the system that the data needs to be passed to another separate application before the processing is possible. The path to the external application must be supplied as well in the  [Options] section under the key name ExtPPFilename.

[Options] Section

This section contains the settings necessary to determine what data pre-processing is required - if any- before the individual call record elements can be extracted. Possible options are described below:

OptionDescriptionDefault value
EndTimeInforms the call processor that the call time specified is actually the time that the call ended. This ensures that the duration of the call is subtracted from the given call time to achieve the effect of the start time. All call data stored in the database assumes that the call time is the time that the call started, not ended.true or false
SubtractAnswerTimeNotifies the call processor to subtract the answer (response) time from the call duration. Use this option if the duration of a call includes the response time.true or false
AddAnswerTimeNotifies the call processor to add the answer (response) time to the call duration, if not outputted by the PBX already.true or false
StartEndDurationThis option is used when a PBX outputs the call's start and end time separately, but no duration time. As the system requires a call duration, the end time will appears as the duration, in which case this option will instruct the system to subtract the value specified for call time (elements d, e and f) from the value specified for duration (elements g, h and i), in order to achieve the correct duration.true or false
LinesInforms the system how many lines make up a call record. Requires the Line1 option in order to know how to recognise the first line of a call record. The pre-processor will then amalgamate all lines of a call record into a single line. 
Line1Instructs the system how to identify the first line of a call record, whereafter the system knows how many further lines are necessary before the amalgamation occurs (see Lines option, above). 

[CallTypes] Section

This section contains information about how the system identifies each line of call logging data, in terms of its call type, e.g. outgoing, incoming, etc, and how to extract the call record elements from the each line. Each call type is being assigned a code, which is then used to identify each line of data with a particular type of call.

Each type of call consists of three lines of data, as shown below:

<p>The first line (<span class="keyword">##
Code Block
'Outgoing Direct Dial
##-???-##  ##:##:##             ???#:##   ###   ###   ####?????????????????????????????????##*
aa bbb cc  dd ee ff             hhhh ii   jjj   mmm   kllllllllllllllll
1
HTML
First line
SymbolDescription
##-???-##

...

##:##:

...

##The match line,

...

which

...

informs the

...

system

...

how

...

to

...

match

...

this

...

particular

...

call

...

type
#Indicates any digit between 0 and 9
?Indicates any character including letters and numbers
*Indicates that any character or number of characters further on that line are ignored
Second line
SymbolDescription
aa bbb cc dd ee ffInforms the system how to extract each call record element from the line of data
aaSpans the first two characters of the data line meaning that the call date's day should be taken from here;
bbbSpans three characters starting at column 4, showing where the month is taken from.
Third line

The third line contains the code associated with the type of call. These call type numbers are internally used to identify the call type, as follows:

Call Type #Type of Call
1Outgoing direct dialled
2Outgoing failed to connect
7Mobile call
8Mobile SMS
50Outgoing transferred
100Answered direct dialled
101Answered transferred
150Abandoned direct dialled
151Abandoned transferred
200Internal call
300Feature call (dialled number should contain the feature number)
400Tandem Call
500Event types sent to CTI server