Skip to content

What is a report & how do I run one?

Understand can turn your analysis into a shareable document — a report. There are three ways to get one:

  • Interactive Reports — plugin scripts (.upy / .upl) that render a report window for a chosen target — the project, an architecture, an entity, or a CodeCheck inspection.
  • Batch Reports — built-in cross-reference and metrics reports (Data Dictionary, cross references, metrics summaries, unused objects, ...) generated as a set, to HTML and/or text.
  • und report — generate either kind headlessly from the command line; see Export & script reports.

See which report should I use? to map a task to a specific report, or the reports catalog for the full list.

Enable & run Interactive Reports

Most shipped Interactive Reports are off until you enable them in the Plugin Manager (Tools → Plugin Manager) — see Install & run plugins. Once enabled, a report appears where its target lives:

  • Project-wide reports: Project → Interactive Reports → [report].
  • Entity, architecture, or inspection reports: right-click the target and choose Interactive Reports.

Interactive Reports are plugins, so you can also write your own — or start with the tutorial.

Run Batch Reports

Batch Reports let you pick a set of built-in reports and generate them all at once.

  1. Configure them. Reports → Configure Reports — select which reports to run, choose HTML, text, or both, set the output directory, and set advanced options (custom headers, showing parameters, grouping by directory).
  2. Generate them. Reports → Generate Reports. When they finish you can view, regenerate, or close.
  3. View them. Reports → View Reports → HTML (or Text). The HTML version has a table of contents, a project overview with charts, and links that jump to the source location.

Built-in report types include Data Dictionary, File Contents, several cross references (Program Unit, Object, Type, Macro, Include File), invocation and declaration trees, and metrics reports (Project Metrics, File Metrics, Class Metrics, Class OO Metrics, Program Unit Metrics), plus unused-object reports. The exact list depends on the languages in your project.

Just want the numbers?

For a raw per-entity metrics spreadsheet, use Metrics → Export Metrics instead — see Export & track metrics over time. The metrics reports here are formatted documents; the metrics export is a CSV dump.