1. Einleitung
In diesem Modul wird die Einrichtung des Open Source UML-Modellierungswerkzeug Papyrus sowie des X-Generators erläutert, die für die Entwicklung von XÖV-konformen Standards notwendig sind. Folgende Tools und XÖV-Produkte werden benötigt:
-
Papyrus als UML-Tool für die Erstellung des Modells mit Hilfe von Klassendiagrammen
-
XÖV-Profil (enthalten im XÖV-Starterpaket)
-
DocBook-Generierungsteil des KoSIT-Zubehör (enthalten im XÖV-Starterpaket)
-
XGenerator
Diese Dokumentation bezieht sich auf Papyrus 6.4.0, dem XÖV-Starterpaket 3.0.2 und dem XGenerator 3.1.1
2. Papyrus
2.1. Einrichtung von Papyrus
Eclipse Papyrus kann als komplettes Paket unter www.eclipse.org/papyrus/download.html für das jeweilige Betriebssystem heruntergeladen werden. Die nachfolgenden Erläuterungen beziehen sich auf Windows-Systeme, da nur diese offiziell von der KoSIT unterstützt werden.
Papyrus wird als ZIP-Datei zur Verfügung gestellt und die entpackten Dateien können direkt in einen Programm-Ordner beispielsweise in den Anwendungsordner geschoben werden (in diesem Fall müssen Administratorrechte gewährt werden).
Details
Gestartet wird Papyrus, in dem die ausführbare Papyrus-Datei mit einem Doppelklick gestartet wird (die Papyrus-Datei mit dem Vogel als Logo).
Details
Nach dem Starten von Papyrus einen Workspace auswählen.
Details
Danach sollte das Programm ordnungsgemäß gestartet sein.
2.2. Orientierung in Papyrus
2.2.1. Werkzeugleiste
Die Werkzeugleiste von Papyrus befindet sich normalerweise am oberen Rand des Hauptfensters. Sie enthält eine Reihe von Symbolen und Schaltflächen, die verschiedene Aktionen und Funktionen repräsentieren. Hier finden Sie häufig verwendete Werkzeuge wie das Erstellen neuer Diagramme, das Speichern von Änderungen, das Kopieren und Einfügen von Elementen und mehr. Die Werkzeugleiste ist ein zentraler Ort, um auf häufig genutzte Funktionen zuzugreifen.
2.2.2. Project Explorer
Der Project Explorer ist ein Fenster auf der linken Seite des Hauptfensters. Hier können Sie die Struktur Ihres aktuellen Projekts anzeigen und verwalten. Der Project Explorer zeigt Ordner, Dateien und Ressourcen Ihres Projekts an. Dies ist besonders nützlich, um Modelle, Diagramme und andere Artefakte zu organisieren und zu navigieren. Sie können neue Ressourcen erstellen, bestehende Ressourcen umbenennen, verschieben oder löschen, und auf die Kontextmenüs zugreifen, um verschiedene Aktionen auszuführen.
2.2.3. Model Explorer
Der Model Explorer ist ein Fenster auf der rechten Seite des Hauptfensters. Er zeigt die Struktur und Hierarchie des aktuell ausgewählten Modells oder Diagramms an. Hier können Sie die Elemente Ihres Modells anzeigen, auswählen und bearbeiten. Sie können Klassen, Beziehungen, Pakete und andere Modellierungselemente hier sehen und organisieren. Der Model Explorer bietet eine praktische Möglichkeit, sich einen Überblick über Ihr Modell zu verschaffen und direkt darin zu arbeiten.
2.2.4. Editorfenster
Das Editorfenster ist der zentrale Bereich von Papyrus, in dem Sie Ihre Diagramme und Modelle erstellen und bearbeiten können. Wenn Sie ein bestimmtes Diagramm oder Modell im Project Explorer oder Model Explorer auswählen, wird es im Editorfenster angezeigt. Hier können Sie Elemente ziehen und ablegen, Eigenschaften bearbeiten, Verbindungen erstellen und Diagramme visuell gestalten.
3. Einbinden des XÖV-Starterpakets
In diesem Kapitel werden wir die Schritte zum Bezug des XÖV-Starterpakets und die Integration in Papyrus erläutert. Das XÖV-Starterpaket bietet Ihnen eine Grundlage für die Einrichtung Ihrer XÖV-Entwicklungsumgebung für die anschließende Entwicklung. Es kann hier in der aktuellen sowie älteren Versionen für Papyrus bezogen werden.
Im Folgenden wird davon ausgegangen, dass die ZIP-Datei an einem beliebigen Ort entpackt, Papyrus gestartet und ein neuer Workspace (s.o.) ausgewählt wurde.
-
In dem leeren Workspace soll ein Projekt importieren werden. Dafür kann über das Menü File→Import… gewählt werden oder direkt im leeren Project Explorer Import projects… gewählt werden.
Details
-
Dort General→Existing Projects into Workspace wählen und auf Next > klicken.
Details
-
Im nächsten Fenster bei Select root directory: auf Browse… klicken.
Details
-
Dort das model-Verzeichnis aus dem Starterpaket wählen und Open anklicken.
Details
-
Anschließend das XOEV-Starterpaket auswählen, falls dieses noch nicht durch einen Haken ausgewählt ist, und auf Finish klicken.
Details
Das Starterpaket ist nun in Papyrus eingebunden und kann als Ausgangspunkt für die Entwicklung XÖV-konformen Standards dienen.
4. Einrichtung des XGenerators
Der XGenerator ist ein Tool, das speziell für die automatisierte Generierung von Artefakten aus XÖV-Modellen entwickelt wurde. Mit dem ihm können Entwickler XML-Schemas, Codefragmente, Dokumentation und andere relevante Artefakte erstellen.
Der XGenerator basiert auf vordefinierten Konfigurationen, die auf den XÖV-Spezifikationen beruhen. Diese Konfigurationen enthalten Regeln und Vorlagen, die den Generierungsprozess steuern und sicherstellen, dass die erstellten Artefakte den Standards entsprechen. Durch die Nutzung des XGenerators werden potenzielle Fehler minimiert, da der Prozess automatisiert und reproduzierbar ist.
4.1. Installation des XGenerators
Der XGenerator kann unter docs.xoev.de/downloads/downloads#_xgenerator als msi-Datei bezogen werden. Die hier angegebene Installation bezieht sich nur auf Windows-Systeme.
Nach dem Starten der Datei kann den Anweisungen der Installation gefolgt werden (ggf. brauchen Sie adminestrative Rechte für ihr Betriebssystem)
Details
Sie können nun den XGenerator über das Startmenü öffnen. Der XGenerator ist nun einsatzbereit.
4.2. Testen des XGenerators
Nach der Installation kann der XGenerator getestet werden, indem das Projekt aus dem Starterpaket geladen wird und die Generierung der Artefakte dessen durchgeführt wird.
Dafür starten Sie den XGenerator, falls das noch nicht geschehen ist über ihr Startmenü und wählen Sie anschließend im Menü Projekt öffnen….
Details
Im folgenden Dialog die wird starterpaket.xgen-project aus dem Starterpaket-Ordner ausgewählt und geöffnet.
Details
Anschließend kann duch Anlicken von Verarbeitung starten die Erzeugung der Artefakte gestartet werden.
Details
Mittels der Baumansicht wird eine Übersicht gegeben, welche Artefakte erzeugt wurden und wo es Fehlermeldungen gab. In diesem Fall sollte die Erzeugung fehlerfrei erfolgt sein.
4.3. Vom XGenerator generierte Artefakte
Im Folgenden werden die in diesem Fall vom XGenerator generierten Artefakte erläutert:
4.3.1. XML-Schema-Dateien
Die XML-Schema-Dateien, die vom XGenerator erstellt werden, sind eine Schlüsselkomponente für XÖV-Implementierungen. Diese Dateien definieren die Struktur und den Aufbau von XML-Nachrichten, die zwischen verschiedenen Behörden oder Systemen ausgetauscht werden sollen. Sie spezifizieren, welche Elemente in einer Nachricht enthalten sein dürfen, welche Datentypen sie haben können und wie sie miteinander verknüpft sind. Diese XML-Schemas sind entscheidend, um sicherzustellen, dass Nachrichten gemäß den XÖV-Standards erstellt und validiert werden können.
Beispiel starterpaket-baukasten.xsl (Auszug):
4.3.2. Schematron-Datei
Die Schematron-Datei, die vom XGenerator generiert wird, ist ein weiteres wichtiges Artefakt. Schematron ist eine regelbasierte Validierungssprache, die sich für die Prüfung von Geschäftsregeln und strukturellen Bedingungen in XML-Nachrichten eignet. Die Schematron-Regeln werden in dieser Datei definiert und können auf die erzeugten XML-Nachrichten angewendet werden, um sicherzustellen, dass sie den spezifischen Anforderungen und Geschäftslogiken entsprechen.
Beispiel starterpaket-schematron.sch (Auszug):
4.3.3. Dokumentationsfragmente in DocBook
Der XGenerator erstellt Dokumentationsfragmente im DocBook-Format, einem weit verbreiteten XML-basierten Format für die Erstellung von technischer Dokumentation. Diese Fragmente können als Grundlage für umfassende Benutzerhandbücher, Entwicklerdokumentation oder andere technische Unterlagen dienen. Sie enthalten Informationen über die generierten XML-Schemas, Schematron-Regeln, Datentypen und andere relevante Details, die für die erfolgreiche Implementierung und den Datenaustausch erforderlich sind.
Beispiel Identifikation.Hamster.xml (Auszug):
4.4. Erzeugung der Dokumentation
Aus den statischen und dynamischen Fragmenten wird hier im Workflow die Dokumentation als PDF erstellt mit Hilfe eines Skripts erzeugt. Dafür starten Sie die generate_documentation.bat im Starterpaket-Ordner (bei der Dokumentation eines "echten" XÖV-konformen Standards müssen in der Regel noch Textpassagen, die beispielsweise zugrunde liegende Paragraphen benennen, händisch vom Nutzer eingepflegt werden).
Nachdem das Skript durchgelaufen ist, ist die PDF unter pdf/spezifikation.pdf zu finden.
