Chapter 9. Reports

Table of Contents

9.1. Organizing report definitions
9.1.1. Adding a folder
9.1.2. Adding a report definition
9.1.3. Copying a report definition
9.1.4. Adding a report section
9.1.5. Copying a report section
9.1.6. Deleting a folder, report definition or report section
9.1.7. Importing and exporting report definitions
9.1.8. Reloading report definintions
9.1.9. Changing the name of a folder, report definition or report section
9.1.10. Reorganizing reports and sections using drag and drop
9.2. Editing report definitions and sections
9.2.1. Viewing report results
9.2.2. Editing a query section
9.2.2.1. Defining how query results are displayed
9.2.2.2. Editing a query using basic settings
9.2.2.3. Editing a query using advanced settings
9.2.2.4. Editing a query using scripted settings
9.2.3. Editing an HTML section
9.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.

9.1. Organizing report definitions

The reports browse pane allows you create, edit, and delete report definitions. It also allows you to organize report definitions in folders. Folders, report definintions and report sections are shown using icons:

Open or closed folder. Folders are always shown sorted alphabetically.
Report definition. Report definitions are always shown sorted alphabetically within a folder.
Report section

The reports browse pane includes a tool bar with a number of buttons which allow you to create and organize report definitions. It also allows you to rearrange report definintions using drag and drop. You can access common tasks by clicking with the right button and selecting from the menu.

9.1.1.  Adding a folder

To add a new folder in an existing parent folder, first select the parent folder and then click the new folder button. To add a new folder at the top level, make sure that there is no selection in the reports browse pane, and then click the new folder button. The new folder button will be active only when a folder is selected or there is no selection.

9.1.2.  Adding a report definition

To add a new report definition, first select the folder which will contain the new report definintion, then click the new report button. The new report button will be active only when a folder is selected.

9.1.3.  Copying a report definition

To copy report definition, first select the report definition that you want to copy, then click the copy report button. A copy of the report definition will be created in the same folder as the original report definition. You can use drag and drop to move the copied report definition to another folder. The copy report button will be active only when a report definition is selected.

9.1.4.  Adding a report section

To add a new report section, first select the report definition in which to add the new section, then click the new section button, and then select either HTML section, Query section, or Scripted query section. The new section button will be active only when a report definition is selected.

9.1.5.  Copying a report section

To copy a report section, first select the report section that you would like to copy, then click the copy section button. A copy of the report section will be created in the same report definintion as the original report section. You can use drag and drop to move the copied report section to another report definition. The copy section button will be active only when a report definition is selected.

9.1.6.  Deleting a folder, report definition or report section

To delete a folder, report definition, or report section, first select the folder, report definition or report section, then click the delete button. The delete button will be active only when there is a selection. You can also delete the current selection by clicking with the right button and selecting Delete from the menu.

9.1.7. Importing and exporting report definitions

sFlowTrend-Pro allows you to import report definitions and export report definitions so that they can be imported into another sFlowTrend-Pro installation.

To import a report definintion, click on the import button . This brings up a dialog which allows you to select a previously exported report definintion and import it into sFlowTrend-Pro. The report definition will be imported into the Imported reports folder in the Reports tab.

To export a report definintion, first select the report that you would like to export. Then click on the export button . The definition for the selected report will be downloaded to the web browser's download location. The exported report definition can then be transferred to another sFlowTrend-Pro installation or shared with other users. The export button will be active only when a report is selected. You can also export a selected report definition by clicking the right button and selecting Export.

9.1.8.  Reloading report definintions

Administrators can make changes to report definitions and how they are organized. To load changes that other administrative users have made click on the reload reports button.

9.1.9. Changing the name of a folder, report definition or report section

You can change the name of a folder, report definition, or report section by clicking on the folder, report definition or report section. Or you can click with the right button on the current selection and select Edit name from the menu. You will be allowed to rename a folder, report definition or report section if you choose a name which is unique among siblings.

When you change the name of a folder, the folders in the parent folder will be resorted alphabetically. Similarly, when you change the name of a report definition, the reports within the folder will be resorted alphabetically.

9.1.10. Reorganizing reports and sections using drag and drop

The reports browse pane supports drag and drop. You can use drag and drop to move a folder to a different folder, move a report definition to a different folder, reorder sections within a report, or move a section to a different report. You will be allowed to move a folder, report definition or report section only if the move will not duplicate a name.