Reports

Reports provide information to use as security oversight, operational reviews, or audits. Various predefined reports can be configured to recur on a periodic basis.

Role requirements

All users can subscribe to reports via the report template controls.

To modify the report schedules and email recipients of predefined reports, or to modify report templates that you did not create, you must be assigned the Admin role.

note

In the upper-right corner of any Edit Report Template page, the email address of the creator of the report template is displayed.

For more information on ActiveEye capabilities and the role(s) required to access them, see the ActiveEye Capabilities by User Role topic.

Report templates

Report templates allow you to apply time ranges of analysis to available report modules, and then generate reports of the findings. Multiple report modules can be added to a report template, and their time ranges of analysis can be configured individually. Optionally, you can configure the report to be generated on a recurring basis, and to be emailed to a list of contacts when generated.

You can associate any number of email notification type contacts with a report template. For information on managing contacts, see the Manage Contacts topic.

Viewing, subscribing to, editing, and deleting report templates

1. In ActiveEye, in the left pane, click Reporting, and then click Templates.
   The Report Templates page appears.
   
note

If you want to change the time zone in which future reports are created, select the appropriate time zone in the Create Future Reports in Time Zone box, and then click Update.

2. Sort the list of report templates by name, or search for a specific report template.
3. In the list, select the row for a report template to access the Edit Report Template page, on which you can see details about the report template. On this page, you can perform the following actions:
   • Subscribe to report: Optionally, switch the Subscribe toggle. If the toggle is set to On, the report will be emailed to you whenever it is generated.
   • Generate Report: To generate a report immediately based on the last saved settings, click the Generate Report button.
     note

     If you have made any modifications to the report template, the Generate Report button will be disabled. To enable it, save the report template by clicking Save.

   • Edit report template: To modify predefined report templates or report templates that you did not create, you must be assigned the Admin role. For predefined report templates, you can only modify the report schedule and email recipients. For other report templates, you can perform all actions described in steps 3 through 11 of the Adding a new report template procedure. When you are finished editing, click Save to save your changes.
   • Delete report template: Report templates predefined by ActiveEye cannot be deleted. To delete any other report template, click the Delete button. There is no additional confirmation. The report template is deleted immediately.

Adding a new report template

1. In ActiveEye, in the left pane, click Reporting, and then click Templates.
   The Report Templates page appears.
   


2. Click Create Report Template.
   The Create Report Template page appears.
   


3. Enter a unique name in the Name box.
4. Optionally, if you do not want to include a title page in reports generated by the report template, turn off the Include Title Page toggle.
5. Optionally, enter a description in the Description box.
6. Optionally, in the Report Delivery section, select Daily, Weekly, or Monthly to set a recurring schedule for automatic report generation.
note

When scheduling recurring reports, be aware that the time ranges of analysis (absolute or relative) for modules predefined by ActiveEye will be overridden by the scheduled cadence. On-demand generated reports will still adhere to the module time ranges.

7. Optionally, in the Report Delivery section, turn off the Require Data toggle. If the toggle is set to On, the report will only be generated if one or more of its modules contains data. This option applies only to scheduled reports.
8. Optionally, in the Report Delivery section, in the Email Recipients box, select a contact. You can select multiple contacts. To remove a contact from the report template, in the Email Recipients box, click the X beside the contact name.
9. In the Available Modules section, in the row for the module that you want to add to the report template, click . Repeat this action for each module that you want to include in the report template.
   
   note

   You can add a maximum of 40 report modules to a report template.

   The selected modules are added to the Modules Included in Report section.

10. Optionally, in the Modules Included in Report section, use the and buttons to modify the order of the modules. This will determine the order in which results are presented in reports generated from the template. To remove a module from the report template, click the button beside the name of that module.
11. For each module in the Modules Included in Report section, select the name of the module, and then, in the Configure Selected Module section, modify the time range of analysis for the module. You can select a specific start and end time, or you can select a scheduled range of time relative to when the report is generated.
note

You cannot modify the time ranges of modules predefined by ActiveEye.

12. Select Submit.
    The report template is saved.
    If you would like to generate a report immediately, click Generate Report.

Report modules

Editing and deleting report modules

1. In ActiveEye, in the left pane, click Reporting, and then click Modules.
   The Report Modules page appears.
   


2. Sort the list of report modules by name, or search for a specific report module.
3. In the list, select the row for a report module to access the Edit Report Module page, on which you can see details about the report module. If the report module is a predefined ActiveEye module, it cannot be edited or deleted. Otherwise, you can perform the following actions:
   • Edit report module: You can modify the values in the Name and Description boxes. When you are finished editing, click Save to save your changes.
   • Edit Query: Click the Edit Query button to open a page where you can edit the query associated with the report module. When you are finished editing the query, click , and then click Update Module to save your changes.
     warning

     Updating a report module does not automatically apply updates to existing report templates that use the module. To update report templates that use the updated module, you must take the additional action of removing the updated report module from the report template, and then re-adding it.

   • Delete report module: To delete the report module, click the Delete button.
   warning

   Before you delete a report module, in the Included in Reports section, check the list of reports in which the module is included. Be aware that, when you delete the module, it will be removed from these reports.

Creating a report module

Report modules are created from investigations. For more information, see the Investigate topic.

Reports status

On the Reports Status page, you can view the statuses of reports in a sortable list. You can also download reports with the status successful.

Viewing statuses of reports

1. In ActiveEye, in the left pane, click Reporting, and then click Reports Status.
   The Reports Status page appears.
   


2. Sort the list of reports by name, date created, or status, or search for a specific report.
   note

   To refresh the statuses displayed, click the Refresh Reports Status button.

3. In the list, select the row for any report with the status successful to download it.

Generated reports

On the Generated Reports page, you can download successfully generated reports. If you cannot find a report that you expect to appear, you may want to check its status. See the Reports Status section of this topic for more information.

Downloading generated reports

1. In ActiveEye, in the left pane, click Reporting, and then click Generated Reports.
   The Generated Reports page appears.
   


2. Search for a specific report, or, as needed, refine the list of reports displayed by using the buttons at the top of the page. You can refine the list based on date range, report type, provider, service, or frequency.
3. Sort the list of reports by report date, timespan (frequency), report type, provider, or service.
4. In the list, select the row for any report to download it.