Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
HTML
<p>Given that the system is built around HTML using the HTTP protocol, this allows the user to
completely customise the look and feel of all HTML pages and reports.</p>

<p>Each report that is produced by the system consists of a header, the body (containing the
information), and a footer.  Whilst the body is customised by the
parameters that are passed to the report, the header and footer
remain constant and can be edited using any HTML editor such as,
amongst others, Microsoft FrontPage.</p>

<p>Each report has an ID number, as follows:</p>

<table class="confluenceTable">
	<tbody>
		<tr>
			<th class="confluenceTh">Report name</th>
			<th class="confluenceTh">ID</th>
		</tr>
		<tr>
			<td class="confluenceTd"><b>Custom Report</b></td>
			<td class="confluenceTd">1</td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>Billing Report</b></td>
			<td class="confluenceTd">2</td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>Organisation Drill-Down</b></td>
			<td class="confluenceTd">3</td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>Trunks Busy</b></td>
			<td class="confluenceTd">4</td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>Call Geography</b></td>
			<td class="confluenceTd">5</td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>Top Calls</b></td>
			<td class="confluenceTd">6</td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>Incoming Response Analysis</b></td>
			<td class="confluenceTd">7</td>
		</tr>
		<tr>
			<td class="confluenceTd"><b>Dialled Numbers Report</b></td>
			<td class="confluenceTd">8</td>
		</tr>
	</tbody>
</table>

<p>Using these ID numbers, header and footer files can be created in the <span class="keyword">\data</span> 
folder in the form <span class="keyword">customheader_x.html</span> and <span class="keyword">customfooter_x.html</span>, where <span class="keyword">x</span> is 
the ID number of the report whose output you want to customise.</p>

<p>For example, suppose we wanted to add your company name to the heading of each telephone bill
you produce.  We know that a telephone bill is a <span class="reference">Billing Report</span> whose
ID is <span class="keyword">2</span>.  The custom header would therefore need to be a standard HTML 
file in the <span class="keyword">\data</span> folder named <span class="keyword">customheader_2.html</span>. The raw HTML for 
such a file may look something like the following:</p>

...

themeEclipse

...

Given the system is built around HTML using the HTTP protocol, the user is able to entirely customise the look and feel of all HTML pages and reports.

Each report produced by the system consists of a header, body (containing the information), and a footer. Whilst the body of the report is shaped by the parameters that are passed to it, the header and footer will remain constant and can be edited using any HTML editor.

Each report has an ID number assigned to it, as follows:

Report nameID
Custom Report1
Billing Report2
Organisation Drill-Down3
Trunks Busy4
Call Geography5
Top Calls6
Incoming Response Analysis7
Frequent number
8
Target response90
Extension Usage91
Daily activity92
Account summary93
Full Call Analysis94
First and Last Calls95
Cost Summary97
Inbound Call Performance98
Business Centre Summary100

Using these ID numbers, you can customise the header and footer of any report, by amending the corresponding customheader_x.html and customfooter_x.html files (where x is the ID number of the report), located in

Referencemacro
Labeldata
folder of the main installation program.

For example, if you want to add the company name to the heading of each telephone bill you produce, you need to locate the customheader_2.html within the

Referencemacro
Labeldata
folder.

An HTML example for such file is shown below:

Code Block
languagehtml/xml
 <html>
    <body>
        <div align="left">
            <table border="0" cellpadding="3" cellspacing="0" width="100%" style="font-family:Tahoma, Arial; font-size: 9pt">
                <tr>
                    <td width="66%" colspan="2">
                        <font size="6">Telephone Bill<br></font>
                        <font size="5">for<#SSI_PARAM:extngroup><#SSI_PARAM:extension><#SSI_PARAM:account></font>
                    </td>
                    <td width="34%"><img src="img/company_logo.gif" align="right" width="100" height="100"></td>
                </tr>
                <tr>
                    <td width="33%"></td>
					                    <td width="33%"></td>
					                    <td width="34%"><p align="right">Bill enquiries 020 79207265 7095<2600</td>
				                </tr>
			            </table>
		        </div>
 		
        <table border="0" width="100%" cellspacing="0" cellpadding="4" style="font-family: Tahoma; font-size: 9pt">
			<tr>
				            <tr>
                <td width="20%"><strong>Covering period</strong></td>
				                <td width="80%"><#SSI_PARAM:fromdate><#SSI_PARAM:fromtime>&nbsp;<strong>to</strong>&nbsp;<#SSI_PARAM:todate>&nbsp;<#SSI_PARAM:totime></td>
			</tr> 			<tr> 				<td width="20%"><strong>Billing Entity</strong></td> 				<td width="80%"><#SSI_PARAM:extngroup><#SSI_PARAM:extension><#SSI_PARAM:account></td>
			      </tr>
		</table>
HTML
<p>This example uses server-side includes (SSIs) which are explained later in this section.</p><tr>
 <p>The example code would produce an output similar to the following:</p>  <img class="screenshot naked" src="http://www.tri-line.com/common/img/documentation/tim_professional/customisation.png" alt="Customisation" />

<p>When creating header and footer files, it is important to remember that
the system constructs the final report from three bits of HTML -
the header, the body, and the footer.  Whilst it is not essential for
some web browsers, you should stick to the HTTP specification where
an HTML page is completely housed in a pair of <img class="icon" src="http://www.tri-line.com/common/img/documentation/tim_professional/html_1.png" />
<img class="icon" src="http://www.tri-line.com/common/img/documentation/tim_professional/html_2.png" /> tags.  This means that the report, taken as a whole consisting of all three parts,
collectively subscribes to this convention.  Your header should
contain the <img class="icon" src="http://www.tri-line.com/common/img/documentation/tim_professional/html_1.png" /> tag, whilst your footer should contain the <img class="icon" src="http://www.tri-line.com/common/img/documentation/tim_professional/html_2.png" /> tag.</p>  <td width="20%"><strong>Billing Entity</strong></td>
                <td width="80%"><#SSI_PARAM:extngroup><#SSI_PARAM:extension><#SSI_PARAM:account></td>
            </tr>
        </table>

The example code would produce the following output:

Screenshotmacro
Borderfalse
Shadowfalse
URL/download/attachments/7241982/customisation.png

Info

The example above uses server-side includes (SSIs), described in the Dynamic reports section below.

The system constructs the final report from three different HTML files - header, body and footer. As the final report needs to be rendered in one single file, the open HTML tag must be placed in the header and the closed HTML tag in the footer of the report.