Report Templates

From WebWatchBotWiki
Jump to: navigation, search
 Share 

Summary

  • Reports are generated from HTML template files located in the "resource" sub-folder of the installation folder, e.g. C:\Program Files\WebWatchBot [5/6]\resource.
  • Each template file contains basic HTML and special "replacement tags", encapsulated with "<%" and "%>", which are dynamically replaced when the report is generated. Replacement tags may be removed from your template file and will affect all reports.
  • Any HTML 4 tag may be used; however, we do not recommend you insert Flash or Java. Your results may vary.
  • There are three templates used in all reports, in the following order:
  1. template_report_heading.html or template_report_heading_specialized.html
  2. template_report_charting.html
  3. template_report_footing.html
  • NOTE: Rows of detailed data are not included in a template, but can be customized by modifying the report.css file

template_report_charting.html

HTML template for charts, if a report is configured to generate one or more charts.

Replacement Tags

The following replacement tags are used in this file. If the report is configured to NOT display a particular chart, the replacement tag is simply removed:

  • <%ChartPerformance%> - Performance chart, if report is configured to display.
  • <%ChartSlow%> - Slow chart, if report is configured to display.
  • <%ChartFailing%> - Failing chart, if report is configured to display.
  • <%ChartDowntime%> - Uptime/Downtime chart, if report is configured to display.

template_report_footing.html

HTML footing template for all reports. Contains no replacement tags

template_report_heading.html

HTML heading template for all reports, except "Top Failing" and "Top Slow"

Replacement Tags

The following replacement tags are used in this file:

  • <%ReportName%> - The name of the report
  • <%ReportDate%> - The date the report was created
  • <%WatchItemName%> - The name of the Watch Item, Transaction, Watch Group, or "All Watch Items"
  • <%DateStart%> - The start date for the report data
  • <%DateEnd%> - The end date for the report data
  • <%AverageName%> - Descriptive text for average value
  • <%AverageValue%> - Value for average
  • <%Uptime%> - Total uptime
  • <%Downtime%> - Total downtime
  • <%TimesChecked%> - Total number of checks for the date span specified
  • <%TimesFailed%> - Total number of checks for the date span specified
  • <%FailurePct%> - Percentage failure
  • <%LastFailure%> - Date of last failure
  • <%LastSuccess%> - Date of last success

template_report_heading_specialized.html

HTML template file used for "Top Failing" and "Top Slow" reports

Replacement Tags

The following replacement tags are used in this file:

  • <%ReportName%> - The name of the report
  • <%ReportDate%> - The date the report was created
  • <%WatchItemName%> - The name of the Watch Item, Transaction, Watch Group, or "All Watch Items"
  • <%DateStart%> - The start date for the report data
  • <%DateEnd%> - The end date for the report data

report.cs

Cascading style sheet used to format the report.