Logo IT Planungsrat
logo

XÖV-Primer: Handreichung zur vereinfachten Spezifikation von XÖV-Standards

Der XÖV-Primer ist ein von der Koordinierungstelle für IT-Standards (KoSIT) im Auftrag des IT-Planungsrats herausgegebenes Dokument. Er baut auf dem XÖV-Handbuch auf und stellt keinen Ersatz hierzu dar. Die in dem XÖV-Handbuch dargestellten Konformitätskriterien und Namens- und Entwurfsregeln sind Grundlage zur Zertifizierung von XÖV-Standards.

Versionskennung: urn:xoev-de:kosit:handbuch:primer_1.0
Fassung vom: 15.12.2022
Lizenz: Creative Commons Namensnennung 4.0

1. Vorbemerkungen

Das XÖV-Rahmenwerk wird seit 2010 im Auftrag des IT-Planungsrats durch die Koordinierungsstelle für IT-Standards (KoSIT) herausgegeben und fortentwickelt. Das Rahmenwerk, seine Methodik und seine Produkte wurden von Beginn an auf Grundlage der spezifischen Anforderungen von Standardisierungsvorhaben der öffentlichen Verwaltung konzipiert und umgesetzt. Die einzelnen, kostenfrei bereitgestellten XÖV-Produkte bieten Standardisierungsvorhaben qualitätsgesicherte und praxistaugliche Lösungen zur effizienten und wirtschaftlichen Umsetzung der eigenen fachlichen Anforderungen bei der Entwicklung und Fortschreibung von XÖV-Standards.

Mit dem Release 3.0 des XÖV-Standardisierungsrahmens und seiner Produkte wurde ein Augenmerk darauf gelegt, den Einstieg in die Entwicklung und auch den letztendlichen Betrieb von XÖV-Standards zu vereinfachen. Die mit dem Release bereitgestellten Produkte bieten die Möglichkeit, alternativ zum kommerziellen Modellierungswerkzeug MagicDraw das Open-Source-Modellierungswerkzeug Papyrus zur Entwicklung des XÖV-Fachmodells zu verwenden.

Darüber hinaus wurde die Methodik zur Spezifikation und Produktion von XÖV-Standards deutlich vereinfacht. Die aktualisierte Methodik wird in der mit diesem Dokument vorliegenden ersten Version des so genannten XÖV-Primers[1] beschrieben.

1.1. Zielgruppe und Zweck

Der XÖV-Primer richtet sich an Personen, die mit der Entwicklung, Umsetzung oder dem Betrieb eines Standards betraut sind und sich im Rahmen dieser Aufgabe mit der Pflege eines XÖV-Fachmodells befassen.

Leser:innen des Dokuments sollten mit den Inhalten des XÖV-Handbuchs und des Codelisten-Handbuchs vertraut sein und bestenfalls bereits an einer XÖV-Schulung teilgenommen haben.

1.2. Ansprechpartner und Mitwirkende

Der XÖV-Primer wird durch die KoSIT im Auftrag des IT-Planungsrats betrieben und unter der CC BY Lizenz (Creative Commons Namensnennung 4.0) herausgegeben. Er unterliegt dem geregelten Produktbetrieb. Etwaige Änderungsanforderungen, Erweiterungen oder Fehlermeldungen zum XÖV-Primer können über die Website zum Produkt an die KoSIT gemeldet werden.

An der vorliegenden Fassung des Dokuments haben folgende Personen mitgewirkt:

Table 1. Ansprechpartner und Mitwirkende
Rolle Name Institution

Editor

Lutz Rabe

Koordinierungsstelle für IT-Standards

Editor

Dr. Mirco Kuhlmann

LAVA Unternehmensberatung

Mitwirkend

Hauke Edeler

Koordinierungsstelle für IT-Standards

Mitwirkend

Moritz Hanke

Koordinierungsstelle für IT-Standards

2. Einleitung

Der XÖV-Primer soll als Erweiterung des XÖV-Handbuchs verstanden werden. Er fokussiert auf die im XÖV-Handbuch dargestellten, grundlegenden und in allen XÖV-Fachmodellen eingesetzten Modellierungstechniken zur Spezifizierung der Abbildung eines Standards in seine technische Repräsentation respektive seinen XML Schema-Definitionen.

Die in einem XÖV-Standard modellierten Bestandteile zur Datenübermittlung (insb. Nachrichten und Datentypen) können beinahe beliebig komplexe Strukturen aufweisen, die die volle Sprachbandbreite von XML Schema und damit den vollen Funktionsumfang des XÖV-Profils ausschöpfen.

In der Praxis wird von der Mehrheit der bestehenden XÖV-Standards allerdings nur ein Bruchteil der zur Verfügung stehenden Sprachvielfalt und -komplexität bei der Ausgestaltung der eigenen XML Schema-Definitionen genutzt. Zudem kann festgestellt werden, dass die Teilmenge der genutzten Funktionen des XÖV-Profils und somit auch die Teilmenge der Sprachelemente zur Ausgestaltung der XML Schema-Definitionen bei einem Großteil der Standards nahezu identisch ist.

Mit XÖV 3.0 und dem XÖV-Primer wird jetzt die Möglichkeit geschaffen, die Sprachelemente, die durch alle bzw. sehr viele Standards genutzt werden, vereinfacht (i. S. v. implizit) im XÖV-Fachmodell zu modellieren.

Dafür werden für die Produktionsumgebung eine Reihe von Annahmen getroffen, die dazu führen, dass, sofern keine explizite technische Auszeichnung für den jeweiligen Modellbestandteil im XÖV-Fachmodell vorliegt, eine Standardüberführung in XML Schema durchgeführt wird. Man kann somit von einer impliziten Modellierung dieser Sprachelemente im XÖV-Fachmodell sprechen. Mit diesem Ansatz können die Aufwände und Fehlerquellen bei der Überführung eines Fachmodells in ein XÖV-Fachmodell deutlich reduziert werden.

Mit dem Fachmodell eines XÖV-Standards werden die fachlichen Anforderungen an eine Datenübermittlung beschrieben. Es ist in UML notiert und definiert neben den auszutauschenden Informationen einer Datenübermittlung (Klassendiagramm) auch Anwendungsfälle (Anwendungsfalldiagramm) und Prozesse (Aktivitätsdiagramm). Werden die Details der technischen Umsetzung in beispielsweise XML Schema in einem Fachmodell ergänzt, so spricht man vom XÖV-Fachmodell eines Standards.

Die hierzu für die Produktionsumgebung getroffenen Annahmen basieren auf den folgenden Leitmotiven:

  • Vermeidung redundanter Auszeichnungen im XÖV-Fachmodell

  • Einheitliche Überführung von impliziten Modellierungsmustern in XML Schema-Definitionen

In den folgenden Abschnitten werden die neuen Möglichkeiten zur vereinfachten, impliziten Ausgestaltung des XÖV-Fachmodells im Detail anhand eines fiktiven XÖV-Standards beschrieben.

Die Inhalte der folgenden Abschnitte bauen auf den im XÖV-Handbuch in Kapitel 4. "Spezifikation und Produktion von XÖV-Standards" geschaffenen Grundlagen auf. Die im XÖV-Handbuch dargestellten expliziten Modellierungsansätze behalten weiterhin ihre Gültigkeit und können parallel zu den im XÖV-Primer beschriebenen impliziten Modellierungsansätzen genutzt werden.

3. Bestandteile eines XÖV-Fachmodells

In diesem und den folgenden Abschnitten werden die Bestandteile eines (XÖV-)Fachmodells beschrieben, für die eine implizite Modellierung der XML Schema-Sprachelemente, d. h. eine Standardüberführung in XML Schema, zur Verfügung steht.

Die implizite Modellierung betrifft die folgenden Modellbestandteile:

Nachrichten

Nachrichten stellen die Modellbestandteile zur Datenübermittlung dar, mit denen der Umfang, die Struktur und die Form der mit einer entsprechenden Nachrichteninstanz übermittelbaren Daten bestimmt wird. Nachrichten besitzen Eigenschaften, mit denen letztlich die zu übermittelnden Daten bzw. Datenkomplexe spezifiziert werden. Eigenschaften besitzen einfache Datentypen (sie beschreiben somit einfach strukturierte Daten wie bestimmte Zeichenfolgen) oder komplexe Datentypen (sie beschreiben somit Datenstrukturen bestehend aus weiteren Eigenschaften, die wiederum eine einfache oder komplexe Struktur besitzen können).

Datentypen

Datentypen stellen Modellbestandteile dar, mit denen bestimmte fachliche oder technische Dinge einmalig in Umfang, Struktur und Form spezifiziert werden. Datentypen können daraufhin an den benötigten Stellen in Nachrichten und weiteren Datentypen eingesetzt, das heißt wiederverwendet, werden. Datentypen besitzen wie Nachrichten Eigenschaften mit einfachen oder komplexen Strukturen.

3.1. Beispielhafter Standard

Zur Veranschaulichung der folgenden Ausführungen und Details werden Ausschnitte aus einem fiktiven XÖV-Standard bzw. dem zugehörigen (XÖV-)Fachmodell herangezogen.

In diesem Standard werden verschiedene Anwendungsfälle zur Organisation einer Schulung modelliert. Einer der Anwendungsfälle ist die Anmeldung von Teilnehmer:innen (Trainees) mittels einer (XÖV-)Nachricht.

3.2. Entwurf in einem Fachmodell

In der Entwurfsphase eines Standards wird das Fachmodell des Standards entwickelt, siehe Abschnitt 1.3. "XÖV-Entwicklungsprozess" des XÖV-Handbuchs.

Nachrichten, Datentypen und deren Eigenschaften werden mittels UML-Klassen, UML-Klassenattributen und UML-Beziehungen (gerichtete Kompositionen) modelliert. Den Eigenschaften werden Datentypen und Multiplizitäten zugeordnet.

Mit der Multiplizität einer Eigenschaft wird die Häufigkeit bestimmt, mit der Daten im Kontext der Eigenschaft übermittelt werden dürfen bzw. müssen. Eine Multiplizität hat die Form "m…​n". Mit der Zahl m wird bestimmt, wie häufig mindestens zu übermitteln ist, und mit der Zahl n wie häufig maximal übermittelt werden darf. Wenn m und n gleich sind, wird häufig die verkürzte Darstellung der Multiplizität "m" genutzt. Wenn die Häufigkeit nach oben nicht beschränkt werden soll, erhält n den Wert "*".

Das folgende Fachmodell stellt die Nachricht 0001 zur Schulungsanmeldung (organisation.anmeldung.0001) sowie die Datentypen Schulung und Trainee dar.

Nachricht organisation.anmeldung.0001 und darin genutzte Datentypen Schulung und Trainee

Organisation.Anmeldung.Fachmodell

Der Datentyp Schulung besitzt vier einfache Eigenschaften, mit denen die Schulungsbezeichnung, die Art der Schulung, das Schulungsmodul und der Schulungstermin mittels einfacher Zeichenfolgen (basierend auf dem XÖV-Datentyp datatypeC aus der XÖV-Bibliothek) übermittelt werden. Die Eigenschaften besitzen die Multiplizität "1" und müssen somit jeweils genau einmal übermittelt werden. Der Datentyp Trainee besitzt zwei einfache Eigenschaften mit denen der Name und die E-Mail-Adresse eines Trainees ebenfalls jeweils genau einmal übermittelt werden.

Die Nachricht 0001 führt diese Modellbestandteile zusammen. Sie enthält eine einfache Eigenschaft, mit der die Bezeichnung der Organisation, in deren Namen die Anmeldung erfolgt, übermittelt wird sowie zwei komplexe Eigenschaften, mit denen die Daten einer Schulung und mindestens eines anzumeldenden Trainees übermittelt werden.

Die Eigenschaften einer Nachricht bzw. eines Datentyps können als Klassenattribute, also innerhalb des Körpers einer Klasse aufgeführt werden. Dies geschieht in der Regel für einfache Eigenschaften (z. B. anmeldendeOrganisation). Komplexe Eigenschaften können ebenso als Klassenattribute aufgeführt werden. In der Regel werden diese jedoch als Enden einer UML-Beziehung (d. h. einer gerichteten Komposition) modelliert (z. B. die Eigenschaft schulung).

Nachrichten und Datentypen werden in verschiedene thematische oder strukturierende Modellpakete eingeordnet, die Nachricht 0001 in die Nachrichtengruppe zu Schulungsanmeldungen und die beiden Datentypen in einen so genannten Baukasten, der die fachlichen Datentypen zur Wiederverwendung im Standard enthält.

Organisation von Nachrichten und genutzten Datentypen in Modellpaketen

Organisation.Anmeldung.Fachmodell.Pakete

3.3. Spezifikation in einem XÖV-Fachmodell

In der Spezifikationsphase eines Standards wird das Fachmodell durch Anwendung der XÖV-Namens- und Entwurfsregeln (siehe Abschnitt 4.3. "XÖV-Namens- und Entwurfsregeln" des XÖV-Handbuchs) sowie Ergänzung technischer Details mittels der Stereotypen des XÖV-Profils in ein XÖV-Fachmodell überführt.

Die technischen Details werden zur Steuerung der automatisierten Generierung der Bestandteile des Standards aus dem XÖV-Fachmodell benötigt, d. h. insbesondere zur Steuerung der Überführung der Bestandteile des XÖV-Fachmodells in XML Schema-Definitionen und zugehörige DocBook-Dokumentation.

Nachrichten und Datentypen werden mit dem Standard als XML Schema-Bestandteile geordnet in XML-Schema-Definitionen zur technischen Verarbeitung bereitgestellt, z. B. zum automatisierten Aufbau der Grundstrukturen eines Softwareverfahrens oder der automatischen Validierung von Nachrichteninstanzen.

Mit der impliziten Modellierung werden die zu ergänzenden technischen Details für die genannten Modellbestandteile gegenüber der bisherigen, expliziten XÖV-Modellierung soweit reduziert, dass unter Annahme einer bestimmten Standardüberführung in XML Schema ausschließlich zwingend benötigte Angaben zur Steuerung verbleiben.

Im Folgenden werden die zur Spezifikation eines XÖV-Fachmodells benötigten Ergänzungen anhand des gegebenen Beispiels erläutert.

Dabei wird für Personen, die mit der bisherigen XÖV-Modellierung Erfahrung haben, auf die Unterschiede zwischen der früheren und der zukünftig möglichen Modellierung eingegangen.
Fachmodell und seine Erweiterung zum XÖV-Fachmodell