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:

Das ECF Tool for Schild-NRW liest direkt aus der Schild-NRW-Datenbank und generiert ECF-Dateien.
Das ECF Tool for ENBREA importiert die ECF-Dateien nach ENBREA.

Mit dem PowerShell-Modul PSEnbrea können beide Schritte mit einem einzigen Befehl ausgeführt werden.

Installieren¶

Falls noch nicht geschehen, bitte auf dem Computer die .NET Core Laufzeitumgebung, PowerShell 7, das PowerShell-Modul PSEnbrea installieren und einen Zeitraum in ENBREA anlegen. Was genau hierfür zu tun ist, steht im Kapitel Voraussetzungen.
Im Windows-Explorer ein neues Verzeichnis c:\enbrea anlegen (das Verzeichnis kann natürlich auch anders heißen).
PowerShell 7 über das Windows-Menü starten: Start > Windows Powershell > Windows Powershell
Mit folgendem Befehl in das soeben angelegte Verzeichnis wechseln:
```
cd c:\enbrea
```
Nun folgenden PowerShell-Befehl eintippen:
```
Initialize-EnbreaImport enbrea.json
```
Es wird jetzt eine Konfigurationsdatei enbrea.json angelegt, die als Vorlage für die weitere Konfiguration dient.
Bitte folgenden PowerShell-Befehl eintippen:
```
Install-EcfTools enbrea,schildnrw
```
Es werden das ECF Tool for ENBREA und das ECF Tool for Schild-NRW installiert.

Konfigurieren¶

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:

Eigenschaft	Bedeutung
`Enbrea.EcfImport.IdentityServiceUrl`	URL zum ENBREA Identity Service
`Enbrea.EcfImport.IdentityUserName`	ENBREA Benutzername
`Enbrea.EcfImport.IdentityPassword`	ENBREA Kennwort
`Enbrea.EcfImport.SyncHubUrl`	URL zum ENBREA School Service
`Enbrea.EcfImport.SchoolTermId`	ID des ENBREA-Zeitraums, in den importiert werden soll. Die ID des Zeitraums ist in der Adressleiste des Browsers sichtbar, während man an der ENBREA-Instanz angemeldet ist.

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

Eigenschaft	Bedeutung
`SchildNRW.EcfExport.DatabaseProvider`	zur Zeit nur `MySQL`
`SchildNRW.EcfExport.DatabaseConnection`	Connection-String zur MySQL-Datenbank von Schild-NRW
`SchildNRW.EcfExport.SchoolYear`	Schuljahr in Schild-NRW
`SchildNRW.EcfExport.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:

{
    "SchildNRW" : {
        "EcfExport": {
            "TargetFolderName": "schildnrw\\ecf-export",
            "DatabaseProvider": "MySql",
            "DatabaseConnection": "server=localhost;port=3306;database=schild;uid=mein-benutzername;pwd=mein-kennwort",
            "SchoolYear": 2020,
            "SchoolTerm": 1
        }   
    },
    "Enbrea" : {
        "EcfImport": 
        {
            "IdentityServiceUrl" : "https://enbrea.beispiel.de/identity",
            "IdentityUserName" : "importbenutzer",
            "IdentityPassword" : "qwertz",
            "SchoolServiceUrl" : "https://enbrea.beispiel.de/syncHub",
            "SchoolTermId" : "9067eff1-6817-4e59-855c-9ace4e51f139",
            "Files" : [
                { "Name" : "CourseCategories", "KeyHeaders":"Code" },
                { "Name" : "CourseFlags", "KeyHeaders":"Code" },
                { "Name" : "CourseTypes", "KeyHeaders":"Code" },
                { "Name" : "EducationalAreas", "KeyHeaders":"Code" },
                { "Name" : "EventTypes", "KeyHeaders":"Code" },
                { "Name" : "ExamTypes", "KeyHeaders":"Code" },
                { "Name" : "FormsOfTeaching", "KeyHeaders":"Code" },
                { "Name" : "LessonProfiles", "KeyHeaders":"Code" },
                { "Name" : "LevelOfQualifications", "KeyHeaders":"Code" },
                { "Name" : "ResourceCategories", "KeyHeaders":"Code" },
                { "Name" : "ResourceFlags", "KeyHeaders":"Code" },
                { "Name" : "RoomAbsenceReasons", "KeyHeaders":"Code" },
                { "Name" : "RoomTypes", "KeyHeaders":"Code" },
                { "Name" : "SchoolClassAbsenceReasons", "KeyHeaders":"Id" },
                { "Name" : "SchoolClassFlags", "KeyHeaders":"Code" },
                { "Name" : "SchoolClassLevels", "KeyHeaders":"Code" },
                { "Name" : "SchoolClassProfils", "KeyHeaders":"Code" },
                { "Name" : "SchoolForms", "KeyHeaders":"Code" },
                { "Name" : "SchoolOrganisations", "KeyHeaders":"Code" },
                { "Name" : "SchoolTypes", "KeyHeaders":"Code" },
                { "Name" : "SubjectFocuses", "KeyHeaders":"Code" },
                { "Name" : "SubjectTypes", "KeyHeaders":"Code" },
                { "Name" : "TeacherAbsenceReasons", "KeyHeaders":"Id" },
                { "Name" : "TeacherAbsenceReasonDifferentiations", "KeyHeaders":"Code" },
                { "Name" : "TeacherTypes", "KeyHeaders":"Code" },
                { "Name" : "TimeAccountEntryReasons", "KeyHeaders":"Code" },
                { "Name" : "TimeAccountEntryReportings", "KeyHeaders":"Code" },
                { "Name" : "TimeAccountEntryTypes", "KeyHeaders":"Code" },
                { "Name" : "VacationTypes", "KeyHeaders":"Code" },
                { "Name" : "VocationalField", "KeyHeaders":"Code" },
                { "Name" : "EducationalPrograms", "KeyHeaders":"Code" },
                { "Name" : "TimeFrames", "KeyHeaders":"Code" },
                { "Name" : "Departments", "KeyHeaders":"Code" },
                { "Name" : "Rooms", "KeyHeaders":"Code" },
                { "Name" : "RoomAbsences", "KeyHeaders":"Id" },
                { "Name" : "Subjects", "KeyHeaders":"Code" },
                { "Name" : "EducationalContents", "KeyHeaders":"Code" },
                { "Name" : "EducationalMaterials", "KeyHeaders":"Code" },
                { "Name" : "SubjectLearningField", "KeyHeaders":"Code" },
                { "Name" : "Teachers", "KeyHeaders":"Code" },
                { "Name" : "TeacherAbsences", "KeyHeaders":"Id" },
                { "Name" : "Students", "KeyHeaders":"LastName;FirstName;Birthdate" },
                { "Name" : "StudentAbsences", "KeyHeaders":"Id" },
                { "Name" : "StudentSubjects", "KeyHeaders":"Id" }
                { "Name" : "SchoolClasses", "KeyHeaders":"Code" },
                { "Name" : "SchoolClassAbsences", "KeyHeaders":"Id" },
                { "Name" : "Courses", "KeyHeaders":"Id", "DeleteStrategy" : "DeleteRemaining" },
                { "Name" : "Announcements", "KeyHeaders":"Id", "DeleteStrategy" : "DeleteRemaining" },
                { "Name" : "ScheduledLessons", "KeyHeaders":"Id", "DeleteStrategy" : "DeleteRemaining" },
                { "Name" : "SubstituteLessons", "KeyHeaders":"Id", "DeleteStrategy" : "DeleteRemaining" },
                { "Name" : "LessonGaps", "KeyHeaders":"Id", "DeleteStrategy" : "DeleteRemaining" },
                { "Name" : "Vacations", "KeyHeaders":"Id", "DeleteStrategy" : "DeleteRemaining" }
            ]
        }
    }
}

Testen¶

PowerShell 7 über das Windows-Menü starten: Start > Windows Powershell > Windows Powershell
Mit folgendem Befehl in unser ENBREA-Verzeichnis wechseln:
```
cd c:\enbrea
```

Folgenden PowerShell-Befehl eintippen:

Start-EnbreaImport schildnrw 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. Tipps zur Automation per BATCH-Datei oder Windows-Aufgabenplanung findet man im Kapitel Automation.