U kunt uw Instructure OneRoster-integratieopties configureren op het niveau van elke clientverbinding.
Tijdens de alpha-testfase van uw integratie zal Instructure met u samenwerken om aanbevolen standaardconfiguratie-instellingen voor uw instelling vast te stellen.
Leer meer overroosterconfiguraties En beste praktijken voor het integreren van roosters.
Opmerking:Instructure is een OneRoster-consument. Voor definities van OneRoster-consumenten en -providers, zie deIntroductie tot OneRoster.
Gelijktijdigheid
Concurrency is het aantal eindpunten dat tegelijkertijd verwerkt kan worden. Met een concurrency van drie kunt u maximaal drie afzonderlijke, gelijktijdige eindpunten configureren. U kunt bijvoorbeeld gebruikmaken van de volgende configuratie:getTerms,getTeachers,getClasseseindpunten gelijktijdig.
Leer meer over het configurerenschoolspecifieke eindpunten voor het samenstellen van leerlingenlijstenom gelijktijdige synchronisatie van inschrijvingsgegevens mogelijk te maken.
Opmerking:Instructure past geen gelijktijdigheid toe op paginering. Hierdoor is het laden van de gegevens net zo traag als de traagste responstijd van het eindpunt in combinatie met de paginering op één enkele thread.
Foutafhandeling
Foutafhandeling heeft betrekking op de configuratie van de weergegeven foutcodes.
Volg OneRosterspecificaties voor foutafhandelingDaarnaast wordt aangeraden om uw SIS-naam aan het begin van deimsx_descriptionHierdoor kan de integratie automatisch informatieve foutmeldingen weergeven aan eindgebruikers.
Uitgesloten eindpunten
Uitgesloten eindpunten zijn de eindpunten die niet in een API-aanroep zijn opgenomen.
Als twee eindpunten identieke datasets retourneren, sluit dan één dataset uit om het aantal API-aanroepen te verminderen. Bijvoorbeeld:getAllAcademicSessions En getAllTermsZe kunnen identieke datasets leveren, dus neem er slechts één op in uw eindpuntconfiguratie.
Tijdens de alpha-testfase van uw integratie dient u Instructure op de hoogte te stellen van alle uitgesloten eindpunten.
Leer meer over OneRostereindpuntconfiguraties.
Filterquery's
Filter de gegevens die in een gegevenssynchronisatie zijn opgenomen met behulp van filterquery's. U kunt filterquery's per taak configureren, waardoor zowel bulk- als incrementele gegevenssynchronisaties mogelijk zijn.
Tijdens de alpha-testfase van uw integratie dient u Instructure op de hoogte te stellen van de filterquery's die u voor OneRoster hebt geconfigureerd.
Leer meer over OneRosterfilterquery'sDaarnaast kunt u meer te weten komen overVereisten voor de implementatie van incrementele synchronisatie.
Paginering
Omdat API-aanroepen naar een SIS grote hoeveelheden gegevens kunnen opvragen, voegt paginering orde toe aan uw API-queryresultaten. Om het HTTP-verkeer te verminderen en de synchronisatietijd te verbeteren, wordt aanbevolen om paginering zo te configureren dat er maximaal 1000 records tegelijk worden verwerkt.
Leer meer over OneRoster.pagineringsvereisten.
Opmerking: Hoewel niet aanbevolen, kan Instructure implementaties ondersteunen waarbij alle gevraagde gegevens in één API-aanroep worden opgenomen, mits het aantal time-outs niet te hoog oploopt.
Opnieuw proberen
Het aantal herhalingen is het aantal keren dat de integratie een API-aanroep probeert uit te voeren. De Instructure OneRoster-integratie probeert een API-aanroep maximaal drie keer voordat er een fout optreedt. Tussen elke poging is er een vertragingsperiode, en een vertragingsvermenigvuldiger verlengt de vertragingsperiode tussen herhalingen.
Met de onderstaande voorbeeldconfiguratie wordt een API-aanroep maximaal drie keer geprobeerd. Na de eerste fout wordt 5 seconden gewacht, en na de tweede fout 15 seconden. Als de aanroep een derde keer mislukt, mislukt de integratietaak.
Voorbeeld van een configuratie voor opnieuw proberen | Interpretatie |
|---|
“standaardRetries”: 2
| 3 pogingen |
“standaardvertraging”: 5000
| 5 seconden |
“standaardvertragingvermenigvuldiger”: 3
| 15 seconden |
Time-outs
Time-outs treden op wanneer een API-verzoek aan de webserver te lang duurt in vergelijking met de wachttijd van de website-server. Indien nodig kunt u de wachttijd van uw website-server verhogen (bijvoorbeeld naar 2 minuten of langer). Waar mogelijk dient u uw integratie echter zo aan te passen dat deze sneller reageert (bijvoorbeeld binnen twintig seconden).