Sie können Ihre Instructure OneRoster-Integrationsoptionen auf jeder Client-Verbindungsebene konfigurieren.
Während Ihrer Integrations-Alpha-Testphase wird Instructure mit Ihnen zusammenarbeiten, um empfohlene Standardkonfigurationseinstellungen für Ihre Institution festzulegen.
Erfahren Sie mehr überDienstplanungs-Servicekonfigurationen Und Best Practices für die Integration der DienstplanungDie
Notiz:Instructure ist ein OneRoster-Nutzer. Definitionen von OneRoster-Nutzern und -Anbietern finden Sie hier:Einführung in OneRosterDie
Gleichzeitigkeit
Die Parallelität gibt die Anzahl der gleichzeitig zu verarbeitenden Endpunkte an. Bei einer Parallelität von drei können Sie bis zu drei separate, parallele Endpunkte konfigurieren. Beispielsweise könnten Sie Folgendes verwenden:Begriffe abrufen,getTeachers,getClassesgleichzeitige Endpunkte.
Erfahren Sie mehr über die KonfigurationSchulspezifische Endpunkte für die Teilnehmerlisteum die gleichzeitige Synchronisierung von Anmeldedaten zu ermöglichen.
Notiz:Instructure wendet keine Parallelverarbeitung auf die Paginierung an. Daher ist das Laden der Daten so langsam wie die langsamste Antwortzeit eines Endpunkts in Kombination mit der Paginierung auf einem einzelnen Thread.
Fehlerbehandlung
Die Fehlerbehandlung bezieht sich auf die Konfiguration der angezeigten Fehlercodes.
Folge dem OneRosterSpezifikationen zur FehlerbehandlungZusätzlich wird empfohlen, Ihren SIS-Namen am Anfang des Dokuments anzugeben.imsx_descriptionDadurch kann die Integration automatisch aufschlussreiche Fehlerbeschreibungen für Endbenutzer anzeigen.
Ausgeschlossene Endpunkte
Ausgeschlossene Endpunkte sind die Endpunkte, die nicht in einem API-Aufruf enthalten sind.
Wenn zwei Endpunkte identische Datensätze zurückgeben, sollte einer der Datensätze ausgeschlossen werden, um die Anzahl der API-Aufrufe zu reduzieren. Zum Beispiel:getAllAcademicSessions Und getAllTermsEs können identische Datensätze bereitgestellt werden, daher sollte nur einer in die Endpunktkonfiguration aufgenommen werden.
Bitte benachrichtigen Sie Instructure während Ihrer Alpha-Testphase der Integration über alle ausgeschlossenen Endpunkte.
Erfahren Sie mehr über OneRosterEndpunktkonfigurationenDie
Filterabfragen
Filtern Sie die in einer Datensynchronisierung enthaltenen Daten mithilfe von Filterabfragen. Sie können Filterabfragen pro Auftrag konfigurieren und so sowohl Massen- als auch inkrementelle Datensynchronisierungen ermöglichen.
Bitte teilen Sie Instructure während Ihrer Alpha-Testphase der Integration Ihre konfigurierten Filterabfragen für OneRoster mit.
Erfahren Sie mehr über OneRosterFilterabfragenErfahren Sie außerdem mehr überAnforderungen an die Implementierung der inkrementellen SynchronisierungDie
Seitennummerierung
Da API-Aufrufe an ein SIS große Datenmengen anfordern können, sorgt die Paginierung für eine übersichtliche Darstellung der API-Abfrageergebnisse. Um den HTTP-Traffic zu reduzieren und die Synchronisierung zu verbessern, wird empfohlen, die Paginierung so zu konfigurieren, dass maximal 1000 Datensätze gleichzeitig verarbeitet werden können.
Erfahren Sie mehr über OneRosterSeitenzahlenanforderungenDie
Notiz: Instructure kann zwar Implementierungen unterstützen, bei denen alle angeforderten Daten in einem einzigen API-Aufruf enthalten sind, dies wird jedoch nicht empfohlen, sofern die Anzahl der Timeouts nicht übermäßig hoch wird.
Wiederholungsversuche
Die Anzahl der Wiederholungsversuche gibt an, wie oft die Integration einen API-Aufruf versucht. Die Instructure OneRoster-Integration unternimmt bis zu drei API-Aufrufe, bevor ein Fehler auftritt. Zwischen den einzelnen Versuchen tritt eine Verzögerungszeit auf, die durch einen Verzögerungsmultiplikator erhöht wird.
Mit der unten stehenden Beispielkonfiguration wird ein API-Aufruf bis zu dreimal versucht. Nach dem ersten Fehler wird 5 Sekunden gewartet, anschließend 15 Sekunden auf den zweiten Fehler. Schlägt der Aufruf ein drittes Mal fehl, schlägt der Integrationsauftrag fehl.
Beispielkonfiguration für Wiederholungsversuche | Interpretation |
|---|
„defaultRetries“: 2
| 3 Versuche |
„Standardverzögerung“: 5000
| 5 Sekunden |
„defaultDelayMultiplier“: 3
| 15 Sekunden |
Auszeiten
Timeouts treten auf, wenn eine API-Anfrage an den Webserver im Vergleich zur Serverwartezeit der Website zu lange dauert. Bei Bedarf können Sie die Serverwartezeit Ihrer Website erhöhen (z. B. auf mehr als zwei Minuten). Wo immer möglich, sollten Sie jedoch Ihre Integration optimieren, um eine schnellere Antwortzeit zu erreichen (z. B. unter zwanzig Sekunden).