Knowledge Center > Tutorials

ipMonitor 8's enhanced Configurable Reports support the ability to customize Report cell titles using supplemental formatting Tokens.

There are a number of benefits to using custom Tokens:

• When a Report is executed, Tokens are replaced with dynamic content.
• Formatting Tokens allow you to obtain detailed, relevant information and insert it into individual Report cells.
• A wide variety of formatting Tokens are available for your use.
• Time and date formatting Tokens follow the conventions set by Microsoft's Standard and Custom "DateTime" Format Strings.

Click the PDF icon to open a printable PDF version of this tutorial. It includes all the information found here, including images from the ipMonitor software, diagrams, and links to additional resources.

Insert any of the following custom Tokens into your Report cell titles or subtitles to obtain detailed Monitor information. This data is directly related to the Monitor currently set as the Data Source for the Report cell:

Token Name	Description
%monitorname%	The name of the Monitor.
%monitortype%	The type of Monitor.
%monitoraddr%	The IP Address, Primary Server Name or Domain Name of the Monitor.
%monitorid%	The unique identification number automatically assigned to the Monitor.
%monitoravail%	The percentage of the Coverage time that the Monitor has been in the Up state.
%monitorcoverage%	The total length of time ipMonitor has been monitoring the resource.
%monitorfailures%	The total number of Monitor failures recorded since the Monitor was enabled.
%monitorcriticals%	The total number of Monitor failures that triggered configured Alerts.
%monitorstatus%	The result of the last test performed by the Monitor.
%monitorlastrun%	The date and time when the Monitor last tested the monitored resource.
%monitordowndate%	The date and time when the Monitor last registered a failure.
%monitormaxtest%	The Monitor's configured maximum test duration, in seconds.
%monitoralertmax%	The Monitor's configured maximum number of Alerts to send.
%monitoralertssent%	The number of Alerts triggered by the Monitor.
%monitordownlength%	The total length of time the Monitor has been in a Down state.
%monitoruplength%	The total length of time the Monitor has been in an Up state.
%monitorstate%	The current Monitor state, in textual format.
%monitorstatenum%	The current Monitor state, represented as a number.
%monitortestup%	The configured value for the Monitor's Delay Between Tests While: Up field.
%monitortestwarn%	The configured value for the Monitor's Delay Between Tests While: Warn field.
%monitortestdown%	The configured value for the Monitor's Delay Between Tests While: Down field.
%monitortestlost%	The configured value for the Monitor's Delay Between Tests While: Lost field.
%monitortag[...]%	The value of the specified custom information Tag attached to the Monitor.

Note: Enter the name of the custom Tag within the square brackets [ ] of the %monitortag[...]% token to obtain the appropriate value.

Insert any of the following custom Tokens into your Report cell titles or subtitles to obtain detailed date and time information:

Token Name	Description
%rangestart[format]%	The specified starting date and time of the Report period.
%rangestop[format]%	The specified ending date and time of the Report period.
%now[format]%	The exact date and time that the Report was generated.

Note: Date and time formatting options follow the conventions set by Microsoft's Standard and Custom "DateTime" Format Strings, as outlined on the MSDN website: http://msdn2.microsoft.com/en-us/library/az4se3k1.aspx

For additional information on formatting options available for use with the date and time ipMonitor Report Tokens, refer to the next section of this tutorial.

Choose from the formatting options listed here and insert the appropriate string within the square brackets [ ] of the date and time formatting Tokens outlined in the above section.

The table below contains formatting options based on Microsoft's Standard "DateTime" Format Strings. For additional, in-depth information on these strings, refer to the following article located on the MSDN website: http://msdn2.microsoft.com/en-us/library/az4se3k1.aspx

Format String	Description	Sample Return Value
d	The date, written in abbreviated format.	10/25/2006
D	The date, written in full.	Wednesday, October 25, 2006
f - or - g	A combination of the abbreviated date and the abbreviated time pattern.	10/25/2006 9:19 AM
F -or- U	A combination of the full date and the full time pattern.	Wednesday, October 25, 2006 10:18:59 AM
G	A combination of the abbreviated date and the full time pattern.	10/25/2006 10:18:59 AM
m -or- M	The date, written in a month and day format.	October 25
r -or- R	The RFC 1123 date and time string pattern.	Wed, 25 Oct 2006 14:18:59 GMT
s	The ISO 8601 date and time string pattern.	2006-10-25T09:19:00
t	The abbreviated time pattern.	10:18 AM
T	The full time pattern.	10:18:59 AM
u	The date and time written in a short format. Additionally, the universal time designator "Z" is added at the end.	2006-10-25 13:19:00Z
y -or- Y	The date, written in a month and year format.	October, 2006

The table below contains formatting options based on Microsoft's Custom "DateTime" Format Strings. For additional, in-depth information on these strings, refer to the following article located on the MSDN website: http://msdn2.microsoft.com/en-us/library/8kb3ddd4.aspx

Format String	Description	Sample Return Value
dd	The day of the month, displayed as a number ranging from 01 to 31. Single-digit days are precluded by a zero (0).	25
ddd	The abbreviated name of the day of the week.	Wed
dddd	The full name of the day of the week.	Wednesday
h	The hour, represented as a number ranging from 0 to 23, based on the 24-hour clock.	9
HH	The hour, represented as a number from 00 to 23, based on the 24-hour clock. Single-digit hours are precluded by a zero (0).	09
mm	The minute, represented as a number from 00 to 59, based on the 60-minute hour. Single-digit minutes are precluded by a zero (0).	18
MM	The month, represented as a number from 01 to 12, based on the 12-month year. Single-digit months are precluded by a zero (0).	10
MMM	The abbreviated name of the month.	Oct
MMMM	The full name of the month.	October
ss	The second, represented as a number from 0 to 59, based on the 60-second minute.	59
tt	The AM or PM designation.	AM
yy	The year, represented as a two-digit number.	06
yyy	The year, represented as a three-digit number.	006
yyyy	The year, in full (a four-digit number).	2006

The following examples show two types of Report customizations available with the use of Tokens. A wide variety of configurations using a mix of the above Tokens and formatting options are possible.

The first scenario illustrated here shows how you can customize a Report cell header to display the name of the Monitor and the result of the last test performed by the Monitor. In addition, you may also wish to see a combination of the full date and time pattern for the starting time period, but only the date, written in month and day format, for the ending time period.

To do so, you would configure the Report Cell Title and the Report Cell Subtitle as shown:

This configuration would result in the following Report header:

The second scenario illustrates how you can customize a Report cell header for an hourly report to display the Monitor type, the percentage of total Coverage time that the Monitor has been in the Up state, and the Monitor's IP Address, Primary Server Name or Domain Name. In addition, the subtitle can be configured to reflect the day of the week and the hour span when the data used to generate the Report was recorded.

To achieve this configuration, you would configure the Report Cell Title and the Report Cell Subtitle as shown:

This configuration would result in the following Report header:

For information on other features and concepts related to those discussed in this article, refer to the following ipMonitor resources:

< Back

Last Updated: November 2, 2006 | What did you think of this topic?