WebUntis#

Mit dem Paket IServ WebUntis-Connector haben Sie zum einen die Möglichkeit sich auf der Webseite von WebUntis mit Ihren IServ-Anmeldedaten anzumelden. Zum Anderen können die Daten der Schüler zwischen IServ und WebUntis synchronisiert werden.

Das Modul setzt dabei auch das Paket IServ 3: OAuth- und Open-ID-Connect-Server voraus. Sofern dieses nicht installiert ist, wird es automatisch zusätzlich installiert.

Einrichtung#

Nach der Installation müssen IServ und WebUntis erst konfiguriert werden, damit Sie das Modul nutzen können.

In IServ#

Konfiguration#

Warnung

Dieser Schritt ist für die Nutzung des Moduls zwingend notwendig!

Zuerst muss unter Verwaltung → System → Konfiguration folgende Information eingetragen werden:

Modul: WebUntis#
  • Url zu WebUntis: Hier muss die URL mit der Sie zur Anmeldeseite Ihres WebUntis kommen, eingetragen werden.

    Diese muss folgendes Format haben:

    https://<SERVERNAME>.webuntis.com/WebUntis/?school=<SCHUL-ID>

    <SERVERNAME> und <SCHUL-ID> müssen durch Ihre Werte ohne die Klammern ersetzt werden!

    Ein möglicher Link sieht dann beispielsweise so aus:

    https://zeus.webuntis.com/WebUntis/?school=AnneFrankGesamtschule

../../../_images/login_webuntis.png

Hinweis

Für die Angabe der weiteren Konfigurationsparameter muss in WebUntis die IServ Plattform-Applikation eingerichtet sein. Siehe Aktivierung in WebUntis.

  • WebUntis Tenant ID: Hier muss die Tenant ID aus WebUntis eingetragen werden.

    Die Tenant ID finden Sie in WebUntis unter Administration → Plattform → IServ. Im Abschnitt Zugangsdaten muss der Wert aus dem Feld Tenant ID übernommen werden.

  • WebUntis OIDC Client ID: Hier muss die Client ID Ihres WebUntis eingetragen werden.

    Die Client ID finden Sie in WebUntis unter Administration → Plattform → IServ. Im Abschnitt Zugangsdaten muss der Wert aus dem Feld OIDC Client ID übernommen werden.

../../../_images/config_clientId.png
  • Passwort für die WebUntis-Plattform: Hier muss das Passwort Ihres WebUntis eingetragen werden.

    Das Passwort finden Sie in WebUntis unter Administration → Plattform → IServ. Dort müssen sie auf Passwort zurücksetzen klicken um ein neues Passwort zu erzeugen. Nach Bestätigung der Sicherheitsabfrage wird das neue Passwort angezeigt und muss kopiert werden.

../../../_images/config_password.png

Im Anschluss müssen Sie mit der Schaltfläche Änderungen übernehmen die Änderungen speichern. Sollten hierbei Fehler auftreten, vergewissern Sie sich, dass die korrekte WebUntis URL eingetragen ist.

Hinweis

Sollten Sie die Plattform-Applikation in WebUntis schon zu einem früheren Zeitpunkt aktiviert haben und Ihnen keine Zugangsdaten angezeigt werden, löschen Sie bitte die Plattform-Applikation und fügen Sie diese neu hinzu. Siehe Aktivierung in WebUntis.

Single-Sign-On#

Damit die Anmeldung mit den IServ-Anmeldedaten funktioniert, muss außerdem ein Single-Sign-On-Client konfiguriert werden. Die Einstellungen finden Sie unter Verwaltung → System → Single-Sign-On → WebUntis.

Hinweis

Die wichtigsten Einstellungen wurden bereits automatisch nach dem Speichern der Konfiguration für Sie vorgenommen. Weitere Informationen zu den Single-Sign-On-Clients erhalten Sie hier: Single-Sign-On.

Allgemein#

  • Vertrauenswürdig: Mit der Einstellung legen Sie fest, ob Nutzerinnen und Nutzer vor dem Login bei WebUntis ihre Anmeldung manuell legitimieren müssen.

  • Client-ID: Die Client-Id benötigen Sie später bei der Einrichtung in WebUntis.

  • Client-Geheimnis: Das Client-Geheimnis benötigen Sie später bei der Einrichtung in WebUntis.

../../../_images/general.png
Rechte#

Hier steuern Sie, welche IServ-Rollen oder IServ-Gruppen sich mit IServ in WebUntis anmelden dürfen. Wenn Sie keine Gruppen oder Rollen angeben, können sich alle Nutzerinnen und Nutzer bei WebUntis anmelden.

../../../_images/privilege.png
Beschränkungen#

Der Scope Webuntis wird hinzugefügt. Bei der Autorisierung werden folgende Informationen übertragen:

  • Rolle des Benutzers

  • Benutzername des Benutzers

  • Schulidentifikator

In WebUntis#

Aktivierung in WebUntis#

Damit IServ als Menüpunkt in WebUntis angezeigt wird und die Schülerdatensynchronisation zwischen beiden Systemen funktioneirt, muss IServ als Plattform-Applikation in WebUntis aktiviert werden. Eine Anleitung dazu ist zu finden unter https://help.untis.at/hc/de/articles/4403307948434

Als Nächstes müssen die Daten aus dem in IServ angelegten Single-Sign-On-Client in WebUntis unter Administration → Integration → OpenID Connect eingetragen und gespeichert werden. Siehe Single-Sign-On – Allgemein

Konfiguration des Single-Sign-On-Client#

Schauen Sie in der WebUntis Dokumentation nach, um die aktuellsten Informationen zur Konfiguration zu erhalten. Folgen Sie der Beschreibung im Abschnitt „Aktivierung in WebUntis“ um die Konfiguration in WebUntis fortzuführen.

Nutzerzuordnung#

Damit Sie sich problemlos mit Ihrem IServ-Account bei WebUntis anmelden können, müssen die Benutzer beider Systeme einander zugeordnet werden. Hierfür gibt es mehrere Möglichkeiten.

Automatische Zuordnung#

Dies ist die sicherste und empfohlene Variante.

Hierbei wird vorausgesetzt, dass Ihre Nutzerdaten aus der gleichen Schulverwaltungssoftware stammen.

Die Lehrkräfte können beispielsweise aus der Desktopversion von Untis importiert werden. Diese werden durch Ihr Kürzel, welches beim Import in IServ unter Klasse/Zusätzliche Informationen angegeben wird, zugeordnet.

Die Daten Ihrer Schülerinnen und Schüler beziehen Sie aus dem System Ihres Landes. Diese werden durch die Import-ID eindeutig zugeordnet.

Hinweis

Falls diese Daten nicht vorhanden sein sollten, wird alternativ versucht über die Nutzernamen zuzuordnen.

Weitere Informationen zum Import in IServ erhalten Sie hier: Import.

Manuelle Zuordnung#

Für Schüler#

Hierbei müssen Sie die Import-Id oder den IServ-Nutzernamen (in der Regel vorname.nachname) in der Nutzerverwaltung von WebUntis eintragen. Dafür wählen Sie einfach die entsprechende Schülerin, oder den entsprechenden Schüler aus und tragen den Nutzernamen als Fremdbenutzername ein.

Für Lehrer#

Hierbei müssen Sie das Lehrerkürzel oder den IServ-Nutzernamen (in der Regel vorname.nachname) in der Nutzerverwaltung von WebUntis eintragen. Dafür wählen Sie einfach die entsprechende Nutzerin, oder den entsprechenden Nutzer aus und tragen den Nutzernamen als Fremdbenutzername ein.

Hinweis

Wenn Sie in den OpenID Connect-Einstellungen in WebUntis die Option Unbekannten Benutzer nach erfolgreicher Anmeldung anlegen aktiviert haben, werden neue Benutzer beim Anmelden über IServ automatisch in WebUntis angelegt.

Schülerdatensynchronisation#

Warnung

Sollten Sie das Single-Sign-On bereits vor der Schülerdatensynchronisation genutzt haben, könnten Benutzer ohne zugehörige Person (Schüler*innen) angelegt worden sein. Um eine vollständige Synchronisation durchführen zu können, müssen Sie diese Benutzer zunächst in WebUntis löschen. Hierfür gehen Sie in WebUntis in die Administration auf „Benutzer“, wählen Benutzergruppe „Schüler:innen“ aus und löschen diejenigen Einträge, deren Benutzername der Import-Id aus IServ entspricht. Diese Einträge weisen in der Regel auch keinen Eintrag in der Spalte „Person“ auf und können entsprechend in der Liste sortiert werden.

Die Daten aller Schüler können zwischen den beiden Systemen synchronisiert werden. Dabei ist IServ das führende System und überschreibt die Schülerdaten in WebUntis. Die Synchronisation kann unter Verwaltung → Benutzer → Webuntis gestartet werden.

Vorschau der Synchronisation#

Im ersten Schritt wird eine Vorschau der Synchronisation erstellt. Dazu kann das Startdatum der Klassenzugehörigkeit, die in WebUntis gesetzt werden soll, angegeben werden. Das Datum gibt an, ab welchem Zeitpunkt die Klassenzugehörigkeit in WebUntis erfolgen soll. Bis zu diesem Datum gilt die bisherige Zuordnung der Klasse.

Hinweis

Die Eingabe des Startdatums ist erforderlich, damit die Klassenzugehörigkeit nach WebUntis synchronisiert werden kann. Wird kein Datum gesetzt, werden die Schüler(innen) ohne Klassenzugehörigkeit synchronisiert.

Hinweis

Um eine erfolgreiche Synchronisation zu gewährleisten muss sichergestellt sein, dass in WebUntis alle Klassen so angelegt sind, wie sie auch in IServ vorhanden sind. Sollte eine Klasse in WebUntis nicht vorhanden sein, kommt es zu Fehlern in der Synchronisation.

../../../_images/synchronization_start.png

Optional können Gruppen- oder Benutzer-Filter angegeben werden. Dabei werden nur die Schüler berücksichtigt, die den entsprechenden Gruppen zugeordnet sind, oder als Benutzer ausgewählt wurden. Wenn Gruppen oder einzelne Benutzer angegeben wurden, findet keine Vollsynchronisation statt und es werden auch keine Deaktivierungen an WebUntis übermittelt.

Hinweis

Die Filter „Gruppen“ oder „Benutzer“ können nicht kombiniert werden.

Anschließend kann in einem Probelauf die Vorschau der Synchronisation gestartet werden. Dabei werden alle Schülerdaten von WebUntis abgerufen und mit den Schülerdaten in IServ verglichen.

Hinweis

Es werden nur IServ-Benutzer mit der Rolle Schüler berücksichtigt.

Das Ergebnis des Abgleichs wird auf der Vorschauseite als Tabelle dargestellt.

../../../_images/synchronization_preview.png

Es sind drei Tabs zu sehen, die alle Schüler enthalten, die in WebUntis erstellt, aktualisiert oder deaktiviert werden. Im Tab-Titel wird die jeweilige Anzahl der zugeordneten Schüler dargestellt. Mit einem Klick auf den Tab-Titel kann die Ansicht zur jeweiligen Tabelle gewechselt werden. Für jeden Schüler werden Vorname, Nachname und die Klassenzuordnung (falls ein Startdatum angegeben wurde) angezeigt.

Synchronisation durchführen#

Nach der Vorschau kann die eigentliche Synchronisation durch einen Klick auf Starte Synchronisation gestartet werden. Dabei wird ein erneuter Abgleich der Schülerdaten und anschließend die Übertragung an WebUntis durchgeführt.

Hinweis

Je nach Anzahl der Benutzer kann die Synchronisierung einige Minuten dauern.

Nach Abschluss der Synchronisation wird das entsprechende Ergebnis angezeigt. Die Schüler die erstellt, aktualisiert, oder deaktiviert wurden, werden tabellarisch in drei Tabs, analog zur Vorschau-Ansicht dargestellt.

../../../_images/synchronization_result.png

Sollten während der Synchronisation Fehler auftreten, werden diese zusätzlich auf der Ergebnisseite angezeigt.

Weitere Informationen zum Import in IServ erhalten Sie hier: Import.

Messengerintegration in WebUntis#

Im Rahmen der Kooperation zwischen IServ und Untis, bietet Untis seinen Kunden die Möglichkeit, den Untis Messenger powered by IServ zur Kommunikation zu verwenden. Dafür müssen Nutzerdaten von WebUntis zur IServ-Instanz synchronisiert werden. Zur Einrichtung der Plattform „IServ Messenger“ in Ihrer WebUntis-Instanz benötigen Sie eine Server-URL. Diese bekommen Sie von unserem Support mitgeteilt, zusammen mit weiteren Einrichtungsschritten.

Die automatische Synchronisation der Nutzerdaten von WebUntis wird täglich ausgeführt. In besonderen Fällen kann diese auch von Supportmitarbeitern händisch angestoßen werden.

Während des Synchronisationsprozesses werden folgende Daten Synchronisiert: * WebUntis Benutzer-ID * Vorname * Nachname * Rolle (Schüler:in oder Lehrer:in) * Zugewiesene Klassen

Für die zugewiesenen Klassen werden aufseiten des IServ jeweils Gruppen erstellt. Diese Gruppen sind für die entstehenden Messengerräume notwendig. Die jeweiligen Gruppenbesitzer werden automatisch Besitzer der Messengerräume. Hierfür wird die alphabetisch erste Person, die als Lehrkraft in WebUntis hinterlegt ist, verwendet. Das Synchronisieren mehrerer Besitzer von Messengerräumen ist aufgrund technischer Einschränkungen noch nicht möglich. Nach erfolgreichem Import werden die Messengerräume automatisch erstellt.

Aufgrund des speziellen Einsatzes des IServ-Servers, sind die Konfigurationsoptionen stark eingeschränkt. Um die automatische Synchronisation von WebUntis nach IServ zu ermöglichen, muss die Konfigurationsoption WebUntis automatischer Benutzerimport aktiviert werden. Diese ist, der Sicherheit halber, in der Oberfläche nicht veränderbar und standardmäßig ausgeschaltet. Bei der initialen Einrichtung des IServ-Servers als Messengerlösung wird diese angeschaltet. Sollten Sie Änderungen an diesem Konfigurationseintrag vornehmen wollen, muss dies über den Support geschehen.

Folgende weiteren Konfigurationsoptionen sind zu setzen:

  • WebUntis OIDC Client ID: Der Benutzer zur Authentifizierung an der WebUntis-API

  • Passwort für die WebUntis-Plattform: Das Passwort zur Authentifizierung an der WebUntis-API

  • Url zu WebUntis: Die URL zur WebUntis-API