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:
-
Enbrea Cli liest direkt aus der PostgreSQL-Datenbank von edoo.sys 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.
Sollte ein direkter Zugriff auf die PostgreSQL-Datenbank von edoo.sys nicht möglich sein, sieht der Workflow etwas anders aus:
-
Zunächst muss manuell aus edoo.sys heraus eine Exportdatei generiert werden.
-
Enbrea Cli liest die edoo.sys-Exportdatei ein 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: -
Nun folgenden Befehl eintippen:
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:
Allgemeine Konfiguration
Url
-
URL zu Ihrer Enbrea-Instanz
AccessToken
-
Enbrea-Zugriffstoken
SchoolTerm
-
Kürzel des Enbrea-Zeitraums, in den importiert werden soll.
Bei einem direkten Zugriff auf die PostgreSQL-Datenbank von edoo.sys müssen folgende Eigenschaften ebenfalls angepasst werden:
edoo.sys (PostgreSQL)
Edoosys.DataProvider
-
Wert =
Postgres
Edoosys.DatabaseConnection
-
Ein Connection-String zur PostgreSQL-Datenbank von edoo.sys
Edoosys.SchoolYearCode
-
Das edoo.sys-Schuljahr, aus dem Exportiert werden soll.
Edoosys.SchoolNo
-
Offizielle Schulnummer der eigenen Schule
NoSchoolClassGroups
-
Sollen Klassengruppen aus edoo.sys exportiert werden oder nicht?
Wert Bedeutung true
Es werden keine Klassengruppen exportiert, stattdessen nur die Klassen (jede Klassengruppe verweist auf genau eine Klasse). false
Es werden Klassengruppen exportiert. Wichtig: Beim Einsatz von edoo.sys UND DaVinci hängt die Einstellung davon ab, ob in DaVinci mit Klassengruppen oder nur mit Klassen geplant wird. Die exportierten Klassendaten aus DaVinci und edoo.sys müssen übereinstimmen.
Bei einer Nutzung der Exportschnittsstelle von edoo.sys müssen folgende Eigenschaften ebenfalls angepasst werden:
edoo.sys (Manueller Export)
Edoosys.DataProvider
-
Wert =
Csv
Edoosys.CsvExportFile
-
Dateiname der edoo.sys-Exportdatei
NoSchoolClassGroups
-
Sollen Klassengruppen aus edoo.sys exportiert werden oder nicht?
Wert Bedeutung true
Es werden keine Klassengruppen exportiert, stattdessen nur die Klassen (jede Klassengruppe verweist auf genau eine Klasse). false
Es werden Klassengruppen exportiert. Wichtig: Beim Einsatz von edoo.sys UND DaVinci hängt die Einstellung davon ab, ob in DaVinci mit Klassengruppen oder nur mit Klassen geplant wird. Die exportierten Klassendaten aus DaVinci und edoo.sys müssen übereinstimmen.
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 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": ";",
"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.
-
Bitte edoo.sys starten und anmelden.
-
Bitte
Datei > Verwaltung > Exportformatbibliothek
wählen und dort den BefehlNeuen Datensatz hinzufügen
ausführen. Ein neues Exportformat wird erzeugt. -
Einen Namen für das neue Exportformat eintippen (z.B.
Enbrea-Export
) -
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
Hinweis
Klasse
oder Klasse/Klassenguppe
? Enbrea.Cli kann beides einlesen. Es versucht erst die Spalte "Klasse" einzulesen, wenn es die nicht gibt, dann die Spalte "Klasse / Klassengruppe".
- 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:
-
In der rechten Navigation der aktuellen Ansicht
Exportformate verwalten
den DatenbereichSchüler
auswählen. -
Auf die Schaltfläche
Datensätze für Export auswählen
klicken. Ein Dialgofenster öffnet sich. -
Bitte die gewünschten Klassen bzw. Schüler auswählen.
-
Unter
Exportziel
die OptionDatei
auswählen und als Dateinamen jenen angeben, der in der JSON-Konfigurationsdatei unterEdoosys.CsvExportFile
definiert ist. In unserer Beispielkonfiguration würde der Dateinamec:\enbrea\edoosys\export\csv\beispiel.csv
lauten. -
Nun auf
Exportieren
klicken.
Das Resultat ist eine frisch aus edoo.sys exportierte CSV-Datei.
Übertrag¶
-
Im Suchfeld der Windows-Taskleiste
Eingabeaufforderung
eintippen und die Windows-Eingabeaufforderung öffnen. -
Mit folgendem Befehl in unser Enbrea-Verzeichnis wechseln:
-
Folgenden Befehl eintippen und bestätigen:
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:
-
Im Suchfeld der Windows-Taskleiste
Eingabeaufforderung
eintippen und die Windows-Eingabeaufforderung als Administrator öffnen. -
Mit folgendem Befehl in unser Enbrea-Verzeichnis wechseln:
-
Folgenden Befehl eintippen und bestätigen:
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.