Du kan konfigurere Instructure OneRoster-integrasjonsalternativene dine på hvert klienttilkoblingsnivå.
I løpet av alfatestfasen for integrasjonen vil Instructure samarbeide med deg for å etablere anbefalte standardkonfigurasjonsinnstillinger for institusjonen din.
Lær mer omkonfigurasjoner av vakthavende tjenesterogBeste praksis for integrering av vakter.
Note:Instructure er en OneRoster-forbruker. For definisjoner av OneRoster-forbrukere og -leverandører, seIntroduksjon til OneRoster.
Samtidighet
Samtidighet er antallet endepunkter som skal kobles sammen samtidig. Med en samtidighet på tre, konfigurer opptil tre separate samtidige endepunkter. Du kan for eksempel brukegetTerms,getTeachers,getClassesendepunkter samtidig.
Lær mer om konfigurasjonskolespesifikke endepunkter for vaktplanleggingfor å tillate samtidig synkronisering av registreringsdata.
Note:Instructure bruker ikke samtidighet på paginering. Som et resultat er datainnlastingen like treg som den tregeste endepunktets responstid kombinert med pagineringen på en enkelt tråd.
Feilhåndtering
Feilhåndtering er knyttet til konfigurasjonen av viste feilkoder.
Følg OneRosterspesifikasjoner for feilhåndteringI tillegg anbefales det at du inkluderer SIS-navnet ditt i begynnelsen avimsx_beskrivelseDette gjør at integrasjonen automatisk kan vise instruksjonsfulle feilbeskrivelser for sluttbrukere.
Ekskluderte endepunkter
Ekskluderte endepunkter er endepunkter som ikke er inkludert i et API-kall.
Hvis to endepunkter returnerer identiske datasett, ekskluder ett datasett for å redusere antall API-kall. For eksempel,hentAlleAkademiskeØkteroghentAllevilkårkan gi identiske datasett, så inkluder bare ett i endepunktkonfigurasjonen din.
I løpet av alfatestperioden for integrasjonen, vennligst gi Instructure beskjed om eventuelle ekskluderte endepunkter.
Lær mer om OneRosterendepunktkonfigurasjoner.
Filtrer spørringer
Filtrer dataene som er inkludert i en datasynkronisering ved hjelp av filterspørringer. Du kan konfigurere filterspørringer per jobb, noe som tillater både massesynkronisering og trinnvise datasynkroniseringer.
I løpet av alfatestperioden for integrasjonen, vennligst gi Instructure beskjed om de konfigurerte filterspørringene dine for OneRoster.
Lær mer om OneRosterfilterspørringerI tillegg kan du lære mer omkrav til implementering av trinnvis synkronisering.
Paginering
Fordi API-kall til et SIS kan be om store mengder data, gir paginering orden til API-spørringsresultatene dine. For å redusere HTTP-trafikk og forbedre synkroniseringstimingen anbefales det at du konfigurerer paginering til å støtte opptil 1000 poster om gangen.
Lær mer om OneRosterkrav til paginering.
Merk:Selv om det ikke anbefales, kan Instructure støtte implementeringer der alle forespurte data er inkludert i ett enkelt API-kall hvis antallet tidsavbrudd ikke blir for høyt.
Nye forsøk
Nye forsøk er antall ganger integrasjonen forsøker et API-kall. Instructure OneRoster-integrasjonen forsøker et API-kall opptil tre ganger før den gir feil. Det oppstår en forsinkelsesperiode mellom hvert forsøk, og en forsinkelsesmultiplikator øker forsinkelsesperioden mellom nye forsøk.
Med eksempelkonfigurasjonen nedenfor vil et API-kall forsøke opptil tre ganger, vente 5 sekunder etter den første feilen, og deretter vente 15 sekunder på den andre feilen på rad. Hvis kallet mislykkes en tredje gang, mislykkes integrasjonsjobben.
Eksempel på nytt forsøkskonfigurasjon | Tolkning |
|---|
«Standardforsøk»: 2
| 3 forsøk |
«Standardforsinkelse»: 5000
| 5 sekunder |
«standardforsinkelsesmultiplikator»: 3
| 15 sekunder |
Timeouts
Tidsavbrudd oppstår når en API-forespørsel til webserveren tar for lang tid sammenlignet med nettstedets ventetid på serveren. Om nødvendig kan du øke nettstedets ventetid på serveren (f.eks. 2+ minutter). Der det er mulig, bør du imidlertid justere integrasjonen din for å gjøre den mer responsiv (f.eks. mindre enn tjue sekunder).