Reporting tool

Overview Copied

The Reporting Tool allows you to schedule queries that can take snapshots of the system state, and output these snapshots as a saved file locally or as the contents of the search view.

You can open the Reporting Tool in two ways:

• Press CTRL + R.
• Go to Active Console > Tools > Reporting.

Create a report Copied

To create a report:

1. Click Add in the Reporting dialog.
2. Double-click the Name to provide a name for the report.
3. Double-click the Description to configure the search criteria.
4. Double-click the Destination to identify the results destination.
5. Double-click the Schedule to set the reports schedule. Alternatively, you can right-click each row and select Edit Selected Report.
6. Set the Status to Active or Inactive.
7. Click OK to save the changes.

Note

If the query is set to Inactive, the system does not trigger the report component. Also, any scheduled report that has file destination can only execute when the Active Console is running.

Run a report Copied

If you want to run the report without following the schedule:

1. Right-click the report you created in the Reporting dialog.
2. Click Run Selected Report.

The report displays in the Search Results dockable:

File results destination Copied

The output of a query can be either set within the Results Destination > Active Console Destination, or in your local file through File Destination.

Active Console destination Copied

The Active Console Destination has the following options:

File destination Copied

You can specify the location of the results destination of a file through File Destination.

The Filename field automatically appends .csv to any file that you are going to save, and the file will be saved as CSV by default.

Configure the report schedule Copied

The Report Schedule only appears in the settings of Reporting Tool.

You can configure the conditions and timing for the query using a number of possible options:

• Interval — sets a period to hourly, daily, weekly, or monthly.
• Days — sets a single day or multiple days in a week. To select multiple days, press and hold CTRL while selecting the day.
• Time — sets the exact time to trigger the query.

Further reading Copied

The Report Settings include the Search Criteria and Results Destination which have similar functionalities in Search Function and Search Dockable.