Schnittstellen - Versionsgeschichte

LBA am 2026-04-22 um 06:31:47 Uhr

2026-04-22T06:31:47Z

← Nächstältere Version		Version vom 2026-04-22, 08:31:47 Uhr
Zeile 70:		Zeile 70:
	Der Export selbst erfolgt über die Maske „Sammeländerung“ im [[Sammel%C3%A4nderung#Register_%E2%80%9ENotenverwaltungsexport%E2%80%9C\|Register „Notenverwaltungsexport“]].		Der Export selbst erfolgt über die Maske „Sammeländerung“ im [[Sammel%C3%A4nderung#Register_%E2%80%9ENotenverwaltungsexport%E2%80%9C\|Register „Notenverwaltungsexport“]].

	[[Kategorie: Onlineschulmodul]] [[Kategorie: Handbuch]]		[[Kategorie: Onlineschulmodul]] [[Kategorie: Handbuch]] [[Kategorie: Schnittstellen]]

Houska am 2026-03-05 um 06:28:04 Uhr

2026-03-05T06:28:04Z

← Nächstältere Version		Version vom 2026-03-05, 08:28:04 Uhr
Zeile 68:		Zeile 68:
	=Schnittstelle verwenden=		=Schnittstelle verwenden=

	Der Export selbst erfolgt über die Maske „Sammeländerung“ im Register „Notenverwaltungsexport“.		Der Export selbst erfolgt über die Maske „Sammeländerung“ im [[Sammel%C3%A4nderung#Register_%E2%80%9ENotenverwaltungsexport%E2%80%9C\|Register „Notenverwaltungsexport“]].

	[[Kategorie: Onlineschulmodul]] [[Kategorie: Handbuch]]		[[Kategorie: Onlineschulmodul]] [[Kategorie: Handbuch]]

Houska am 2026-03-05 um 06:26:24 Uhr

2026-03-05T06:26:24Z

← Nächstältere Version		Version vom 2026-03-05, 08:26:24 Uhr
Zeile 53:		Zeile 53:
	=API-Key erzeugen für „Notenverwalter (beste-schule)“=		=API-Key erzeugen für „Notenverwalter (beste-schule)“=

	Zum Erzeugen eines API-Keys benötigt der Account von beste.schule ~~entsprechende Berechtigungen~~.		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.		* 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.
Zeile 65:		Zeile 65:
	* 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.		* 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.
	: [[File:s-schnittstellen-besteschule-tokenerstellen-erstellen.png\|rand\|500px]]		: [[File:s-schnittstellen-besteschule-tokenerstellen-erstellen.png\|rand\|500px]]

			=Schnittstelle verwenden=

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

	[[Kategorie: Onlineschulmodul]] [[Kategorie: Handbuch]]		[[Kategorie: Onlineschulmodul]] [[Kategorie: Handbuch]]

LBA am 2026-03-05 um 06:23:08 Uhr

2026-03-05T06:23:08Z

← Nächstältere Version		Version vom 2026-03-05, 08:23:08 Uhr
Zeile 1:		Zeile 1:
	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 [[Sammel%C3%A4nderung#Register_%E2%80%9ENotenverwaltungsexport%E2%80%9C\|Register „Notenverwaltungsexport“]].		Mit der Maske „Schnittstellen“ werden Im- und Exportfunktionen zu Anwendungen von Drittanbietern eingerichtet. <br>
			Diese Einstellungen sind nur einmalig erforderlich. Der Export selbst erfolgt über die Maske „Sammeländerung“ im [[Sammel%C3%A4nderung#Register_%E2%80%9ENotenverwaltungsexport%E2%80%9C\|Register „Notenverwaltungsexport“]].

	=Maske „Schnittstellen“=		=Maske „Schnittstellen“=

Houska am 2026-03-04 um 06:53:36 Uhr

2026-03-04T06:53:36Z

← Nächstältere Version		Version vom 2026-03-04, 08:53:36 Uhr
Zeile 1:		Zeile 1:
	Mit der Maske „Schnittstellen“ werden Im- und Exportfunktionen zu Anwendungen von Drittanbietern eingerichtet. Diese Einstellungen sind nur einmalig erforderlich.		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 [[Sammel%C3%A4nderung#Register_%E2%80%9ENotenverwaltungsexport%E2%80%9C\|Register „Notenverwaltungsexport“]].

	=Maske „Schnittstellen“=		=Maske „Schnittstellen“=

Houska: Die Seite wurde neu angelegt: „Mit der Maske „Schnittstellen“ werden Im- und Exportfunktionen zu Anwendungen von Drittanbietern eingerichtet. Diese Einstellungen sind nur einmalig erforderlich. =Maske „Schnittstellen“= Menü „Benutzervorgaben“ > „Schnittstellen“ 1000px Die Maske „Schnittstellen“ besteht aus einem Bereich „Schnittstellen“, in dem mehrere Im- und Exportkonfigurationen zu verschiedener Anwendungen von Drittanb…“

2026-02-12T09:18:25Z

Die Seite wurde neu angelegt: „Mit der Maske „Schnittstellen“ werden Im- und Exportfunktionen zu Anwendungen von Drittanbietern eingerichtet. Diese Einstellungen sind nur einmalig erforderlich. =Maske „Schnittstellen“= Menü „Benutzervorgaben“ > „Schnittstellen“ rand|1000px Die Maske „Schnittstellen“ besteht aus einem Bereich „Schnittstellen“, in dem mehrere Im- und Exportkonfigurationen zu verschiedener Anwendungen von Drittanb…“

Neue Seite

Mit der Maske „Schnittstellen“ werden Im- und Exportfunktionen zu Anwendungen von Drittanbietern eingerichtet. Diese Einstellungen sind nur einmalig erforderlich.

=Maske „Schnittstellen“=

Menü „Benutzervorgaben“ > „Schnittstellen“

[[File:s-schnittstellen.png|rand|1000px]]

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.
: [[File:s-schnittstellen-neueschnittstelleerstellen.png|rand|500px]]
* Im Auswahlfeld „Richtung“ kann ausgewählt werden, ob die neue Schnittstelle eine Import- oder eine Exportschnittstelle sein soll.
: [[File:s-schnittstellen-neueschnittstelleerstellen-richtung.png|rand|500px]]
* Im Auswahlfeld „Typ“ kann zwischen „Notenverwalter“ und „Schulpflichtüberwachung“ ausgewählt werden.
: [[File:s-schnittstellen-neueschnittstelleerstellen-typ.png|rand|500px]]
* Das Auswahlfeld „Schnittstelle“ wird durch die beiden vorherigen Auswahlfelder vorgefiltert. Es steht dann nur noch eine Auwahl zur Verfügung.
: [[File:s-schnittstellen-neueschnittstelleerstellen-schnittstelle.png|rand|500px]]
* Im Freitextfeld „Bezeichnung“ kann ein beliebiger Bezeichner eingetragen werden, der nur zur eigenen Erläuterung der eingerichteten Schnittstelle dient.
: [[File:s-schnittstellen-neueschnittstelleerstellen-bezeichnung.png|rand|500px]]
* In das Freitextfeld „API-Key“ muss der API-Key der jeweiligen Fremdanwendung ([[Schnittstellen#API-Key erzeugen für den „Notenverwalter (beste-schule)“|Notenverwalter (beste-schule)]] oder „Schulpflichtüberwachung (Freie Schulen)“) eingefügt werden.
: [[File:s-schnittstellen-neueschnittstelleerstellen-apikey.png|rand|500px]]
* 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.
: [[File:s-schnittstellen-neueschnittstelleerstellen-vonbis.png|rand|500px]]
* Nach Betätigen des Schalters „Schnittstelle speichern“ wird die Schnittstelle gespeichert und in der Maske angezeigt.
: [[File:s-schnittstellen-neueschnittstelleerstellen-schnittstellespeichern.png|rand|500px]]

=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.
: [[File:s-schnittstellen-suchfeld.png|rand|1000px]]
* Durch Anwahl des Schalters „Zeile löschen“ (Papierkorb-Symbol) am Anfang einer jeden Zeile, kann die Schnittstelle gelöscht werden.
: [[File:s-schnittstellen-schnittstelleloeschen.png|rand|1000px]]
* In der Spalte „Aktiv“ kann durch Betätigen des Schalter (Schlosssymbol) die Schnittstelle aktiviert bzw. deaktiviert werden.
: [[File:s-schnittstellen-aktiv.png|rand|1000px]]
* In der Spalte „Richtung“ wird angezeigt, ob es sich um eine Import- oder Exportschnittstelle handelt. Die Richtung ist nachträglich nicht veränderbar.
: [[File:s-schnittstellen-richtung.png|rand|1000px]]
* 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.
: [[File:s-schnittstellen-typ.png|rand|1000px]]
* In der Spalte „Bezeichnung“ ist ein Bezeichner eingetragen, der nur zur eigenen Erläuterung der eingerichteten Schnittstelle dient. Dieser kann beliebig verändert werden.
: [[File:s-schnittstellen-bezeichnung.png|rand|1000px]]
* 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.
: [[File:s-schnittstellen-letzterzugriff.png|rand|1000px]]
* 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.
: [[File:s-schnittstellen-apikey.png|rand|1000px]]
* In den Spalten „von“ und „bis“ wird die Gültigkeit der eingerichteten Schnittstelle definiert.
: [[File:s-schnittstellen-vonbis.png|rand|1000px]]

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

Zum Erzeugen eines API-Keys benötigt der Account von beste.schule entsprechende Berechtigungen.

* 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.
: [[File:s-schnittstellen-besteschule-benutzerkonto.png|rand|250px]]
* Im linken Menü kann nun durch Auswahl des Menüeintrags „API“ die gleichnamige Maske geöffnet werden.
: [[File:s-schnittstellen-besteschule-api.png|rand|250px]]
* Im unteren Bereich „Personal Access Tokens“ kann durch Anwahl des Links „Neuen Token erstellen“ der Dialog „Token erstellen“ geöffnet werden.
: [[File:s-schnittstellen-besteschule-neuentokenerstellen.png|rand|750px]]
* Im Dialog „Token erstellen“ kann im Freitextfeld „Name“ ein beliebiger Bezeichner eingetragen werden.
: [[File:s-schnittstellen-besteschule-tokenerstellen-name.png|rand|500px]]
* 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.
: [[File:s-schnittstellen-besteschule-tokenerstellen-erstellen.png|rand|500px]]

[[Kategorie: Onlineschulmodul]] [[Kategorie: Handbuch]]