Skip to main content
Version: 5.0 🚧

Reports

Overview​

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.

Reports page Reports page

Before you begin​

Required permissions​

  • You must have permission to list, review, add, download, remove, stop Reports.
info

Access to the Reports page is controlled by the role permission group named Reports.

Preconditions​

  • At least one report must exist before the Reports grid shows records.

Important limitations​

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

Page layout​

The page header identifies the page and shows the number of available entries.

Reports header Reports header
CalloutUI elementDescriptionWhen to use
1Page titleShows the current page nameUse to confirm that you are on the page.
2Page entries countShows the total number of entriesUse to understand how many entries are available.
3Add iconPlus icon next to the page title. Opens the Create report wizard.Use to create a new report.

Reports grid​

The Reports grid displays report names, associated groups/panels, execution schedules, latest execution results, and available management actions.

Reports grid Reports grid
CalloutUI elementDescriptionWhen to use
1Name column

Shows the report name.

Use to identify the report definition.

2Group/Panel column

Shows the report target with a target icon and ID.

Use to confirm which group or panel the report applies to.

3Schedule column

Shows the report schedule frequency and current state.

Use to understand whether the report is one-time, finished, stopped, or repeating.

4Last Result column

Shows the latest report result with a status icon and timestamp.

Use to check whether the latest report execution completed successfully and when it completed.

5Mark as viewed action

Marks the report result as viewed.

Use after reviewing or acknowledging the latest report result.

6Pause action

Pauses an active repeating report schedule.

Use to stop future scheduled executions without removing the report.

7Remove action

Removes the selected report from the reports grid.

Use when the report is no longer needed.

8Download action

Downloads the selected report result.

Use to save a local copy of the report result.

Pagination controls​

Pagination controls appear at the bottom of the entries grid.

pagination controls (light) pagination controls (dark)
CalloutUI elementDescriptionWhen to use
1Previous and next arrowsShows left and right arrows, such as < and >, to move between pages.Use when the entries list has more records than the current page can show.
2Range indicatorShows the current range and total number of entriesUse to understand where you are in the entries list.
3Entries per page selectorControls how many entries appear on one page.Use to show fewer or more entries in the grid.

Create report wizard navigation​

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.

Reports wizardReports wizard
CalloutUI elementDescriptionWhen to use
1Create report steps panel

Shows the report creation steps and highlights the current step, Name Information.

Use to track progress through the report creation workflow.

2Name field

Field for entering the report name.

Use to define a name that identifies the report in the reports grid.

3Group dropdown

Dropdown for selecting the group associated with the report.

Use to choose which group the report applies to.

4Cancel button

Cancels report creation and closes the create report form.

Use to exit the workflow without saving the report.

5Save button

Saves the entered report information.

Use after entering the required report details.

How to use this page​

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 grid.

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.

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.

Review the report​

Goal:

  • Mark the latest report result as viewed after you review or acknowledge the result.

Steps:

  1. Open Reports.
  2. Locate the report in the Reports grid.
  3. Check the Last Result column to confirm that a report result is available.
  4. Select the Mark as viewed action.

Expected result:

  • The report result is marked as viewed.
  • The report remains available in the Reports grid.

Download the finished report​

Goal:

  • Download a completed report result.

Steps:

  1. Open Reports.
  2. Locate the report in the Reports grid.
  3. Check Last Result to confirm that the latest execution completed.
  4. Select the Download action.
  5. Save the downloaded file when prompted by the browser.

Expected result:

  • The report result is downloaded to the local device.

Pause the report schedule​

Goal:

  • Stop future executions of an active repeating report without removing the report definition.

Steps:

  1. Open Reports.
  2. Locate the repeating report in the Reports grid.
  3. Check the Schedule column to confirm that the report is active or repeating.
  4. Select the Pause action.
  5. Confirm the action if prompted.

Expected result:

  • The report schedule is paused.
  • The report definition remains in the Reports grid.
  • Future scheduled executions do not run while the report is paused.

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 grid.
  • 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.
  • 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 Review Reports.
  • Pagination or scrolling hides additional reports.

What to do

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

Download action is unavailable​

Possible causes

  • No report result exists.
  • The report execution has not completed.
  • You do not have permission to Download reports.

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.

Report paused unexpectedly​

Possible causes

  • A user selected the Pause action.
  • The report schedule reached a configured end condition.
  • The report is no longer active because of a schedule or execution state change.

What to do

  1. Check the Schedule column for the current report state.
  2. Confirm whether another user paused the report.
  3. Review the report recurrence settings, including end conditions.
  4. If the report must run again, create a new report or update the schedule according to the available actions.

Report removed​

Possible causes

  • A user selected the Remove action.
  • You do not have permission to see the report.

What to do

  1. If the report was removed, create a new report with the required settings.
  2. Confirm that your role includes permission to list and review reports.
warning

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

Report not delivered to email or FTP​

Possible causes

  • The email address is missing or invalid.
  • The FTP server address is missing or invalid.
  • The configured FTP path, user name, password, host, or port is incorrect.

What to do

  1. Check Last Result to confirm that the report execution completed.
  2. Verify the Email address value in the delivery options.
  3. Verify the FTP server address value, including protocol, credentials, host, port, and path.
  4. Download the report manually if delivery still fails and the download action is available.
  5. Create a new report with corrected delivery details if the existing report cannot be updated.
Was this page helpful?