Create and Customize Project Reports
Overview
How do I create and structure custom reports in CxPlanner?
The Reporting module allows you to build project-specific reports by combining your own content with live data, graphs, files, and attachments. You can generate general documents such as QA and progress reports, or formal final reports that follow ASHRAE Guideline 0, ASHRAE Standard 202, or LEED certification requirements.
When and why to use this
Use this module when you need to generate tailored reports for stakeholders, documentation, or certification.
- Create both general and formal commissioning reports
- Add project-specific content, charts, and file references
- Attach full documentation (checklists, QA logs, test results)
- Save time by reusing templates and structuring data-rich documents
Steps to create a new report:
- Open the Reporting module in the left sidebar.
If it’s not visible, activate it in the project modules.
- Choose from one of the following options:
- Add a completely new report
- Import a template from the Template Center
- Open an existing report
- Clone an existing report to reuse the layout
Report structure and sections
The report builder is divided into several areas to manage layout and content effectively.
1. Report details
Store metadata like the report name and category. This information is used for internal tracking only and not included in the exported report.
2. Cover page
Design the report’s front page with a title, subtitle, and optional info boxes.
3. Custom content
Write formatted text with rich styling, including:
- Headings (used in the automatic table of contents)
- Paragraphs
- Page breaks
- Fonts and formatting options
4. Charts and CxPlanner elements
Build visual dashboards with charts, lists, and statistics:
- Drag-and-drop elements into your layout
- Use Data filters to focus on specific systems, dates, or checklists
- For checklist filters, use the checklist ID from the URL
- Don’t mix incompatible chart types (e.g., commissioning + site inspection) in one block
5. File groups
Organize and include project files as grouped sections:
- Add a new file group
- Assign it a name
- Add files directly from the file module
- Rearrange files by dragging them
For example, you might add FPTs to one group and ISTs to another.
6. Appendices
Attach system-generated reports and overviews:
- Overview: Includes a list of all completed checklists
- Reports: Compiles all reports performed across the project
Video guide
Watch a step-by-step video on how to build reports:
Behavior and results
Report Component | Description |
|---|---|
Report Details | Internal metadata; not shown in final output |
Cover Page | Used as the front page of the report |
Custom Content | Fully formatted free text with table of contents generation |
Charts/Elements | Drag-and-drop layout with filtering options |
File Groups | Organize project files by topic or type |
Appendices | Adds structured project reports and documentation |
Template Support | Allows reusable layouts across projects or teams |
Troubleshooting
Problem | Cause | Solution |
|---|---|---|
Can’t see reporting module | Module not activated in project | Enable via Project Settings → Modules |
Charts not showing expected data | Mixed chart types or missing checklist filters | Apply correct filters or split into sections |
Table of contents missing | No headings used in custom text | Use heading styles for section titles |
Files not showing in report | Not added to file group | Add files manually under the correct group |
Quick facts
- Requires: Project role: Anyone
- Location: Reporting Module → Create / Edit Report
- Affects: Report exports, PDF content, documentation control
Updated on: 07/25/2025
Thank you!