2. Pilotierung: 17.01.2023 bis 17.03.2023

1. Zielstellung und Inhalt

Durch die Teilnahme an der 2. Pilotierung von XHochschule können Sie sich als Hochschulen und Softwarehersteller auf die anstehende Implementierung einer XHochschule-Schnittstelle vorbereiten und auf diese Weise Ihr Campus Management System (CaMS) fit machen für den zukünftigen Standard XHochschule v1.0. Gleichzeitig helfen Sie durch Ihre Teilnahme dabei, eventuell noch bestehende Anpassungsbedarfe in der Spezifikation aufzudecken und dadurch eine reibungslose Inbetriebnahme von XHochschule zu ermöglichen.

Im Rahmen dieser 2. Pilotierung wird das Einlesen sowie das Ausstellen von drei verschiedenen XHS-Dokumententypen erprobt:

  • Exmatrikulationsbescheinigung (Exma)
  • Studienverlaufsbescheinigung (SVB)
  • Hochschulabschlusszeugnis (HAZ)

2. Zeitraum

Die 2. Pilotierung startet am 17.01.2023 und soll bis zum 17.03.2023 abgeschlossen sein.

[collapsed]

3. Welche Ressourcen werden bereitgestellt?

Die 2. Pilotierung basiert a) auf dem aktuellen Release von XHochschule XHS v0.94 und b) auf einem Set von Testdateien

a) Das Release XHS v0.94 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 2. Pilotierung beinhalten:

Auf Basis der bereitgestellten Testdateien soll das automatisierte Einlesen von XHS-Dokumenten erprobt werden.

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

Die Negativ-Testdateien stellen hingegen nicht-valide XHS-Dokumente dar, die jeweils genau einen spezifischen Fehler enthalten (z.B. fehlendes Pflichtfeld, Verletzung von Datentypen), der im XML-Quelltext dokumentiert ist. Die Negativ-Testdateien sollen ebenfalls automatisiert von einer CaMS-Schnittstelle validiert werden, wobei der entsprechende Fehler erkannt werden soll. Das negative Validierungsergebnis soll dazu führen, dass die entsprechende Testdatei nicht in das CaMS bzw. die zugrundeliegende Datenbank eingelesen wird. 

[/collapsed]

[collapsed]

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 XHochschule v1.0 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 XHS v0.94 wie gewohnt als neue Issues auf GitHub einbringen. Hierfür steht ein allgemeines GitHub-Template zur Verfügung.

[/collapsed]

[collapsed]

5. Welche grundlegenden Schritte umfasst die Pilotierung?

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

5.1. Einlesen von XHS-Dokumenten (Testdateien)

  • Mapping erstellen: XHS – CaMS
    1. Bilden Sie die Elemente der drei XHS-Dokumententypen (Exma, SVB, HAZ) auf die Datenstruktur Ihres CaMS ab.
    2. Nutzen Sie dazu die bereitgestellten XSD- und Schematron-Dateien, die Positiv-Testdateien sowie die XHochschule 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).
  • Bereitgestellte Testdateien validieren
    1. Validieren Sie alle Positiv- und Negativ-Testdateien gegen das XHS-Schema (Ordner /xsd) und gegen die XHS-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 das CaMS 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 XHS-Dokumenten

  • Testdaten vorbereiten
    1. Verwenden Sie keine realen Studierendendaten, sondern legen Sie (falls nicht vorhanden) einen Testdatensatz einer fiktiven studierenden Person in Ihrem System an. Nutzen Sie dafür gerne die <!-- Angaben zur studierenden Person -->  aus der Testdatei T04_Exma_max_positiv.xml.
    2. Für weitere Testdaten zu Hochschulen, Studienfächern, etc. können Sie sich ebenfalls an den  bereitgestellten XHS-Testdateien orientieren, oder eigene Testdaten verwenden.
  • XHS-Dokumente automatisch generieren 
    1. Generieren Sie, basierend auf den angelegten Testdaten sowie dem erstellten Mapping, je eine möglichst umfassende, beispielhafte XML-Datei nach dem XHS v0.4-Schema für jeden der drei XHS-Dokumenttypen und benennen Sie diese Dateien wie folgt: 
      • [Ersteller]_Exma_max.xml
      • [Ersteller]_SVB_max.xml
      • [Ersteller]_HAZ_max.xml
    2. Möglichst umfassend bedeutet: Nutzen Sie alle Daten, die strukturiert in Ihrem CaMS bzw. Ihrer Datenbank vorgehalten werden, um möglichst viele verschiedene der laut XHS-Spezifikation erlaubten Elemente in jedem der drei XHS-Dokumenttypen zu befüllen.
    3. Verwenden Sie dabei gerne auch außergewöhnliche Testdaten aus Ihrem System, um die Robustheit des XHS-Schemas zu testen, wie z.B. unvollständige Studienabschnitte, ungewöhnliche Namen, seltene Herkunftsländer, unvollständige Angaben, u.ä. Erstellen Sie dafür gerne weitere XML-Dokumente.
    4. Dokumentieren Sie bitte, welche Herausforderungen oder Besonderheiten es ggf. bei der Generierung der XHS-Dokumente gab.
  • Erstellte XHS-Dokumente validieren
    1. Validieren Sie die erstellten XHS-Dokumente gegen das XHS-Schema (Ordner /xsd).
    2. Validieren Sie die erstellten XHS-Dokumente gegen die XHS-Schematron-Regeln (Ordner /sch).
    3. Dokumentieren Sie ggf. Fehler und Probleme bei der Validierung (z.B. Pflichtfeld nicht in CaMS 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 XHS v0.4 validieren und dokumentieren Sie die Gründe.
    3. Bündeln Sie ggf. mehrere ausgestellte Dateien als ZIP-Archiv.

[/collapsed]

[collapsed]

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 XHS-Dokumenten in Ihrem CaMS 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 Ihrem CaMS jeweils ein möglichst umfassendes, fiktives Beispieldokument für
    • eine Exmatrikulationsbescheinigung (Exma)
    • eine Studienverlaufsbescheinigung (SVB) und
    • ein Hochschulabschlusszeugnis (HAZ).
  2. Öffnen Sie die bereitgestellten Positiv-Testdateien mit einem Texteditor oder mit Excel.
  3. Vergleichen Sie die Felder der bereitgestellten maximalen Positiv-Testdateien (T01 bis T07) mit den entsprechenden, aus Ihrem CaMS 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 Ihr CaMS zur Bearbeitung eines konkreten Anwendungsfalls benötigt, welche aber nicht in den bereitgestellten Testdateien T01 bis T03 vorhanden sind?
    • Gibt es optionale Felder, die ihr CaMS zur Bearbeitung eines konkreten Anwendungsfalls benötigt, welche aber nicht in den bereitgestellten Testdateien T04 bis T06 vorhanden sind?
    • Gibt es Felder oder Inhalte in den bereitgestellten Testdateien T04 bis T07, 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.

[/collapsed]