A report template defines what data to include in a report and how to display it. Catchpoint includes pre-defined report templates, and you can follow the instructions below to create your own custom templates.
Accessing Report Templates
Templates can be accessed in Catchpoint by selecting the Reports in the left navigation menu and then clicking Templates. Here you can create a new Template by clicking create, or modify an existing custom template by clicking the template name.
Note: You cannot modify the default templates included with Catchpoint.
Report Template Properties
- Name - a unique name identifying the template.
- Test Type - defines whether the template should include data for a specific test type. This determines what metrics are displayed, as different test types collect different metrics.
- Report On - defines what type of data will be included in the report.
- Test - report metric data broken down by test
- Host - report metric data broken down by host
- Host List - report metric data broken down by host list
- Zone - report metric data broken down by zone
- Error List - report errors generated by the test(s)
- SLA Accepted - report only test data classified as SLA Accepted
- SLA All Runs - report data from all test runs regardless of SLA classification
- Overview - provide an overview of test results
- Chartable — Defines if the data should be sent as chart or table, (CSV attachment) which is only available for Test, Host, and Zone level data
- If Chartable set to True:
- Chart Dimension - dimension of the chart (X axis) (Time, City, Country, Continent, ISP, Node, Step, Step Name )
- For Host - Host dimension is added
- For Zone - Zone dimension is added
- Breakdown 1 - break the chart in separate groups (Test, City, Country, Continent, ISP, Node, Step, Step Name)
- For Host - Host Breakdown is added
- For Zone - Zone Breakdown is added
- Breakdown 2 - break the data within a chart (Test, City, Country, Continent, ISP, Node, Step, Step Name)
- For Host - Host Breakdown is added
- For Zone - Zone Breakdown is added
- Chart Dimension - dimension of the chart (X axis) (Time, City, Country, Continent, ISP, Node, Step, Step Name )
- If Chartable set to False:
- Field 1 - first column of the table (Time, Test, City, Country, Continent, ISP, Node)
- For Host - Host Field is added
- For Zone - Zone Field is added
- Field 2 (Time, Test, City, Country, Continent, ISP, Node)
- For Host - Host Field is added
- For Zone - Zone Field is added
- Field 3 (Time, Test, City, Country, Continent, ISP, Node)
- For Host - Host Field is added
- For Zone - Zone Field is added
- Field 1 - first column of the table (Time, Test, City, Country, Continent, ISP, Node)
- If Chartable set to True:
- For Error List level: Different fields are available (Test, Time, Step / Hop / Level, Step Name, Continent, Country, City, Node, ISP, Domain, IP, URL, Monitor, Error Type, Error Code)
- Sort by: Option available only for error list to sort by different fields including #Test Failures
- Statistical Values - what value should be included
- Metrics
- The metrics available for selection are dependent on the Test type that has been selected for the template.
- In case multiple tests with different test types have been added to the report and the metrics selected don't corelate to the specific test type, NA will be shown as the value for the metric.