Variable list

HTML

<p>There now follows a complete list of all server-side include variables 
available for use in your HTML pages.</p>

<p>Most SSI variables do not need to be housed in the '<>' HTML tags, however, 
variable-length ones do, and these are detailed at the bottom of the list.</p>

<table class="confluenceTable">
	<tbody>
		<tr>
			<th class="confluenceTh" width=110>SSI variable</th>
			<th class="confluenceTh">Description</th>
		</tr>
		<tr>
			<td class="confluenceTd"><span class="keyword"><b>#SSI_DATELONG</b></span></td>
			<td class="confluenceTd">Displays the current system date in long 'dd mmmm yyyy' format, eg. 04 January 2001.</td>
		</tr>
		<tr>
			<td class="confluenceTd"><span class="keyword"><b>#SSI_DATESHORT</b></span></td>
			<td class="confluenceTd">Displays the current system date in short dd/mm/yyyy format, eg. 04/01/2001.</td>
		</tr>
		<tr>
			<td class="confluenceTd"><span class="keyword"><b>#SSI_TIME</b></span></td>
			<td class="confluenceTd">Displays the current system time in HH:MM:SS format, eg. 23:02:41.</td>
		</tr>
		<tr>
			<td class="confluenceTd"><span class="keyword"><b>#SSI_PERIODS</b></span></td>
			<td class="confluenceTd">Produces a list of valid periods which are used to replace the fromdate and todate parameters in reports.</td>
		</tr>
		<tr>
			<td class="confluenceTd"><span class="keyword"><b>#SSI_EXTNGROUP</b></span></td>
			<td class="confluenceTd">Produces a list of available extension groups, including the internal 'New Extensions' group which contains newly-discovered extension numbers.</td>
		</tr>
		<tr>
			<td class="confluenceTd"><span class="keyword"><b>#SSI_TRUNKGROUP</b></span></td>
			<td class="confluenceTd">Produces a list of available trunk groups, including the internal 'New Trunks' group which contains newly-discovered trunk numbers.</td>
		</tr>
		<tr>
			<td class="confluenceTd"><span class="keyword"><b>#SSI_SITELIST</b></span></td>
			<td class="confluenceTd">Produces a list of valid sites as found in the SITES.CFG file.</td>
		</tr>
		<tr>
			<td class="confluenceTd"><span class="keyword"><b>#SSI_REGNAME</b></span></td>
			<td class="confluenceTd">Displays the name of the company to whom the software is registered.</td>
		</tr>
		<tr>
			<td class="confluenceTd"><span class="keyword"><b>#SSI_REMOTEIP</b></span></td>
			<td class="confluenceTd">Displays the IP address of the client (ie. the entity that is connecting to the web server).</td>
		</tr>
		<tr>
			<td class="confluenceTd"><span class="keyword"><b>#SSI_REMOTEHOST</b></span></td>
			<td class="confluenceTd">Displays the resolved host name of the client.</td>
		</tr>
		<tr>
			<td class="confluenceTd"><span class="keyword"><b>#SSI_REMOTEPORT</b></span></td>
			<td class="confluenceTd">Displays the request port of the client.</td>
		</tr>
		<tr>
			<td class="confluenceTd"><span class="keyword"><b>#SSI_LCV</b></span></td>
			<td class="confluenceTd">Returns an HTML table containing a copy of the information currently displayed in the live call view list.  The table includes the column headers and also any highlighted calls.</td>
		</tr>
		<tr>
			<td class="confluenceTd"><span class="keyword"><b>#SSI_FIELDS</b></span></td>
			<td class="confluenceTd">Produces a drop-down list in the context of an HTML form, containing a list of the fields in the database. Its primary use is for telling a report which field to sort on.</td>
		</tr>
		<tr>
			<td class="confluenceTd"><span class="keyword"><b>#SSI_STATS:ID</b></span></td>
			<td class="confluenceTd">Returns the unique identifier of the set of statistics currently being collected.  This could be a numeric form of the current date on which live statistics are being collected.</td>
		</tr>
		<tr>
			<td class="confluenceTd"><span class="keyword"><b>#SSI_STATS:GROUP</b></span></td>
			<td class="confluenceTd">Returns the extension group (if any) that statistics are currently being collected for.</td>
		</tr>
		<tr>
			<td class="confluenceTd"><span class="keyword"><b>#SSI_STATS:NUMABANDON</b></span></td>
			<td class="confluenceTd">Returns the total number of abandoned calls.</td>
		</tr>
		<tr>
			<td class="confluenceTd"><span class="keyword"><b>#SSI_REMOTEPORT</b></span></td>
			<td class="confluenceTd">Displays the request port of the client.</td>
		</tr>
		<tr>
			<td class="confluenceTd"><span class="keyword"><b>#SSI_LCV</b></span></td>
			<td class="confluenceTd">Returns an HTML table containing a copy of the information currently displayed in the live call view list.  The table includes the column headers and also any highlighted calls.</td>
		</tr>
		<tr>
			<td class="confluenceTd"><span class="keyword"><b>#SSI_FIELDS</b></span></td>
			<td class="confluenceTd">Produces a drop-down list in the context of an HTML form, containing a list of the fields in the database. Its primary use is for telling a report which field to sort on.</td>
		</tr>
		<tr>
			<td class="confluenceTd"><span class="keyword"><b>#SSI_STATS:ID</b></span></td>
			<td class="confluenceTd">Returns the unique identifier of the set of statistics currently being collected.  This could be a numeric form of the current date on which live statistics are being collected.</td>
		</tr>
		<tr>
			<td class="confluenceTd"><span class="keyword"><b>#SSI_STATS:GROUP</b></span></td>
			<td class="confluenceTd">Returns the extension group (if any) that statistics are currently being collected for.</td>
		</tr>
		<tr>
			<td class="confluenceTd"><span class="keyword"><b>#SSI_STATS:NUMABANDON</b></span></td>
			<td class="confluenceTd">Returns the total number of abandoned calls.</td>
		</tr>
		<tr>
			<td class="confluenceTd"><span class="keyword"><b>#SSI_STATS:NUMANSWERED</b></span></td>
			<td class="confluenceTd">Returns the total number of answered calls.</td>
		</tr>
		<tr>
			<td class="confluenceTd"><span class="keyword"><b>#SSI_STATS:NUMOUTBOUND</b></span></td>
			<td class="confluenceTd">Returns the total number of outbound calls.</td>
		</tr>
		<tr>
			<td class="confluenceTd"><span class="keyword"><b>#SSI_STATS:MAXOUTDURATION</b></span></td>
			<td class="confluenceTd">Shows the duration of the longest outbound call. Format is hh:mm:ss.</td>
		</tr>
		<tr>
			<td class="confluenceTd"><span class="keyword"><b>#SSI_STATS:MAXOUTBY</b></span></td>
			<td class="confluenceTd">Shows the name (if any) of the extension responsible for the longest outbound call.</td>
		</tr>
		<tr>
			<td class="confluenceTd"><span class="keyword"><b>#SSI_STATS:MAXRESPONSEBY</b></span></td>
			<td class="confluenceTd">Shows the name (if any) of the extension responsible for the value #SSI_STATS:MAXRESPONSE (above).</td>
		</tr>
		<tr>
			<td class="confluenceTd"><span class="keyword"><b>#SSI_STATS:MAXWAIT</b></span></td>
			<td class="confluenceTd">Shows the maximum wait an incoming caller endured before abandoning. Format is hh:mm:ss.</td>
		</tr>
		<tr>
			<td class="confluenceTd"><span class="keyword"><b>#SSI_STATS:MAXWAITBY</b></span></td>
			<td class="confluenceTd">Shows the name (if any) of the extension responsible for the value #SSI_STATS:MAXWAIT (above).</td>
		</tr>
		<tr>
			<td class="confluenceTd"><span class="keyword"><b>#SSI_STATS:AVGOUT</b></span></td>
			<td class="confluenceTd">Shows the average duration of all outgoing calls in the current statistics set. Format is hh:mm:ss.</td>
		</tr>
		<tr>
			<td class="confluenceTd"><span class="keyword"><b>#SSI_STATS:AVGRESPONSE</b></span></td>
			<td class="confluenceTd">Shows the average response time for all incoming answered calls in the current statistics set. Format is hh:mm:ss.</td>
		</tr>
		<tr>
			<td class="confluenceTd"><span class="keyword"><b>#SSI_STATS:AVGWAIT</b></span></td>
			<td class="confluenceTd">Shows the average time incoming callers wait until abandoning the call. Format is hh:mm:ss.</td>
		</tr>
		<tr>
			<td class="confluenceTd"><span class="keyword"><b>#SSI_STATS:MAXWAIT</b></span></td>
			<td class="confluenceTd">Shows the maximum wait an incoming caller endured before abandoning. Format is hh:mm:ss.</td>
		</tr>
		<tr>
			<td class="confluenceTd"><span class="keyword"><b>#SSI_STATS:MAXWAITBY</b></span></td>
			<td class="confluenceTd">Shows the name (if any) of the extension responsible for the value #SSI_STATS:MAXWAIT (above).</td>
		</tr>
		<tr>
			<td class="confluenceTd"><span class="keyword"><b>#SSI_STATS:AVGOUT</b></span></td>
			<td class="confluenceTd">Shows the average duration of all outgoing calls in the current statistics set. Format is hh:mm:ss.</td>
		</tr>
		<tr>
			<td class="confluenceTd"><span class="keyword"><b>#SSI_STATS:AVGRESPONSE</b></span></td>
			<td class="confluenceTd">Shows the average response time for all incoming answered calls in the current statistics set. Format is hh:mm:ss.</td>
		</tr>
		<tr>
			<td class="confluenceTd"><span class="keyword"><b>#SSI_STATS:AVGWAIT</b></span></td>
			<td class="confluenceTd">Shows the average time incoming callers wait until abandoning the call. Format is hh:mm:ss.</td>
		</tr>
	</tbody>
</table>

A complete list of all SSI variables is described below. Most SSI variables do not need to be housed in '<>' HTML tags; however, variable-length ones do, and these are detailed at the bottom of the list.

SSI variable

Description

#SSI_DATELONG

Displays the current system date in long dd mmmm yyyy format, e.g. 04 January 2001

#SSI_DATESHORT

Displays the current system date in short dd/mm/yyyy format, e.g. 04/01/2001

#SSI_TIME

Displays the current system time in HH:MM:SS format, e.g. 23:02:41

#SSI_CALLTYPES

Produces a drop-down list in the context of an HTML form displaying all call types

#SSI_PERIODS

Produces a list of valid periods used to replace the

Referencemacro

Label	fromdate

and

Referencemacro

Label	todate

parameters in reports

#SSI_EXTNGROUP

Produces a list of available extension groups, including the internal

Referencemacro

Label	New Extensions

group containing the newly-discovered extension numbers

#SSI_TRUNKGROUP

Produces a list of available trunk groups, including the internal

Referencemacro

Label	New Trunks

group which containing the newly-discovered trunk numbers

#SSI_SITELIST

Produces a list of valid sites as found in the SITES.CFG file

#SSI_REGNAME

Displays the name of the company the software is registered to

#SSI_REMOTEIP

Displays the IP address of the client, e.g. the entity connected to the web server

#SSI_REMOTEHOST

Displays the resolved host name of the client

#SSI_REMOTEPORT

Displays the request port of the client

#SSI_LCV

Returns an HTML table containing a copy of the information currently displayed in the

Referencemacro

Label	Call view

list. The table includes the column headers and any highlighted calls

#SSI_FIELDS

Produces a drop-down list with the database fields, in the context of an HTML form. Its primary use is to specify by which field the data should be sorted

#SSI_STATS:ID

Returns the unique identifier of the set of statistics currently being collected. This could be a numeric form of the current date on which live statistics are being collected

#SSI_STATS:GROUP

Returns the extension group (if any) that statistics are currently being collected for

#SSI_STATS:NUMABANDON

Returns the total number of abandoned calls

#SSI_STATS:NUMANSWERED

Returns the total number of answered calls

#SSI_STATS:NUMOUTBOUND

Returns the total number of outbound calls

#SSI_STATS:MAXOUTDURATION

Shows the duration of the longest outbound call (in hh:mm:ss format)

#SSI_STATS:MAXOUTBY

Shows the name (if any) of the extension responsible for the longest outbound call

#SSI_STATS:MAXRESPONSEBY

Shows the name (if any) of the extension responsible for the #SSI_STATS:MAXRESPONSE value above

#SSI_STATS:MAXWAIT

Shows the maximum length of time a caller waited before abandoning (in hh:mm:ss format)

#SSI_STATS:MAXWAITBY

Shows the name (if any) of the extension responsible for the #SSI_STATS:MAXWAIT value above

#SSI_STATS:AVGOUT

Shows the average duration of all outgoing calls in the current statistics set (in hh:mm:ss format)

#SSI_STATS:AVGRESPONSE

Shows the average response time for all incoming answered calls in the current statistics set (in hh:mm:ss format)

#SSI_STATS:AVGWAIT

Shows the average length of time callers wait before abandoning a call (in hh:mm:ss format)

#SSI_STATS:TOTALOUTDURATION

Shows the total duration of all outgoing calls in the current statistics set (in hh:mm:ss format)

#SSI_STATS:SMAXRESPONSE

Returns the maximum response time (seconds only)

#SSI_STATS:SMAXWAIT

Returns the maximum wait time (seconds only)

#SSI_STATS:SAVGRESPONSE

Returns the average response time (seconds only)

#SSI_STATS:SAVGWAIT

Returns the average wait time (seconds only)

Variable list

Versions Compared

Old Version 8

New Version Current

Key