Schnittstellen

Mit der Maske „Schnittstellen“ werden Im- und Exportfunktionen zu Anwendungen von Drittanbietern eingerichtet.
Diese Einstellungen sind nur einmalig erforderlich. Der Export selbst erfolgt über die Maske „Sammeländerung“ im Register „Notenverwaltungsexport“.

Maske „Schnittstellen“

Menü „Benutzervorgaben“ > „Schnittstellen“

Die Maske „Schnittstellen“ besteht aus einem Bereich „Schnittstellen“, in dem mehrere Im- und Exportkonfigurationen zu verschiedener Anwendungen von Drittanbietern eingerichtet werden können.

Neue Schnittstelle erstellen

• Nach Betätigen des Schalters „Neue Schnittstelle hinzufügen“ (Plus-Symbol) im Kopf des Bereichs „Schnittstellen“ öffnet sich ein Dialog zur Konfiguration einer neuen Schnittstelle.

• Im Auswahlfeld „Richtung“ kann ausgewählt werden, ob die neue Schnittstelle eine Import- oder eine Exportschnittstelle sein soll.

• Im Auswahlfeld „Typ“ kann zwischen „Notenverwalter“ und „Schulpflichtüberwachung“ ausgewählt werden.

• Das Auswahlfeld „Schnittstelle“ wird durch die beiden vorherigen Auswahlfelder vorgefiltert. Es steht dann nur noch eine Auwahl zur Verfügung.

• Im Freitextfeld „Bezeichnung“ kann ein beliebiger Bezeichner eingetragen werden, der nur zur eigenen Erläuterung der eingerichteten Schnittstelle dient.

• In das Freitextfeld „API-Key“ muss der API-Key der jeweiligen Fremdanwendung (Notenverwalter (beste-schule) oder „Schulpflichtüberwachung (Freie Schulen)“) eingefügt werden.

• In die Datumsfelder „von“ und „bis“ können Datumsangaben eingetragen werden, innerhalb derer die Schnittstelle aktiv ist. Das „bis“-Datum muss dabei stets nach dem „von“-Datum liegen.

• Nach Betätigen des Schalters „Schnittstelle speichern“ wird die Schnittstelle gespeichert und in der Maske angezeigt.

Schnittstelle bearbeiten und löschen

• Jede Zeile der Tabelle steht für eine Schnittstelle.
• Im Suchfeld im Kopf des Bereichs „Schnittstellen“ können durch Eingabe von Suchbegriffen die eingerichteten Schnittstellen gefiltert werden. Es werden alle Felder der angezeigten Tabelle in die Suche einbezogen.

• Durch Anwahl des Schalters „Zeile löschen“ (Papierkorb-Symbol) am Anfang einer jeden Zeile, kann die Schnittstelle gelöscht werden.

• In der Spalte „Aktiv“ kann durch Betätigen des Schalter (Schlosssymbol) die Schnittstelle aktiviert bzw. deaktiviert werden.

• In der Spalte „Richtung“ wird angezeigt, ob es sich um eine Import- oder Exportschnittstelle handelt. Die Richtung ist nachträglich nicht veränderbar.

• In der Spalte „Typ“ wird angezeigt, ob es sich um eine Schnittstelle des Typs „Notenverwalter“ oder „Schulpflichtüberwachung“ handelt. Der Typ ist nachträglich nicht veränderbar.

• In der Spalte „Bezeichnung“ ist ein Bezeichner eingetragen, der nur zur eigenen Erläuterung der eingerichteten Schnittstelle dient. Dieser kann beliebig verändert werden.

• In der Spalte „Letzter Zugriff“ wird ein Zeitstempel der letzten Nutzung jeder Schnittstelle angezeigt. Ein grüner Haken oder ein rotes Kreut geben ferner darüber Auskunft, ob der letzte Im- bzw. Export erfolgreich war.

• In der Spalte „API-Key“ wird der definierte API-Key (aus Gründen der Sicherheit durch acht Sterne symbolisiert) angezeigt. Dieser kann auch durch einen neuen API-Key ersetzt werden.

• In den Spalten „von“ und „bis“ wird die Gültigkeit der eingerichteten Schnittstelle definiert.

API-Key erzeugen für „Notenverwalter (beste-schule)“

Zum Erzeugen eines API-Keys benötigt der Nutzende einen „Schul-Administrator“-Account von beste.schule.

• Nach der Anmeldung bei beste.schule wird durch Anwahl des Accounts ein Auswahlmenü geöffnet. Nach Auswahl von „Benutzerkonto“ wird die entsprechende Maske geöffnet.

• Im linken Menü kann nun durch Auswahl des Menüeintrags „API“ die gleichnamige Maske geöffnet werden.

• Im unteren Bereich „Personal Access Tokens“ kann durch Anwahl des Links „Neuen Token erstellen“ der Dialog „Token erstellen“ geöffnet werden.

• Im Dialog „Token erstellen“ kann im Freitextfeld „Name“ ein beliebiger Bezeichner eingetragen werden.

• Nach Betätigen des Schalters „Erstellen“ wird der Dialog geschlossen und ein neuer Dialog „Personal Access Token“ geöffnet. Der nun angezeigte „Personal Access Token“ entspricht dem „API-Key“ in SaxSVS und kann dort eingefügt werden. Beim Kopieren ist auf vollständiges Kopieren des Keys zu achten.

Schnittstelle verwenden

Der Export selbst erfolgt über die Maske „Sammeländerung“ im Register „Notenverwaltungsexport“.