View Source

<p>Each report has its own set of parameters, specific to the nature of each one.  However, 
many are common between all reports.</p>

<p>The parameters for each report are now summarised over the next few pages for your convenience.</p>

<table class="confluenceTable">
	<tbody>
		<tr>
			<td class="confluenceTd table_super_header" colspan="3"><b>COMMON PARAMETERS</b></td>
		</tr>
		<tr>
			<th class="confluenceTh" width=120>Parameter</th>
			<th class="confluenceTh">Description</th>
			<th class="confluenceTh">Default value</th>
		</tr>
		<tr>
			<td class="confluenceTd"><b>period</b> <b class="red">*</b></td>
			<td class="confluenceTd">Report period</td>
			<td class="confluenceTd"><no default></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>fromdate</b> <b class="red">*</b></td>
			<td class="confluenceTd">From date</td>
			<td class="confluenceTd"><no default></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>todate</b> <b class="red">*</b></td>
			<td class="confluenceTd">To date</td>
			<td class="confluenceTd"><no default></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>fromtime</b></td>
			<td class="confluenceTd">From time</td>
			<td class="confluenceTd"><no default></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>totime</b></td>
			<td class="confluenceTd">To time</td>
			<td class="confluenceTd"><no default></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>name</b></td>
			<td class="confluenceTd">Report title</td>
			<td class="confluenceTd"></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>width</b></td>
			<td class="confluenceTd">Width of results table (% is provided)</td>
			<td class="confluenceTd"><span class="keyword">100</span></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>site</b></td>
			<td class="confluenceTd">Site to report on</td>
			<td class="confluenceTd">Blank implies all sites</td>
		</tr>

		<tr>
			<td class="confluenceTd table_super_header" colspan="3"><b>CUSTOM REPORT (1)</b></td>
		</tr>
		<tr>
			<th class="confluenceTh" width=120>Parameter</th>
			<th class="confluenceTh">Description</th>
			<th class="confluenceTh">Default value</th>
		</tr>
		<tr>
			<td class="confluenceTd"><b>type</b></td>
			<td class="confluenceTd">Specifies call type from:<br/>
			'outgoing' or 'all outgoing calls'<br/>
			'outgoingx' or 'outgoing transfers'<br/>
			'incoming' or 'all incoming calls'<br/>
			'answered' or 'answered calls'<br/>
			'answeredx' or 'answered transfers'<br/>
			'abandoned' or 'abandoned calls'<br/>
			'abandonedx' or 'abandoned transfers'<br/>
			'internal' or 'internal calls'<br/>
			'feature' or 'pbx feature calls'</td>
			<td class="confluenceTd">Blank implies all call types</td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>fromdurn</b></td>
			<td class="confluenceTd">Duration range start</td>
			<td class="confluenceTd"><no default></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>todurn</b></td>
			<td class="confluenceTd">Duration range end</td>
			<td class="confluenceTd"><no default></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>fromresponse</b></td>
			<td class="confluenceTd">Response time range start</td>
			<td class="confluenceTd"><no default></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>toresponse</b></td>
			<td class="confluenceTd">Response time range end</td>
			<td class="confluenceTd"><no default></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>extension</b></td>
			<td class="confluenceTd">Extension number</td>
			<td class="confluenceTd"><no default></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>fromextn</b></td>
			<td class="confluenceTd">Extension number range start</td>
			<td class="confluenceTd"><no default></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>toextn</b></td>
			<td class="confluenceTd">Extension number range end</td>
			<td class="confluenceTd"><no default></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>extname</b></td>
			<td class="confluenceTd">Extension name</td>
			<td class="confluenceTd"><no default></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>extngroup</b></td>
			<td class="confluenceTd">Extension group</td>
			<td class="confluenceTd"><no default></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>trunk</b></td>
			<td class="confluenceTd">Trunk number</td>
			<td class="confluenceTd"><no default></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>fromtrunk</b></td>
			<td class="confluenceTd">Trunk number range start</td>
			<td class="confluenceTd"><no default></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>totrunk</b></td>
			<td class="confluenceTd">Trunk number range end</td>
			<td class="confluenceTd"><no default></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>trunkname</b></td>
			<td class="confluenceTd">Trunk name</td>
			<td class="confluenceTd"><no default></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>trunkgroup</b></td>
			<td class="confluenceTd">Trunk group</td>
			<td class="confluenceTd"><no default></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>account</b> <b class="red">**</b></td>
			<td class="confluenceTd">Account code match</td>
			<td class="confluenceTd"><no default></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>cli</b> <b class="red">**</b></td>
			<td class="confluenceTd">Caller ID match</td>
			<td class="confluenceTd"><no default></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>accesscode</b></td>
			<td class="confluenceTd">Specifies a trunk access code (eg. 9)</td>
			<td class="confluenceTd"><no default></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>lcr</b></td>
			<td class="confluenceTd">Specifies a Least Cost Route sequence</td>
			<td class="confluenceTd"><no default></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>diallednumber</b> <b class="red">**</b></td>
			<td class="confluenceTd">Dialled number match</td>
			<td class="confluenceTd"><no default></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>destination</b> <b class="red">**</b></td>
			<td class="confluenceTd">Location name match</td>
			<td class="confluenceTd"><no default></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>tariff</b> <b class="red">**</b></td>
			<td class="confluenceTd">Tariff name match</td>
			<td class="confluenceTd"><no default></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>fromcost</b></td>
			<td class="confluenceTd">Cost range start</td>
			<td class="confluenceTd"><no default></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>tocost</b></td>
			<td class="confluenceTd">Cost range end</td>
			<td class="confluenceTd"><no default></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>orderby</b></td>
			<td class="confluenceTd">Specifies field to order result by, from: 'site', 'datetime', 'date', 'time', 'type', 'duration', 'response', 'dayminute', 'dayhalfhour', 'extension', 'extensionname', 'extensiongroup', 'trunk', 'trunkname', 'trunkgroup', 'account', 'cli', 'accesscode', 'lcr', 'diallednumber', 'destination', 'tariff', or 'cost'</td>
			<td class="confluenceTd"><no default></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>sort</b></td>
			<td class="confluenceTd">Specifies direction of sort 'up' or 'down' where 'up' specifies ascending, etc</td>
			<td class="confluenceTd"><span class="keyword">up</span></td>
		</tr>
		<tr>
			<td class="confluenceTd table_super_header" colspan="3"><b>BILLING REPORT (2)</b></td>
		</tr>
		<tr>
			<th class="confluenceTh" width=120>Parameter</th>
			<th class="confluenceTh">Description</th>
			<th class="confluenceTh">Default value</th>
		</tr>
		<tr>
			<td class="confluenceTd"><b>extngroup</b> <b class="red">*</b></td>
			<td class="confluenceTd">Extension Group name</td>
			<td class="confluenceTd"><no default></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>extension</b> <b class="red">*</b></td>
			<td class="confluenceTd">Extension number</td>
			<td class="confluenceTd"><no default></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>accountcode</b> <b class="red">*</b></td>
			<td class="confluenceTd">Account code</td>
			<td class="confluenceTd"><no default></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>markup</b></td>
			<td class="confluenceTd">Markup per call (% is provided)</td>
			<td class="confluenceTd"><span class="keyword">0</span></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>surcharge</b></td>
			<td class="confluenceTd">Surcharge per call (no currency symbol)</td>
			<td class="confluenceTd"><span class="keyword">0</span></td>
		</tr>
		<tr>
			<td class="confluenceTd table_super_header" colspan="3"><b>ORGANISATION DRILL-DOWN (3)</b></td>
		</tr>
		<tr>
			<th class="confluenceTh" width=120>Parameter</th>
			<th class="confluenceTh">Description</th>
			<th class="confluenceTh">Default value</th>
		</tr>
		<tr>
			<td class="confluenceTd"><b>extngroup</b></td>
			<td class="confluenceTd">Extension Group name</td>
			<td class="confluenceTd"><no default></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>live</b></td>
			<td class="confluenceTd">True or False - enables/disables hyperlinks</td>
			<td class="confluenceTd"><span class="keyword">false</span></td>
		</tr>
		<tr>
			<td class="confluenceTd table_super_header" colspan="3"><b>TRUNKS BUSY (4)</b></td>
		</tr>
		<tr>
			<th class="confluenceTh" width=120>Parameter</th>
			<th class="confluenceTh">Description</th>
			<th class="confluenceTh">Default value</th>
		</tr>
		<tr>
			<td class="confluenceTd"><b>trunkgroup</b></td>
			<td class="confluenceTd">Trunk group</td>
			<td class="confluenceTd"><no default></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>trunk</b></td>
			<td class="confluenceTd">Trunk number</td>
			<td class="confluenceTd"><no default></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>diallednumber </b><b class="red">**</b></td>
			<td class="confluenceTd">Dialled number</td>
			<td class="confluenceTd"><span class="keyword">0</span></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>destination</b> <b class="red">**</b></td>
			<td class="confluenceTd">Destination/Place name</td>
			<td class="confluenceTd"><no default></td>
		</tr>
		<tr>
			<td class="confluenceTd table_super_header" colspan="3"><b>CALL GEOGRAPHY ANALYSIS (5)</b></td>
		</tr>
		<tr>
			<th class="confluenceTh" width=120>Parameter</th>
			<th class="confluenceTh">Description</th>
			<th class="confluenceTh">Default value</th>
		</tr>
		<tr>
			<td class="confluenceTd"><b>extension</b></td>
			<td class="confluenceTd">Extension number</td>
			<td class="confluenceTd"><no default></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>extngroup</b></td>
			<td class="confluenceTd">Extension group</td>
			<td class="confluenceTd"><no default></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>trunk</b></td>
			<td class="confluenceTd">Trunk number</td>
			<td class="confluenceTd"><no default></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>trunkgroup</b></td>
			<td class="confluenceTd">Trunk group</td>
			<td class="confluenceTd"><no default></td>
		</tr>
		<tr>
			<td class="confluenceTd table_super_header" colspan="3"><b>TOP X CALLS REPORT (6)</b></td>
		</tr>
		<tr>
			<th class="confluenceTh" width=120>Parameter</th>
			<th class="confluenceTh">Description</th>
			<th class="confluenceTh">Default value</th>
		</tr>
		<tr>
			<td class="confluenceTd"><b>incomingonly</b></td>
			<td class="confluenceTd">True or False - specifies incoming calls only</td>
			<td class="confluenceTd"><no default></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>outgoingonly</b></td>
			<td class="confluenceTd">>True or False - specifies outgoing calls only</td>
			<td class="confluenceTd"><no default></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>extension</b></td>
			<td class="confluenceTd">Extension number</td>
			<td class="confluenceTd"><no default></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>extngroup</b></td>
			<td class="confluenceTd">Extension group</td>
			<td class="confluenceTd"><no default></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>order</b></td>
			<td class="confluenceTd">'duration' or 'cost'</td>
			<td class="confluenceTd"><span class="keyword">cost</span></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>topx</b></td>
			<td class="confluenceTd">Topmost number of calls from selection</td>
			<td class="confluenceTd"><span class="keyword">50</span></td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>live</b></td>
			<td class="confluenceTd">True or False - enables/disables hyperlinks</td>
			<td class="confluenceTd"><span class="keyword">false</span></td>
		</tr>
	</tbody>
</table>

<p><b class="red">* </b>Indicates a mandatory field.</p>
<p><b class="red">** </b>It is provided.</p>