Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

Generate Reports

 

You can generate HealthBot reports for device groups and network groups. These reports include alarm statistics, device or network health data, as well as device-specific information (such as hardware and software specifications).

HealthBot’s reporting functionality allows you to:

  • Send reports by email, save them on the HealthBot server, or download them to your local machine

  • Schedule reports to run at regular intervals, or for a specific time

  • Generate reports on demand (HealthBot 2.1.0 and later)

  • Compare (diff) two reports (HealthBot 2.1.0 and later)

  • Capture a snapshot of a specific set of fields at a given point in time (HealthBot 3.1.0 and later)

This section includes the following procedures:

Generate On-Demand Reports

You can generate and download a report on demand for a device group or network group. As with regular report generation, formats supported include HTML or JSON, and you can download the report or receive it by email.

Once generated, you can re-download on-demand reports from the Reports page. These reports have the report name HB_MANUAL_REPORT.

To generate an on-demand report:

  1. For a device group, navigate to the Configuration > Device Group page from the left-nav bar and select the device group name from the list.

    For a network group, navigate to the Configuration > Network page from the left-nav bar and select the network group name from the list.

  2. Click the Report Snapshot (Page) icon in the upper right part of the page as shown in
    Figure 1: Report Snapshot Button
    Report Snapshot Button
  3. On the page that appears, enter report generation details, including:
    • Format - HTML or JSON

    • Destination Type - save to your computer (disk) or send to email (which also saves to disk)

      • If disk, specify the number of reports to save on the server before deleting older reports

      • If email, add target email address(es)

    • (Optional) Select graph canvases to include in the report.

    • (Optional) Select the desired graph panels to include in the report.

  4. Click Submit.
  5. A dialog box appears allowing you to download the file. Additionally, if the destination is disk, HealthBot stores a copy of the report on the server. If the destination is email, HealthBot sends the report to the specified account.

Generate Scheduled Reports

The workflow to configure and generate scheduled reports is as follows:

Create a Destination Profile

  1. Select the Settings > System page from the left-nav bar.
  2. Click the Destination tab on the left of the page.
  3. In the Destination Settings section, click the + Destinationbutton.
  4. Specify the destination profile settings as appropriate.

    The following table describes the attributes in the Add a destination and Edit a destination panes:

    Attributes

    Description

    Destination Name

    Enter a name. The name cannot be changed once saved.

    Destination Type

    Options include Email or Disk.

    Email > Email Id

    Enter an email address to which the report will be sent.

    Disk > Maximum Reports

    Specify how many versions of this report will be stored on the server. Older reports are deleted as newer reports are generated and saved.

    Note

    Using the email option also saves a copy of the report to disk.

  5. Click Save and Deploy.

Create a Schedule Profile

  1. Click the Scheduler tab on the left side of the page.
  2. In the Scheduler Settings section, click the + Scheduler button.
  3. Specify the schedule profile settings as appropriate.

    The following table describes the attributes in the Add a scheduler and Edit a scheduler panes:

    Attributes

    Description

    Name

    Enter a name .

    Scheduler Type

    Select continuous.

    Start On

    Select the date and time for the first report to be generated.

    Run for

    Not applicable.

    End On

    (Optional) Select the date and time to stop generating reports.

    Leave blank to generate the report indefinitely.

    Repeat

    Select one of the following:

    • The frequency (every day, week, month, or year) at which you want the report to be generated.

    • Never—generate the report only once.

    • Custom—select and use the Repeat Every fields to configure a custom frequency.

  4. Click Save and Deploy.

Create a Report

  1. Click the Report tab on the left side of the page.
  2. In the Report Settings section, click + Reportbutton.
  3. Specify the schedule profile settings as appropriate.

    The following table describes the attributes in the Add a report setting and Edit a report setting panes:

    Attributes

    Description

    Name

    Enter a name.

    Format

    Options include HTML and JSON.

    Schedule(s)

    Select the schedule profile you created above.

    Destination(s)

    Select the destination profile you created above.

    Canvas(es)

    (Optional) Select graph canvases to include in the report. The list of graph panels in the Panel(s) drop-down list changes based on the canvas selected.

    For information on creating graphs, see Graph Page.

    Panel(s)

    (Optional) Select the desired graph panels to include in the report.

    NOTE: JSON reports include the raw time series data only, no graphs.

  4. Click Save and Deploy.

Associate the Report to a Device Group or Network Group

  1. For a device group, select the Configuration > Device Groups page from the left-nav bar.

    For a network group, select the Configuration > Network page from the left-nav bar.

  2. Click the name of the device group or network group for which you want to generate reports.
  3. Click the Edit (Pencil) button.
  4. In the Reports section, click the caret to expand the menu.
  5. Click the name(s) of the reports that you want to associate with this group.
  6. Click Save and Deploy.

View Reports

To view reports for a device group or network group:

  1. If the report’s notification parameters are set to use email, check the email box of the specified account for the report and open the attachment.
  2. If the report’s notification parameters are set to save to the server’s disk (or even if set to email), select the Monitor > Reports page from the left-nav bar. The reports are organized by the date and time at which they were generated. The most recent report is listed at the top of the table.
  3. Find the report you wish to download. To help find the desired report:
    • Click the column headings to sort based on that column.

    • Search within a column using the text box under the column heading.

    • Use the bottom of the page to view more rows or change pages.

  4. Click on the name of the report to download it to your system.

Sample Report

A report shows the following information:

Create Field Snapshot

You can capture fields (and their values) from rules applied to deployed devices. In the HealthBot CLI, you identify the fields to capture by specifying an xpath as shown below (without spaces):

In the HealthBot GUI, you specify the fields during the creation of a report. HealthBot takes care of creating the xpath from your configuration in the Settings > System > Reports > Add a Report Setting or the Settings > System > Reports > Edit Report window as shown in Figure 2 below:

Figure 2: Add/Edit Report Setting
Add/Edit Report Setting

Compare (Diff) Reports

You can compare the differences between two reports for a device group or network group. The diff allows you to view added/removed/modified alerts, devices, health information, and graphs.

To generate a report diff:

  1. On the Reports page, select two reports and click the Diff Reports button.
  2. The diff opens as an HTML page in a new tab.

Sample Report Diff

A sample of a report diff for a device group is shown below.

A sample of a report diff for a network group is shown below.

Release History Table
Release
Description
Capture a snapshot of a specific set of fields at a given point in time (HealthBot 3.1.0 and later)
Generate reports on demand (HealthBot 2.1.0 and later)
Compare (diff) two reports (HealthBot 2.1.0 and later)