Pilotierung #1: Prüfungszeugnis
1. Zielstellung und Inhalt
Mit Hilfe der Pilotierung des Prüfungszeugnisses soll die Erstellung von XBBD-Dokumenten mit der jeweils in Verwendung befindlichen Verwaltungssoftware in der Praxis erprobt werden. Zudem sollen Erkenntnisse über das Vorgehen bei einer Pilotierung erlangt und weiterentwickelt werden.
Durch Ihre Teilnahme an der ersten Pilotierung von XBerufsbildung haben zuständige Stellen nach § 71 ff. Berufsbildungsgesetz (BBiG) sowie Softwarehersteller die Möglichkeit, sich gezielt auf eine zukünftige Implementierung einer XBerufsbildung-Schnittstelle vorzubereiten und das Modell in seiner jetzigen Version bereits auf Praxistauglichkeit zu prüfen. Ihre Beteiligung trägt auch dazu bei, potenzielle Anpassungsbedarfe in der Spezifikation zu identifizieren und somit eine Weiterentwicklung von XBerufsbildung zu ermöglichen.
2. Zeitraum
Die Pilotierung startet nutzerorientiert jederzeit.
3. Welche Ressourcen werden bereitgestellt?
Die Pilotierung basiert a) auf dem aktuellen Release von XBerufsbildung XBBD V0.4 und b) auf einem Set von Testdateien
a) Das Release XBBD v0.4 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) Die Testdateien für die 1. Pilotierung beinhalten:
- Die Positiv-Testdateien im Ordner /v.04_pilotierung/testdateien_positiv
- Die Negativ-Testdateien im Ordner /v.04_pilotierung/testdateien_negativ
Auf Basis der bereitgestellten Testdateien soll das automatisierte Einlesen des Prüfungszeugnisses erprobt 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.
4. Wie kann eine Rückmeldung eingereicht werden?
Um möglichst viele Erkenntnisse aus der Pilotierung für die Weiterentwicklung und die zukünftige Implementierung von XBerufsbildung V0.4 zu sammeln und allen Beteiligten zur Verfügung zu stellen, ist 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 zum Release XBBD V0.4 wie gewohnt als neue Issues auf GitHub einbringen. Hierfür steht ein allgemeines GitHub-Template zur Verfügung.
5. Welche grundlegenden Schritte umfasst die Pilotierung?
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)
- Bilden Sie die Elemente des XBBD-Prüfungszeugnis auf die Datenstruktur Ihrer Kammersoftware ab.
- Nutzen Sie dazu die bereitgestellten XSD- und Schematron-Dateien, die Positiv-Testdateien sowie die XBerufsbildung Spezifikation.
- 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
- Daten aus Positiv-Testdateien übernehmen
- 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.
- 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
- 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.
- 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
- Generieren Sie, basierend auf den angelegten Testdaten sowie dem erstellten Mapping, je eine möglichst umfassende, beispielhafte XML-Datei nach dem XBBD V0.4-Schema für das XBBD-Prüfungszeugnis und benennen Sie diese Datei wie folgt:
- [Ersteller]_pruefungszeugnis_max_positiv.xml
- 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.
- 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.
- Dokumentieren Sie bitte, welche Herausforderungen oder Besonderheiten es ggf. bei der Generierung des Prüfungszeugnisses gab.
- Generieren Sie, basierend auf den angelegten Testdaten sowie dem erstellten Mapping, je eine möglichst umfassende, beispielhafte XML-Datei nach dem XBBD V0.4-Schema für das XBBD-Prüfungszeugnis und benennen Sie diese Datei wie folgt:
- Erstellte XBBD-Dokumente validieren
- Validieren Sie das erstellte XBBD-Prüfungszeugnis gegen das XBBD-Schema (Ordner /xsd).
- Validieren Sie das erstellte XBBD-Prüfungszeugnis gegen die XBBD-Schematron-Regeln (Ordner /sch).
- 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)
- Laden Sie Ihre ausgestellten und validierten XML-Dateien als Anhänge zu Ihrem GitHub-Issue hoch.
- Laden Sie auch solche XML-Dateien hoch, die ggf. nicht gegen XBBD V0.4 validieren und dokumentieren Sie die Gründe.
- Bündeln Sie ggf. mehrere ausgestellte Dateien als ZIP-Archiv.
6. Ist die Teilnahme auch ohne technische Implementierung möglich?
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:
- Generieren Sie aus Ihrer Software jeweils ein möglichst umfassendes, fiktives Beispieldokument für ein Prüfungszeugnis.
- Öffnen Sie die bereitgestellten Positiv-Testdateien mit einem Texteditor oder mit Excel.
- Vergleichen Sie die Felder der bereitgestellten maximalen Positiv-Testdateien mit den entsprechenden, aus Ihrer Software generierten Beispieldokumenten.
- 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?
- Laden Sie wenn möglich Ihre generierten Beispieldokumente als Anhang zu Ihrem GitHub-Issue hoch.
Interesse an einer Pilotierung? Dann melden Sie sich gern unter beteiligung@xberufsbildung@init.de. Gerne besprechen wir unverbindlich offene Fragen und das Vorgehen mit Ihnen.