Logo
EMCO Ping Monitor Documentation Ping Monitor Overview | Download | Purchase

Notification E-mail Placeholders

This part of the guide describes the placeholders that can be used in the templates for the notification messages sent by e-mail in case of certain events. There are three types of messages, these are: Connection Status Notification, Summary Report and Detailed Report. Each of them is described below.

Connection Status Notification

Connection Status Notification placeholders can be used for notification messages that are sent when the connection status changes. The following placeholders can be used:

%REMOTE_HOST%

the remote host being monitored, including the host label, if defined;

%REMOTE_HOST_ADDRESS%

the address of the remote host being monitored;

%REMOTE_HOST_LABEL%

the label of the remote host being monitored;

%REMOTE_HOST_IP%

the resolved IP address of the remote host;

%REMOTE_HOST_GROUP%

the group the remote host belongs to;

%REMOTE_HOST_DESCRIPTION%

the description of the remote host being monitored;

%CONNECTION_STATUS%

the current connection status. It can be either 'established', or 'failed to establish', or 'lost', or 'restored'. For the 'lost' and 'failed to establish' statuses, the reason for ping failure is added. If you do not want to see the reason, use the '%SHORT_CONNECTION_STATUS%' placeholder;

%SHORT_CONNECTION_STATUS%

the current connection status. It can be either 'established', or 'failed to establish', or 'lost', or 'restored'. The reason for ping failure is never added;

%CHANGE_TIME%

the date and time the connection status was changed at;

%LOCAL_HOST%

the machine name;

%RUNNING_PRODUCT%

the running program name;

%PRODUCT_VERSION%

the current version of the running program;

%TIME%

the current time;

%DATE%

the current date;

%DATETIME%

the current date and time;

%YEAR%

the current year.

Summary Report

For the e-mail messages, sent as summary reports you can use the following placeholders:

%REPORT_NAME%

the name of the generated report;

%REPORT_DESCRIPTION%

the description of the generated report;

%REPORT_TYPE%

the type of the generated report;

%REPORT_PERIOD%

the period the report is generated for;

%SUMMARY_TABLE%

the table with the summary information on hosts availability and ping performance;

%LOCAL_HOST%

the machine name;

%RUNNING_PRODUCT%

the running program name;

%PRODUCT_VERSION%

the current version of the running program;

%TIME%

the current time;

%DATE%

the current date;

%DATETIME%

the current date and time;

%YEAR%

the current year.

Detailed Report

For the detailed report, the message body is generated for each host separately, and the header and footer are generated only once. So, the placeholders standing for any information on a single host can be used only wihin the message body. The following placeholders are available:

%REPORT_NAME%

the name of the generated report;

%REPORT_DESCRIPTION%

the description of the generated report;

%REPORT_TYPE%

the type of the generated report;

%REPORT_PERIOD%

the period the report is generated for;

%REMOTE_HOST_EXT%

the remote host being monitored, including the host label, if defined, and footnote sign, if required;

%REMOTE_HOST%

the remote host being monitored, including the host label, if defined;

%REMOTE_HOST_ADDRESS%

the address of the remote host being monitored;

%REMOTE_HOST_LABEL%

the label of the remote host being monitored;

%REMOTE_HOST_IP%

the resolved IP address of the remote host;

%REMOTE_HOST_GROUP%

the group the remote host belongs to;

%REMOTE_HOST_DESCRIPTION%

the description of the remote host being monitored;

%MONITORING_TIME%

the time span the host was monitored for during the report period;

%PAUSE_TIME%

the time span the host monitoring was paused for during the report period;

%ACTIVITY_TIME%

the time span the host was either monitored or paused for during the report period;

%MIN_RESPONSE_TIME%

the minimum ping response time during the report period in milliseconds;

%MAX_RESPONSE_TIME%

the maximum ping response time during the report period in milliseconds;

%AVG_RESPONSE_TIME%

the average ping response time during the report period in milliseconds;

%RESPONSE_DEVIATION%

the ping response deviation during the report period in milliseconds;

%UPTIME%

the percentage of alive connection time during the report period;

%OUTAGES_COUNT%

the number of outages that took place during the report period;

%UPTIME_INTERVAL%

a time span the connection to the host was alive during the report period;

%DOWNTIME_INTERVAL%

a time span the connection to the host was down during the report period;

%SHORTEST_OUTAGE%

the shortest outage that took place during the report period;

%LONGEST_OUTAGE%

the longest outage that took place during the report period;

%OUTAGES_TABLE%

detailed information on outages that took place during the report period in a form of a table, where each row stands for a single outage;

%UPTIME_CHART%

the host availability chart for the report interval (HTML e-mail messages only);

%RESPONSE_CHART%

the ping response chart for the report interval (HTML e-mail messages only);

%LOCAL_HOST%

the machine name;

%RUNNING_PRODUCT%

the running program name;

%PRODUCT_VERSION%

the current version of the running program;

%TIME%

the current version of the running program;

%DATE%

the current date;

%DATETIME%

the current date and time;

%YEAR%

the current year.