Test Result Variables

The data stored in the MCS database from tests being run can be used in various ways. The mechanism for referencing the data is what we call a dollar ($) variable. It allows the user to extract test results for use in things like emails and a web page.

This tutorial details the available variables by type and, when applicable, how to use them.

Variables like date, session ID, and connection type.

Variable Example

To use the variables above, a new param tag has to be added to the m_applet_params variable in the HTML of the test page. An example of this can be seen below.

The value of the param tag is simply a JavaScript variable call. Create this method and the variables will be passed to it on test completion.

var m_applet_params = '<applet width="600" height="400">\
    <param name="testspecid" value="-2">\
    <param name="js" value="processResults($IP$,$DATETIME$,$SID$,$DETAILLINK$,$MSSID$,$CONNTYPE$,$PROXY$)">\
    <param name="config" value="default">\
    </applet>';

Variables related to throughput tests, like download and upload speed.

Variable Example

var m_applet_params = '<applet width="600" height="400">\
    <param name="testspecid" value="-2">\
    <param name="js" value="processResults($SPEED.DSPEED$, $SPEED.USPEED$, $SPEED.QOS$, $SPEED.UQOS$, $SPEED.RTT$, $SPEED.MAXRTT$, $SPEED.AVGRTT$, $SPEED.RTTCONSISTENCY$, $SPEED.MAXPAUSE$, $SPEED.AVGPAUSE$, $SPEED.BANDWIDTH$, $SPEED.ROUTESPEED$, $SPEED.FORCEDIDLE$, $SPEED.ROUTECONC$, $SPEED.DTESTTYPE$, $SPEED.UTESTTYPE$)">\
    <param name="config" value="default">\
    </applet>';

Variables related to VoIP tests, like jitter and packet loss.

Variable Example

var m_applet_params = '<applet width="600" height="400">\
    <param name="testspecid" value="-1">\
    <param name="js" value="processResults($VOIP.JITTER$, $VOIP.PACKETLOSS$, $VOIP.DJITTER$, $VOIP.DPACKETLOSS$, $VOIP.DISCARDS$, $VOIP.ORDER$, $VOIP.RTTMIN$, $VOIP.RTTAVG$, $VOIP.RTTMAX$, $VOIP.RTTCONSISTENCY$, $VOIP.REGISTER$, $VOIP.INVITE$, $VOIP.BYE$, $VOIP.SIPALGFW$, $VOIP.MOS$, $VOIP.DMOS$)">\
    <param name="config" value="default">\
    </applet>';

Variables related to route tests, like hops and ISP.

Array Variable Examples

Hop Numbers: An array of the hop numbers. The first hop of the route is noted as 0.

var hop_numbers = [0,1,2,3,4,5,6,7,8,9,10,11]

IP Addresses: An array of the IP addresses uncovered for each hop of the route.

var ip_addresses = ['192.168.1.254', '162.195.124.1', '---', '12.242.115.3', '154.54.13.149', '154.54.27.117', '154.54.44.85', '154.54.42.66', '154.54.29.221', '154.54.82.242', '66.28.4.22', '38.108.44.211']

Average Responses: An array of average response time for each hop. There are, by default, 7 pings to each hop.

var avg_responses = [0,1,'-',4,2,2,14,22,36,62,68,61]

Packet Loss: An array of the packet loss, as a percentage, for each hop of the route.

var packet_loss = [14,0,100,0,0,0,0,0,0,0,0,0]

Locations: An array of the geographical location of each hop, if available.

var loc = ['-','-','-','-','-','-','-','-','-','-','miami-fl','miami-fl']

Network Names: An array of the network name of each hop, if available.

var networks = ['-','-','-','-','-','-','-','-','-','-','Cogent Communications','PSINet Inc']

Variables related to capacity tests, like download and upload capacity.

Variable Example

var m_applet_params = '<applet width="600" height="400">\
    <param name="testspecid" value="-7">\
    <param name="js" value="testcomplete($CAPACITY.DCAPACITY$, $CAPACITY.UCAPACITY$, $CAPACITY.QOS$, $CAPACITY.DPACKETS$, $CAPACITY.UPACKETS$, $CAPACITY.PACKETSIZE$)">\
    <param name="config" value="default">\
    </applet>';

Variables related to firewall tests, like ports open and closed.

JavaScript Example

Note that the MSSIDS call is made from js-firewall, not js.

var m_applet_params = '<applet width="600" height="400">\
    <param name="testspecid" value="-3">\
    <param name="js-firewall" value="jsfw($FIREWALL.MSSIDS$)">\
    <param name="js" value="processResults($FIREWALL.PORTTOTAL$,$FIREWALL.PORT$,$FIREWALL.STATUS$,$FIREWALL.PROTOCOL$)">\
    <param name="config" value="default">\
    </applet>';

Array Variable Examples

Ports: An array of the ports/port groups tested.

var ports = [80, 110, 465, 20000]

Protocol: An array of the protocols for the ports/port groups tested.

var protocol = ['TCP', 'UDP', 'UDP', 'UDP']

Port Status: An array of the results for the port/port groups tested. 0 for closed and 1 for open.

var port_status = [1, 1, 1, 0]

Record IDs: A vertical bar delimited string of the record IDs for each port/port group tested.

var port_recordids = '455|456|457|458'