Reports

Overview

Reports is the export and audit hub that produces standard report packages (JSON manifest + HTML + PDF) from the analysis, issue, task, change and evidence data across the application. Every report is compiled on demand from the current analysis/issue/task/change data and recorded with a downloadable package identifier (package_id).

Key Concepts

• Report catalogue — 5 ready-made report templates: BOM Reconciliation Report (EBOM/MBOM/ERP discrepancies, revision, cost, recommended actions), Visual Evidence Report (viewer snapshots + issues + actions + evidence package), Localization Report (weighted domestic content ratio, imported critical parts, alternative sources), PLM Readiness Report (Windchill/Teamcenter/ENOVIA/Codebeamer comparison and gap list), Spec2Action Kickoff Pack (requirement candidates, ambiguities, departmental tasks).
• Report package — a single production run of a report; it contains a package identifier of the form RPT-{REPORT_ID}-{sequence}, a summary (issue/critical/task/evidence/change counts) and the last 20 audit records.
• Export manifest — the record holding the paths of a package's JSON/HTML/PDF output files; every report run creates these three files on the server.
• Audit trail — every report run is written to the audit log with who created which package under which role (requires the audit:export permission).

Typical Workflow

1. Open Reports from the left-hand menu and pick one of the 5 report templates in the catalogue.
2. Click Generate Report — the system compiles the report on the spot from the latest analysis, open issues, tasks and change requests.
3. Review the resulting package with its summary KPIs (issue/critical/task/evidence/change counts).
4. Download it as a JSON manifest, an HTML report or a PDF report.
5. If needed, regenerate the same report template after a different analysis run and compare it with the earlier package (each run gets a new package identifier; past packages are not deleted).

Feature Reference

• Report catalogue listing and a list of previously produced packages (/api/reports/catalog)
• Report package generation (/api/reports/{report_id}/generate) — compiled from current analysis/issue/task/change data
• Template-specific section content (e.g. domestic content KPIs and alternative source suggestions in the Localization report; the snapshot list in the Visual Evidence report)
• Automatic generation of a JSON manifest + HTML report + minimal PDF report
• Summary statistics: issue / critical issue / task / evidence snapshot / change request counts
• Embedding of the last 20 audit records into the report
• Authorisation: report generation requires the audit:export permission and is written to the audit log

Constraints / Known Limits

• XLSX output is a placeholder: it appears in the package's downloadable file list, but no real Excel file is created on the server — only the JSON, HTML and PDF files are actually produced.
• The PDF report is "minimal" (a simple document with a title and description); a corporate PDF template with rich tables/charts must be developed separately in the production phase.
• Reports rely on demo/in-memory analysis and issue data; historical/comparative reporting against a persistent data warehouse does not exist yet.