Sie sind hier:

Genericoder

Ein Online-Service zur Erstellung und Bearbeitung von Codelisten

Mit dem „Genericoder“ stellt die Koordinierungsstelle für IT-Standards (KoSIT) auf der Website www.genericoder.xoev.de einen Online-Service zur Unterstützung der praktischen Arbeit mit Codelisten bereit. Der Genericoder kann Codelisten anzeigen, prüfen und konvertieren.

Neues Regelwerk

Parallel zur Veröffentlichung des XÖV-Handbuchs 2.2 gibt die KoSIT zum ersten Mal das Codelistenhandbuch heraus. Es beschreibt einen Standard zur strukturierten Veröffentlichung und Nutzung von Codelisten. Die neue Methodik bietet einige Erweiterungen gegenüber dem im XÖV-Handbuch 2.1 beschriebenen Vorgehen.

Codelisten, welche zur neuen Methodik konform sind können demnächst im XRepository bereitgestellt werden. Ein entsprechender Hinweis wird an dieser Stelle veröffentlicht.

Im Abschnitt "Häufig gestellte Fragen" geben wir Hinweise zur Umstellung Ihrer Codelisten auf die aktuellste Methodik. Bei Fragen oder Unterstützungbedarf sprechen Sie uns bitte direkt an.

Codelisten

Die vorhabenübergreifende Nutzung von Codelisten erfordert die Verwendung eines einheitlichen, maschinenlesbaren Datenformats. Das XÖV-Rahmenwerk setzt für die technische Abbildung von Codelisten-Daten und -Metadaten den XML-basierten Standard Genericode des OASIS-Konsortiums ein.
Zur komfortablen Bearbeitung von Codelisten wird das Format Microsoft Excel (.xlsx) als Intermediärformat eingesetzt.

Funktionen des Genericoders

, png, 43.6 KB

„Prüfen und anzeigen“
Mit den Funktionen „Prüfen und anzeigen“ können Sie sich die Daten und Metadaten einer Genericode-Codeliste direkt im Webbrowser anzeigen lassen. Die Codeliste wird hinsichtlich ihrer Konformität zum Standard Genericode und zum Codelistenhandbuch überprüft. Die Ergebnisse der Prüfung werden im Detail aufgeführt.

„Excel erzeugen“ und „XML erzeugen“
Die Funktion „Excel erzeugen“ bietet Ihnen die Möglichkeit, eine oder mehrere Codelisten aus dem Genericode-Format in das Microsoft Excel-Format (.xlsx) zu überführen. So erzeugte Codelisten können direkt mit Microsoft Excel bearbeitet und bei Bedarf wieder mit der Funktion „XML erzeugen“ in das Genericode-Format überführt werden.

Excel-Dateien, die Sie in Genericode-Dateien überführen möchten, müssen auf Grundlage der von der KoSIT bereitgestellten Vorlage erstellt werden bzw. auf einer vom Genericoder erstellten Excel-Datei basieren. Das Format *.xlsx wird durch Excel ab der Version 2007 verwendet. Hier können Sie die Excel-Vorlagedatei herunterladen: Download (xlsx, 17.8 KB)

Häufige gestellte Fragen

Unabhängiger Betrieb
Die Entwicklung der Codelistenmethodik kann unabhängig vom Release-Zyklus des XÖV-Handbuchs vorangetrieben werden.
Mehrere Codespalten
Codelisten, welche der neuen Methodik folgen, können mehrere Spalten als Code-Spalte ausweisen. Dadurch können Codelisten einfacher über verschiedene Vorhaben hinweg verwendet werden.
Empfohlene Code-Spalte
Darüber hinaus hat der Bereitstellende die Möglichkeit eine der Codespalten als zur Verwendung empfohlen zu markieren.
Spezifikation der Verwendung
Ebenfalls neu ist die Möglichkeit für Beschreibungsspalten anzugeben, ob jede Zeile einen Eintrag enthalten muss.

Genericode-Codelisten können nach dem neuen Regelwerk mehrere Codespalten, eine als empfohlen markierte Spalte sowie eine spaltenweise Spezifikation der Verwendung enthalten. Außerdem referenziert eine Codeliste nun die Konformität zu einer Version des Codelisten-Handbuchs (statt einer Version des XÖV-Handbuchs). Diese Änderungen wirken sich gegebenenfalls auf die automatisierte Verarbeitung von Codelisten (z. B. durch Verfahrenshersteller) aus.

Details entnehmen Sie bitte dieser Seite.

Die Umstellung ist zunächst nicht zwingend. Die Weiterentwicklung der XÖV-Methoden und Produkte wird sich allerdings an der neusten Codelistenmethodik orientieren. Um die entstehenden Vorteile vollumfänglich nutzen zu können, raten wir daher zu einer Umstellung solange keine zwingenden Gründe dagegensprechen. Auch in dieser Frage stehen wir gerne beratend zur Verfügung.

Wenn Sie bereits eine oder mehrere Codelisten im XRepository bereitgestellt haben, können Sie für diese wie bisher neue Versionen nach dem „alten“ Regelwerk herausgeben. Falls Sie Ihre Codelisten in der Vergangenheit im Excel-Format gepflegt haben, können Sie Ihre bestehenden Excel-Dateien weiterhin verwenden. Mittelfristig sollten Sie eine Migration Ihrer Codelisten vornehmen um von den neuen Funktionalitäten zu profitieren (siehe unten).

Es gibt mehrere Möglichkeiten ihre zum XÖV-Handbuch 2.1. konforme Codeliste zu migrieren.

Händische Migration via Excel und Genericoder
Liegt Ihre Codeliste bereits im Excel-Format vor beginnen Sie mit Schritt 2. Liegt Ihre Codeliste im XML-Format vor, beginnen Sie mit 1.

  1. Rufen Sie unter www.genericoder.xoev.de den Menüpunkt „Excel erzeugen“ auf. Laden Sie Ihre XML-Codeliste hoch und speichern Sie die Excel-Fassung der Codeliste ab.
  2. Laden Sie die neue Excel-Vorlage (xlsx, 17.8 KB) herunter.
  3. Öffnen Sie die vom Genericoder erstellte Excel-Fassung Ihrer Codeliste und die neue Excel-Vorlage.
  4. Kopieren Sie die vorhandenen Daten in die Vorlage. Beachten Sie jeweils die beiden Blätter „Daten“ und „Metadaten“. Weitere Hinweise zum Ausfüllen der Vorlage finden Sie im Codelistenhandbuch.
  5. Ergänzen Sie die neuen Spalten-Metadaten: „Codespalte“, „Empfohlene Codespalte“ und „Verwendung“. Hinweise zu den zulässigen Werten und ihrer Bedeutung finden Sie mit einem Klick auf die Zeilenüberschriften in der Vorlage oder im Codelistenhandbuch.
  6. Beachten sie das Feld „Version Codelisten-Handbuch“. Es verweist nun auf die verwendete Version des Codelistenhandbuchs und nicht mehr auf das XÖV-Handbuch.
  7. Vermerken Sie unter „Änderungen zur Vorversion“ den Wechsel auf das Codelistenhandbuch in der Version 1.0.
  8. Benutzen sie die Funktion „XML erzeugen“ auf www.genericoder.xoev.de um die ausgefüllte Excel-Vorlage wieder in das XML-Format zu überführen.
  9. Der Genericoder validiert das Ergebnis und weist ggf. auf Probleme hin.

Migration durch Anpassung des XML-Dokuments (fortgeschritten)
Dieser Abschnitt beschreibt wie die Migration einer Codeliste per händischer Änderung des XML-Dokuments erreicht werden kann.

  1. Ersetzen Sie die Namensraum-Deklaration „xmlns:xoev-cl-2="http://xoev.de/schemata/genericode/2"“ im Element „gc:Codelist“ durch „xmlns:xoev-cl-3="http://xoev.de/schemata/genericode/3"“
  2. Ersetzen sie den Eintrag „xoev-cl-2:versionXOEVHandbuch“ durch „xoev-cl-3:versionCodelistenHandbuch“. Tragen sie als Version „1.0“ ein.
  3. Passen Sie die Einträge unter Annoation/Description an. Aus „xoev-cl-2:nameKurz“ wird „xoev-cl-3:nameKurz“, usw.
  4. Entfernen Sie das Element Annotation/AppInfo/xoev-cl-2:xoev-code aus dem Bereich ColumnSet/Key.
  5. Fügen Sie bei Bedarf das Element „xoev-cl-3:empfohleneCodeSpalte“ unter ColumnSet/key ein. Beachten Sie, dass diese Angabe optional ist und sich in der Bedeutung vom Element „xoev-cl-2:xoev-code“ unterscheidet. Weitere Informationen finden sie im Codelistenhandbuch.
  6. Vermerken Sie unter „Änderungen zur Vorversion“ den Wechsel auf das Codelistenhandbuch in der Version 1.0.
  7. Kontrollieren Sie die Anpassungen mit der Funktion „Prüfen und Anzeigen“ des Genericoders.

Migration durch die KoSIT
Kontaktieren Sie uns gerne, insbesondere auch, wenn sie Unterstützung bei der Umstellung mehrerer Codelisten benötigen.

Neue, noch nicht im XRepository veröffentlichte Codelisten sollten Sie nach den Regelungen des aktuellen Codelistenhandbuchs anlegen. Eine Beschreibung der Metadaten von Codelisten und deren Abbildung finden Sie im Codelistenhandbuch. Möchten Sie die Codeliste per Excel erstellen, gehen Sie bitte folgendermaßen vor:

Schritt 1: Herunterladen der Voralge

Laden Sie die Excel-Vorlagedatei (xlsx, 17.8 KB) herunter.

Schritt 2: Eintragen der Daten

Tragen Sie die Daten (Blatt 1) und Metadaten (Blatt 2) Ihrer neuen Codeliste in die Vorlage ein.

Schritt 3: Überführen in Genericode

Verwenden Sie die Funktion „XML erzeugen“ des Genericoders um die ausgefüllte Excel-Vorlage in eine genericodekonforme XML-Codeliste zu überführen.
Bei dieser Überführung wird die Codeliste auf Konformität zu den Genericode- und XÖV-Regelungen geprüft. Etwaige Fehler, Warnungen oder Hinweise werden Ihnen detailliert angezeigt.

Schritt 4: Bereitstellen

Die vom Genericoder erstellte XML-Datei kann heruntergeladen und in das XRepository eingestellt werden. Weitere informationen finden sie unter auf der entsprechenden Hilfeseite des XRepository zum Thema Bereitstellen.

Beispiel

Als Beispiel für eine der neuen Methodik entsprechende Codeliste können sie diese Datei (xml, 5.8 KB) verwenden. Beachten sie, dass es sich um eine zu Beispielzwecken erstellte Codeliste handelt, welche nicht in anderen Kontexten Verwendung finden darf.

Bezug

Der Service Genericoder ist im Internet unter www.genericoder.xoev.de abrufbar.

Methodik

Die Methodik zur Bereitstellung und Nutzung von Codelisten ist im Codelistenhandbuch beschrieben.

Betrieb

Der Genericoder 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
1.0 Erste Umsetzung des vormals Java-basierten Programms in einen Web-basierten Service erledigt
2.0 Anpassung an das XÖV-Handbuch Version 2.1 erledigt
3.0 Anpassung an die Methodik des Codelistenhandbuchs erledigt

Änderungsanträge

ID Beschreibung Status