Du kan konfigurera dina Instructure OneRoster-integrationsalternativ på varje klientanslutningsnivå.
Under din alfatestfas för integrationen kommer Instructure att samarbeta med dig för att fastställa rekommenderade standardkonfigurationsinställningar för din institution.
Läs mer omkonfigurationer för schemaläggningstjänsterochBästa praxis för integration av schemaläggning.
Notera:Instructure är en OneRoster-konsument. För definitioner av OneRoster-konsumenter och leverantörer, seIntroduktion till OneRoster.
Samtidighet
Samtidighet är antalet slutpunkter som ska trådas samtidigt. Med en samtidighet på tre kan du konfigurera upp till tre separata samtidiga slutpunkter. Du kan till exempel användagetTerms,getTeachers,getClassesslutpunkter samtidigt.
Läs mer om konfigurationskolspecifika slutpunkter för schemaläggningför att möjliggöra samtidig synkronisering av registreringsdata.
Notera:Instructure tillämpar inte samtidighet på paginering. Som ett resultat är datainläsningen lika långsam som den långsammaste svarstiden för slutpunkten i kombination med pagineringen på en enda tråd.
Felhantering
Felhantering avser konfigurationen av visade felkoder.
Följ OneRosterspecifikationer för felhanteringDessutom rekommenderas det att du inkluderar ditt SIS-namn i början avimsx_beskrivningDetta gör att integrationen automatiskt kan visa instruktionsbeskrivningar av fel för slutanvändare.
Uteslutna slutpunkter
Undantagna slutpunkter är slutpunkter som inte ingår i ett API-anrop.
Om två slutpunkter returnerar identiska datamängder, exkludera en datamängd för att minska antalet API-anrop. Till exempel,hämta alla akademiska sessionerochhämtaAllaTermerkan tillhandahålla identiska datamängder, så inkludera endast en i din slutpunktskonfiguration.
Under din alfatestperiod för integrationen, vänligen meddela Instructure om eventuella undantagna slutpunkter.
Läs mer om OneRosterslutpunktskonfigurationer.
Filtrera frågor
Filtrera data som ingår i en datasynkronisering med hjälp av filterfrågor. Du kan konfigurera filterfrågor per jobb, vilket möjliggör både masssynkronisering och stegvisa datasynkroniseringar.
Under din alfatestperiod för integrationen, vänligen meddela Instructure om dina konfigurerade filterfrågor för OneRoster.
Läs mer om OneRosterfilterfrågorLäs dessutom mer omkrav för implementering av stegvis synkronisering.
Paginering
Eftersom API-anrop till ett SIS kan begära stora mängder data, ger paginering ordning till dina API-frågeresultat. För att minska HTTP-trafik och förbättra synkroniseringstiderna rekommenderas att du konfigurerar paginering för att stödja upp till 1000 poster åt gången.
Läs mer om OneRosterkrav på paginering.
Obs:Även om det inte rekommenderas, kan Instructure stödja implementeringar där all begärd data inkluderas i ett enda API-anrop om antalet timeouts inte blir för högt.
Återförsök
Återförsök är antalet gånger integrationen försöker ett API-anrop. Instructure OneRoster-integrationen försöker ett API-anrop upp till tre gånger innan den får ett fel. En fördröjningsperiod uppstår mellan varje försök, och en fördröjningsmultiplikator ökar fördröjningsperioden mellan återförsöken.
Med exempelkonfigurationen nedan kommer ett API-anrop att försöka upp till tre gånger, vänta 5 sekunder efter det första felet och sedan vänta 15 sekunder på det andra felet i rad. Om anropet misslyckas en tredje gång misslyckas integrationsjobbet.
Exempel på återförsökskonfiguration | Tolkning |
|---|
"standardförsök": 2
| 3 försök |
"standardfördröjning": 5000
| 5 sekunder |
"standardfördröjningsmultiplikator": 3
| 15 sekunder |
Timeouts
Timeouts uppstår när en API-förfrågan till webbservern tar för lång tid jämfört med webbplatsens serverväntetid. Om det behövs kan du öka din webbplats serverväntetid (t.ex. 2+ minuter). Du bör dock, där det är möjligt, justera din integration för att göra den mer responsiv (t.ex. mindre än tjugo sekunder).