Reports¶

WideQuick Modular Framework includes a built-in report module for generating, scheduling and customizing reports based on alarm and energy data. This section covers everything from using the default templates to creating fully custom ones.

Contents¶

Get started¶

• Setting up the Reporter — How to add and configure report templates in WideQuick® Designer.
• Using the Reporter — Introduction to generating reports in WideQuick® Runtime.
• Units and prefixes — Choosing the unit a report is presented in, and how per-signal scale factors are applied.
• Scheduling a report — How to set up recurring scheduled reports.

Configuring¶

• Alarm Report — How it works and how to reconfigure it.
• Alarm Report One Alarm — How it works and how to reconfigure it.
• Energy Report — How it works and how to reconfigure it.
• Energy Report Week — How it works and how to reconfigure it.
• Delta Year — Reporting the change over each year.
• Delta Week — Reporting the change over each week.
• Report History — Where to find it and how to use it.

Extending¶

• Creating templates — How to design and configure a custom report template.
• Creating a ReportController — How to create a ReportController view for a custom template.
• Changing the maximum number of signals — How to increase the signal limit for report generation.
• Adding a base unit — How to add custom units to the unit system.

Troubleshooting¶

• Common Issues — Common issues and how to fix them.