Each report has its own set of parameters, specific to the nature of each one. However, many are common between all reports.
The parameters for each report are now summarised over the next few pages for your convenience.
COMMON PARAMETERS
Parameter | Description | Default value |
---|---|---|
period * | Report period | |
fromdate * | From date | |
todate * | To date | |
fromtime | From time | |
totime | To time | |
name | Report title | |
width | Width of results table (% is provided) | 100 |
site | Site to report on | Blank implies all sites |
CUSTOM REPORT (1)
Parameter | Description | Default value |
---|---|---|
type | Specifies call type from: 'outgoing' or 'all outgoing calls' 'outgoingx' or 'outgoing transfers' 'incoming' or 'all incoming calls' 'answered' or 'answered calls' 'answeredx' or 'answered transfers' 'abandoned' or 'abandoned calls' 'abandonedx' or 'abandoned transfers' 'internal' or 'internal calls' 'feature' or 'pbx feature calls' | Blank implies all call types |
fromdurn | Duration range start | |
todurn | Duration range end | |
fromresponse | Response time range start | |
toresponse | Response time range end | |
extension | Extension number | |
fromextn | Extension number range start | |
toextn | Extension number range end | |
extname | Extension name | |
extngroup | Extension group | |
trunk | Trunk number | |
fromtrunk | Trunk number range start | |
totrunk | Trunk number range end | |
trunkname | Trunk name | |
trunkgroup | Trunk group | |
account ** | Account code match | |
cli ** | Caller ID match | |
accesscode | Specifies a trunk access code (eg. 9) | |
lcr | Specifies a Least Cost Route sequence | |
diallednumber ** | Dialled number match | |
destination ** | Location name match | |
tariff ** | Tariff name match | |
fromcost | Cost range start | |
tocost | Cost range end | |
orderby | 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' | |
sort | Specifies direction of sort 'up' or 'down' where 'up' specifies ascending, etc | up |
BILLING REPORT(2)
Parameter | Description | Default value |
---|---|---|
extngroup * | Extension Group name | |
extension * | Extension number | |
accountcode * | Account code | |
markup | Markup per call (% is provided) | 0 |
surcharge | Surcharge per call (no currency symbol) | 0 |
HTML |
---|
<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" width=240>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"><img class="icon" src="http://www.tri-line.com/common/img/documentation/tim_professional/no_default.png" /></td> </tr> <tr> <td class="confluenceTd"><b>fromdate</b> <b class="red">*</b></td> <td class="confluenceTd">From date</td> <td class="confluenceTd"><img class="icon" src="http://www.tri-line.com/common/img/documentation/tim_professional/no_default.png" /></td> </tr> <tr> <td class="confluenceTd"><b>todate</b> <b class="red">*</b></td> <td class="confluenceTd">To date</td> <td class="confluenceTd"><img class="icon" src="http://www.tri-line.com/common/img/documentation/tim_professional/no_default.png" /></td> </tr> <tr> <td class="confluenceTd"><b>fromtime</b></td> <td class="confluenceTd">From time</td> <td class="confluenceTd"><img class="icon" src="http://www.tri-line.com/common/img/documentation/tim_professional/no_default.png" /></td> </tr> <tr> <td class="confluenceTd"><b>totime</b></td> <td class="confluenceTd">To time</td> <td class="confluenceTd"><img class="icon" src="http://www.tri-line.com/common/img/documentation/tim_professional/no_default.png" /></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"><img class="icon" src="http://www.tri-line.com/common/img/documentation/tim_professional/no_default.png" /></td> </tr> <tr> <td class="confluenceTd"><b>todurn</b></td> <td class="confluenceTd">Duration range end</td> <td class="confluenceTd"><img class="icon" src="http://www.tri-line.com/common/img/documentation/tim_professional/no_default.png" /></td> </tr> <tr> <td class="confluenceTd"><b>fromresponse</b></td> <td class="confluenceTd">Response time range start</td> <td class="confluenceTd"><img class="icon" src="http://www.tri-line.com/common/img/documentation/tim_professional/no_default.png" /></td> </tr> <tr> <td class="confluenceTd"><b>toresponse</b></td> <td class="confluenceTd">Response time range end</td> <td class="confluenceTd"><img class="icon" src="http://www.tri-line.com/common/img/documentation/tim_professional/no_default.png" /></td> </tr> <tr> <td class="confluenceTd"><b>extension</b></td> <td class="confluenceTd">Extension number</td> <td class="confluenceTd"><img class="icon" src="http://www.tri-line.com/common/img/documentation/tim_professional/no_default.png" /></td> </tr> <tr> <td class="confluenceTd"><b>fromextn</b></td> <td class="confluenceTd">Extension number range start</td> <td class="confluenceTd"><img class="icon" src="http://www.tri-line.com/common/img/documentation/tim_professional/no_default.png" /></td> </tr> <tr> <td class="confluenceTd"><b>toextn</b></td> <td class="confluenceTd">Extension number range end</td> <td class="confluenceTd"><img class="icon" src="http://www.tri-line.com/common/img/documentation/tim_professional/no_default.png" /></td> </tr> <tr> <td class="confluenceTd"><b>extname</b></td> <td class="confluenceTd">Extension name</td> <td class="confluenceTd"><img class="icon" src="http://www.tri-line.com/common/img/documentation/tim_professional/no_default.png" /></td> </tr> <tr> <td class="confluenceTd"><b>extngroup</b></td> <td class="confluenceTd">Extension group</td> <td class="confluenceTd"><img class="icon" src="http://www.tri-line.com/common/img/documentation/tim_professional/no_default.png" /></td> </tr> <tr> <td class="confluenceTd"><b>trunk</b></td> <td class="confluenceTd">Trunk number</td> <td class="confluenceTd"><img class="icon" src="http://www.tri-line.com/common/img/documentation/tim_professional/no_default.png" /></td> </tr> <tr> <td class="confluenceTd"><b>fromtrunk</b></td> <td class="confluenceTd">Trunk number range start</td> <td class="confluenceTd"><img class="icon" src="http://www.tri-line.com/common/img/documentation/tim_professional/no_default.png" /></td> </tr> <tr> <td class="confluenceTd"><b>totrunk</b></td> <td class="confluenceTd">Trunk number range end</td> <td class="confluenceTd"><img class="icon" src="http://www.tri-line.com/common/img/documentation/tim_professional/no_default.png" /></td> </tr> <tr> <td class="confluenceTd"><b>trunkname</b></td> <td class="confluenceTd">Trunk name</td> <td class="confluenceTd"><img class="icon" src="http://www.tri-line.com/common/img/documentation/tim_professional/no_default.png" /></td> </tr> <tr> <td class="confluenceTd"><b>trunkgroup</b></td> <td class="confluenceTd">Trunk group</td> <td class="confluenceTd"><img class="icon" src="http://www.tri-line.com/common/img/documentation/tim_professional/no_default.png" /></td> </tr> <tr> <td class="confluenceTd"><b>account</b> <b class="red">**</b></td> <td class="confluenceTd">Account code match</td> <td class="confluenceTd"><img class="icon" src="http://www.tri-line.com/common/img/documentation/tim_professional/no_default.png" /></td> </tr> <tr> <td class="confluenceTd"><b>cli</b> <b class="red">**</b></td> <td class="confluenceTd">Caller ID match</td> <td class="confluenceTd"><img class="icon" src="http://www.tri-line.com/common/img/documentation/tim_professional/no_default.png" /></td> </tr> <tr> <td class="confluenceTd"><b>accesscode</b></td> <td class="confluenceTd">Specifies a trunk access code (eg. 9)</td> <td class="confluenceTd"><img class="icon" src="http://www.tri-line.com/common/img/documentation/tim_professional/no_default.png" /></td> </tr> <tr> <td class="confluenceTd"><b>lcr</b></td> <td class="confluenceTd">Specifies a Least Cost Route sequence</td> <td class="confluenceTd"><img class="icon" src="http://www.tri-line.com/common/img/documentation/tim_professional/no_default.png" /></td> </tr> <tr> <td class="confluenceTd"><b>diallednumber</b> <b class="red">**</b></td> <td class="confluenceTd">Dialled number match</td> <td class="confluenceTd"><img class="icon" src="http://www.tri-line.com/common/img/documentation/tim_professional/no_default.png" /></td> </tr> <tr> <td class="confluenceTd"><b>destination</b> <b class="red">**</b></td> <td class="confluenceTd">Location name match</td> <td class="confluenceTd"><img class="icon" src="http://www.tri-line.com/common/img/documentation/tim_professional/no_default.png" /></td> </tr> <tr> <td class="confluenceTd"><b>tariff</b> <b class="red">**</b></td> <td class="confluenceTd">Tariff name match</td> <td class="confluenceTd"><img class="icon" src="http://www.tri-line.com/common/img/documentation/tim_professional/no_default.png" /></td> </tr> <tr> <td class="confluenceTd"><b>fromcost</b></td> <td class="confluenceTd">Cost range start</td> <td class="confluenceTd"><img class="icon" src="http://www.tri-line.com/common/img/documentation/tim_professional/no_default.png" /></td> </tr> <tr> <td class="confluenceTd"><b>tocost</b></td> <td class="confluenceTd">Cost range end</td> <td class="confluenceTd"><img class="icon" src="http://www.tri-line.com/common/img/documentation/tim_professional/no_default.png" /></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"><img class="icon" src="http://www.tri-line.com/common/img/documentation/tim_professional/no_default.png" /></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"><img class="icon" src="http://www.tri-line.com/common/img/documentation/tim_professional/no_default.png" /></td> </tr> <tr> <td class="confluenceTd"><b>extension</b> <b class="red">*</b></td> <td class="confluenceTd">Extension number</td> <td class="confluenceTd"><img class="icon" src="http://www.tri-line.com/common/img/documentation/tim_professional/no_default.png" /></td> </tr> <tr> <td class="confluenceTd"><b>accountcode</b> <b class="red">*</b></td> <td class="confluenceTd">Account code</td> <td class="confluenceTd"><img class="icon" src="http://www.tri-line.com/common/img/documentation/tim_professional/no_default.png" /></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"><img class="icon" src="http://www.tri-line.com/common/img/documentation/tim_professional/no_default.png" /></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"><img class="icon" src="http://www.tri-line.com/common/img/documentation/tim_professional/no_default.png" /></td> </tr> <tr> <td class="confluenceTd"><b>trunk</b></td> <td class="confluenceTd">Trunk number</td> <td class="confluenceTd"><img class="icon" src="http://www.tri-line.com/common/img/documentation/tim_professional/no_default.png" /></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"><img class="icon" src="http://www.tri-line.com/common/img/documentation/tim_professional/no_default.png" /></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"><img class="icon" src="http://www.tri-line.com/common/img/documentation/tim_professional/no_default.png" /></td> </tr> <tr> <td class="confluenceTd"><b>extngroup</b></td> <td class="confluenceTd">Extension group</td> <td class="confluenceTd"><img class="icon" src="http://www.tri-line.com/common/img/documentation/tim_professional/no_default.png" /></td> </tr> <tr> <td class="confluenceTd"><b>trunk</b></td> <td class="confluenceTd">Trunk number</td> <td class="confluenceTd"><img class="icon" src="http://www.tri-line.com/common/img/documentation/tim_professional/no_default.png" /></td> </tr> <tr> <td class="confluenceTd"><b>trunkgroup</b></td> <td class="confluenceTd">Trunk group</td> <td class="confluenceTd"><img class="icon" src="http://www.tri-line.com/common/img/documentation/tim_professional/no_default.png" /></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"><img class="icon" src="http://www.tri-line.com/common/img/documentation/tim_professional/no_default.png" /></td> </tr> <tr> <td class="confluenceTd"><b>outgoingonly</b></td> <td class="confluenceTd">True or False - specifies outgoing calls only</td> <td class="confluenceTd"><img class="icon" src="http://www.tri-line.com/common/img/documentation/tim_professional/no_default.png" /></td> </tr> <tr> <td class="confluenceTd"><b>extension</b></td> <td class="confluenceTd">Extension number</td> <td class="confluenceTd"><img class="icon" src="http://www.tri-line.com/common/img/documentation/tim_professional/no_default.png" /></td> </tr> <tr> <td class="confluenceTd"><b>extngroup</b></td> <td class="confluenceTd">Extension group</td> <td class="confluenceTd"><img class="icon" src="http://www.tri-line.com/common/img/documentation/tim_professional/no_default.png" /></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> <tr> <td class="confluenceTd table_super_header" colspan="3"><b>INCOMING CALL ANALYSIS (7)</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"><img class="icon" src="http://www.tri-line.com/common/img/documentation/tim_professional/no_default.png" /></td> </tr> <tr> <td class="confluenceTd"><b>extngroup</b></td> <td class="confluenceTd">Extension group</td> <td class="confluenceTd"><img class="icon" src="http://www.tri-line.com/common/img/documentation/tim_professional/no_default.png" /></td> </tr> <tr> <td class="confluenceTd"><b>trunk</b></td> <td class="confluenceTd">Trunk number</td> <td class="confluenceTd"><img class="icon" src="http://www.tri-line.com/common/img/documentation/tim_professional/no_default.png" /></td> </tr> <tr> <td class="confluenceTd"><b>trunkgroup</b></td> <td class="confluenceTd">Trunk group</td> <td class="confluenceTd"><img class="icon" src="http://www.tri-line.com/common/img/documentation/tim_professional/no_default.png" /></td> </tr> <tr> <td class="confluenceTd"><b>noxfers</b></td> <td class="confluenceTd">True or False - includes or excludes transferred calls</td> <td class="confluenceTd"><img class="icon" src="http://www.tri-line.com/common/img/documentation/tim_professional/no_default.png" /></td> </tr> <tr> <td class="confluenceTd"><b>rowheight</b></td> <td class="confluenceTd">Specifies height of each row in table</td> <td class="confluenceTd"><span class="keyword">18</span></td> </tr> <tr> <td class="confluenceTd"><b>daystart</b></td> <td class="confluenceTd">Specifies starting half-hour of working day</td> <td class="confluenceTd"><span class="keyword">15</span></td> </tr> <tr> <td class="confluenceTd"><b>dayend</b></td> <td class="confluenceTd">Specifies ending half-hour of working day</td> <td class="confluenceTd"><span class="keyword">37</span></td> </tr> <tr> <td class="confluenceTd"><b>coldaylight</b></td> <td class="confluenceTd">Colour RRGGBB of daytime's light shade</td> <td class="confluenceTd"><span class="keyword">FFFFEC</span></td> </tr> <tr> <td class="confluenceTd"><b>coldaydark</b></td> <td class="confluenceTd">Colour RRGGBB of daytime's dark shade</td> <td class="confluenceTd"><span class="keyword">FFD7C4</span></td> </tr> <tr> <td class="confluenceTd"><b>colnightlight</b></td> <td class="confluenceTd">Colour RRGGBB of night-time's light shade</td> <td class="confluenceTd"><span class="keyword">F0F0FF</span></td> </tr> <tr> <td class="confluenceTd"><b>colnightdark</b></td> <td class="confluenceTd">Colour RRGGBB of night-time's dark shade</td> <td class="confluenceTd"><span class="keyword">E0E0FF</span></td> </tr> <tr> <td class="confluenceTd"><b>reversehours</b></td> <td class="confluenceTd">True or False - True specifies 00:00 at top of report, to 23:59 at bottom</td> <td class="confluenceTd"><span class="keyword">false</span></td> </tr> <tr> <td class="confluenceTd"><b>viewstart</b></td> <td class="confluenceTd">Starting half-hour of view (ignores earlier)</td> <td class="confluenceTd"><span class="keyword">1</span></td> </tr> <tr> <td class="confluenceTd"><b>viewend</b></td> <td class="confluenceTd">Ending half-hour of view (ignores later)</td> <td class="confluenceTd"><span class="keyword">48</span></td> </tr> <tr> <td class="confluenceTd table_super_header" colspan="3"><b>FREQUENT NUMBERS (8)</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>diallednumber </b><b class="red">**</b></td> <td class="confluenceTd">Specifies dialled digits</td> <td class="confluenceTd"><img class="icon" src="http://www.tri-line.com/common/img/documentation/tim_professional/no_default.png" /></td> </tr> <tr> <td class="confluenceTd"><b>extngroup</b></td> <td class="confluenceTd">Extension group</td> <td class="confluenceTd"><img class="icon" src="http://www.tri-line.com/common/img/documentation/tim_professional/no_default.png" /></td> </tr> <tr> <td class="confluenceTd"><b>minfrequency</b></td> <td class="confluenceTd">Specifies minimum frequency of a dialled number to feature in the results</td> <td class="confluenceTd"><span class="keyword">2</span></td> </tr> <tr> <td class="confluenceTd"><b>orderby</b></td> <td class="confluenceTd">Specifies order of results, either 'number of calls', 'duration', 'cost'</td> <td class="confluenceTd"><span class="keyword">cost</span></td> </tr> </tbody> </table> <p><b class="red">* </b>Indicates a mandatory field.</p> <p><b class="red">** </b>It is provided.</p> <h2>Example usage</h2> <p><span class="keyword">http://192.168.0.1:8080/rhdl.exe?reportid=1&period=thisyear&extension=7095&sortby=cost</span></p> |
...