XÖV-Rahmenwerk
Mit dem XOV Rahmenwerk werden Vorhaben dabei unterstützen, einen Fachstandard zur nachrichtenbasierten Datenübermittlung von und an Behörden der öffentlichen Verwaltung Deutschlands zu entwickeln und zu betreiben.
Das durch die XÖV-Koordination bereitgestellte XÖV-Rahmenwerk und seine Produkte ermöglichen die praktische Umsetzung der einzelnen Schritte des XÖV-Entwicklungsansatzes Damit wird ein XÖV-Vorhaben umfassend von der ersten systematischen Ermittlung der fachlichen Anforderungen bis zur letztendlichen Bereitstellung eines XÖV-Standards unterstützt. Der Standardisierungsrahmen besteht aus einer Reihe von aufeinander abgestimmten Regelungen, Werkzeugen, Bausteinen und Infrastrukturkomponenten, die im Folgenden zusammenfassend als XÖV-Produkte beschrieben werden.
XÖV-Produkte
XÖV-Produkte sind einzelne oder zusammengefasste Komponenten des XÖV-Rahmenwerks, wie beispielsweise das XÖV-Profil, das XÖV-Handbuch, der XGenerator oder das XRepository. Alle Produkte werden im Rahmen eines geregelten Betriebs auf der Basis von Änderungsanträgen durch die KoSIT fortgeschrieben und zur (kosten-)freien Verwendung bereitgestellt.
Anwender:innen können mit einer Ausnahme alle XÖV Produkte über die Plattform docs.xoev.de downloaden. Zudem werden hier grundlegende Beschreibungen zu allen Produkten wie auch Informationen zu den Produkt-Release und zugehörigen Änderungsanträgen bereitgestellt.
Eine Ausnahme bilden in diesem Zusammenhang die durch die KoSIT herausgegebenen Codelisten, die über die Plattform XRepository zum Download bereitgestellt werden (siehe hierzu auch XRepository).
Eine zusammenfassende Sicht auf die sich aktuell in Bearbeitung befindlichen Änderungsanträge und deren Bearbeitungsstatus werden über die Plattform projekte.kosit.org/xoev/betrieb-public für alle Anwender:innen bereitgestellt.
Mit den folgenden Abschnitten werden einzelen, im Kontext der Schulung besonders relevante XÖV-Produkte detaillierter beschrieben werden.
XÖV-Bibliothek
Mit der XÖV-Bibliothek werden den Standardisierungsvorhaben alle XÖV-Bausteine [1] gebündelt zur Nachnutzung bereitgestellt.
Aus Sicht eines / einer Entwickler:in bzw. Modellierer:in eines XÖV-Fachmodells stellt sich die Bibliothek als eigenständiges Modell dar, das technisch in das eigene Fachmodell als externes Modell eingebunden werden kann.
Weil die Verwendung der mit der Bibliothek bereitgestellten Datentypen und Kernkomponenten durch die NDRs geregelt und in Teilen mandatorisch vorgegeben wird, ist die Bibliothek de facto ein fester Bestandteil eines jeden XÖV-Standards.
Allgemeine Informationen zur Bibliothek, zu den einzelnen Fassungen und zum Bezug der Bibliothek finden Sie unter docs.xoev.de/bibliothek.
XÖV-Codelisten
Die XÖV-Koordination gibt im Rahmen des Betriebs der XÖV-Produkte eine Reihe von Codelisten heraus, die durch die XÖV-Standards direkt verwendet werden können.
Eine Codeliste wird im XÖV-Kontext definiert als eine Liste von Codes und zugehöriger Beschreibung(en). Codes und zugehörige Beschreibungen können, wie im Folgenden illustriert, als Tabelle dargestellt werden. Die Tabelle 1, “Codeliste Familienstand” zeigt beispielhaft die Daten einer Codeliste zur Übermittlung des Familienstands, wie sie in vergleichbarer Form beispielsweise im Standard XMeld verwendet wird.
SpalteA | SpalteB |
---|---|
LD | ledig |
VH | verheiratet |
VW | verwitwet |
GS | geschieden |
EA | Ehe aufgehoben |
LP | in eingetragener Lebenspartnerschaft |
LV | durch Tod aufgelöste Lebenspartnerschaft |
LA | aufgehobene Lebenspartnerschaft |
LE | durch Todeserklärung aufgelöste Lebenspartnerschaft |
NB | nicht bekannt |
Neben den Daten einer Codeliste erfordert deren systematische, vorhabenübergreifende Nutzung die Beschreibung der Codeliste als solche, ihrer Versionen und der zugehörigen Daten. Diese sogenannten Metadaten informieren unter anderem über Name, Version, Gültigkeit und Herausgeber einer Codeliste. Es wird unterschieden in Metadaten, die
-
eine Codeliste und alle ihre Versionen (versionsunabhängig),
-
ausschließlich eine einzelne Version (versionsabhängig) und
-
ausschließlich die Daten(-struktur) einzelner Versionen beschreiben.
XÖV-Standards entwickeln und betreiben in der Regel eine ganze Reihe von eigenen, in der Regel fachspezifischen Codelisten.
Neben diesen können aber auch Codelisten anderer Herausgeber durch den eigenen Standard verwendet werden. Solche in der Regel fachübergreifende oder fachunabhängige Codelisten werden beispielsweise durch die XÖV-Koordination oder durch die fachlich verantwortlichen direkt herausgegeben. Typische Vertreter dieser Klasse von Codelisten sind in Tabelle 2, “Beispiele fachübergreifender Codelisten” beispielhaft aufgeführt.
Name | Herausgeber | Inhalt |
---|---|---|
Koordinierungsstelle für IT-Standards | Die Codeliste basiert auf der Staats- und Gebietssystematik des Statistischen Bundesamtes (DESTATIS) und dem Standard "Country codes" der International Organization for Standardization (ISO). | |
Koordinierungsstelle für IT-Standards | Die Codeliste basiert auf dem Standard "Currency codes" der International Organization for Standardization (ISO). | |
Koordinierungsstelle für IT-Standards | Liste der Verzeichnisdienste, in die Behörden / öffentliche Stellen eingetragen sein können | |
Koordinierungsstelle für IT-Standards | Eine Liste der Kommunikationsmedien und -kanäle, über die man eine Person oder Institution erreichen kann. | |
Statistisches Bundesamt, Wiesbaden | Diese Codeliste stellt alle Gemeinden Deutschlands durch den Amtlichen Gemeindeschlüssel (AGS) dar, wie im Gemeindeverzeichnis des Statistischen Bundesamtes enthalten. |
In der definierten Struktur eines XÖV-Fachmodells können XÖV-Codelisten wie auch alle anderen Codelisten fremder Herausgeben beispielsweise zu Dokumentationszwecken in das eigene Modell integriert werden. Details hierzu werden im Schulungsmodul Paketstruktur des Modells vermittelt.
Zur Herausgabe der eigenen Codelisten wie auch der Bezug fremder Codelisten wird im XÖV-Kontext das XRepository (siehe hierzu auch XRepository) genutzt.
XRepository
Das XRepository ist die zentrale XÖV-Distributionsplattform. Es unterstützt die Prozesse der Entwicklung und Bereitstellung eines Standards, seine XÖV-Zertifizierung wie auch seine operative Nutzung.
Alle Bestandteile eines XÖV-Standards sowie die für den Datenaustausch notwendigen Artefakte wie Codelisten können über das XRepository manuell sowie automatisiert (REST-Schnittstelle) bezogen werden. Das XRepository ist somit für Verfahrenshersteller, Betreiber von IT-Verfahren, Betreiber von XÖV-Standards, Herausgeber von Codelisten und die KoSIT ein wichtiges Werkzeug für die tägliche Arbeit.
Die öffentliche Bereitstellung von XÖV-Standards und zugehörigen Bestandteilen wie beispielsweise Spezifikationsdokument, Codelisten oder XML Schema ist für eine gemeinsame Nutzung essentiell und aus diesem Grund mit dem XÖV-Rahmenwerk verbindlich vorgegeben. |
XÖV-Starterpaket
Das XÖV-Starterpaket stellt für neue XÖV-Vorhaben einen Einstiegspunkt in die praktische Entwicklung eines XÖV-Standards dar. Es besteht aus
-
einem XÖV-Fachmodell mit
-
beispielhaften Anwendungsfällen, Prozessen, Datentypen und Nachrichten
-
sowie eingebundener XÖV-Bibliothek,
-
-
den aktuellen XÖV-Prüfanweisungen und XÖV-Übersetzungsanweisungen des XÖV-Profils zur Verarbeitung des XÖV-Fachmodells durch den XGenerator,
-
einer beispielhaften DocBook-Dokumentation, welche die Grundlage des Spezifikationsdokuments zum Starterpaket darstellt, und
-
ein beispielhaftes DocBook-Zubehör zur automatisierten Erstellung des Spezifikationsdokuments als PDF.
Das Starterpaket wird durch die XÖV-Koordination für die derzeit unterstützten Modellierungsumgebung MagicDraw und Papyrus herausgegeben.
Weitere Informationen hierzu wie auch das XÖV-Starterpaket selbst sind unter docs.xoev.de/starterpaket bereitgestellt.
XÖV-Entwicklungsansatz
Für die initiale Entwicklung eines XÖV-Standards wird die in Abbildung 1, “Phasen des XÖV-Entwicklungsansatzes” dargestellte schrittweise Vorgehensweise empfohlen.
Mit diesem Ansatz soll dem Vorhaben eine praxiserprobte Methode an die Hand gegeben werden, mittels derer alle für einen XÖV-Standard relevanten Informationen sukzessive erfasst und in einer einheitlichen "Sprache" für alle Beteiligten des Standardisierungsvorhabens nachvollziehbar dokumentieren werden können.
Dieser Prozess beginnt mit der sogenannten Entwurfsphase, in der die fachlichen Anforderungen an die geplanten Szenarien zur Datenübermittlung erhoben und in Form von Anwendungsfall- und Aktivitätsdiagrammen im Fachmodell abgebildet werden. Im Rahmen der Konkretisierung der einzelnen Anwendungsfälle werden auch die zu übermittelnden Daten und deren Strukturen in Form von Klassendiagramm im Detail spezifiziert. Die Prozesse der Entwurfsphase finden in aller Regel moderiert und unter Einbeziehung von Fachexperten und Vertretern der beteiligten Kommunikationspartner statt.
In der Spezifikationsphase wird das technikneutrale Fachmodell aus der Entwurfsphase um technische Details erweitert und konkretisiert. In diesem Sinne kann das Fachmodell als Schnittstelle zwischen fachlicher und technischer Entwicklung verstanden werden. Die technische Ausgestaltung des Fachmodells ist unter anderem die Grundlage für die spätere automatisierte Verarbeitung dieses Modells durch den XGenerator und somit für die Erzeugung der einzelnen Bestandteile des Standards.
In der abschließenden Produktionsphase werden alle Bestandteile des Standards werkzeuggestützt aus dem XÖV-Fachmodell generiert. Dies umfasst sowohl die technischen Bestandteile zur Implementierung des XÖV-Standards wie bespielsweise die XML Schemata des Standards als auch ein menschenlesbares Spezifikationsdokument. Schon während der Verarbeitung des XÖV-Fachmodells stellt eine in die Produktionswerkzeuge integrierte Prüfumgebung die Einhaltung einer Reihe von XÖV-Regelungen sicher. Den Abschluss der Produktionsphase bildet die XÖV-Zertifizierung.
Die UML-Notation im XÖV-Kontext
UML ist eine standardisierte visuelle Modellierungssprache, die in der Softwareentwickung und Systemanalyse weit verbreitet ist. Die Verwendung von UML zur Beschreibung bestimmter Sachverhalte im XÖV-Fachmodell ist mit der aktuellen Methodik und dem zugehörigen Regelwerk verbindlich geregelt.
Die im Folgenden dargestelten UML-Diagrammarten werden in der Entwurfs- und Spezifikationsphase genutzt, um den oder die Anwendungsbereiche eines Standards, der Verwendung seiner Nachrichten und die zu übermittelnden Datenstrukturen zu spezifizieren.
Anwendungsfalldiagramm
Ein Anwendungsfalldiagramm ist eine Diagrammart zur allgemeinen Beschreibung von Anforderungen an ein System in Form seiner Anwendungsfälle (engl.: Use Case) und den daran beteiligten Akteuren bzw. Systemen. Im XÖV-Kontext werden mit dieser Art von Diagrammen die jeweiligen Szenarien der Datenübermittlung beschrieben, in denen der Standard Verwendung finden kann, soll oder muss. In Abbildung 2, “Beispielhaftes Anwendungsfalldiagramm” sind beispielhaft die Phasen des XÖV-Entwicklungsansatzes als zusammengefasste Anwendungsfälle dargestellt.
Anwendungsfalldiagramme sind durch eine Beschreibung der dargestellten Akteure und Anwendungsfälle zu ergänzen.
Aktivitätsdiagramm
Ein Aktivitätsdiagramm ist eine Diagrammart der UML zur Darstellung allgemeiner Abläufe. Im XÖV-Kontext werden Aktivitätsdiagramme zur Dokumentation der Aktivitäten und Prozessen von Datenübermittlungsszenarios genutzt. Mit Hilfe dieses Diagrammart kann als explizit dokumentiert werden, wer mit wem welche Nachrichten austauscht und unter welchen Bedingungen diese Datenübermittlung stattfindet.
In der Praxis werden für die Umsetzung der jeweiligen Anwendungsfälle eines Standards häufig Gruppen von Nachrichten gebildet. Mittel Aktivitätsdiagramm wird dann im Detail für jede Gruppe dokumentiert unter welchen Bedingungen die einzelnen Nachrichten einer Gruppe zu verwenden sind.
Die Modellierung von Aktivitätsdiagrammen wird durch das Konformitätskriterium K-8: Modellierung der Prozesse in UML gefordert (siehe hierzu Konformitätskriterien).
|
Klassendiagramm
Ein Klassendiagramm ist eine Diagrammart der UML, die Klassen von Informationsobjekten eines Systems, deren Strukturen und Beziehungen untereinander darstellt. Im XÖV-Kontext bestehen Klassendiagramme insbesondere aus Klassen, Klasseneigenschaften, einseitig navigierbare Kompositionen, Generalisierungsbeziehungen, Abhängigkeitsbeziehungen und Enumerationen. Die untenstehende Darstellung zeigt beispielhaft ein Klassendiagramm der XÖV-Kernkomponente Anschrift
.
Die Modellierung von AktivitätsdiKlassendiagrammen wird durch das Konformitätskriterium K-9: Modellierung der Datenstrukturen in UML gefordert (siehe hierzu Konformitätskriterien).
|
Regelungen des XÖV-Rahmenwerks
Das Handbuch zur Entwicklung XÖV-konformer Standards ("XÖV-Handbuch") ist das zentrale Produkt des XÖV-Rahmenwerks. Es umfasst neben einer detailierten Erläuterung der XÖV-Methodik zur Erstellung und Fortschreibung eines XÖV-Fachmodells auch alle für ein XÖV-Vorhaben relevanten Regelungen.
Die XÖV-Regelungen sind in die Bereiche Konformitätskriterien und Namens- und Entwurfsregeln (kurz NDRs) strukturiert.
Konformitätskriterien
Konformitätskriterien decken die unterschiedlichen methodischen, organisatorischen und technischen Bereiche eines Standardisierungsvorhabens ab. Demgegenüber wird mit den Namens- und Entwurfsregeln ausschließlich die technische Ausgestaltung des XÖV-Fachmodells und der technischen Bestandteile des Standards geregelt. Die Einhaltung der technischen Regelungen wird durch die Konformitätskriterien gefordert
XÖV-Konformitätskriterien sind konkrete Prüfkriterien, die ein XÖV-Standard erfüllt. Sie sind in die vier Bereiche
-
Bereitstellungspflichten,
-
Auskunftspflichten der Standardentwickler und -betreiber,
-
Wiederverwendung der XÖV-Bausteine, sowie
-
technische Kriterien
unterteilt. Es werden die Verbindlichkeitsstufen Muss und Soll unterschieden:
-
Muss: Kriterien dieser Verbindlichkeitsstufe müssen durch ein XÖV-Vorhaben und seinen Standard eingehalten werden.
-
Soll: Kriterien dieser Verbindlichkeitsstufe ermöglichen die Abweichung des XÖV-Vorhabens und seines Standards. Der Ansatz der kontinuierlichen Verbesserung erfordert allerdings, dass die Begründung für die Abweichung zur Zertifizierung dokumentiert wird.
Eine Übersicht wie auch eine detaillierte Beschreibung der derzeit insgesamt 15 XÖV-Konformitätskriterien ist im XÖV-Handbuch gegeben. Mit der Beschreibung werden sowohl die Begründungen der einzelnen Kriterien als auch die in der Konformitätsprüfung jeweils genutzten Prüfgrundlagen und Prüfinhalte beschrieben.
Namen- und Entwurfsregeln
Mit dem Konformitätskriterium K-10 wird die Einhaltung der XÖV-Namens- und Entwurfsregeln (kurz NDRs) gefordert.
Die NDRs lenken die technische Ausgestaltung eines XÖV-Standards während seiner Spezifikationsphase, in der das Fachmodell des Standards in ein XÖV-Fachmodell überführt wird.
Anders als bei den Konformitätskriterien existieren bei den NDRs auch Regelungen mit der Verbindlichkeitsstufe Empfehlung
.
Die Einhaltung der NDRs mit der Verbindlichkeit Muss
und Soll
ist zertifizierungsrelevant und wird mit der Nutzung der XÖV-Spezifikations- und Produktionswerkzeuge, sofern technisch möglich, automatisiert geprüft.
Grundlage für eine korrekte Prüfung ist eine zur verwendeten Handbuchversion gültige Konfiguration der genutzten XÖV-Produkte. Eine Übersicht aller gültigen Konfigurationen ist unter docs.xoev.de/konfigurationen veröffentlicht. |
Tabelle 3, “Übersicht der XÖV Namens- und Entwurfsregeln” gibt eine Übersicht über die derzeit insgesamt 30 Namens- und Entwurfsregeln des XÖV-Rahmenwerks.
Nr. | Verbindlichkeit | Kurzbeschreibung |
---|---|---|
Strukturen und Inhalte | ||
NDR-1 | Muss | Konsistente Inhalte in XÖV-Fachmodell und technischen Bestandteilen des Standards |
NDR-2 | Muss | Hauptstruktur eines XÖV-Fachmodells |
NDR-3 | Muss | Nachrichten als globale Elemente |
NDR-4 | Soll | Erlaubte Einbindungsarten für Codelisten |
NDR-5 | Empfehlung | Detaillierte Struktur eines XÖV-Fachmodells |
NDR-6 | Empfehlung | Nutzung von XML-Attributen und XML-Elementen |
NDR-7 | Empfehlung | XML-Wildcard-Elemente mit Namensraum |
NDR-9 | Empfehlung | Umgang mit speziellen Anforderungen an die Nutzung von Codelisten |
NDR-34 | Empfehlung | Modellierung von Codelistenversionen als benannte Typen |
Namen für XML-Attribute, -Elemente und -Typen | ||
NDR-11 | Soll | Erlaubte Zeichen für Namen |
NDR-12 | EMPFEHLUNG | Erlaubte Zeichen für Klassifikationen in Namen |
NDR-13 | Soll | Versionsübergreifend eindeutige Nachrichtennamen |
NDR-14 | Empfehlung | Namen in deutscher Sprache |
NDR-15 | Empfehlung | Groß- und Kleinschreibung von (und innerhalb zusammengesetzter) Namen |
NDR-16 | Empfehlung | Namensstruktur globaler Elemente |
NDR-17 | Empfehlung | Versionsübergreifend eindeutige Nachrichtennummern |
NDR-18 | Empfehlung | Namen von XML Schema-Dateien |
Dokumentation | ||
NDR-32 | Muss | Dokumentation der Metadaten des Standards |
NDR-19 | Soll | Dokumentation in deutscher Sprache |
NDR-20 | Empfehlung | Dokumentation der Rechtsgrundlagen |
Wiederverwendung | ||
NDR-33 | Muss | Codelisten konform zu den Regelungen des Codelisten-Handbuchs |
NDR-22 | Muss | Unveränderte Übernahme von XÖV-Codelisten |
NDR-24 | Soll | Wiederverwendung generischer Nachrichteneigenschaften |
NDR-25 | Empfehlung | Aufbau und Nutzung wiederverwendbarer Datentypen |
NDR-26 | Empfehlung | Physische Speicherorte von XML Schema-Definitionen als URL |
NDR-27 | Empfehlung | Verwendung des ursprünglichen Namensraumpräfixes bei XML Schema-Importen |
XML Schema-Konformität | ||
NDR-28 | Muss | Valide W3C XML Schema-Definitionen |
Namensräume und Versionen | ||
NDR-29 | Muss | Identifizierende Namensräume |
NDR-30 | Muss | Versionierung der XML Schema-Definitionen |
NDR-31 | Soll | Namensräume mit Versionen |
Eine detaillierte Beschreibung der Regeln ist im XÖV-Handbuch gegeben. Sie umfasst neben einer Erläuterung auch die Begründungen der Regelung sowie einen Hinweis, ob die Regelung technisch geprüft werden kann.