Below is the full list of substitution variables available for use in file-based event actions.
Example – Logging Test Results to a File
To log specific test details — such as the timestamp, session ID, and download speed — to a file named log.txt, configure it as follows:
| Field |
Value |
| File name |
log.txt |
| File contents |
%TIME%,%SID%,%SPEED.DSPEED% |
This creates a comma-separated line in the log file for each test triggered by an event.
Example – Creating Daily Log Files
To generate a separate log file for each day, include date variables in the file name:
log-%YYYYMMDD%.txt
If a test runs on July 21, 2022, the data will be written to log-20220721.txt. A test on the following day will go to log-20220722.txt.
You can customize the timestamp format using these variables:
| Variable |
Description |
Example |
%YYYY% |
4-digit year |
2022 |
%YY% |
2-digit year |
22 |
%MM% |
2-digit month |
07 |
%DD% |
2-digit day |
21 |
%HH% |
Hour (24-hour format) |
14 |
%NN% |
Minutes |
05 |
Note: If no folder path is specified, the file will be saved in the MyConnection Server installation directory by default.
General
| Variable |
Description |
%RECORDID% |
The ID number for this single record |
%TESTID% |
The ID number for this group of tests |
%ACCID% |
The account ID for this single record |
%TIME% |
The date and time of the test (GMT string) |
%TIMEINT% |
The date and time as a number (e.g., 20220725140500 for 14:05 on 25-Jul-2022) |
%DATETIME% |
The date and time in yyyy-mm-dd hh:mm:ss format |
%CONTYPE% |
The connection type (wifi/ethernet) for the test |
%WIFISIG% |
If the connection type is wifi, the signal in dBm |
%WIFIQ% |
If the connection type is wifi, the quality of signal in percentage |
%DETAILLINK% |
The URL for the detail report |
%SID% |
The session ID number |
%IP% |
The IP address of the system which performed the test |
%DNSNAME% |
The host name of the system which performed the test |
%CC% |
The two-letter country code representing the system's location |
%ISP% |
The name of the ISP to which the system is connected |
Time Fields (File Name Only)
| Variable |
Description |
%YYYYMMDDHHMM% |
Year-month-day-hour-minute (e.g., 202207251405) |
%YYYYMMDD% |
Year-month-day (e.g., 20220725) |
%YYYY% |
Four-digit year (e.g., 2022) |
%YY% |
Two-digit year (e.g., 09) |
%MM% |
Two-digit month, 01–12 |
%DD% |
Two-digit day of month, 01–31 |
%HH% |
Two-digit hour of day, 00–23 |
%NN% |
Two-digit minute of hour, 00–59 |
CRT
| Variable |
Description |
%CRT.TESTTIME% |
Test Duration (min/sec) |
%CRT.OUTCOME% |
Test Outcome |
%CRT.REASON% |
Fail Reason |
%CRT.TCALLS% |
Target Calls |
%CRT.ACALLS% |
Supported Calls |
%CRT.DSPEED% |
Download Speed (Mbps) |
%CRT.USPEED% |
Upload Speed (Mbps) |
%CRT.UJIT% |
Upstream Jitter |
%CRT.DJIT% |
Downstream Jitter |
%CRT.ULOSS% |
Upstream Packet Loss |
%CRT.DLOSS% |
Downstream Packet Loss |
%CRT.SIPALG% |
SIP ALG |
%CRT.RTT% |
Round Trip Time |
%CRT.BP% |
Blocked Ports |
DNS
| Variable |
Description |
%DNSNS.LATENCY% |
Latency |
%DNSNS.FAILURE% |
Failure |
%DNSNS.QNAME% |
Query Name |
Errors
| Variable |
Description |
%ERROR.SOURCE% |
The process that contained the error (e.g., Satellite, Server) |
%ERROR.TYPE% |
The error type (e.g., Error with plugin) |
%ERROR.ID% |
The ID for this error (e.g., for plugin errors this will be the plugin name) |
%ERROR.CODE% |
An ID-specific error number |
%ERROR.DESC% |
A short description of the error |
FTP
| Variable |
Description |
%FTP.LATENCY% |
Latency |
%FTP.FAILURE% |
Failure |
%FTP.GETPUT% |
Method |
%FTP.KBREAD% |
Read (KB) |
%FTP.KBWRITE% |
Write (KB) |
%FTP.KBSECREAD% |
Read (KB/sec) |
%FTP.KBSECWRITE% |
Write (KB/sec) |
%FTP.RTTMIN% |
RTT Min |
%FTP.RTTAVG% |
RTT Avg |
%FTP.RTTMAX% |
RTT Max |
Capacity
| Variable |
Description |
%CAPACITY.DCAPACITY% |
Download capacity |
%CAPACITY.UCAPACITY% |
Upload capacity |
%CAPACITY.DPACKETS% |
Download packets |
%CAPACITY.UPACKETS% |
Upload packets |
%CAPACITY.PACKETSIZE% |
Packet size |
%CAPACITY.QOS% |
QoS |
%CAPACITY.DMAXBANDWIDTH% |
Download max limit |
%CAPACITY.UMAXBANDWIDTH% |
Upload max limit |
DHCP
| Variable |
Description |
%DHCP.OFFER% |
IP Available |
%DHCP.OPT1% |
Subnet Mask (1) |
%DHCP.OPT2% |
Time Offset (2) |
%DHCP.OPT3% |
Gateway IP (3) |
%DHCP.OPT6% |
DNS IP(s) (6) |
%DHCP.OPT15% |
Domain Name (15) |
%DHCP.OPT42% |
NTP Servers (42) |
%DHCP.OPT51% |
Address Time (51) |
%DHCP.OPT53% |
Message Type (53) |
%DHCP.OPT54% |
Server ID (54) |
%DHCP.OPT66% |
Server Name (66) |
%DHCP.OPT132% |
VLAN ID (132) |
%DHCP.OPT150% |
TFTP ethBoot and GRUB (150) |
%DHCP.OPT159% |
v4 Port Params (159) |
%DHCP.OPT160% |
Captive Portal (160) |
%DHCP.OPTSREQ% |
Options Requested |
%DHCP.OPTSRECVD% |
Options Received |
Firewall
| Variable |
Description |
%FIREWALL.AVGRESPONSE% |
Avg Response |
%FIREWALL.MINRESPONSE% |
Min Response |
%FIREWALL.MAXRESPONSE% |
Max Response |
%FIREWALL.PORTS% |
Port # |
%FIREWALL.PROTOCOL% |
Protocol |
%FIREWALL.POPEN% |
Ports Open |
%FIREWALL.PBLOCK% |
Ports Blocked |
%FIREWALL.TPOPEN% |
Total Ports Open |
%FIREWALL.TPBLOCK% |
Total Ports Blocked |
%FIREWALL.PBLOCKLIST% |
Ports Blocked List |
Route
| Variable |
Description |
%ROUTE.ENTEREDNAME% |
Trace to |
%ROUTE.HOPS% |
Route hops |
%ROUTE.ENDMS% |
Response to end |
%ROUTE.MAXMS% |
Response Max |
%ROUTE.ENDLOSS% |
Loss to end |
%ROUTE.MAXLOSS% |
Max Loss |
%ROUTE.DNSTIME% |
DNS Time |
%ROUTE.IPTO% |
Target IP |
%ROUTE.IPFROM% |
Trace from |
Speed
| Variable |
Description |
%SPEED.DSPEED% |
Download Speed |
%SPEED.USPEED% |
Upload Speed |
%SPEED.QOS% |
CoS |
%SPEED.UQOS% |
UCoS |
%SPEED.RTT% |
Min RTT |
%SPEED.RTTMAX% |
Max RTT |
%SPEED.RTTAVG% |
Avg RTT |
%SPEED.RTTCONSISTENCY% |
RTT Consistency |
%SPEED.MAXPAUSE% |
Max Delay |
%SPEED.AVGPAUSE% |
Avg Delay |
%SPEED.BANDWIDTH% |
Effective Speed |
%SPEED.ROUTESPEED% |
Route Speed |
%SPEED.FORCEDIDLE% |
Forced Idle |
%SPEED.ROUTECONC% |
Route Conc |
%SPEED.DTESTTYPE% |
Download test |
%SPEED.UTESTTYPE% |
Upload test |
%SPEED.ERRORS% |
Errors |
VoIP
| Variable |
Description |
%VOIP.JITTER% |
Upstream jitter |
%VOIP.DJITTER% |
Downstream jitter |
%VOIP.MAXJITTER% |
Upstream Maximum jitter |
%VOIP.DMAXJITTER% |
Downstream Maximum jitter |
%VOIP.LOSS% |
Upstream packet loss |
%VOIP.DLOSS% |
Downstream packet loss |
%VOIP.ORDER% |
Upstream packet order |
%VOIP.DORDER% |
Downstream packet order |
%VOIP.DISCARDS% |
Packet discards |
%VOIP.MOS% |
MOS |
%VOIP.DMOS% |
DMOS |
%VOIP.LINES% |
Lines simulated |
%VOIP.BANDWIDTH% |
Bandwidth Demand |
%VOIP.REGISTER% |
REGISTER |
%VOIP.INVITE% |
INVITE |
%VOIP.BYE% |
BYE |
%VOIP.RTTMIN% |
RTT Min |
%VOIP.RTTAVG% |
RTT Avg |
%VOIP.RTTMAX% |
RTT Max |
%VOIP.RTTCONSISTENCY% |
RTT Consistency |
%VOIP.UPDISTLOSS% |
Upstream Loss distribution |
%VOIP.DOWNDISTLOSS% |
Downstream Loss distribution |
%VOIP.SIPALGFW% |
SIP ALG |
%VOIP.ERRORS% |
Errors |
%VOIP.STIPADDR% |
STUN IP:Port |
%VOIP.STLATENCY% |
STUN latency |
%VOIP.STFAIL% |
STUN pass/fail |
Ping
| Variable |
Description |
%PING.AVGLATENCY% |
Average Latency |
%PING.MINLATENCY% |
Minimum Latency |
%PING.MAXLATENCY% |
Maximum Latency |
%PING.LOSS% |
Ping Packet Loss |
Port
| Variable |
Description |
%PORT.AVGLATENCY% |
Average Latency |
%PORT.FAILURE% |
Failure |
%PORT.MINLATENCY% |
Minimum Latency |
%PORT.PORT% |
Test Port(s) |
%PORT.MAXLATENCY% |
Maximum Latency |
%PORT.OPENED% |
Opened |
%PORT.FAILED% |
Failed |
%PORT.REFUSED% |
Refused |
%PORT.TIMEDOUT% |
Timed out |
Quality
| Variable |
Description |
%ACT.DSPEED% |
Download Speed |
%ACT.USPEED% |
Upload Speed |
%ACT.DPCTKBPS% |
Down Bandwidth |
%ACT.UPCTKBPS% |
Up Bandwidth |
%ACT.DPCTILE% |
Down Percentile |
%ACT.UPCTILE% |
Up Percentile |
%ACT.DSLAHIGHKBPS% |
Down SLA Hi Bandwidth |
%ACT.DSLALOWKBPS% |
Down SLA Lo Bandwidth |
%ACT.USLAHIGHKBPS% |
Up SLA Hi Bandwidth |
%ACT.USLALOWKBPS% |
Up SLA Lo Bandwidth |
%ACT.QOS% |
CoS |
%ACT.UQOS% |
UCoS |
%ACT.RTT% |
Min RTT |
%ACT.RTTMAX% |
Max RTT |
%ACT.RTTAVG% |
Avg RTT |
%ACT.MAXROUTESPEED% |
Max route speed down |
%ACT.UMAXROUTESPEED% |
Up Route Speed |
%ACT.MAXPAUSE% |
Max Delay |
%ACT.UMAXPAUSE% |
Up Delay |
%ACT.MAXLINESPEED% |
Effective speed |
%ACT.UMAXLINESPEED% |
Up Effective speed |
%ACT.CONCURRENTTCP% |
Max TCP connections |
%ACT.UCONCURRENTTCP% |
Up Max TCP connections |
%ACT.TCPFORCEDIDLE% |
TCP forced idle |
%ACT.UTCPFORCEDIDLE% |
Up TCP forced idle |
%ACT.TCPMTU% |
TCP MTU (B) |
%ACT.TCPRXPOOO% |
Pkts Norder |
%ACT.TCPRXBOOO% |
Bytes Norder |
%ACT.TCPRXPOW% |
Pkts Xwindow |
%ACT.TCPRXBOW% |
Bytes Xwindow |
%ACT.TCPRXDOP% |
Pkts dup |
%ACT.TCPRXDOB% |
Bytes dup |
%ACT.TCPRXPDP% |
Pkts partdup |
%ACT.TCPRXPDB% |
Bytes partdup |
%ACT.TCPRXCRCERR% |
Pkts CRC errors |
%ACT.TCPRXBOFF% |
Pkts bad offset |
%ACT.TCPRXTS% |
Pkts too short |
%ACT.TCPRXPROBE% |
Wnd Probes Recvd |
%ACT.TCPRXWINZEROUP% |
Zero wnd updates sent |
%ACT.TCPBYTESLOST% |
Bytes lost |
%ACT.TCPTXRTXTMO% |
ReTx Timeouts |
%ACT.TCPTXRTXFAST% |
Fast ReTx |
%ACT.TCPTXPRETX% |
Pkts ReTx |
%ACT.TCPTXBRETX% |
Bytes ReTx |
%ACT.TCPTXSNDWINCLOSE% |
Wnd Closed |
%ACT.TCPTXRCVWINUPD% |
Pure Wnd Update |
%ACT.TCPTXRCVACKTOOMUCH% |
Acks for unsent |
%ACT.TCPTXRCVDUPACK% |
Dup acks |
%ACT.TCPTXSNDPROBE% |
Wnd probes sent |
%ACT.TCPTXPERSISTTIMEO% |
Persist timeouts |
%ACT.INTERFACE% |
Interface |
%ACT.ETHRXFTL% |
XL Frames |
%ACT.ETHRXNOAL% |
NA Frames |
%ACT.ETHRXSF% |
Short Frames |
%ACT.ETHRXCRCERR% |
CRC errors |
%ACT.ETHRXOVR% |
Overruns |
%ACT.ETHRXTRUNC% |
Cut Frames |
%ACT.DTESTTYPE% |
Download Type |
%ACT.UTESTTYPE% |
Upload Type |
%ACT.NETDOWNSEC% |
Network downtime (sec) |
%ACT.NETUPSEC% |
Network uptime (sec) |
%ACT.NETDOWNPC% |
Network downtime (%) |
%ACT.HTTP3XXSEC% |
HTTP 3xx |
%ACT.HTTP4XXSEC% |
HTTP 4xx |
%ACT.HTTP5XXSEC% |
HTTP 5xx |
%ACT.HTTPQXXSEC% |
HTTP ?xx |
%ACT.VERSION% |
Firmware Version |
%ACT.RUNTIME% |
Runtime |
%ACT.FREEQ% |
FreeQ |
Satellite
| Variable |
Description |
%SATELLITE.NETDOWNSEC% |
Network downtime (sec) |
%SATELLITE.NETUPSEC% |
Network uptime (sec) |
%SATELLITE.NETDOWNPC% |
Network downtime (%) |
%SATELLITE.HTTP3XXSEC% |
HTTP 3xx |
%SATELLITE.HTTP4XXSEC% |
HTTP 4xx |
%SATELLITE.HTTP5XXSEC% |
HTTP 5xx |
%SATELLITE.HTTPQXXSEC% |
HTTP ?xx |
%SATELLITE.VERSION% |
Firmware Version |
%SATELLITE.RUNTIME% |
Runtime |
%SATELLITE.FREEQ% |
FreeQ |
Web
| Variable |
Description |
%WEB.URL% |
URL |
%WEB.LATENCY% |
Latency |
%WEB.FAILURE% |
Failure |
%WEB.CONNECT% |
Connect Latency |
%WEB.FIND% |
Find Latency |
%WEB.READ% |
Read Latency |
%WEB.PAGESIZE% |
Page Size |
%WEB.KBSEC% |
Read (KB/sec) |
