Anleitung zur Pilotierung

Diese Anleitung richtet sich an Fachverfahrenshersteller, interne IT-Verantwortliche und technisch beteiligte Stellen. Sie beschreibt die technischen Artefakte und Arbeitsschritte für das Einlesen, Erzeugen, Validieren und Testen von XBBD-Dokumenten.

Informationen zum Zweck der Pilotierung, zu den möglichen Rollen und zu den pilotierbaren Nachweisen finden Sie auf der allgemeinen Pilotierungsseite. Welche organisatorischen und fachlichen Voraussetzungen Sie für den Einstieg benötigen, zeigt die Checkliste zur Pilotierung. 

Die Pilotierung startet nutzerorientiert jederzeit.

Die Pilotierung basiert a) auf dem aktuellen Release von XBerufsbildung XBBD V0.7 und b) auf bereitgestellten Beispielinstanzen bzw. Testdateien. 

a) Das Release XBBD v0.7 enthält:

• Die XML-Schemata im Ordner /xsd
• Die Schematron-Regeln im Ordner /sch
• Die Beispielinstanzen im Ordner /xml
• Die eingebundenen Codelisten im Ordner /code
• Die Darstellung der Spezifikation als PDF im Ordner /spec

b) Für die Pilotierung stehen beispielhafte Testdateien bzw. Beispielinstanzen zur Verfügung: 

• Positiv-Testdateien für das Prüfungszeugnis v.07_pilotierung/testdateien_positiv
• Negativ-Testdateien ifür das Prüfungszeugnis v.07_pilotierung/testdateien_negativ

Auf Basis der bereitgestellten Testdateien soll das automatisierte Einlesen des Prüfungszeugnisses erprobt werden. Bei Bedarf können ergänzende Testdateien für weitere XBBD-Dokumente erstellt werden. 

Die Positiv-Testdateien stellen valide XBBD-Dokumente dar. Diese sollen jeweils automatisiert gegen die XBerufsbildung XSD-Dateien und Schematron-Regeln validiert und anschließend in die zugrundeliegende Datenbank eingelesen werden können. Die Positiv-Testdateien dienen außerdem als Orientierungshilfe für das Ausstellen von validen XBBD-Dokumenten.

Die Negativ-Testdateien stellen hingegen nicht-valide XBBD-Dokumente dar, die jeweils genau einen spezifischen Fehler enthalten (z. B. doppelte Eingabe eines Pflichtfeldes, Eingabe eines ungültigen Wertes), der im XML-Quelltext dokumentiert ist. Die Negativ-Testdateien sollen ebenfalls automatisiert von einer Schnittstelle validiert werden, wobei der entsprechende Fehler erkannt werden soll. Das negative Validierungsergebnis soll dazu führen, dass die entsprechende Testdatei nicht in die zugrundeliegende Datenbank eingelesen wird.

Um möglichst viele Erkenntnisse aus der Pilotierung für die Weiterentwicklung und die zukünftige Implementierung von XBerufsbildung zu sammeln und allen Beteiligten zur Verfügung zu stellen, ist eine gut strukturierte und offen zugängliche Dokumentation besonders wichtig:

• Für die strukturierte Rückmeldung aller Erkenntnisse, die Sie bei der Pilotierung sammeln, gibt es ein zentrales GitHub-Template. Dieses enthält strukturierte Fragen zu allen Aspekten der Pilotierung. Bitte nutzen Sie ausschließlich dieses Template für Ihre Rückmeldung.
• Wir bitten Sie als Teilnehmer für Ihre Organisation nur ein GitHub-Issue für die gesamte Pilotierung auszufüllen. Dieses können Sie je nach Fortschritt weiter ergänzen bzw. pflegen.
• Davon unabhängig können Sie konkrete Änderungsvorschläge zur aktuellen Spezifikation wie gewohnt als neue Issues auf GitHub einbringen. Hierfür steht ein allgemeines GitHub-Template zur Verfügung.

Für die einzusetzende Technologie zur Umsetzung der zuvor beschriebenen Schnittstelle zum Einlesen und Ausstellen von XBBD-Dokumenten gibt es keinerlei Einschränkungen oder Präferenzen aus Sicht von XBerufsbildung. Die folgende Übersicht erläutert daher kurz die grundlegenden Schritte, die für das erfolgreiche Einlesen und Ausstellen von XBBD-Dokumenten notwendig sind. 

5.1. Einlesen von XBBD-Dokumenten (Testdateien)

• Mapping erstellen: XBBD – Schnittstelle (Kammersoftware)
  1. Bilden Sie die Elemente des XBBD-Prüfungszeugnis auf die Datenstruktur Ihrer Kammersoftware ab.
  2. Nutzen Sie dazu die bereitgestellten XSD- und Schematron-Dateien, die Positiv-Testdateien sowie die XBerufsbildung Spezifikation.
  3. Dokumentieren Sie dabei bitte, bei welchen Elementen dieses Mapping ggf. problematisch oder unmöglich ist. Nutzen Sie dafür die entsprechende Stelle im GitHub-Template (siehe Punkt 4).
• Schnittstelle programmieren, die die Daten im XBBD-XML Format einließt
• Bereitgestellte Testdateien validieren
  1. Validieren Sie alle Positiv- und Negativ-Testdateien gegen das XBBD-Schema (Ordner /xsd) und gegen die XBBD-Schematron-Regeln (Ordner /sch).
  2. Dokumentieren Sie dabei bitte Ihre Validierungsergebnisse und ggf. entstandene Herausforderungen (siehe Punkt 4).
• Daten aus Positiv-Testdateien übernehmen
  1. Auf Basis des erstellten Mappings und der erfolgreichen Validierung der Positiv-Testdateien sollten nun die Daten aus den Positiv-Testdateien automatisiert in die Verwaltungssoftware bzw. die zugrundeliegende Datenbank übernommen werden können. Testen Sie dies bitte für alle Positiv-Testdateien.
  2. Dokumentieren Sie dabei bitte, an welchen Stellen die Datenübernahme ggf. Probleme verursacht hat (siehe Punkt 4).

5.2. Ausstellen von XBBD-Dokumenten

• Testdaten vorbereiten
  1. Verwenden Sie keine realen Daten eines Prüflings, sondern legen Sie (falls nicht vorhanden) einen Testdatensatz eines fiktiven Prüflings in Ihrem System an. Nutzen Sie dafür gerne die <!-- Angaben zum Prüfling -->  aus der Testdatei T02_pruefungszeugnis_max_positiv.xml.
  2. Für weitere Testdaten zu Kammern, Prüfungsfächern, Ausbildungsberufen etc. können Sie sich ebenfalls an den bereitgestellten XBBD-Testdateien orientieren, oder eigene Testdaten verwenden.
• XBBD-Dokumente automatisch generieren
  1. Generieren Sie, basierend auf den angelegten Testdaten sowie dem erstellten Mapping, je eine möglichst umfassende, beispielhafte XML-Datei nach der aktuellen XBBD-Spezifikation für das XBBD-Prüfungszeugnis und benennen Sie diese Datei wie folgt:
     • [Ersteller]_pruefungszeugnis_max_positiv.xml
  2. Möglichst umfassend bedeutet: Nutzen Sie alle Daten, die strukturiert in Ihrer Kammersoftware bzw. Ihrer Datenbank vorgehalten werden, um möglichst viele verschiedene der laut XBBD-Spezifikation erlaubten Elemente in XBBD-Dokument "Prüfungszeugnis" zu befüllen.
  3. Verwenden Sie dabei gerne auch außergewöhnliche Testdaten aus Ihrem System, um die Robustheit des XBBD-Schemas zu testen, wie z. B. unvollständige Angaben zum Ausbildungsberuf oder anderen Elementen, ungewöhnliche Namen u.ä. Erstellen Sie dafür gerne weitere XML-Dokumente.
  4. Dokumentieren Sie bitte, welche Herausforderungen oder Besonderheiten es ggf. bei der Generierung des Prüfungszeugnisses gab.
• Erstellte XBBD-Dokumente validieren
  1. Validieren Sie das erstellte XBBD-Prüfungszeugnis gegen das XBBD-Schema (Ordner /xsd).
  2. Validieren Sie das erstellte XBBD-Prüfungszeugnis gegen die XBBD-Schematron-Regeln (Ordner /sch).
  3. Dokumentieren Sie ggf. Fehler und Probleme bei der Validierung (z.B. Pflichtfeld nicht in der Verwaltungssoftware verfügbar)
• Ergebnisse auf GitHub bereitstellen (siehe Punkt 4)
  1. Laden Sie Ihre ausgestellten und validierten XML-Dateien als Anhänge zu Ihrem GitHub-Issue hoch.
  2. Laden Sie auch solche XML-Dateien hoch, die ggf. nicht gegen die aktuelle XBBD-Spezifikation validieren und dokumentieren Sie die Gründe.
  3. Bündeln Sie ggf. mehrere ausgestellte Dateien als ZIP-Archiv.

Sollte es Ihnen nicht möglich sein, die Funktionen zum automatisierten Einlesen der bereitgestellten Testdateien und zum Ausstellen von XBBD-Dokumenten in Ihrer Kammersoftware zu implementieren, können Sie trotzdem an der Pilotierung teilnehmen. 

In diesem Falle bitten wir Sie, die folgenden Schritte durchzuführen:

1. Generieren Sie aus Ihrer Software jeweils ein möglichst umfassendes, fiktives Beispieldokument für ein Prüfungszeugnis.
2. Öffnen Sie die bereitgestellten Positiv-Testdateien mit einem Texteditor oder mit Excel.
3. Vergleichen Sie die Felder der bereitgestellten maximalen Positiv-Testdateien mit den entsprechenden, aus Ihrer Software generierten Beispieldokumenten.
4. Dokumentieren Sie Ihre Erkenntnisse mit Hilfe dieses alternativen GitHub-Templates und gehen Sie dabei insbesondere auf folgende Fragen ein:
   • Gibt es Pflichtfelder, die Ihre Software zur Bearbeitung eines konkreten Anwendungsfalls benötigt, welche aber nicht in den bereitgestellten Testdateien T01 und T02 vorhanden sind?
   • Gibt es Felder oder Inhalte in den bereitgestellten Testdateien T01 und T02, die in Ihrem System nicht abgebildet werden können bzw. für die Sie keinen Nutzen sehen?
5. Laden Sie wenn möglich Ihre generierten Beispieldokumente als Anhang zu Ihrem GitHub-Issue hoch.