Automated Documentation &
Compliance Reports for TIA Portal
Generate complete project reports, FAT/SAT acceptance test documents, and project deliverable packages in one command - no manual data gathering, no formatting work.
Four Report Types, One Command
From a quick technical overview to a signed-off compliance package
Project Report
Full technical documentation of the TIA Portal project. Covers hardware configuration, network topology, I/O list, program blocks, tags, UDTs, HMI screens, cross-references, and compilation status. The baseline document for any project handover.
FAT Report
Factory Acceptance Test report combining the full project report with automated test results, a VCS snapshot of the project state at test time, and a sign-off page. Produced at the end of factory testing before shipment.
SAT Report
Site Acceptance Test report with the same structure as the FAT report, tailored for on-site commissioning. Documents the final installed and commissioned state of the system.
Project Deliverable
A complete ZIP archive combining the PDF report, XLSX data export, a TIA Portal .zap20 archive, and a VCS snapshot. Everything the client or archive system needs in a single file.
What a Project Report Contains
Automatically extracted from the live TIA Portal project - no manual data entry
- Hardware configuration: racks, modules, firmware versions, slot assignments
- Network topology: PROFINET rings, subnets, IP addresses, device connections
- Complete I/O list: physical addresses, symbolic names, data types, descriptions
- Program block inventory: OBs, FBs, FCs, DBs with sizes and modification dates
- Tag tables: all PLC tags with addresses, types, and comments
- User-Defined Types (UDTs): structure definitions and member details
- HMI screens: screen list, elements count, and tag bindings overview
- Cross-reference analysis: where each tag and block is used across the project
- Compilation status: last build result, errors, warnings per device
Output Formats
Each format serves a different audience and workflow
PDF Report
Human-readable document for clients, auditors, and project archives. Structured sections, tables, and a cover page. Ready for printing or digital signature.
XLSX Data Export
Machine-readable spreadsheet for further analysis, import into ERP/MES systems, or custom reporting pipelines. Each section on a dedicated sheet.
ZIP Deliverable
Complete project package: PDF report + XLSX data + .zap20 TIA Portal archive + VCS snapshot. One file to hand over to the client or store in the document management system.
Report Options
Fine-tune what each report includes
Device Filter
Scope the report to a specific PLC or HMI device using the deviceName option. Useful for multi-device projects where each device has its own acceptance test.
Source Code Inclusion
The includeSourceCode option appends full SCL source for all program blocks. Useful for audits, code reviews, or contractual source delivery requirements.
Test Results
includeTestResults attaches the output of T-IA Connect automated PLC tests run before report generation. Proves that the system passed its test suite at the moment of sign-off.
VCS Snapshot
includeVcsSnapshot records the Git commit hash and branch at report generation time. Provides a tamper-evident link between the report and the exact code version tested.
Reports as Part of Your DevOps Pipeline
Trigger report generation automatically at the end of CI/CD stages
T-IA Connect exposes both synchronous and asynchronous REST endpoints for report generation. A CI pipeline can trigger a FAT report at the end of a successful PLCSim test run, attach the PDF as a build artifact, and notify the responsible engineer - all without human intervention.
The async endpoint is recommended for large projects: the job is queued, the pipeline polls for completion, and the finished report is downloaded when ready. For smaller projects, the sync endpoint returns the file directly.
Combined with Git versioning and automated PLC testing, automated reporting closes the DevOps loop: every merge to main produces a versioned report, a tested system state, and a complete project deliverable.
MCP Tools Reference
Six tools covering all report types and output formats
generate_project_report
Generates the full technical project report. Options: deviceName, includeSourceCode, outputPath. Returns the PDF report file.
generate_project_deliverable
Produces the complete ZIP deliverable package: PDF + XLSX + .zap20 archive + VCS snapshot. The standard handover package for project completion.
fat_generate_report
Generates the Factory Acceptance Test report. Combines project report with test results, VCS snapshot, and sign-off page. Produced at end of factory testing.
sat_generate_report
Generates the Site Acceptance Test report. Same structure as FAT, adapted for on-site commissioning documentation.
Async REST endpoint
POST /api/reports/generate - queues a report generation job and returns a job ID. Poll GET /api/reports/job/{id} for status, then download when complete. Recommended for large projects.
Sync REST endpoint
POST /api/reports/generate/sync - generates the report synchronously and returns the file directly. Suitable for smaller projects or interactive use.