Report Templates

The Report Templates page defines customizable report templates. For detailed information see:

Terms and Concepts

Report Definitions - Report definitions contain all the settings that determine the content, layout and file format of a report. A report is published from a report definition.
Report Templates - A report definition is created by copying settings from a report template. Report templates define all the default settings for the content, layout and file format of a report definition. There are two types of report templates:
- Custom - Customizable report templates.
- Legacy - Fixed layout report templates provided in earlier releases.
Data Sets - Customizable report templates are constructed from data sets. A data set is a collection of data, in table format, queried from the Kaseya Server SQL server database. Predefined data sets are listed on the Report Parts page, organized by VSA module folder. For example, in the Agent module folder, the following data sets are provided:

Agent Configuration
Agent Portal Access
Agent Protection Settings
Agent Status

Data Columns - Each dataset is a collection of one or more data columns. For example, the Agent Status data set lists the following data columns.

agentGuid
Computer Name
Current User
Group Name
Last Logged On User
Machine ID
Online
Operating System
OS Information
Reverse Group Name
Show Tooltip
Timezone Offset
Tooltip Notes
Transition Time

Report Parts - The content and layout of a report template or report definition is constructed out of report parts. When constructing a report part, you select the columns of data in a data set you want to display in the report template or report definition. Each part can only select columns of data from a single data set. Each report part also determines the display of data in a particular format. There are four types of report part formats:
- Tables - Displays one or more columns of data in table format returned by a selected data set.
- Bar Charts - Displays a bar chart, based on two columns of data returned by a selected data set.
- Pie Charts - Displays a pie chart, based on two columns of data returned by a selected data set.
- Name Value Parts - Displays a single value with a user-defined label, based on a custom data set. For example: Open Tickets: 247.
Report Part Options - Each report part can be configured using the following options:
- Aggregate Options - Aggregate options return a single numeric value calculated from multiple cells in a selected column. For example, the aggregate option COUNT returns the number of non-null values in a selected column. Except for COUNT or COUNT_BIG, aggregate functions ignore null values.
- Order by - Data can be displayed in a preferred order, using combinations of selected columns, aggregate options, and ascending/descending sort orders.
- Group by - Returned rows of data can by organized into subheadings and subgroups by selecting "group by" columns. Multiple levels of "group by" columns are supported. Applies to table parts only.
- Filtering - The data displayed can be limited by specialized data filters. These include:
  - A specified number of rows or percentage of rows of data.
  - Comparing selected columns with specified values.
Custom Fields - Custom agent fields—created using the Audit > Machine Summary or System Information pages—are supported in views, procedures, legacy reports and in selected Audit category reports parts. Custom reports do not support more than 40 custom fields.
Coverpage, Header, Footer - This page defines presentation elements that are independent of the data displayed in the report. You can use these elements to "brand" your reports by creating a unique look and feel. Assign different combinations of coverpages, headers and footers to multiple custom report templates and custom report definitions.
Published / Unpublished - A published report template can be used to create report definitions. Unpublished report templates are hidden from the list of templates available to create report definitions.
Make Template - A Make Template button in Reports saves a report definition to a selected Report Templates folder. For example, users may create useful enhancements to their own report definitions. These in turn might be worth converting into report templates that other users can use to create report definitions.
Reusing Parts - Any time after a part is configured within a template you can optionally save a part to the Report Parts page This makes it a "standard" part that can be reused in templates and report definitions. You can also copy a part directly from an existing template into another template, without saving it as a "standard" part.
Import / Export - Both report templates and report parts can be imported and exported using System > Import Center.