Puede configurar sus opciones de integración de Instructure OneRoster en cada nivel de conexión de cliente.
Durante la fase de prueba alfa de integración, Instructure trabajará con usted para establecer la configuración predeterminada recomendada para su institución.
Obtenga más información sobreconfiguraciones de servicio de programación y Mejores prácticas de integración de listas de personal.
Nota:Instructure es un consumidor de OneRoster. Para conocer las definiciones de consumidor y proveedor de OneRoster, consulteIntroducción a OneRoster.
Concurrencia
La concurrencia es la cantidad de puntos finales que se deben subprocesar a la vez. Con una concurrencia de tres, configure hasta tres puntos finales simultáneos separados. Por ejemplo, podría usar elobtenerTérminos,obtenerProfesores,obtenerClasespuntos finales simultáneamente.
Obtenga más información sobre la configuraciónpuntos finales de la lista de escuelas específicaspara permitir la sincronización simultánea de datos de inscripción.
Nota:Instructure no aplica concurrencia a la paginación. Como resultado, la carga de datos es tan lenta como el tiempo de respuesta del punto final más lento combinado con la paginación en un solo hilo.
Manejo de errores
El manejo de errores se relaciona con la configuración de los códigos de error mostrados.
Sigue el OneRosterespecificaciones de manejo de erroresAdemás, se recomienda que incluya el nombre de su SIS al comienzo deldescripción de imsxEsto permite que la integración muestre automáticamente descripciones de errores instructivas para los usuarios finales.
Puntos finales excluidos
Los puntos finales excluidos son los puntos finales que no están incluidos en una llamada API.
Si dos puntos finales devuelven conjuntos de datos idénticos, excluya uno para reducir el número de llamadas a la API. Por ejemplo:obtenerTodasLasSesionesAcadémicas y obtenerTodosLosTérminospuede proporcionar conjuntos de datos idénticos, así que incluya solo uno en la configuración de su punto final.
Durante el período de prueba alfa de integración, notifique a Instructure sobre cualquier punto final excluido.
Obtenga más información sobre OneRosterconfiguraciones de puntos finales.
Consultas de filtro
Filtre los datos incluidos en una sincronización mediante consultas de filtro. Puede configurar consultas de filtro por trabajo, lo que permite sincronizaciones de datos tanto masivas como incrementales.
Durante el período de prueba alfa de integración, notifique a Instructure sobre sus consultas de filtro configuradas para OneRoster.
Obtenga más información sobre OneRosterconsultas de filtro. Además, aprenda más sobreRequisitos de implementación de sincronización incremental.
Paginación
Dado que las llamadas API a un SIS pueden solicitar grandes cantidades de datos, la paginación ordena los resultados de las consultas API. Para reducir el tráfico HTTP y optimizar la sincronización, se recomienda configurar la paginación para que admita hasta un límite de 1000 registros a la vez.
Obtenga más información sobre OneRosterrequisitos de paginación.
Nota: Si bien no se recomienda, Instructure puede admitir implementaciones donde todos los datos solicitados se incluyen en una única llamada API si la cantidad de tiempos de espera no se vuelve excesiva.
Reintentos
Los reintentos son la cantidad de veces que la integración intenta una llamada a la API. La integración de Instructure OneRoster intenta una llamada a la API hasta tres veces antes de generar un error. Se produce un retraso entre cada intento y un multiplicador de retraso aumenta el retraso entre reintentos.
Con la siguiente configuración de ejemplo, se realizará un máximo de tres intentos de llamada a la API, con una espera de 5 segundos tras el primer error y de 15 segundos tras el segundo error consecutivo. Si la llamada falla una tercera vez, la integración falla.
Ejemplo de configuración de reintento | Interpretación |
|---|
“Reintentos predeterminados”: 2
| 3 intentos |
“retardo predeterminado”: 5000
| 5 segundos |
“Multiplicador de retardo predeterminado”: 3
| 15 segundos |
Tiempos de espera
Los tiempos de espera se producen cuando una solicitud de API al servidor web tarda demasiado en comparación con el tiempo de espera del servidor del sitio web. Si es necesario, puede aumentar el tiempo de espera de su sitio web (por ejemplo, a más de 2 minutos). Sin embargo, siempre que sea posible, debe ajustar su integración para que sea más rápida (por ejemplo, a menos de veinte segundos).