Generating PDF Reports
TX1 can produce two PDF report types: Project Summary and Cost Breakdown. Both are generated by the Report Service and respect the current user's branding.
Generating a PDF
- Open the Project.
- Reports → Generate Project Summary PDF (or Generate Cost Breakdown PDF).
- Configure options (below).
- Click Generate → save location.
Service: GenerateProjectSummaryPdfAsync, GenerateCostBreakdownPdfAsync.
PdfReportOptions
| Option | Effect |
|---|---|
| IncludeSummary | Show the KPI / summary section. |
| IncludeDirectCosts | Full direct cost schedule. |
| IncludeOverheads | Full overhead schedule. |
| IncludeCarbonEmissions | Carbon section with scope breakdown. |
| IncludeCharts | Dashboard charts (dashboard widget images). |
| CompanyName | Appears on every page header. |
| LogoPath | Path to a PNG/JPG logo. |
Typical Layouts
Project Summary PDF
- Cover page — project name, client, version, date.
- Executive summary — sell total, margin, carbon headline.
- Status and health indicators.
- Top cost items and top emitters.
- Distribution charts.
- Appendix — assumptions / notes.
Cost Breakdown PDF
- Cover page.
- Direct costs schedule grouped by WBS or code set.
- Overheads schedule.
- Markup / margin breakdown.
- Sell rate schedule (if enabled).
- Carbon section (if enabled).
Branding
Set CompanyName and LogoPath once per organisation via Settings → PDF Branding. All future exports pick up the settings automatically.
Localisation
Dates, numbers, and currency are formatted according to the project's locale. Captions and section headings are localised.
File Naming
Default file name: <ProjectNumber>_<ProjectName>_Summary_<YYYY-MM-DD>.pdf. You can override at the save dialog.
Watermarks
Set Settings → PDF Branding → Draft Watermark to automatically print a "DRAFT" watermark on any PDF generated from a project with Status = Draft or Status = In Progress. Completed projects have no watermark.
Footer
Every page shows:
- Page number of total.
- Project version.
- Timestamp of generation.
- Generated-by user name.
Large Projects
PDFs for very large projects (thousands of items) can take a minute or two. A progress dialog shows percentage complete. The rendering streams direct-to-disk so memory consumption stays low.
Limitations
- PDFs are snapshots — they don't embed live data or links.
- Charts are rasterised at generation time; not searchable as text.
- For data-first sharing, prefer Excel or JSON (section 13).