Du kan konfigurere dine Instructure OneRoster-integrationsmuligheder på hvert klientforbindelsesniveau.
Under din alfatestfase for integrationen vil Instructure samarbejde med dig om at fastsætte anbefalede standardkonfigurationsindstillinger for din institution.
Lær mere omKonfigurationer af vagtplanlægningstjenesterogBedste praksis for integration af vagtplanlægning.
Note:Instructure er en OneRoster-forbruger. For definitioner af OneRoster-forbrugere og -udbydere, seIntroduktion til OneRoster.
Samtidighed
Samtidighed er antallet af slutpunkter, der skal threades på én gang. Med en samtidighed på tre kan du konfigurere op til tre separate samtidige slutpunkter. Du kan f.eks. brugehentvilkår,getTeachers,getClassesendepunkter samtidigt.
Få mere at vide om konfigurationskolespecifikke vagtplanlægningsslutpunkterfor at tillade samtidig synkronisering af tilmeldingsdata.
Note:Instructure anvender ikke samtidighed på paginering. Som følge heraf er dataindlæsningen lige så langsom som den langsomste slutpunktsresponstid kombineret med pagineringen på en enkelt tråd.
Fejlhåndtering
Fejlhåndtering vedrører konfigurationen af viste fejlkoder.
Følg OneRosterspecifikationer for fejlhåndteringDerudover anbefales det, at du inkluderer dit SIS-navn i begyndelsen afimsx_beskrivelseDette gør det muligt for integrationen automatisk at vise instruktive fejlbeskrivelser til slutbrugere.
Ekskluderede slutpunkter
Ekskluderede slutpunkter er de slutpunkter, der ikke er inkluderet i et API-kald.
Hvis to slutpunkter returnerer identiske datasæt, skal det ene datasæt udelades for at reducere antallet af API-kald. For eksempel,hentAlleAkademiskeSessioneroghentAlleTermerkan levere identiske datasæt, så inkluder kun ét i din slutpunktskonfiguration.
Under din integrations-alfatestperiode bedes du underrette Instructure om eventuelle ekskluderede slutpunkter.
Lær mere om OneRosterkonfigurationer af slutpunkter.
Filtrer forespørgsler
Filtrer dataene, der er inkluderet i en datasynkronisering, ved hjælp af filterforespørgsler. Du kan konfigurere filterforespørgsler pr. job, hvilket muliggør både masse- og trinvise datasynkroniseringer.
Under din integrations-alfatestperiode bedes du give Instructure besked om dine konfigurerede filterforespørgsler til OneRoster.
Lær mere om OneRosterfilterforespørgslerDerudover kan du lære mere omKrav til implementering af trinvis synkronisering.
Paginering
Da API-kald til et SIS kan anmode om store mængder data, tilføjer paginering orden til dine API-forespørgselsresultater. For at reducere HTTP-trafik og forbedre synkroniseringstimingen anbefales det, at du konfigurerer paginering til at understøtte op til 1000 poster ad gangen.
Lær mere om OneRosterkrav til paginering.
Bemærk:Selvom det ikke anbefales, kan Instructure understøtte implementeringer, hvor alle anmodede data er inkluderet i et enkelt API-kald, hvis antallet af timeouts ikke bliver for højt.
Genforsøg
Genforsøg er det antal gange, integrationen forsøger et API-kald. Instructure OneRoster-integrationen forsøger et API-kald op til tre gange, før den fejler. Der er en forsinkelsesperiode mellem hvert forsøg, og en forsinkelsesmultiplikator øger forsinkelsesperioden mellem genforsøgene.
Med nedenstående eksempelkonfiguration vil et API-kald forsøge op til tre gange, vente 5 sekunder efter den første fejl og derefter vente 15 sekunder på den anden fejl i træk. Hvis kaldet mislykkes en tredje gang, mislykkes integrationsjobbet.
Eksempel på gentagelseskonfiguration | Fortolkning |
|---|
"Standardforsøg": 2
| 3 forsøg |
"StandardForsinkelse": 5000
| 5 sekunder |
"standardForsinkelsesmultiplikator": 3
| 15 sekunder |
Timeouts
Timeouts opstår, når en API-anmodning til webserveren tager for lang tid i forhold til webstedets serverventetid. Om nødvendigt kan du øge dit websteds serverventetid (f.eks. 2+ minutter). Du bør dog, hvor det er muligt, justere din integration for at gøre den mere responsiv (f.eks. mindre end tyve sekunder).