Skip to main content
Version: 5.0 🚧

Reports

Overview​

Reports page Reports page

Reports

The Reports page is used to create, review, and manage report definitions and report execution results.

Use this page to:

  • View configured reports.
  • Create reports with the Create report wizard.
  • Check report schedule and execution state.
  • Remove reports that are no longer needed.

The Reports page helps administrators monitor scheduled reporting, verify whether reports completed successfully, and access generated report files.

Before you begin​

Required permissions​

  • You must have permission to view, add, download, remove Reports.
info

Access to the Reports page and report actions is controlled by role permissions.

Preconditions​

  • At least one report must exist before the Reports table shows records.
  • Required wizard steps must be completed before a report can be saved.

Dependencies​

  • Report targets depend on configured groups, panels, or equipment records.
  • Scheduled reports depend on schedule configuration.
  • Email and FTP delivery depend on configured delivery infrastructure and valid destination values.

Important limitations​

warning
  • Removing a report permanently deletes the report definition from the Reports page.
  • Required wizard fields are marked with an asterisk.

Page layout​

Reports table​

Reports page Reports page

The Reports page shows the report count, an add icon, report rows, status indicators, and row actions.

Reports

CalloutUI elementDescriptionWhen to use
1Add iconPlus icon next to the page title. Opens the Create report wizard.Use to create a new report.
2Name columnShows the report name.Use to identify the report definition.
3Group/Panel columnShows the report target with a target icon and ID.Use to confirm which group or panel the report applies to.
4Schedule columnShows schedule frequency and state.Use to understand whether the report is one-time, finished, stopped, or repeating.
5Last Result columnShows the latest report result with a green check icon and a timestamp.Use to check whether the latest report execution completed successfully and when it completed.
6View, Pause, Remove, Download actionsEye, Pause, Trash, Download icons shown.Use to pause an active repeating report, Remove, Download or mark the report result as viewed when the action is available.

Create report wizard navigation​

Reports page Reports page

The Create report wizard opens when you select the add icon. The wizard uses a step list on the left and the selected step form on the right.

Create report wizard

CalloutUI elementDescriptionWhen to use
1Step 1: Name InformationText field with placeholder Name and Dropdown field with placeholder Group.Use to enter the report display name and the group target for the report
2Step 2: Report typeDropdown field labeled Report Type. Use to select the report type.
3Step 3: Schedule startShows the section title Schedule start.Use to configure when the report schedule starts.
4Step 4: Report formatShows the section title Report format.Use to select the report output format.
5Step 5: Delivery optionsText field with placeholder Email address and Text field with placeholder FTP server address.Use to configure delivery options.

How to use this page​

Review reports​

Goal:

  • Review configured reports and their latest execution results.

Steps:

  1. Open Reports.
  2. Review the report count in the page header.
  3. Review the reports table.
  4. Check the Name, Group/Panel, Schedule, and Last Result columns.
  5. Use the scrollbar or pagination controls when more reports are available.

Expected result:

  • The Reports page shows report definitions and the latest available execution result for each report.

Create a report​

Goal:

  • Create a new report definition.

Steps:

  1. Open Reports.
  2. Select the add icon.
  3. In Step 1 Name, enter the report Name.
  4. Select a Group.
  5. In Step 2 Report type, select Report Type.
  6. In Step 3 Schedule start, keep Start right now enabled or enter a date and time.
  7. In Step 4 Report format, select CSV, Extended CSV, or both formats according to your requirement.
  8. In Step 5 Delivery options, enter an Email address or FTP server address when delivery is required.
  9. Select Save.

Expected result:

  • The report definition is created when all required wizard values are valid.
  • The report appears in the Reports table.

Start a report immediately​

Goal:

  • Configure the report schedule to start immediately.

Steps:

  1. Open the Create report wizard.
  2. Go to Step 3 Schedule start.
  3. Turn on Start right now.
  4. Continue the wizard and select Save.

Expected result:

  • The report schedule starts immediately after the report is created, according to report type and system behavior.

Schedule a report for a specific date and time​

Goal:

  • Configure a report to start at a selected date and time.

Steps:

  1. Open the Create report wizard.
  2. Go to Step 3 Schedule start.
  3. Turn off Start right now if required.
  4. Enter or select a date in MM/DD/YYYY format.
  5. Enter or select a time in hh:mm aa format.
  6. Continue the wizard and select Save.

Expected result:

  • The report uses the selected schedule start date and time when the values are valid.

Select report output format​

Goal:

  • Choose the output format for a report.

Steps:

  1. Open the Create report wizard.
  2. Go to Step 4 Report format.
  3. Select CSV.
  4. Select Extended CSV if the extended output is required.
  5. Continue the wizard and select Save.

Expected result:

  • The report is generated in the selected format when the report runs.

Configure delivery options​

Goal:

  • Configure where report output is delivered.

Steps:

  1. Open the Create report wizard.
  2. Go to Step 5 Delivery options.
  3. Enter an Email address if report delivery by email is required.
  4. Enter an FTP server address if report delivery to FTP is required.
  5. Select Save.

Expected result:

  • Delivery options are saved when the values are valid and delivery is supported.

Pause a repeating report​

Goal:

  • Pause a repeating report when the pause action is available.

Steps:

  1. Open Reports.
  2. Find a report with the pause action.
  3. Select the pause icon.
  4. Confirm the action if prompted.

Expected result:

  • The report is paused or stopped according to system behavior.

Download a report​

Goal:

  • Download a generated report result.

Steps:

  1. Open Reports.
  2. Locate the report in the table.
  3. Check Last Result to confirm that a result is available.
  4. Select the download action for the report.

Expected result:

  • The report result downloads when a result is available and the action is allowed.

Remove a report​

Goal:

  • Remove a report that is no longer needed.

Steps:

  1. Open Reports.
  2. Locate the report.
  3. Select the remove action.
  4. Confirm the action if prompted.

Expected result:

  • The report is removed from the Reports page.
warning

Removing a report permanently deletes the report definition from the Reports page.

Tips​

tip
  • Use clear report names so reports are easy to identify in the table.
  • Check Last Result before downloading a report.
  • Confirm the target in Group/Panel before saving a report definition.
  • Use the schedule column to identify reports that are finished, stopped, or repeating.
  • Select at least one report format before saving.
  • Enter a valid email address or FTP server address if report delivery is required.
  • Remove reports only when the report definition is no longer needed.

Troubleshooting​

No reports are shown​

Possible causes

  • No reports exist.
  • You do not have permission to view Reports.
  • The page did not finish loading.
  • Pagination or scrolling hides additional reports.

What to do

  1. Refresh the page.
  2. Check the report count.
  3. Use the table scrollbar or pagination controls.
  4. Confirm that your role includes permission to view Reports.
  5. Create a report if no report definitions exist.

Report was not created​

Possible causes

  • Required wizard fields were not completed.
  • Name is missing.
  • Group is missing or unavailable.
  • Report Type is missing or unavailable.
  • Report format is not selected.
  • Delivery values are invalid.
  • You do not have permission to create reports.

What to do

  1. Open the Create report wizard again.
  2. Complete required steps marked with an asterisk.
  3. Enter Name.
  4. Select Group.
  5. Select Report Type.
  6. Configure Schedule start.
  7. Select at least one report format.
  8. Check delivery values if entered.
  9. Select Save.

Download action is unavailable​

Possible causes

  • No report result exists.
  • The report execution has not completed.
  • You do not have permission to download reports.
  • The report status does not support download.

What to do

  1. Check Last Result.
  2. Wait for report execution to complete.
  3. Refresh the Reports page.
  4. Confirm that your role includes download permission.
info
Was this page helpful?