Working with Reports

The Reporting tab provides reports for IPAM, Peering, DNS, Activity, Resources, and DHCP.

To view reports for the available modules (IPAM, Peering, DNS, Activity, and Resources), click on the applicable sub-tab button at the top of the page, or select it from the Reporting Tab dropdown menu. 

Default reports are available for each module sub-tab, and users may create their own customized report based from the existing templates.

Working with Reports - Overview

Reporting v2, accessible to admin users from the Reporting tab, contains reports for the following modules: IPAM, Peering, DNS, Activity, Resources, and DHCP. Default reports are available for each module sub-tab, and users may create their own customized report from the existing templates. Once created, reports may be exported on-demand, or have exports scheduled to be sent to a user at regular intervals.

Admin users may perform the following reporting actions:

• View reports
• Create new reports
• Edit reports
• Copy reports
• Delete user-created reports
• Export and/or schedule export of a report

For each module, these actions are accessed in two general areas - the Saved Reports list, which shows the reports existing for each report type, and Report View, which displays the data for the selected report, and where report edits, exports, and filter updates may be performed. 

The Saved Reports List

The Saved Reports List shows the reports created for each module, including both default and user-created reports. Each report row displays the report name, description (optional), last modified date, last loaded date, the owner (creator), and provides action button options. 

Available actions under the Saved Reports area:

• Expand and Collapse the Saved Reports List by clicking the caret ( ⌃ ) in the blue bar
• Sort the list (toggle ascending / descending ) for any field with an up/down arrow ( ↓↑ )by clicking on the column name
• Open a report by clicking on the report name link, or click View under Actions (opens Report View)
• Edit a report's name, description, or scheduled report settings by clicking Edit, under Actions. (opens Report View → Actions)
• Duplicate a report, or use an existing report as a template, by clicking Copy 

Report View

Report View displays the data for the selected report, using the filter options saved to the report. It it divided into three general areas - the header, graph display (if applicable), and data display.

Report View Filters

While in Report View, you may view or edit the applied filters by clicking Filter ﹥ in the report header.

The filter flyout opens from the right side of the Report View, showing all fields available to filter by for that report type. 

Select or enter values for the filter criteria that you wish to apply to the report, and click "Apply" when finished. Close the filter flyout by clicking Filter ﹤ .

Applying updated report filters allows you to adjust the report output on a temporary basis - just until the page is reloaded. This is useful for quick look-ups, or to export a partial data set. 

If you wish to permanently save the updated filters to the report, saving the current state as the report's default, click the Report View menu (gear icon), and select Save. 

View Report

Open a report view by clicking on the report name in the Saved Reports list, or click "View" under report Actions.

The Report View for the selected report will open, where you can edit, filter, and export the report.

Create New Report

Step 1 - Add Report

To create a new report, click "Add Report" from any reports module page. This opens the Add Report page.

Under Add New Report, select the desired report type to add, enter the name of the report, and a description. Click "Save" when complete. 

The Saved Reports list page for that report type will automatically load, showing the newly created report.

New reports are created without any filters applied, so the next step is to open the report and apply filter customizations and report settings to the report.

Step 2 - Customize Filters

Open the report from the Saved Reports list by clicking either the report name, or the "View" button under Actions. 

Report View opens for the report, showing the report with no filters applied. To view or edit the report filters, click filter﹥ to open the filter flyout.

The filter flyout opens from the right side of the Report View, showing all fields available to filter by for that report type. 

Some report types, such as IPAM Utilization, have additional secondary filters available for items such as metadata fields. To open or close these additional filters, click More Filters.

Select or enter values for the filter criteria that you wish to apply to the report.

For our example, "Some IPAM Report", we have selected IPv4 blocks assigned in the last 60 days, that have the "Customer" tag.

When done, click Apply, and then close the flyout by clicking Filter ﹤. This applies the filter conditions to the report in the current view, but does not permanently save them.

Step 3 - Save Report

After applying filters to the report, review the data to ensure the filter conditions result in the desired output. 

To permanently save the applied filters and settings, click the Report View menu (gear icon), and select Save. This ensures that subsequent report views and exports use the same filter set.

Export / Schedule Report

Reports may be exported immediately, as they are currently displayed in the Report View, or exported on a regular basic automatically (Schedule Report). Note: Schedule Report requires the Scheduler Tab to be running.

Export Current View

Export a report by opening Report View for the desired report, and then clicking Export as CSV or Export as PDF (if available). Export options are also available from the gear menu.

The applicable file type will download via your browser. 

Schedule Report

Scheduling a report generates an export of the report at the set time interval, and emails the export file to the entered recipient(s).

Open the Scheduled Report Settings by clicking Edit for the report in the Saved Reports list, or by clicking the Actions panel in Report View.

To add Scheduled Report Settings, enter the email address(es) that the report should be sent to (Multiple addresses may be comma, semicolon, or space separated). You may specific a "From" addresses if desired. 

Then, select an interval frequency for how often the report export should be emailed, and (if available) select the report export type to send. When done, click Save. To close the actions panel, click Actions .   

Edit Report

Edit a report's name, description, permissions, or scheduled report settings by clicking Edit in the Saved Reports list. The report actions panel will open.

You may also open the report actions panel from Report View. Click the gear icon, then select Edit, or open the actions + panel.

Edit Report Settings

From the report actions panel, edit the report name and description under Report Settings, then click "Save".

Edit Report Permissions

The Report Permissions module allows the user to set view permissions to public, private, or custom. Custom allows the selection to allow access to only specific users or user groups.

To set Custom permissions, select the radio button for "Custom" and select either User(s) or Group(s) to share with via the dropdowns. Be sure to click "Save" before exiting.

Global Admins may view all reports, even those with Private or Custom settings, by enabling the "Reporting Permissions Override" in the Admin section Application Settings module.

Edit Scheduled Report Settings

To edit Scheduled Report Settings, update or enter the desired field. Under "Email(s)", multiple email addresses may be comma, semicolon, or space separated. When done, click Save. To close the actions panel, click Actions .   

Copy Report

Copy a report by clicking "Copy" in the Saved Reports list for the report. 

You may also copy a report from its Report View. Click the gear icon, then select Copy.

Delete Report

Delete a user-created report by clicking Delete in the Saved Reports list. Default reports (listed with "System" as the owner) may not be deleted.

Additional Information

For additional information on Reporting, see the following areas:

• Reporting
• Scheduler Tab (for editing or reviewing Scheduled Reports)