About GroundWork Built-In Reports

Included as a feature starting in GroundWork 8.6, GroundWork includes an internal query-driven subsystem. This allows a user to build quick summaries of historical data, and export these to spreadsheets of choice.

There are a number of reporting templates included out of the box. However, with the use of SQL and some familiarity with GroundWork databases, the possibilities for customization are high.

The report data is saved on the same cycle as data archiving. Therefore, reports are designed for date ranges ending at least 24 hours in the past. This mechanism has not changed in the transition from Jasper Reports to GroundWork reports.

Running a Default Report

  1. In GroundWork Monitor, go to Reports > GroundWork Reports.
  2. Select the type of report you wish to run and enter input:
    • Availability over time: Host, host group, host service, service group availability over a specified time.
    • Downtimes: Host downtimes over a specified time.
    • Events over time: Event reports for host, host groups, service or service group.
    • Notifications: Notification reports for host group, host, service group or service.

  3. Navigate between the tabs of the chosen report, and enter Host / Service / Date values:
  4. Upon running report, you should see a summary similar to the following. This summary is a minimal subset of what you will find in the reporting data.
  5. Click download csv to initiate download of a csv file that can be imported and processed by spreadsheet software.

Editing a Report as an Administrator

A standard GroundWork user is only able to run reports. As an administrator, however, it is possible to edit report queries or create new reports.

While logged in as a Groundwork administrator, perform the following steps:

  1. Navigate to Reports > GroundWork Reports.
  2. Click the edit icon next to one of the default reports.
  3. Using the query editor, it is possible to configure the report query.
  4. You can also add, remove, and edit the UI fields used within the query. Note that these custom fields are used in the query in the form of keywords like :from and :to and :hostname.



There is currently no method to restore default GroundWork report queries. It is recommended that you copy the existing queries before attempting any experimental reports.


Related Resources