<p>As mentioned, the built-in web server has an integral reporting extension that can produce a full report in HTML format and deliver it direct to a web browser. This reporting function is accessed using the standard CGI (Common Gateway Interface) protocol.</p> <p>The idea is simple: you pass the parameters of the required report, including the ID number of the report you want to produce, the period (date and time), and any other parameters that the report requires. The report is then generated and sent back to the web browser window.</p> <p>The reporting script, as it is known, is invoked by sending CGI variables to the object <span class="keyword">http://tim.yourcompany.com/rhdl.exe</span> where <span class="keyword">tim.yourcompany.com</span> is the host name of the machine running the TIM web server.</p> <p>Report parameters can be passed by the standard <span class="keyword">GET</span> and <span class="keyword">POST</span> methods. Using the <span class="keyword">GET</span> method, the parameters can simply be passed to the <span class="keyword">RHDL.EXE</span> object on the URL, as a hypertext link, or typed directly into the web browser's address bar. For example: <span class="keyword">http://tim.yourcompany.com/rhdl.exe?reportid=5&period=lastmonth</span> would return a full Call Geography report based on the calls made in your organisation over the last month.</p> <p>Using the <span class="keyword">POST</span> method requires an HTML form to be produced. An example of the same Call Geography report is described below:</p> |
<html> <body> <form method="POST" action="http://tim.yourcompany.com/rhdl.exe"> <p>ID <input type="text" name="reportid" size="20" value="5"><br> Period <input type="text" name="period" size="20" value="lastmonth"></p> <p><input type="submit" value="Submit"></p> </form> </body> </html> |
<p>In this example, the user is allowed to enter the reportid and period manually, thus allowing them to choose which type of report and the period that it covers, they want to produce.</p> <p>Listed in the SSIs (server-side variables) section, there is an array of SSI variables that can be used in your HTML code to automatically insert a drop-down list of valid report periods - for the period parameter.</p> <p>Further, there may be times when a drop-down list is needed in your HTML page that holds a list of all the extension groups that have been set-up. Clearly, a static HTML page would not suffice here because the list of extension groups may change. In this case, you must use the server-side variable named <span class="keyword">#SSI_EXTNGROUP</span> to magically do this for you.</p> <p>The difference between actioning a report using the <span class="keyword">POST</span> method instead of the <span class="keyword">GET</span> method, ensures that the parameters you send the <span class="keyword">RHDL.EXE</span> object are hidden from your web browser's address bar. This can sometimes be desirable from a security point of view.</p> |
There are other scripts available for administering your extensions configuration remotely via a web browser, and in the standard installation you will be able to select this from the main menu. However, given the scope of this manual, this script is not described here.
We have also provided a useful gadget for displaying a small bar graph image when passed a parameter between 0 and 100, which reflects a percentage. Try it using the following example:
http://tim.yourcompany.com/bar.jpg?percent=75
A script is also included which invokes a restart of the TIM server. Be aware that it is the whole application that is restarted - not just the web server. The script needs one parameter named sure to equal yes. Suggested use is as follows:
