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 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 hier in der aktuellen Version 3.0.1 bezogen werden. Weitere noch gültige Versionen des Handbuchs können Sie im Downloadbereich beziehen.


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. Die Gültigkeit der unten aufgeführten Produktversionen entnehmen Sie bitte der Konfigurationstabelle.

Änderungsanträge und ggf. die Planung zur Umsetzung sind öffentlich einsehbar auf dieser Gitlab-Seite.

Versionen

Tabelle
VersionZusammenfassung und relevante Änderungsanträge
XÖV-Handbuch 3.0.1 (pdf, 2.8 MB)In der Beschreibung der NDR-33 „Codelisten konform zu den Regelungen des Codelisten-Handbuchs“ wurde eine Aussage zum Umgang mit bestehenden und neuen Codelistenversionen aufgenommen. (Issue Public 45) Redaktionelle Anpassungen wurden vorgenommen.
XÖV-Handbuch 3.0 (pdf, 4 MB)Wesentliche Änderungen des XÖV-Standardisierungsrahmens betreffen die Vorbereitung der XÖV-Produkte für ihren zusätzlichen Einsatz in dem Open-Source-Modellierungswerkzeug Papyrus sowie die Umsetzung und Dokumentation einer vereinfachten, modellgetriebenen Entwicklungsmethodik zur Spezifikation und Produktion eines XÖV-Standards. Die aktualisierte Methodik wird hauptsächlich im neu geschaffenen XÖV-Primer-Dokument beschrieben, welches einen leichten Einstieg in die praktische Entwicklung eines XÖV-Standards ermöglichen soll. In das XÖV-Handbuch wurden an den erforderlichen Stellen Hinweise auf das Modellierungswerkzeug Papyrus und den XÖV-Primer aufgenommen. In der Erläuterung der NDR-3 wurde der Verweis auf den Stereotyp xsdGlobalElement entfernt, da dieser nicht mehr zur Annotation einer Nachricht benötigt wird. Der Begriff "XÖV-Primer" wurde in das Glossar aufgenommen. Die Kurzbeschreibung zu NDR-9 in der Tabelle "Übersicht der Regeln und Empfehlungen" wurde geändert in "Umgang mit speziellen Anforderungen an die Nutzung von Codelisten". (Issue Public 33) Im Abschnitt "XÖV-Datentypen" wurde ein Bezug zur neu eingeführten XÖV-Basisnachricht hergestellt.
XÖV-Handbuch 2.4 (pdf, 2.8 MB)In der aktuellen Version des XÖV-Handbuchs wurden folgende inhaltliche Anpassungen vorgenommen: In Abschnitt 8.3.2. "Modellierung spezieller Anforderungen" wurde der neue Abschnitt "Nutzung mehrsprachiger Codelisten" aufgenommen. (Issue 43) Im Glossar wird unter "Genericoder" auf die geplante Abschaltung und das Nachfolgeprodukt "Codelisten-Editor" hingewiesen. (Issue 42) In Abschnitt 2.3.2. "XGenerator" wurde der Verweis auf die XMI-Version "Eclipse UML2 v4.x" geändert in "Eclipse UML2 v5.x". (Issue 45)
XÖV-Handbuch 2.3.1In der aktuellen Version des XÖV-Handbuchs wurden folgende inhaltliche Anpassungen vorgenommen: Abschnitt 2.2.1. "XÖV-Datentypen" und Kapitel 6. "Nutzung von XÖV-Datentypen" wurden um Aussagen zum neuen XÖV-Adapter "XML namespace" erweitert. (Issue 37) In der NDR-Tabelle "Übersicht der Regeln und Empfehlungen" wurde die Angabe zur Verbindlichkeit der NDR-12 korrigiert. Sie entspricht nun der tatsächlichen Verbindlichkeit der NDR (EMPFEHLUNG). (Issue 38)
XÖV-Handbuch 2.3 (pdf, 2.8 MB)In der aktuellen Version des XÖV-Handbuchs wurden folgende inhaltliche Anpassungen vorgenommen: In den Konformitätskriterien K-1 und K-15 wurden die Prüfgrundlage und der Prüfinhalt aktualisiert. Dabei wurden Aussagen zum XÖV-Steckbreif entfernt. (Issue 3) NDR-34 (Modellierung von Codelistenversionen als benannte Typen) wurde neu erstellt. (Issue 10) NDR-24 wurde hinsichtlich der Möglichkeiten zur Wiederverwendung generischer Nachrichteneigenschaften offener gestaltet. (Issue 12) Im Kapitel „Nutzung von Codelisten“ wurden die Abschnitte „Codelisten im XÖV-Fachmodell“, „Kennzeichnung über Code-Typ 4 genutzter Codelisten(versionen)“ und „Kennzeichnung der Nutzung von Codelisten ohne Code-Datentyp“ neu aufgenommen. Aufgrund der neuen NDR-34 wurden darüber hinaus die Beispiele auf benannte Typen für Codelistenversionen umgestellt und der Abschnitt „Nutzung von Codelistenversionen als anonyme Datentypen“ neu aufgenommen. Der Abschnitt „Nutzung von Codelistenversionen als benannte Datentypen“ wurde grundlegend inhaltlich überarbeitet. Die Abschnitte wurden neu angeordnet. (Issue 26) NDR-33 wurde bezüglich der neuen Codelisten-Methodik konkretisiert. (Issue 28) Eine vollständige Liste der Änderungen finden Sie in Abschnitt C.1. „Release 2.3“ des Handbuchs.
XÖV-Handbuch 2.2 (pdf, 3.9 MB)In der aktuellen Version des XÖV-Handbuchs wurden folgende inhaltliche Anpassungen vorgenommen: Das Konformitätskriterium K-4 wurde um die Anforderung ergänzt, dass alle durch den Standard genutzten Codelisten, wenn sie durch Standard herausgegeben werden, im XRepository veröffentlicht sein müssen. Konformitätskriterium K-6 und K-7 wurden aufgrund der Ersetzung des XÖV-Steckbriefs durch direkte Angaben im XRepository überarbeitet. In Konformitätskriterium K-12 wurde die Vorgabe zur Nutzung der jeweils aktuellen Version gestrichen. Das Konformitätskriterium K-13 „Nutzung von Codelisten“ wurde inhaltlich aktualisiert. In NDR-5 wurde eine Vorgabe zur Benennung des Modells ergänzt. NDR-8 „Versionsübergreifend eindeutige Codes in Codelisten“ wurde aufgrund ihrer Überführung in das Codelisten-Handbuch gestrichen. NDR-10 „Konsistente Namen in XÖV-Fachmodell und XML Schema-Definitionen“ wurde gestrichen, da sie durch die aktualisierte NDR-1 abgedeckt ist. NDR-12 wurde in eine Empfehlung überführt. In NDR-18 wurde bzgl. der Nutzung des technischen Namens aktualisiert. NDR-22 wurde hinsichtlich Konsistenz von Codelisten in XÖV-Fachmodell und XRepository konkretisiert. NDR-33 „Codelisten konform zu den Regelungen des Codelisten-Handbuchs“ wurde neu erstellt. Der Abschnitt „Datentypen der KoSIT“ wurde aufgrund einer neuen Codelisten-Methodik im Bereich „Ableitung von einem XÖV-Datentyp über eine XML Schema-Restriktion“ überarbeitet und um den Bereich „Implizite Nutzung des XÖV-Datentyps Code.“ ergänzt. Das Kapitel „Nutzung von Codelisten“ wurde aufgrund einer neuen Codelisten-Methodik komplett überarbeitet. Teile des Kapitels wurden in das Codelisten-Handbuch verlagert. Eine vollständige Liste der Änderungen finden Sie in Abschnitt C.1. „Release 2.2“ des Handbuchs.
XÖV-Handbuch 2.1.0 (pdf, 4.9 MB)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
XÖV-Handbuch 2.0.1 (pdf, 2.9 MB)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
XÖV-Handbuch 2.0 (pdf, 2.7 MB)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
XÖV-Handbuch 1.1 (pdf, 4 MB)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.
XÖV-Handbuch 1.0 (pdf, 5.2 MB)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.