Skip to content

ENBREA CSV Format (ECF) documentation

License

Notifications You must be signed in to change notification settings

enbrea/schema.ecf

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 

Repository files navigation

ENBREA CSV Format (ECF)

Das ENBREA CSV Format (kurz ECF-Format) dient zum Importieren von Daten nach ENBREA und zum Exportieren von Daten aus ENBREA. Auch andere Anwendungen wie z.B. DAVINCI und MAGELLAN unterstützen das ECF-Format.

Das ECF-Format umfasst einen standardisierte Menge von CSV-Dateien, die mit Hilfe von CSV Table Schema formal spezifiziert sind.

Dokumentation

Liste der ECF-Dateien

Die Liste aller Schema-Dateien findest Du hier.

Manifest

Dateiname Inhalt Spezifikation
Manifest.csv Globale Daten CSV-Schema

Schlüsselverzeichnisse

Dateiname Inhalt Spezifikation
Countries.csv Staaten CSV-Schema
CourseCategories.csv Kurskategorien CSV-Schema
CourseFlags.csv Kursmerkmale CSV-Schema
CourseTypes.csv Kursarten CSV-Schema
Languages.csv Sprachen CSV-Schema
MaritalStatuses.csv Ehestände CSV-Schema
Nationalities.csv Nationalitäten CSV-Schema
Religions.csv Religionszugehörigkeiten CSV-Schema
RoomAbsenceReasons.csv Raumausfallgründe CSV-Schema
RoomAbsenceStatuses.csv Raumausfallstatus CSV-Schema
SchoolClassAbsenceReasons.csv Klassenabwesenheitsgründe CSV-Schema
SchoolClassCategories.csv Klassenkategorien CSV-Schema
SchoolClassLevels.csv Klassenstufen CSV-Schema
SchoolClassProfiles.csv Klassenprofile CSV-Schema
SchoolClassTypes.csv Klassenarten CSV-Schema
SchoolOrganisations.csv Schulorganisationen CSV-Schema
SchoolProfiles.csv Schulprofile CSV-Schema
SchoolTypes.csv Schularten CSV-Schema
SubjectFocuses.csv Fachschwerpunkte CSV-Schema
SubjectCategories.csv Fachkategorien CSV-Schema
SubjectGroups.csv Fachgruppen CSV-Schema
SubjectTypes.csv Facharten CSV-Schema
TeacherAbsenceReasons.csv Lehrerabwesenheitsgründen CSV-Schema

Schuldaten

Dateiname Inhalt Spezifikation
Announcements.csv Mitteilungen CSV-Schema
Courses.csv Kurse CSV-Schema
Departments.csv Abteilungen CSV-Schema
LessonGaps.csv Fehlstellen CSV-Schema
RoomAbsences.csv Raumausfälle CSV-Schema
Rooms.csv Räume CSV-Schema
ScheduledLessons.csv Verplanter Unterricht CSV-Schema
SchoolClassAbsences.csv Klassenabwesenheiten CSV-Schema
SchoolClasses.csv Klassen CSV-Schema
StudentCourseAttendances.csv Schüler-Kursteilnahmen CSV-Schema
StudentForeignLangusges.csv Schüler-Fremdsprachenfolge CSV-Schema
StudentSchoolClassAttendances.csv Schüler-Klassenteilnahmen CSV-Schema
StudentSubjects.csv Schüler-Fachdaten CSV-Schema
Students.csv Schüler CSV-Schema
Subjects.csv Fächer CSV-Schema
SubstituteLessons.csv Vertretungsunterricht CSV-Schema
TeacherAbsences.csv Lehrer-Abwesenheiten CSV-Schema
TeacherCourseAttendances.csv Lehrer-Kursteilnahmen CSV-Schema
Teachers.csv Lehrer CSV-Schema
TimeFrames.csv Zeitrahmen CSV-Schema
Vacations.csv Ferien CSV-Schema

Konzepte

CSV-Schema

ECF ist mit Hilfe von CSV Table Schema formal spezifiziert.

Vorteile:

  • ECF-Dateien sind sauber dokumentiert. Die Dokumentation ist standardisiert und versionierbar.
  • ECF-Dateien können validiert werden.

JSON-Schema als Unterschema

CSV ist ein relationales Format, das Daten 2-dimensional abbildet: Jede Zeile in einer CSV-Datei ist ein Datensatz und jede Spalte repräsentiert ein Feld in diesen Datensätzen. Komplexere Strukturen werden standardmäßig durch zusätzliche CSV-Dateien modelliert, die untereinander eine Relationsbeziehung aufbauen. Das ist aber nicht immer gewünscht. In diesem Fall muss man den Inhalt einzelne CSV-Felder komplexer modellieren.

Das ECF-Format nutzt dafür JSON als eingebettetes Format, d.h. die Inhalte einzelner Felder sind entweder als JSON-Array oder als JSON-Objekt gespeichert.

Ein Beispiel:

Id;Code;Name;DepartmentIdList
216C0B8C-E6BB-4C9A-9463-47531650238A;DE;Deutsch;"[""CA96D550-DA95-4DE4-8CE7-57BB8AE5ADED"",""DDDFA6BF-BDE4-45B9-B4DF-37410CE6619F""]"

Das Feld DepartmentIdList ist hier als JSON-Array mit zwei Id-Einträgen formatiert.

CSV Table Schema unterstützt JSON-Schema als Unterschema, so dass einer vollständigen Validierung von ECF nichts im Wege steht.

Kann ich mithelfen?

Ja, sehr gerne. Der beste Weg mitzuhelfen ist es, Rückmeldung per Issue-Tracker zu geben und/oder eigene Pull-Requests zu generieren. Oder schreibe uns einfach eine E-Mail unter enbrea@stueber.de.

Code of conduct (Verhaltensregeln)

In diesem Projekt wurde der STÜBER SYSTEMS Code of conduct übernommen.

About

ENBREA CSV Format (ECF) documentation

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks