Import aus Schild-NRW

Schild-NRW ist eine offizielle Schulverwaltungssoftware des Landes Nordrhein-Westfalen. ENBREA kann Daten direkt aus der Datenbank (momentan wird nur MySQL unterstützt) von Schild-NRW importieren.

Wie funktioniert der Import?¶

Der Workflow besteht grob aus zwei Schritten:

ENBREA CLI liest direkt aus der Schild-NRW-Datenbank und generiert ECF-Dateien.
ENBREA CLI importiert die generierten ECF-Dateien nach ENBREA. Sollten sich im Vergleich mit dem letzten Import keine Änderungen ergeben haben, wird kein Import durchgeführt.

Initialisierung¶

Falls noch nicht geschehen, bitte einen Zeitraum in ENBREA anlegen und auf Ihrem lokalen Computer ENBREA CLI installieren.
Im Windows-Explorer ein neues Verzeichnis c:\enbrea anlegen (das Verzeichnis kann natürlich auch anders heißen).
Im Suchfeld der Windows-Taskleiste Eingabeaufforderung eintippen und die Windows-Eingabeaufforderung öffnen.
Mit Befehl cd in das soeben angelegte Verzeichnis wechseln:
```
cd c:\enbrea
```
Nun folgenden Befehl eintippen:
```
enbrea init -c enbrea.json
```
Es wird jetzt eine Konfigurationsdatei enbrea.json angelegt, die als Vorlage für die weitere Konfiguration dient.

Konfiguration¶

Die gesamte Konfiguration des Imports befindet sich in der Textdatei enbrea.json. Diese Datei in einem Texteditor öffnen und die gewünschten Eigenschaften überschreiben.

Die folgenden Eigenschaften müssen angepasst werden. Sie konfigurieren den individuellen Zugang zu ENBREA:

Allgemeine Konfiguration

Url: URL zu Ihrer ENBREA-Instanz
AccessToken: ENBREA-Zugriffstoken
SchoolTerm: Kürzel des ENBREA-Zeitraums, in den importiert werden soll.

Die folgenden Eigenschaften müssen ebenfalls angepasst werden. Sie konfigurieren den Zugang zur Datenbank von Schild-NRW:

Schild-NRW

SchildNRW.DatabaseProvider: Wert zur Zeit nur MySQL
SchildNRW.DatabaseConnection: Ein Connection-String zur MySQL-Datenbank von Schild-NRW
SchildNRW.SchoolYear: Schuljahr in Schild-NRW
SchildNRW.SchoolTerm: Halbjahr in Schild-NRW

Alle anderen Eigenschaften sind schon vorkonfiguriert, können aber natürlich jederzeit überschrieben werden.

Bitte beachten

Der Backslash (= umgedrehter Schrägstrich) in Dateipfaden muss in einer JSON-Datei stets gedoppelt werden, also \\ statt \.

Das Ergebnis könnte wie folgt aussehen:

{
  "Url": "https://enbrea.cloud/meine-schule",
  "AccessToken": "9067eff1-6817-4e59-855c-9ace4e51f139",
  "SchoolTerm": "1. HJ 20223/2004",

  ... 

  "SchildNRW": {
    "DataProvider": "MsSql",
    "DatabaseConnection": "server=localhost;port=3306;database=schild;uid=admin;pwd=qwertz",
    "SchoolYear": 2023,
    "SchoolTerm": 1,
    "TargetFolder": ".\\schildnrw\\export"
  }
}

Testen¶

Im Suchfeld der Windows-Taskleiste Eingabeaufforderung eintippen und die Windows-Eingabeaufforderung öffnen.
Mit folgendem Befehl in unser ENBREA-Verzeichnis wechseln:
```
cd c:\enbrea
```

Folgenden Befehl eintippen und bestätigen:

enbrea import -p schildnrw -c enbrea.json

Die Daten aus Schild-NRW werden ins ECF-Format übersetzt und anschließend nach ENBREA übertragen.

Automation¶

Die Synchronisation zwischen Schild-NRW und ENBREA kann natürlich automatisiert werden. Am einfachsten geht dies mit dem ENBREA CLI-Befehl create-import-task.

Ein Beispiel:

Im Suchfeld der Windows-Taskleiste Eingabeaufforderung eintippen und die Windows-Eingabeaufforderung als Administrator öffnen.
Mit folgendem Befehl in unser ENBREA-Verzeichnis wechseln:
```
cd c:\enbrea
```

Folgenden Befehl eintippen und bestätigen:

enbrea create-import-task -p schildnrw -c enbrea.json -i 15

Mit diesem Aufruf wird der in enbrea.json konfigurierte Schild-NRW-Import nach ENBREA alle 15 Minuten ausgeführt.

Eine ausführliche Beschreibung der Möglichkeiten rund um das Thema Automation findet sich im Kapitel Automation.