Allgemeine XML-Export-Schnittstelle

Auf dieser Seite finden Sie technische Informationen zur allgemeinen XML-Exportschnittstelle, d.h. zum Schnittstellenframework. Informationen zu konkreten Schnittstellenimplementierungen, insbesondere deren genaue Definition, finden Sie auf folgenden Seiten:

Allgemein

Die allgemeine XML-Export-Schnittstelle ist ein Framework, das eine umfassende Baumstruktur beschreibt und in der Lage ist, beliebige Teilbäume daraus als gepackte und verschlüsselte XML-Datei zu exportieren.

Aufbau Exportdatei

Das Tag <xml_id>

XML stellt bekanntlich nur baumartige Strukturen dar. Wo „Querreferenzen“ im Baum notwendig werden, wird in referenzierten XML-Elementen eine ID mit dem Tag <xml_id> gesetzt; die Referenzen selbst lauten *_id (soll z. B. ein <lehrkraft>-Element mit xml_id 1011 referenziert werden, geschieht dies mit <lehrkraft_id>1011</lehrkraft_id>).

Die xml_id wird einzig innerhalb der XML-Struktur benutzt und kann sich bei jedem Export ändern. Für verbindliche IDs siehe nächsten Kasten.

Lokales Differenzierungsmerkmal für Lehrkräfte und Schüler

Bei Import-Vorgängen muss eine eindeutige Zuordnung zwischen zu importierenden und bestehenden Datensätzen geleistet werden; dies betrifft ASV selbst als auch andere Verfahren.

Zu diesem Zweck wird für die XML-Elemente <lehrkraftdaten_nicht_schulbezogen> und <schuelerin> jeweils ein eindeutiger Schlüssel namens <lfd_nr><lokales_differenzierungsmerkmal> ausgespielt. Für dieses wird zugesichert:

  • Es identifiziert eine Lehrkraft bzw. einen Schüler eindeutig innerhalb der ASV-Datenbasis (d. h. je nach Installationsvariante schulweit, Schulzentrums-weit oder sogar Sachaufwandsträger-weit).
  • Es ist unveränderlich; sie bleibt insbesondere erhalten bei
    • Schuljahreswechsel und
    • Rückspielen von Datenbank-Backups.
  • Es wird nur einmal vergeben. Auch das „lokale Differenzierungsmerkmal“ ausgetretener Personen wird nicht wieder an neu eintretende Personen vergeben.

Benutzung

Installation des Exports in ASV

Der Notenverwaltungs-Export und weitere XML-Exporte wird von Seiten des StMBW in ASV integriert. Die einzelnen Schnittstellen werden über den Prozess „Anwendungsdaten aktualisieren“ veröffentlicht.

Export in der ASV-GUI vornehmen

Transport der Export-Datei

Die Programme in der Schullandschaft, in die die Daten importiert werden sollen, sind sehr heterogen aufgestellt: Möglicherweise…

Import in einem Schulverwaltungs-Programm

Idealerweise wird das importierende Schulverwaltungs-Programm die Schritte

  1. Passwort vom Benutzer erfragen
  2. ZIP-Datei auspacken
  3. die enthaltene export.xml lesen und weiter verarbeiten
  4. womöglich (z. B. beim Auspacken der ZIP-Datei) entstandene temporäre Dateien zuverlässig löschen

automatisiert vornehmen, so dass es dem Benutzer erspart bleibt, am Ziel-Rechner selbst mit ZIP-Programmen umgehen zu müssen.

Für Schritt 2 (ZIP-Datei auspacken) sehen wir folgende Implementierungs-Möglichkeiten, sortiert nach Präferenz (beste Lösung zuerst):
  1. Benutzung einer Programmbibliothek, nach Möglichkeit in der benutzten Programmiersprache selbst. Beispiele für ZIP-Programmbibliotheken mit AES-Unterstützung:
  2. automatisierte Benutzung eines ZIP-Kommandozeilenprogramms durch das Schulverwaltungsprogramm. Gängige Programmiersprachen sollten Prozesse starten können, ohne dass ein Konsolen-Fenster „aufpoppt“ (in vielen gängigen Programmiersprachen (.NET-Sprachen, Java) mittels einer Process-Klasse). Beispiele für ZIP-Kommandozeilenprogramme mit AES-Unterstützung:
  3. Der Benutzer muss auf dem Zielrechner manuell die ZIP-Datei mittels eines ZIP-Programms mit GUI auspacken :-(. Beispiele für GUI-ZIP-Programme mit AES-Unterstützung:

Leider unterstützen viele ZIP-Programme und -Programmbibliotheken keine Verschlüsselung oder nur die ältere, unsicherere ZipCrypto-Verschlüsselung.

FAQ

Häufig gestellte Fragen aus Sicht der Entwickler von Schulverwaltungsprogrammen

Kontakt

Für technische Unterstützung und Feedback stehen von Seiten des StMUK zur Verfügung: