---
title: "Reporting tool"
description: ""
url: "https://docs.itrsgroup.com/docs/geneos/7.11.0/visualization/active-console/tools/reporting-tool/index.html"
---
## Overview

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

To create a report:

1. Click **Add** ![](https://docscdn.itrsgroup.com/geneos/images/Icons/addItem16x16.png "icon") 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.

![](https://docscdn.itrsgroup.com/geneos/images/active-console/ac-reporting-screen.png)


**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

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:

![](https://docscdn.itrsgroup.com/geneos/images/active-console/ac-run-selected-report-results.png)

## File results destination

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

The **Active Console Destination** has the following options:

![](https://docscdn.itrsgroup.com/geneos/images/active-console/ac-reporting-results-destination.png)

<div class="table-container">
<table class="legacy-table" style="width: 100%;mc-table-style: url('../../../Resources/TableStyles/ref_2_col_table.css');margin-left: 0;margin-right: auto;" class="TableStyle-ref_2_col_table" cellspacing="0">
                        <col class="TableStyle-ref_2_col_table-Column-Column1"/>
                        <col class="TableStyle-ref_2_col_table-Column-Column1"/>
                        <thead>
                            <tr class="TableStyle-ref_2_col_table-Head-Header1">
                                <th class="TableStyle-ref_2_col_table-HeadE-Column1-Header1">Field</th>
                                <th class="TableStyle-ref_2_col_table-HeadD-Column1-Header1">Description</th>
                            </tr>
                        </thead>
                        <tbody>
                            <tr class="TableStyle-ref_2_col_table-Body-Body1">
                                <td class="TableStyle-ref_2_col_table-BodyE-Column1-Body1">Show results in</td>
                                <td class="TableStyle-ref_2_col_table-BodyD-Column1-Body1">
                                    <p>Specify where to display the results:</p>
                                    <ul>
                                        <li>Search View</li>
                                        <li>New Search View Tab</li>
                                        <li>Other</li>
                                    </ul>
                                </td>
                            </tr>
                            <tr class="TableStyle-ref_2_col_table-Body-Body1">
                                <td class="TableStyle-ref_2_col_table-BodyE-Column1-Body1">Merge with existing results</td>
                                <td class="TableStyle-ref_2_col_table-BodyD-Column1-Body1">Combine the new results into the existing results.</td>
                            </tr>
                            <tr class="TableStyle-ref_2_col_table-Body-Body1">
                                <td class="TableStyle-ref_2_col_table-BodyE-Column1-Body1">Dockable</td>
                                <td class="TableStyle-ref_2_col_table-BodyD-Column1-Body1">
                                    <p>Identifies the dockable to display the results in. This only becomes editable when you select "Other" on the <strong>Show results in</strong> menu.</p>
                                    <p>Options include:</p>
                                    <ul>
                                        <li>New Dockable</li>
                                        <li>Managed Entities</li>
                                        <li>Search Results</li>
                                        <li>Status Overview</li>
                                    </ul>
                                </td>
                            </tr>
                            <tr class="TableStyle-ref_2_col_table-Body-Body1">
                                <td class="TableStyle-ref_2_col_table-BodyE-Column1-Body1">Tab</td>
                                <td class="TableStyle-ref_2_col_table-BodyD-Column1-Body1">Specify which tab to display the results in. The options vary depending on the type of dockable that you use. </td>
                            </tr>
                            <tr class="TableStyle-ref_2_col_table-Body-Body1">
                                <td class="TableStyle-ref_2_col_table-BodyB-Column1-Body1"> </td>
                                <td class="TableStyle-ref_2_col_table-BodyA-Column1-Body1"> </td>
                            </tr>
                        </tbody>
                    </table>
                
</div>

### File destination

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.

![](https://docscdn.itrsgroup.com/geneos/images/active-console/ac-search-report-file-destination.png)

## Configure the report schedule

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

![](https://docscdn.itrsgroup.com/geneos/images/active-console/ac-reporting-report-schedule.png)

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

The **Report Settings** include the **Search Criteria** and **Results Destination** which have similar functionalities in [Search Function and Search Dockable](/visualization/active-console/tools/../view-customization/search-function-and-search-dockable/).