Import aus edoo.sys

edoo.sys ist eine offizielle Schulverwaltungssoftware des Landes Rheinland-pfalz. ENBREA kann Daten direkt aus der Datenbank von edoo.sys importieren. Alternativ können auch Daten mit Hilfe der edoo.sys-Exportschnittstelle importiert werden.

Wie funktioniert der Import?¶

Der Workflow besteht grob aus zwei Schritten:

1. ENBREA CLI liest direkt aus der PostgreSQL-Datenbank von edoo.sys und generiert ECF-Dateien.

2. 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.

Sollte ein direkter Zugriff auf die PostgreSQL-Datenbank von edoo.sys nicht möglich sein, sieht der Workflow etwas anders aus:

1. Zunächst muss manuell aus edoo.sys heraus eine Exportdatei generiert werden.

2. ENBREA CLI liest die edoo.sys-Exportdatei ein und generiert ECF-Dateien.

3. 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¶

1. Falls noch nicht geschehen, bitte einen Zeitraum in ENBREA anlegen und auf Ihrem lokalen Computer ENBREA CLI installieren.

2. Im Windows-Explorer ein neues Verzeichnis c:\enbrea anlegen (das Verzeichnis kann natürlich auch anders heißen).

3. Im Suchfeld der Windows-Taskleiste Eingabeaufforderung eintippen und die Windows-Eingabeaufforderung öffnen.

4. Mit Befehl cd in das soeben angelegte Verzeichnis wechseln:

   cd c:\enbrea
   

5. Nun folgenden Befehl eintippen:

   enbrea init -c enbrea.json
   

   Es wird jetzt eine JSON-formatierte Konfigurationsdatei enbrea.json angelegt, die als Vorlage für die weitere Konfiguration dient.

Konfiguration¶

Die gesamte Konfiguration des Imports befindet sich in der soeben angelegten 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:

Bei einem direkten Zugriff auf die PostgreSQL-Datenbank von edoo.sys müssen folgende Eigenschaften ebenfalls angepasst werden:

Bei einer Nutzung der Exportschnittsstelle von edoo.sys müssen folgende Eigenschaften ebenfalls angepasst werden:

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

Das Ergebnis für den direkten Abgleich per edoo.sys-Datenbank könnte wie folgt aussehen:

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

  ... 

  "Edoosys": {
    "DataProvider": "Postgres",
    "DatabaseConnection": "Server=127.0.0.1;Port=5432;Database=asv;User Id=admin;Password=qwertz;",
    "SchoolNo": "12345",
    "SchoolYearCode": "2023/24",
    "NoSchoolClassGroups": true,
    "TargetFolder": ".\\edoosys\\export"
  }
}

Das Ergebnis für den Abgleich über die edoo.sys-Exportschnitstelle könnte wie folgt aussehen:

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

  ... 

  "Edoosys": {
    "DataProvider": "Csv",
    "CsvExportFile": ".\\edoosys\\export\\csv\\beispiel.csv",
    "CsvExportQuote": "\"",
    "CsvExportSeparator": ";",
    "SchoolNo": "12345",
    "SchoolYearCode": "2023/24",
    "NoSchoolClassGroups": true,
    "TargetFolder": ".\\edoosys\\export"
  }
}

Testen¶

Vorbereitung¶

Bei einem direkten Zugriff auf die auf die PostgreSQL-Datenbank von edoo.sys ist nichts weiter zu tun.

Ist dies nicht möglich oder erwünscht, muss die Exportschnitstelle von edoo.sys genutzt werden. Hierbei wird eine CSV-Datei mit den notwendigen Daten erzeugt. Diese kann dann von ENBREA importiert werden.

1. Bitte edoo.sys starten und anmelden.

2. Bitte Datei > Verwaltung > Exportformatbibliothek wählen und dort den Befehl Neuen Datensatz hinzufügen ausführen. Ein neues Exportformat wird erzeugt.

3. Einen Namen für das neue Exportformat eintippen (z.B. ENBREA-Export)

4. Bitte nun im Anschnitt Ausgewählte Felder nacheinander die folgenden Felder definieren:

   • Schüler_Stamm_ID
   • Vornamen
   • Familienname
   • Geburtsdatum
   • Geschlecht
   • Klasse / Klassengruppe
   • Klasse
   • Alle Lehrkräfte (Kürzel) mit Fach

1. Bitte auf Neuen/geänderten Datensatz speichern klicken.

Das neue Exportformat in edoo.sys ist definiert und kann in Zukunft wiederverwendet werden.

Der eigentliche Export funktioniert wie folgt:

1. In der rechten Navigation der aktuellen Ansicht Exportformate verwalten den Datenbereich Schüler auswählen.

2. Auf die Schaltfläche Datensätze für Export auswählen klicken. Ein Dialgofenster öffnet sich.

3. Bitte die gewünschten Klassen bzw. Schüler auswählen.

4. Unter Exportziel die Option Datei auswählen und als Dateinamen jenen angeben, der in der JSON-Konfigurationsdatei unter Edoosys.CsvExportFile definiert ist. In unserer Beispielkonfiguration würde der Dateiname c:\enbrea\edoosys\export\csv\beispiel.csv lauten.

5. Nun auf Exportierenklicken.

Das Resultat ist eine frisch aus edoo.sys exportierte CSV-Datei.

Übertrag¶

1. Im Suchfeld der Windows-Taskleiste Eingabeaufforderung eintippen und die Windows-Eingabeaufforderung öffnen.

2. Mit folgendem Befehl in unser ENBREA-Verzeichnis wechseln:

   cd c:\enbrea
   

3. Folgenden Befehl eintippen und bestätigen:

   enbrea import -p edoosys -c enbrea.json
   

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

Automation¶

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

Ein Beispiel:

1. Im Suchfeld der Windows-Taskleiste Eingabeaufforderung eintippen und die Windows-Eingabeaufforderung als Administrator öffnen.

2. Mit folgendem Befehl in unser ENBREA-Verzeichnis wechseln:

   cd c:\enbrea
   

3. Folgenden Befehl eintippen und bestätigen:

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

Mit diesem Aufruf wird der in enbrea.json konfigurierte edoo.sys-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.