Sie sind hier:

XÖV-Handbuch

Das Handbuch zur Entwicklung XÖV-konformer Standards ("XÖV-Handbuch") umfasst alle für ein XÖV-Vorhaben relevanten Informationen zum XÖV-Standardisierungsrahmen. In ihm ist neben den XÖV-Regelungen und -Vorgaben das XÖV-Angebot in Form von Bausteinen, Infrastrukturkomponenten und Werkzeugen sowie die Methodik zur Nutzung des Angebots beschrieben.
Das Handbuch richtet sich an alle Fach- und Führungskräfte, die Vorhaben zur Entwicklung von Datenübertragungsstandards in der öffentlichen Verwaltung begleiten, bearbeiten oder verantworten.

Zielgruppe und Zweck

Aus Gründen der Übersichtlichkeit ist das Handbuch in der Version 2.0 in zwei Teile gegliedert.
Mit dem ersten Teil des Handbuchs soll den an Standardisierungsvorhaben beteiligten Institutionen und Behörden eine Orientierungshilfe an die Hand gegeben werden, indem Grundlagen, Aufbau und intendierte Verwendung des XÖV-Standardisierungsrahmens in der Übersicht beschrieben und die mit seiner Anwendung verbundenen Anforderungen und Nutzenpotentiale dargestellt werden.
Der zweite Teil des Handbuchs soll den mit der Entwicklung, Umsetzung oder dem Betrieb eines Standards betrauten Mitarbeiterinnen und Mitarbeitern von Behörden und Dienstleistern als Leitfaden zur Produktion von XÖV-konformen Standards dienen. Hierzu werden sie umfassend über die praktische Anwendung des Standardisierungsrahmens und den damit einhergehenden Regelungen, Methoden und Bausteinen informiert. Weitere Informationen zu den für die Entwicklung von XÖV-Standards erforderlichen XÖV-Produkten sind auf dieser Webseite gegeben und werden an den entsprechenden Stellen des Handbuchs referenziert.

Bezug

Das XÖV-Handbuch kann im Downloadbereich bezogen werden.

Betrieb

Das XÖV-Handbuch wird im geregelten Betrieb unter direkter Beteiligung der XÖV-Gemeinschaft fortentwickelt. Änderungsanträge können Sie direkt über diese Webseite stellen.

Versionen

Version Zusammenfassung und relevante Änderungsanträge Status
2.1.0 In dieser Version wurden die Regelungen zur Angabe von Metadaten für Codelisten und Standards konsolidiert und neue Regelungen aufgenommen. Die Regelungen zur Abbildung von Codelisten in Genericode wurden konkretisiert und die Methodik zur Modellierung und Nutzung von Codelisten aktualisiert.

  • 474 - Klärung der Regelungen und des Angebots zu Genericode
  • 667 - Verortung von Metadaten des Standards und der Version eines Standards im XÖV-Fachmodell
  • 668 - Aktualisierung der Angabe von Metadaten zu Codelisten
  • 669 - Verortung von Codelisten-Inhalten und -Metadaten im UML-Fachmodell

aktuell
2.0.1 Das XÖV-Handbuch wurde in verschiedenen Bereichen aktualisiert und konkretisiert. Wesentliche inhaltliche Änderungen sind die Konkretisierung des XÖV-Konformitätskriterium K-5 (Nachhaltigkeit des Standards), die Überarbeitung des Leitfadens zur Bildung von Codelisten-Kennungen und die Anpassung der Übergangsfrist für die Gültigkeit veralteter Handbuchversionen.

  • 390 - Ergänzung des Glossars des XÖV-Handbuchs um den Begriff "XÖV-Starterpaket"
  • 441 - Anpassung des Leitfadens zu Bildung von Codelisten-URNs
  • 479 - Korrektur der Abbildung 7.3. "Beziehungen zu den Eigenschaften einer XÖV-Kernkomponente" im XÖV-Handbuch
  • 512 - Erweiterung des Prüfinhalts zu Konformitätskriterium K-5 (Nachhaltigkeit des Standards)
  • 516 - Redaktionelle Korrekturen im XÖV-Handbuch
  • 526 - Anpassung der Übergangsfrist zur Gültigkeit der XÖV-Regelungen
  • 528 - Redaktionelle Überarbeitung der Tabelle "Metadaten einer Codeliste
  • 529 - Ergänzung eines Hinweises auf die XÖV-Webseite zur Übersicht der XÖV-Releases

aktuell, bis 31. Juli 2020
2.0 Zusammenfassung: Das XÖV-Handbuch 2.0 wurde mit dem Ziel der Verbesserung der zielgruppengerechten Darstellung und des leichteren Einstiegs in die Thematik grundlegend überarbeitet und neu verfasst. Inhaltlich wurde das Handbuch um die Beschreibung der Methodik zur Nutzung der XÖV-Bibliothek, der Kernkomponenten und der XÖV-Adapter ergänzt. Eine detaillierte Änderungsübersicht kann der Versionshistorie des Handbuchs entnommen werden. Änderungsanträge:

  • 288 - Erstellung einer XÖV-Bibliothek
  • 87 - Leitfaden zur Bildung von Uniform Resource Names
  • 47 - Konformitätsprüfung im Kontext neuer XÖV-Versionen
  • 46 - Nutzung externer Standards und externer XML-Schema-Dateien
  • 45 - Entwicklung einer neuen Methodik zur Nutzung von Kernkomponenten

aktuell, bis 30. Sept. 2018
1.1 Zusammenfassung: Im Rahmen der Version 1.1 des XÖV-Handbuchs wurden Detailanpassungen an dem Konformitätskriterium K-4 (Veröffentlichung) und der Methodik zur Bereitstellung von Codelisten vorgenommen. Eine detaillierte Änderungsübersicht kann der Versionshistorie des Handbuchs entnommen werden. aktuell, bis Juli 2016
1.0 Zusammenfassung: Die erste Version des XÖV-Handbuchs wurde im März 2010 herausgegeben. Der Kooperationsausschuss Bund-Länder-Kommunaler Bereich (KoopA ADV) hatte diese Version im Rahmen seiner letzen Sitzung verabschiedet und den Einsatz des Handbuchs empfohlen. veraltet

Änderungsanträge

ID Beschreibung Status
45 Entwicklung einer neuen Methodik zur Nutzung von Kernkomponenten
Laut XÖV-Handbuch 1.0 sollten "die detaillierten Ausführungen zur Wiederverwendung der XÖV-Kernkomponenten in einem XÖV-Standard (...) mit der nächsten Version dieses Handbuchs veröffentlicht" werden. Ein Workshop innerhalb der XÖV-Anwenderkonferenz hat dieses Thema erneut aufgegriffen und somit die Relevanz deutlich unterstrichen. Dementsprechend sollte die Methodik zur Nutzung der Kernkomponenten im der nächsten Version des XÖV-Handbuchs enthalten sein.
umgesetzt
46 Nutzung externer Standards und externer XML-Schema-Dateien
Nachnutzung externer Standards und externer XML Schema Dateien (Standards zu denen kein XÖV-konformes Modell vorhanden ist): Da davon auszugehen ist, dass in vielen Fachlichkeiten und somit auch XÖV-Vorhaben bereits existierende Standards nachgenutzt werden sollen und müssen, wäre ein deutlicher Hinweis zum Umgang mit dieser Thematik im Handbuch nicht nur wünschenswert sondern nötig. Insbesondere bei Vorhaben, die neu in die XÖV-Thematik einsteigen sind Aussagen zur Nachnutzung bereits bestehender Arbeitsergebnisse und Standards wichtig für eine Bewertung der Anwendbarkeit der XÖV-Methodik.
umgesetzt
47 Konformitätsprüfung im Kontext neuer XÖV-Versionen
Derzeit macht das XÖV-Handbuch v1.1 keine Aussagen dazu, wie sich die Fortschreibung des Handbuchs auf eine Konformitätsprüfung auswirkt. Insbesondere für laufende/projektierte XÖV-Vorhaben entsteht hier eine gewisse Unsicherheit, da aus der Dokumentation nicht hervorgeht, ob ein bereits begonnenes Vorhaben, das bspw. erst im Sommer 2012 einen prüfbaren Stand erreicht, noch nach Handbuch 1.0 und dem zugehörigen Produktionszubehör geprüft werden kann, oder ob zum Stichtag der Veröffentlichung des Handbuchs 1.1 nur noch Konformitätsprüfungen nach dem zu aktualisierenden XÖV-Produktionszubehör erfolgen können und somit innerhalb des bereits begonnen Vorhabens eine Umstellung erfolgen muss.
umgesetzt
87 Leitfaden zur Bildung von Uniform Resource Names
Die Bildung der Kennung einer Codeliste sollte auf einheitlichen Vorgaben basieren. Das XÖV-Handbuch soll um einen entsprechenden Leitfaden ergänzt werden.
Die KoSIT beschließt die Umsetzung dieses Änderungsantrags. Ein Leitfaden zur Bildung von Uniform Resource Names wurde dem XÖV-Handbuch hinzugefügt.
umgesetzt
288 Erstellung einer XÖV-Bibliothek
Es soll eine XÖV-Bibliothek für alle von der KoSIT herausgegebenen Bausteine zur Wiederverwendung (außer Codelisten) bereitgestellt und dokumentiert werden.
umgesetzt
390 Ergänzung des Glossars des XÖV-Handbuchs um den Begriff "XÖV-Starterpaket"
Das Produkt "XÖV-Starterpaket" soll im Glossar des XÖV-Handbuchs beschrieben werden. Die KoSIT beschließt die Umsetzung dieses Änderungsantrags. Das XÖV-Glossar wurde entsprechend erweitert.
umgesetzt
441 Anpassung des Leitfadens zur Bildung von Codelisten-URNs
Der "Leitfaden zur Bildung von Uniform Resource Names" (Abschnitt 8.4.1.) soll überarbeitet werden, sodass er insbesondere für Herausgeber, die kein eigenes URN-Konzept entwickelt haben oder kein bereits existierendes nutzen, eine noch gezieltere Handreichung bietet und damit die gemeinschaftliche Verwendung von Codelisten-Kennungen noch weiter vereinfacht. Dieser Änderungsantrag soll auch eine Vorbereitung für ein Gesamtkonzept zur Bildung von URNs für verschiedene Arten von Ressourcen sein.
Der Abschnitt 8.4.1. "Leitfaden zur Bildung von Uniform Resource Names" wurde von der KoSIT inhaltlich, sowie redaktionell überarbeitet. Der Vorschlag der KoSIT wurde in der RC-Phase von der XÖV-Gemeinschaft bewertet und qualitätsgesichert und in die finale Fassung des Handbuchs 2.0.1 übernommen.
umgesetzt
474 Klärung der Regelungen und des Angebots zu Genericode
Aktuell ist in dem XÖV-Handbuch nicht explizit dargelegt, welche Bereiche der Genericode-Funktionalität genutzt werden dürfen bzw. durch den XÖV-Standardisierungsrahmen und dessen Produkte unterstützt werden. Das XÖV-Handbuch soll zukünftig diesbezüglich klare Aussagen machen. Der Abschnitt "Nutzung weiter Genericode-Funktionalitäten" wurde in das Kapitel "Bereitstellung und Nutzung von Codelisten" neu aufgenommen.
umgesetzt
479 Korrektur der Abbildung 7.3. "Beziehungen zu den Eigenschaften einer XÖV-Kernkomponente" im XÖV-Handbuch
In der Abbildung 7.3 ist der Stereotyp xoevASBIE an eine Assoziation angehängt. Dies ist ein Fehler, da der Stereotyp an die Eigenschaften einer UML-Klasse gehängt werden muss. Die KoSIT beschließt die Umsetzung dieses Änderungsantrags. Der falsch angehängte Stereotyp wurde entfernt.
umgesetzt
512 Erweiterung des Prüfinhalts zu Konformitätskriterium K-5 (Nachhaltigkeit des Standards)
Als Prüfinhalt soll die für die Pflege zuständige Stelle ergänzt werden. Die KoSIT beschließt die Umsetzung dieses Änderungsantrags. Der Prüfinhalt zu Konformitätskriterium K-5 wurde entsprechend ergänzt.
umgesetzt
516 Redaktionelle Korrekturen im XÖV-Handbuch
Kontext "NDR-4 (SOLL): Erlaubte Einbindungsarten für Codelisten" IST: "Eine Codeliste soll ausschließlich mittels der in Abschnitt Abschnitt 8.5: Nutzung von Codelisten beschriebenen Code-Typen 1 bis 4 in einem XÖV-Standard genutzt werden." SOLL: "Eine Codeliste soll ausschließlich mittels der in Abschnitt 8.5: Nutzung von Codelisten beschriebenen Code-Typen 1 bis 4 in einem XÖV-Standard genutzt werden."
umgesetzt
526 Anpassung der Übergangsfrist zur Gültigkeit der XÖV-Regelungen
Für Standards, die Standards nutzen, kann eine Übergangsfrist von 24 Monaten zur Umstellung auf die neuen XÖV-Regelungen zu knapp bemessen sein, da zunächst der genutzte Standard (z. B. XInneres) auf die neuen Regelungen und die zugehörigen Spezifikations- und Produktionswerkzeuge umgestellt und in einer neuen Version veröffentlicht werden muss. Erst danach können die den Standard nutzenden Standards (z. B. XAusländer, XMeld und XPersonenstand) umgestellt werden. Aus diesem Grund soll die Übergangsfrist zur Gültigkeit der XÖV-Regelungen auf 36 Monate verlängert werden.
Die KoSIT beschließt die Umsetzung des Änderungsantrags wie gefordert. Das Kapitel 3. "XÖV-Konformität" wurde entsprechend aktualisiert. Zudem wurden die Fristen auf den XÖV-Produktseiten (http://www.xoev.de/de/produkte) und auf der Seite zu den Spezifikations- und Produktsionswerkzeugen (http://www.xoev.de/de/spezifikationproduktion) angepasst.
umgesetzt
528 Redaktionelle Überarbeitung der Tabelle "Metadaten einer Codeliste"
Zur präziseren Darstellung der Metadaten und ihrer Häufigkeiten soll die Tabelle "Metadaten einer Codeliste" überarbeitet werden. Hierbei soll auch verdeutlicht werden, dass 1-n Code-Spalten existieren können.
Die KoSIT beschließt die Umsetzung des Änderungsantrags wie gefordert.
umgesetzt
529 Ergänzung eines Hinweises auf die XÖV-Webseite zur Übersicht der XÖV-Releases
Die neue Webseite zur Übersicht der XÖV-Releases (http://www.xoev.de/de/releases) soll aus dem XÖV-Handbuch heraus referenziert werden.
Die KoSIT beschließt die Umsetzung des Änderungsantrags. Der Abschnitt 2.5. "Änderungsmanagement" wurde entsprechend erweitert.
umgesetzt
667 Verortung von Metadaten des Standards und der Version eines Standards im XÖV-Fachmodell
Die Metadaten eines XÖV-Standards und seiner Version sollen im XÖV-Fachmodell dokumentiert werden. Die Metadaten sollen mittels der Stereotypen xoevStandard und xoevVersionStandard des XÖV-Profils dokumentiert werden. Entsprechende Erläuterungen und Regelungen sollen im XÖV-Handbuch erfolgen.
Mit den Metadaten eines XÖV-Standards und seiner Version werden grundlegende fachliche und technische Informationen über den Standard dokumentiert. Die Angabe der Metadaten im XÖV-Fachmodell erlaubt die unmittelbare Einsicht und Verarbeitung der Informationen. So wird beispielsweise mittels dieser Metadaten der Standard im XRepository angezeigt.
Im Handbuch wurde das Konformitätskriterium K-3 "Dokumentation" um Vorgaben zur Angabe von Metadaten erweitert. In der neuen Namens- und Entwurfsregel NDR 32 "Dokumentation der Metadaten des Standards" werden die Vorgaben konkretisiert. Darüber hinaus wurden die Einleitung des Handbuchs um Aussagen zu Metadaten eines Standards erweitert und der Abschnitt "Metadaten eines XÖV-Standards" neu in das Kapitel "Spezifikation und Produktion von XÖV-Standards" aufgenommen. Der Unterabschnitt "Regelungen zur Bildung von Kennungen" des neuen Abschnitts ersetzt und verallgemeinert den früheren "Leitfaden zur Bildung von Uniform Resource Names" aus dem Kapitel "Bereitstellung und Nutzung von Codelisten".
umgesetzt
668 Aktualisierung der Angabe von Metadaten zu Codelisten
Die Metadaten eines XÖV-Standards und seiner Version sollen im XÖV-Fachmodell dokumentiert Die Möglichkeiten zur Angabe von Metadaten zu Codelisten, Standards und weiteren Inhalten wurden vereinheitlicht. Der Abschnitt "Abbildung von Metadaten" im Kapitel "Bereitstellung und Nutzung von Codelisten" ist hinsichtlich der verfügbaren Metadatenelemente und deren Abbildung in Genericode zu aktualisieren und zu erweitern.
Der genannte Abschnitt wurde wie vorgegeben angepasst. Die zugehörigen Beispiele zur Abbildung von Codelisten wurden dementsprechend aktualisiert.
umgesetzt
669 Verortung von Codelisten-Inhalten und -Metadaten im UML-Fachmodell
Die Metadaten von Codelisten und die Inhalte von Codelisten (in der Code-Spalte und bis zu zwei Beschreibungsspalten) werden im XÖV-Fachmodell eines Standards zukünftig vollständig dokumentiert. Dementsprechend ändert sich die Methodik der Modellierung und Nutzung von Codelisten, sodass eine Anpassung im XÖV-Handbuch erfolgen muss.
Der Abschnitt "Nutzung von Codelisten" im Kapitel "Bereitstellung und Nutzung
von Codelisten" wurde hinsichtlich der neuen Methodik zur Modellierung und Nutzung von Codelisten überarbeitet.
umgesetzt