Report Generation

Step-by-Step Instruction

Generate an On-Demand Report

1. Navigate to Observability Hub > Reports.
2. Open the Execute Reports tab.
3. In the Actions column, click Preview and Generate Report.
4. Select the Report Range.
5. Modify the Report Name, if required.
6. Select the required report format.
7. Enable Configure Distribution Channel, if email distribution is required.
8. Enter email details if distribution is selected.
9. Click Generate.

The report is generated in the background and appears in the Generated Reports tab.

The Generated Reports tab is the main place to check report status, download successful reports, track failed reports, search or filter generated reports, and delete report outputs when they are no longer required.

View Generated Reports

1. Navigate to Observability Hub > Reports.
2. Click the Generated Reports tab.
3. Review the generated report list.
4. Use the search box or filters to locate a specific report.

Track a Failed Report

1. Open the Generated Reports tab.
2. Locate the failed report.
3. Click the Failed status.
4. A tracking information panel appears.
5. Review the tracked information to understand the cause of failure.

Download a Report

1. Open the Generated Reports tab.
2. Locate the required report.
3. In the Actions column, click the PDF or CSV download button.
4. The report is downloaded to the local machine.

When a report is downloaded in PDF format, the generated file includes an initial cover page before the report content.

Delete a Generated Report

1. Open the Generated Reports tab.
2. Locate the required generated report.
3. Click the Delete button under the Actions column.
4. The generated report is deleted.

What Happens After the Steps

After a report is generated:

• The report runs in the background.
• The generated report appears in the Generated Reports tab.
• The report status shows whether generation was successful or failed.
• Users can download successful reports in the selected format.
• If a report fails, users can click the failed status to view tracking information.
• Generated reports can be deleted when no longer required.

Tips / Best Practices

• Use scheduled reports when the same report is needed regularly.
• Use on-demand reports when immediate information is required.
• Check the report range before generating the report.
• Use filters in the Generated Reports tab to quickly locate reports.
• Use report tracking information when report generation fails.
• Download reports in the required format based on usage needs.
• Use PDF when a formatted report with cover page is required.
• Use CSV when tabular data is required, where CSV is supported.

Troubleshooting

1. Issue: Generated report is not visible.

   • Possible Cause: The report may still be generating in the background
   • Solution: Open the Generated Reports tab and click Refresh. Wait for the generation process to complete and check the status again.

2. Issue: Report generation failed.

   • Possible Cause: The report generation process encountered an error
   • Solution: Click the Failed status in the Generated Reports tab. Review the tracking information panel to diagnose the failure reason.

3. Issue: Unable to find a generated report.

   • Possible Cause: The list may contain many generated reports.
   • Solution: Use the Search Box or Add Filters option. Reports can be filtered by Report Name, Status, Applied Report Filter, and Downloaded Count.

4. Issue: Report download is not available in the expected format.

   • Possible Cause: The report may not have been generated in that format, or the format may not be supported for the selected report type.
   • Solution: Check the available download buttons under the Actions column. Use the available PDF or CSV option.

5. Issue: Same report cannot be generated again.

   • Possible Cause: A report generation is already in progress.
   • Solution: Wait until the initial report generation is successful. The system prevents duplicate report generation while the same report is already being generated.

FAQs

What is the Reports module used for?

The Reports module is used to view configured reports, generate reports on demand, view generated reports, download reports, track failed reports, and delete generated report outputs.

Where can I access Reports in vuSmartMaps?

Reports can be accessed from Observability Hub > Reports.

What are the main tabs available on the Reports page?

The Reports page contains two main tabs:

1. Execute Reports
2. Generated Reports

What is the Execute Reports tab used for?

The Execute Reports tab is used to view configured reports, preview reports before generation, generate on-demand reports, and open a report to understand how it is configured.

How can I generate an on-demand report?

Go to Observability Hub > Reports, open the Execute Reports tab, and click Preview and Generate Report under the Actions column. Select the report range, modify the report name if required, select the report format, configure distribution channels if needed, and click Generate.

Where can I view generated reports?

Generated reports are available under the Generated Reports tab. This tab shows reports generated by users or schedules and allows users to view status, download reports, track failures, search, filter, refresh, and delete generated reports.

How can I track a failed report?

Open the Generated Reports tab, locate the failed report, and click the Failed status. A tracking information panel appears and helps users understand the cause of the failure.

Which formats are available for downloading reports?

Generated reports can be downloaded in PDF or CSV format, depending on the format selected during report generation and the available download options.

What happens when a report is downloaded in PDF format?

When a report is downloaded in PDF format, the generated file includes an initial cover page before the report content.

Can I delete a generated report?

Yes. Open the Generated Reports tab, locate the required generated report, and click the Delete button under the Actions column. This deletes only the generated report output, not the report template from Report Studio.

What should I do if a generated report is not visible?

Open the Generated Reports tab and click Refresh. The report may still be generating in the background, so wait for the generation process to complete and check the status again.

Why can the same report not be generated again immediately?

If report generation is already in progress, the system prevents duplicate report generation for the same report. Wait until the initial report generation is successful before generating it again.