È possibile configurare le opzioni di integrazione di Instructure OneRoster a ogni livello di connessione client.
Durante la fase di test alfa di integrazione, Instructure collaborerà con te per stabilire le impostazioni di configurazione predefinite consigliate per il tuo istituto.
Scopri di più suconfigurazioni del servizio di turnazione E migliori pratiche di integrazione dei turni.
Nota:Instructure è un consumatore OneRoster. Per le definizioni di consumatore e fornitore OneRoster, consultareIntroduzione a OneRoster.
Concorrenza
La concorrenza è il numero di endpoint da threadare contemporaneamente. Con una concorrenza di tre, configura fino a tre endpoint simultanei separati. Ad esempio, potresti usareOttieni termini,ottenereInsegnanti,ottenereClassiendpoint contemporaneamente.
Scopri di più sulla configurazionepunti finali di programmazione specifici della scuolaper consentire la sincronizzazione simultanea dei dati di iscrizione.
Nota:Instructure non applica la concorrenza alla paginazione. Di conseguenza, il caricamento dei dati è lento quanto il tempo di risposta dell'endpoint più lento combinato con la paginazione su un singolo thread.
Gestione degli errori
La gestione degli errori riguarda la configurazione dei codici di errore visualizzati.
Segui OneRosterspecifiche di gestione degli erroriInoltre, si consiglia di includere il nome SIS all'inizio delimsx_descriptionCiò consente all'integrazione di visualizzare automaticamente descrizioni di errori istruttive per gli utenti finali.
Endpoint esclusi
Gli endpoint esclusi sono gli endpoint non inclusi in una chiamata API.
Se due endpoint restituiscono set di dati identici, escludere un set di dati per ridurre il numero di chiamate API. Ad esempio,getAllAcademicSessions E Ottieni tutti i terminipotrebbe fornire set di dati identici, quindi includine solo uno nella configurazione dell'endpoint.
Durante il periodo di test alfa di integrazione, informa Instructure di eventuali endpoint esclusi.
Scopri di più su OneRosterconfigurazioni degli endpoint.
Filtra le query
Filtra i dati inclusi in una sincronizzazione dati utilizzando query di filtro. È possibile configurare query di filtro per ogni singolo processo, consentendo sincronizzazioni di dati sia in blocco che incrementali.
Durante il periodo di test alfa di integrazione, informa Instructure delle query di filtro configurate per OneRoster.
Scopri di più su OneRosterfiltrare le queryInoltre, scopri di più surequisiti di implementazione della sincronizzazione incrementale.
Paginazione
Poiché le chiamate API a un SIS possono richiedere grandi quantità di dati, la paginazione aggiunge ordine ai risultati delle query API. Per ridurre il traffico HTTP e migliorare i tempi di sincronizzazione, si consiglia di configurare la paginazione in modo che supporti fino a un limite di 1000 record alla volta.
Scopri di più su OneRosterrequisiti di impaginazione.
Nota:Sebbene non sia consigliato, Instructure può supportare implementazioni in cui tutti i dati richiesti sono inclusi in una singola chiamata API se il numero di timeout non diventa eccessivo.
Nuovi tentativi
I nuovi tentativi indicano il numero di volte in cui l'integrazione tenta una chiamata API. L'integrazione Instructure OneRoster tenta una chiamata API fino a tre volte prima di generare un errore. Tra ogni tentativo si verifica un periodo di ritardo e un moltiplicatore di ritardo aumenta il periodo di ritardo tra i nuovi tentativi.
Con la configurazione di esempio seguente, una chiamata API verrà tentata fino a tre volte, attendendo 5 secondi dopo il primo errore e poi 15 secondi per il secondo errore consecutivo. Se la chiamata fallisce una terza volta, il processo di integrazione fallisce.
Esempio di configurazione di ripetizione | Interpretazione |
|---|
“tentativi predefiniti”: 2
| 3 tentativi |
“defaultDelay”: 5000
| 5 secondi |
“defaultDelayMultiplier”: 3
| 15 secondi |
Timeout
I timeout si verificano quando una richiesta API al server web richiede troppo tempo rispetto al tempo di attesa del server del sito web. Se necessario, puoi aumentare il tempo di attesa del server del tuo sito web (ad esempio, di 2+ minuti). Tuttavia, ove possibile, dovresti modificare l'integrazione per renderla più reattiva (ad esempio, meno di venti secondi).