Seminar Cameo Systems Modeler / MagicDraw – Dokumentation mit Report Wizard und VTL

Freigabefähige Dokumente müssen Modellinhalte selektieren, ordnen und reproduzierbar formatieren. Das Seminar entwickelt Report-Wizard-Vorlagen mit Velocity Template Language von einfachen Variablen bis zu verschachtelten Tabellen, Diagrammen, Hilfsfunktionen und automatisierten Berichtsläufen.

Inhaltsübersicht

• Zielsetzung
• Zielgruppe
• Voraussetzungen
• Seminarinhalte
• Praxisübungen
• Methodik

Zielsetzung

• Berichtsanforderungen in Datenumfang, Struktur und Ausgabeformat übersetzen
• Report-Daten, Variablen und VTL-Ausdrücke sicher verwenden
• Tabellen, Schleifen, Bedingungen, Bilder und Diagramme robust erzeugen
• Vorlagen testen, versionieren und für wiederholbare Läufe bereitstellen

Zielgruppe

Dokumentationsverantwortliche, Systems Engineering, Qualitätsmanagement, technische Redaktion, Modelladministration und Tool-Engineering.

Voraussetzungen

Sichere Navigation im Modell und Grundverständnis der verwendeten Elementtypen. Kenntnisse einfacher Variablen, Bedingungen oder Skriptsprachen sind hilfreich.

Seminarinhalte

1. Schritt 1: Berichtszweck und Datenumfang definieren

   Empfänger, Freigabestatus, Kapitelstruktur, benötigte Elemente, Sortierung und Ausgabemedium werden festgelegt.

2. Schritt 2: Vorlage und Report-Daten vorbereiten

   Basisvorlage, Variablen, Projektkontext, Startpunkte und wiederverwendbare Datenmengen werden eingerichtet.

3. Schritt 3: VTL-Grundlagen anwenden

   Variablen, Eigenschaften, Methodenaufrufe, Bedingungen, Schleifen und Makros werden an kleinen Ausgaben erprobt.

4. Schritt 4: Modellelemente gezielt navigieren

   Besitzhierarchie, Typen, Stereotypen, Beziehungen, gerichtete Enden und Nullwerte werden sicher verarbeitet.

5. Schritt 5: Tabellen und Listen erzeugen

   Zeilenwiederholung, Gruppierung, Sortierung, Summen, leere Mengen und mehrstufige Strukturen werden robust umgesetzt.

6. Schritt 6: Diagramme und Abbildungen einbetten

   Diagrammauswahl, Bildgröße, Beschriftung, Seitenumbruch und fehlende Darstellung werden kontrolliert behandelt.

7. Schritt 7: Format und Dokumentstruktur steuern

   Überschriften, Nummerierung, Inhaltsverzeichnis, Kopf- und Fußbereiche, Querverweise und Abschnittswechsel werden vorbereitet.

8. Schritt 8: Hilfswerkzeuge und OpenAPI nutzen

   Report-Tools, eigene Hilfsfunktionen und gezielte API-Zugriffe erweitern die Standardvariablen, ohne die Vorlage unnötig zu verkomplizieren.

9. Schritt 9: Fehler und Sonderfälle behandeln

   Nicht vorhandene Werte, falsche Typen, zyklische Strukturen, große Datenmengen und Formatierungsfehler werden diagnostiziert.

10. Schritt 10: Berichtsläufe automatisieren

    Parameter, Batch-Aufruf, Ablage, Dateinamen, Protokollierung und Abbruchkriterien werden für reproduzierbare Ausgaben eingerichtet.

11. Schritt 11: Vorlagen versionieren und freigeben

    Testmodell, erwartete Ausgabe, Review, Release-Notiz, Kompatibilität und Rückfall werden in einen Vorlagenprozess überführt.

Praxisübungen

• Eine Berichtsvorlage mit Projektmetadaten und Kapitelstruktur erstellen
• Eine gefilterte Elementtabelle mit Beziehungen und Statuswerten erzeugen
• Diagramme und wiederholte Tabellenzeilen in eine Dokumentvorlage einbetten
• Einen automatisierten Berichtslauf mit Test- und Freigabekriterien definieren

Methodik

Fachliche Einordnung, live geführte Demonstrationen, schrittweise Modellierungsübungen, gemeinsame Reviews und eine durchgängige Fallstudie. Jede Übung baut auf dem vorherigen Arbeitsschritt auf; Fehlerbilder und Qualitätskriterien werden unmittelbar ausgewertet.