Automatisierte Dokumentation &
Compliance-Berichte für TIA Portal
Erstellen Sie vollständige Projektberichte, FAT/SAT Abnahmedokumente und Übergabepakete mit einem Befehl - keine manuelle Datenerfassung, kein Formatierungsaufwand.
Vier Berichtstypen, ein Befehl
Vom schnellen technischen Überblick bis zum unterzeichneten Compliance-Paket
Projektbericht
Vollständige technische Dokumentation des TIA Portal Projekts. Deckt Hardware-Konfiguration, Netzwerktopologie, E/A-Liste, Programmbausteine, Variablen, UDTs, HMI-Bilder, Querverweise und Kompilierungsstatus ab. Das Basisdokument für jede Projektübergabe.
FAT-Bericht
Factory Acceptance Test Bericht, der den vollständigen Projektbericht mit automatisierten Testergebnissen, einem VCS Snapshot des Projektstatus zum Testzeitpunkt und einer Abnahmeseite kombiniert. Erstellt am Ende der Werksprüfung vor dem Versand.
SAT-Bericht
Site Acceptance Test Bericht mit derselben Struktur wie der FAT-Bericht, angepasst für die Inbetriebnahme vor Ort. Dokumentiert den finalen installierten und in Betrieb genommenen Zustand des Systems.
Projektübergabepaket
Ein vollständiges ZIP-Archiv, das den PDF-Bericht, den XLSX-Datenexport, ein TIA Portal .zap20 Archiv und einen VCS Snapshot kombiniert. Alles, was der Kunde oder das Archivsystem benötigt, in einer Datei.
Inhalt eines Projektberichts
Automatisch aus dem Live-TIA Portal Projekt extrahiert - keine manuelle Dateneingabe
- Hardware-Konfiguration: Racks, Module, Firmware-Versionen, Steckplatzbelegungen
- Netzwerktopologie: PROFINET-Ringe, Subnetze, IP-Adressen, Geräteverbindungen
- Vollständige E/A-Liste: physikalische Adressen, Symbolnamen, Datentypen, Beschreibungen
- Programmbaustein-Inventar: OBs, FBs, FCs, DBs mit Größen und Änderungsdaten
- Variablentabellen: Alle SPS-Variablen mit Adressen, Typen und Kommentaren
- User-Defined Types (UDTs): Strukturdefinitionen und Member-Details
- HMI-Bilder: Bilderliste, Elementanzahl und Übersicht der Variablenanbindungen
- Querverweisanalyse: Wo jede Variable und jeder Baustein im Projekt verwendet wird
- Kompilierungsstatus: Letztes Build-Ergebnis, Fehler, Warnungen pro Gerät
Ausgabeformate
Jedes Format bedient eine andere Zielgruppe und einen anderen Workflow
PDF-Bericht
Menschenlesbares Dokument für Kunden, Auditoren und Projektarchive. Strukturierte Abschnitte, Tabellen und ein Deckblatt. Bereit für Druck oder digitale Signatur.
XLSX-Datenexport
Maschinenlesbare Tabelle für weitere Analysen, Import in ERP/MES-Systeme oder benutzerdefinierte Reporting-Pipelines. Jeder Abschnitt auf einem eigenen Blatt.
ZIP-Übergabepaket
Vollständiges Projektpaket: PDF-Bericht + XLSX-Daten + .zap20 TIA Portal Archiv + VCS Snapshot. Eine Datei zur Übergabe an den Kunden oder zur Speicherung im Dokumentenmanagementsystem.
Berichtsoptionen
Feineinstellung des Berichtsinhalts
Gerätefilter
Beschränken Sie den Bericht auf eine bestimmte SPS oder ein HMI-Gerät mit der Option deviceName. Nützlich für Multi-Geräte-Projekte, bei denen jedes Gerät einen eigenen Abnahmetest hat.
Quellcode-Einschluss
Die Option includeSourceCode fügt den vollständigen SCL Quellcode für alle Programmbausteine hinzu. Nützlich für Audits, Code-Reviews oder vertragliche Quellcode-Lieferungen.
Testergebnisse
includeTestResults fügt die Ergebnisse der automatisierten T-IA Connect SPS-Tests hinzu, die vor der Berichtserstellung durchgeführt wurden. Beweist, dass das System zum Zeitpunkt der Abnahme die Testsuite bestanden hat.
VCS Snapshot
includeVcsSnapshot zeichnet den Git Commit-Hash und den Branch zum Zeitpunkt der Berichterstellung auf. Bietet eine manipulationssichere Verbindung zwischen dem Bericht und der exakten getesteten Codeversion.
Berichte als Teil Ihrer DevOps-Pipeline
Berichtserstellung automatisch am Ende der CI/CD-Phasen auslösen
T-IA Connect bietet sowohl synchrone als auch asynchrone REST-Endpunkte für die Berichtserstellung. Eine CI-Pipeline kann am Ende eines erfolgreichen PLCSim Testlaufs einen FAT-Bericht auslösen, das PDF als Build-Artefakt anhängen und den verantwortlichen Ingenieur benachrichtigen - alles ohne menschliches Eingreifen.
Der asynchrone Endpunkt wird für große Projekte empfohlen: Der Auftrag wird in eine Warteschlange gestellt, die Pipeline fragt den Status ab und der fertige Bericht wird heruntergeladen, wenn er bereit ist. Für kleinere Projekte gibt der synchrone Endpunkt die Datei direkt zurück.
Kombiniert mit Git Versionierung und automatisierten SPS-Tests schließt automatisiertes Reporting den DevOps-Kreislauf: Jeder Merge in den Hauptzweig erzeugt einen versionierten Bericht, einen getesteten Systemzustand und ein vollständiges Projektergebnis.
MCP Tools Referenz
Sechs Tools für alle Berichtstypen und Ausgabeformate
generate_project_report
Erstellt den vollständigen technischen Projektbericht. Optionen: deviceName, includeSourceCode, outputPath. Liefert die PDF-Berichtsdatei zurück.
generate_project_deliverable
Erstellt das vollständige ZIP-Übergabepaket: PDF + XLSX + .zap20 Archiv + VCS Snapshot. Das Standardpaket für den Projektabschluss.
fat_generate_report
Erstellt den Factory Acceptance Test Bericht. Kombiniert Projektbericht mit Testergebnissen, VCS Snapshot und Abnahmeseite.
sat_generate_report
Erstellt den Site Acceptance Test Bericht. Gleiche Struktur wie FAT, angepasst für die Dokumentation der Inbetriebnahme vor Ort.
Asynchroner REST-Endpunkt
POST /api/reports/generate - stellt einen Berichtserstellungsauftrag in die Warteschlange und gibt eine Job-ID zurück. Fragen Sie GET /api/reports/job/{id} nach dem Status ab und laden Sie ihn nach Fertigstellung herunter.
Synchroner REST-Endpunkt
POST /api/reports/generate/sync - erstellt den Bericht synchron und gibt die Datei direkt zurück. Geeignet für kleinere Projekte oder interaktive Nutzung.