Vous pouvez configurer vos options d'intégration Instructure OneRoster à chaque niveau de connexion client.
Durant votre phase de test alpha d'intégration, Instructure travaillera avec vous pour établir les paramètres de configuration par défaut recommandés pour votre établissement.
Apprenez-en davantage surconfigurations du service de planification et meilleures pratiques d'intégration de la planification des effectifs.
Note:Instructure est un consommateur OneRoster. Pour les définitions de consommateur et de fournisseur OneRoster, consultez la documentation.Introduction à OneRoster.
Concurrence
La concurrence correspond au nombre de points de terminaison pouvant être traités simultanément. Avec une concurrence de trois, configurez jusqu'à trois points de terminaison simultanés distincts. Par exemple, vous pouvez utiliser…obtenirTermes, getTeachers, obtenirClassespoints de terminaison simultanément.
Apprenez-en davantage sur la configurationpoints de terminaison de la liste des élèves spécifiques à l'écolepour permettre la synchronisation simultanée des données d'inscription.
Note:Instructure n'applique pas la concurrence à la pagination. Par conséquent, le chargement des données est aussi lent que le temps de réponse du point de terminaison le plus lent combiné à la pagination sur un seul thread.
Gestion des erreurs
La gestion des erreurs concerne la configuration des codes d'erreur affichés.
Suivez OneRosterspécifications de gestion des erreursDe plus, il est recommandé d'inclure le nom de votre SIS au début duimsx_descriptionCela permet à l'intégration d'afficher automatiquement des descriptions d'erreurs explicatives pour les utilisateurs finaux.
Points de terminaison exclus
Les points de terminaison exclus sont les points de terminaison qui ne sont pas inclus dans un appel d'API.
Si deux points de terminaison renvoient des ensembles de données identiques, excluez-en un afin de réduire le nombre d'appels d'API. Par exemple,obtenirToutesLesSessionsAcadémiques et obtenirTousLesTermespeuvent fournir des ensembles de données identiques, n'en incluez donc qu'un seul dans la configuration de votre point de terminaison.
Durant votre période de test alpha d'intégration, veuillez informer Instructure de tout point de terminaison exclu.
En savoir plus sur OneRosterconfigurations des points de terminaison.
Requêtes de filtrage
Filtrez les données incluses dans une synchronisation à l'aide de requêtes de filtrage. Vous pouvez configurer ces requêtes pour chaque tâche, permettant ainsi des synchronisations de données en masse ou incrémentales.
Durant votre période de test alpha d'intégration, veuillez informer Instructure de vos requêtes de filtre configurées pour OneRoster.
En savoir plus sur OneRosterrequêtes de filtrageDe plus, apprenez-en davantage surexigences de mise en œuvre de la synchronisation incrémentale.
Pagination
Les appels API à un système d'information de gestion (SIS) pouvant demander d'importants volumes de données, la pagination permet d'organiser les résultats de vos requêtes API. Afin de réduire le trafic HTTP et d'améliorer la synchronisation, il est recommandé de configurer la pagination pour qu'elle prenne en charge jusqu'à 1 000 enregistrements simultanément.
Apprenez-en davantage sur OneRosterexigences de pagination.
Note: Bien que cela ne soit pas recommandé, Instructure peut prendre en charge les implémentations où toutes les données demandées sont incluses dans un seul appel d'API si le nombre de délais d'attente ne devient pas excessif.
Tentatives
Les tentatives correspondent au nombre de fois où l'intégration tente d'effectuer un appel API. L'intégration Instructure OneRoster tente un appel API jusqu'à trois fois avant de générer une erreur. Un délai s'écoule entre chaque tentative, et un multiplicateur de délai augmente ce délai entre les nouvelles tentatives.
Avec la configuration d'exemple ci-dessous, un appel API sera tenté jusqu'à trois fois : une attente de 5 secondes est effectuée après la première erreur, puis une attente de 15 secondes est prévue pour la deuxième erreur consécutive. Si l'appel échoue une troisième fois, la tâche d'intégration échoue.
Exemple de configuration de nouvelle tentative | Interprétation |
|---|
« defaultRetries » : 2
| 3 tentatives |
« defaultDelay » : 5000
| 5 secondes |
« defaultDelayMultiplier » : 3
| 15 secondes |
Délais d'attente
Un délai d'attente est dépassé lorsqu'une requête API adressée au serveur web prend trop de temps par rapport au temps d'attente du serveur. Si nécessaire, vous pouvez augmenter ce temps d'attente (par exemple, à plus de 2 minutes). Toutefois, dans la mesure du possible, il est recommandé d'optimiser votre intégration pour une meilleure réactivité (par exemple, moins de 20 secondes).