Chapter 8. Reports

Table of Contents

8.1. Organising report definitions
8.2. Editing report definitions and sections
8.2.1. Viewing report results
8.2.2. Editing a query section
8.2.2.1. Defining how query results are displayed
8.2.2.2. Editing a query using basic settings
8.2.2.3. Editing a query using advanced settings
8.2.2.4. Editing a query using scripted settings
8.2.3. Editing an HTML section
8.3. Running a report

The Reports tab allows you to define custom reports, run reports and view and save the results of running a report.

A report definition consists of a description to describe the purpose of the report and a number of report sections. There are two types of report section:

Query section
A query section is used to define a query that will extract data from the sFlowTrend-Pro database and display results in tabular or graphical formats.
HTML section
An HTML section is used to embed text and other material in a report. For example an HTML section can be used to add a title and description for the data shown in a query section.

Running a report definition produces report results. These results can be saved so that they are available later and accessible to other users.

The Reports tab includes a reports browse pane that allows you to view existing report definitions, create and delete report definitions, and add and delete sections to report definitions. The Reports tab also includes a report settings pane that allows you to change the settings for a report and its sections, and run a report definition.

When you first install sFlowTrend-Pro a number of example report definitions will be installed in the System reports folder.

8.1. Organising report definitions

The reports browse pane allows you to organise report definitions in folders. A folder is shown using or . The reports browse pane always shows the folders sorted alphabetically.

To add a new folder in an existing parent folder, select the parent folder and then click the new folder button .

A report definition is shown using . The reports browse pane always shows the report definitions sorted alphabetically within a folder. To add a new report definition, select the folder in which to add the new report, then click the new report button . A new report definition with a query section will be created in the selected folder. You can also copy a report definition by selecting the report definition to copy, then clicking the copy report button . A copy of the report definition is created in the same folder.

A report section is shown using . To add a new report section, select the folder in which to add the new report, then click the new section button and then select either HTML section, Query section, or Scripted query section. You can also copy a report section by selecting the section to copy, then clicking the copy section button . A copy of the section is created in the same report.

To delete a folder, report definition, or section, select the folder, report definition, or section to delete, then click the delete button . You can also delete the selected folder, report definition, or section by clicking the right button and selecting Delete.

Administrators can add and delete report definitions. To load changes to report definitions that other administrators have made, click the Reload reports button in the reports browse pane.

You can change the name of a folder, report definition, or section by clicking on the folder, report definition, or section or by clicking the right button and selecting Rename. The reports browse pane will only allow you to rename folders, report definitions, and report sections if you choose a name which is unique among the siblings.

The reports browse pane supports drag and drop, so you can move a report definition to a another folder by dragging and dropping the report on the other folder. You can also use drag and drop to reorder sections within a report definition and move a section to a different report.

In addition, sFlowTrend-Pro allows you to import report definitions and export report definitions so that they can be imported into another sFlowTrend-Pro installation See FileImport report and FileExport selected report .