Files
govoplan-reporting/docs/USER_GUIDE.md
T

49 lines
2.3 KiB
Markdown

# Reporting User Guide
## Open and run a report
Open **Reporting** at `/reports` and choose a report from the left catalogue.
The catalogue separates source-module reports from Reporting semantic reports.
The header identifies the immutable report revision that will be used. Select a
summary, detail, or pivot shape, choose dimensions and measures, enter any
report parameters, and select **Run**.
Only rows authorized for the current tenant and principal reach the query
engine. A successful result shows its authorized row count, visualization,
and table. When a saved chart does not match an ad-hoc query, Reporting shows
the accessible table fallback instead of changing or rejecting the query.
## Inspect evidence
The right panel lists previous runs and definition/source pins. Select an
earlier run to inspect its retained result. Content and output hashes identify
the exact definition and output. Warnings explain freshness, inferred schema,
or provider diagnostics. A failed quality gate records a failed execution and
does not publish a result.
## Save and export
Use **Save current view** to keep the current query under your account. Saved
views do not alter the report definition. CSV and JSON downloads contain only
the authorized result of the selected execution. CSV values that begin with a
spreadsheet formula marker are escaped.
Users with scheduling permission can create an hourly, daily, weekly, or
30-day interval from the current revision, parameters, and query. Scheduled
runs continue to use those exact pins until the schedule is edited.
## Run a module report
Module reports retain their source module's access rules. Select the source
object and any optional parameters, enter the concrete purpose for the run,
and verify the effective tenant audience before selecting **Run**. Reporting
will refuse a result that does not carry the declared privacy transforms,
source revision, and tenant scope.
The result groups declared metrics and details without exposing undeclared
provider data. The Governance panel explains the risk class, permitted export
formats, retention ceiling, contract version, and required privacy transforms.
An export records a separate purpose, actor, audience, time, format, and output
hash. A missing or restricted module report is not replaced with a less
protected client-side query.