Al configurar la integración de Instructure OneRoster, revise las consideraciones de la integración de la devolución de calificaciones. La integración de la devolución de calificaciones (GPB) de Instructure OneRoster incluye variaciones de las especificaciones de OneRoster, según lo exigen diversos proveedores de SIS.
Categorías de calificación
Dependiendo de la configuración de su libro de calificaciones SIS, puede personalizarloobtenerCategoríasconsulta para sincronizar correctamente las tareas de Canvas con su libro de calificaciones SIS.
Períodos de calificación
Dado que la mayoría de los proveedores de SIS calculan automáticamente los períodos de calificación según la fecha de vencimiento de una tarea, es posible que no necesite incluir este punto final en su configuración de devolución de calificaciones.
Carga útil de elemento de línea
Puede configurar sus solicitudes de partidas. Obtenga más información sobre OneRoster.Estructura de datos de categoría de artículo de línea.
Resultados de la carga útil
Puede configurar sus solicitudes de partidas. Obtenga más información sobre OneRoster.resultados.
Nota:Instructure es un consumidor de OneRoster. Para conocer las definiciones de consumidor y proveedor de OneRoster, consulteIntroducción a OneRoster.
Categorías de calificación
Cuando la integración de Instructure OneRoster ejecuta una sincronización de calificaciones,obtenerTodasLasCategoríasLa solicitud devuelve todas las categorías de calificación del libro de calificaciones del SIS.
Cualquier categoría de calificación que no incluya lametadatos.classIdEl campo se considera una categoría global que se puede aplicar y utilizar en todas las clases.
Categorías globales
Si su libro de calificaciones SIS solo admite categorías de calificación globales, entonces la integración debería funcionar correctamente sin los campos de metadatos.
Extensión de objeto de categoría: metadata.classId
Para permitir que la API OneRoster v1.1 asocie de manera más correcta categorías y otros objetos en la especificación de devolución de calificaciones, se requiere un campo de categoría.
La siguiente extensión permite que la integración identifique correctamente las categorías de calificación del SIS necesarias para la devolución de calificaciones. Cualquier categoría que no tenga esta...metadatos.classIdSe supone que los campos son globales y el primer nombre de categoría que coincide con un nombre de grupo de asignación de Canvas se utiliza para GPB.
Si decides apoyarmetadatos.classId, también debe incluir una consulta de filtro para elobtenerCategoríaspunto final. Esto permite que la integración extraiga categorías para una sola sección.
Extensión de objeto de categoría |
|---|
{
"categories": [
{
"status": "active",
"title": "Assessments",
“sourcedId": "guid",
"href": "URI del recurso en el SIS",
"metadata": {
"classId": "{class_id}"
},
"dateLastModified": null
}…
]
} |
Opción de punto final: getCategoriesForClass
En previsión de la especificación de la API 1.2 de OneRoster, puede agregar soporte para una nuevaobtenerCategoríasParaClasePunto final. Esto permite que la integración identifique las categorías de calificación SIS disponibles para una sección durante la sincronización de devolución de calificaciones.
Nota:Si implementa este enfoque, no necesita configurar el soporte para elmetadatos.classId campo.
No hay categorías coincidentes
Su integración con Instructure OneRoster puede configurarse para sincronizar las tareas de Canvas con las categorías de calificación de SIS. Durante la sincronización de calificaciones, si no se encuentran categorías coincidentes, se mostrará un mensaje de error indicando que ninguno de los nombres de las categorías de calificación de SIS coincide con los nombres de los grupos de tareas de Canvas.
Categoría predeterminada
Su SIS puede incluir un valor predeterminadoID de origenCategoría de calificación compatible con todos los libros de calificaciones del SIS. Durante la sincronización de calificaciones desde Canvas, si una tarea no se puede asignar a una categoría de calificación del SIS, se sincroniza con la categoría de calificación predeterminada.
Si una categoría comúnID de origenno está disponible, este valor también se puede enviar comonulo.
No enviar categorías
Si el SIS de su institución admite libros de calificaciones sin categorías de calificación, su integración con Instructure OneRoster se puede configurar para enviar el JSON del elemento de línea de la tarea sin el campo de categoría o con“categoría”: nulaLa integración puede elegir enviar siempre nulo, o solo enviar nulosi no se encuentra ninguna categoría coincidente.
Como alternativa, su integración actual puede sincronizar automáticamente las líneas de tareas sin categorizar con la categoría de calificación sin categorizar del libro de calificaciones del SIS. Si este es el caso de su integración, los instructores pueden mover la tarea a la categoría de calificación del SIS correspondiente. Para evitar que la tarea se vuelva a sincronizar con el campo sin categorizar, su integración debe estar configurada para reconocer la categoría asignada manualmente como un campo fijo.
Categoría de anulación
El libro de calificaciones del SIS de su institución puede configurarse con una categoría de calificación predeterminada y preseleccionada. Para adaptar esta configuración, su integración con Instructure OneRoster puede incluir una categoría predefinida.ID de origenTodos los libros de calificaciones de los instructores en su SIS deben incluir esta categoría. Alternativamente, la integración se puede configurar con una anulación.nulovalor de categoría.
Períodos de calificación
Durante una sincronización de calificaciones desde Canvas, la mayoría de los SIS calculan y asocian automáticamente el período de calificación correcto de una tarea utilizandofecha de vencimientopartida. Este cálculo automático significa que elperíodo de calificaciónEl elemento de línea se puede omitir o enviar comonulo.
Si su integración lo requiere, unperíodo de calificaciónEl elemento de línea se puede configurar. Sin embargo, si se configura incorrectamente, los errores de sincronización de calificaciones se producirán con mayor frecuencia.
Obtenga más información sobreSesiones académicas de OneRoster.
Consideraciones sobre la carga útil de los elementos de línea
Puede configurar solicitudes de elementos de línea para incluirlas en su carga útil de sincronización de GPB.
El siguiente gráfico muestra solicitudes de elementos de línea configurables. Como parte del proceso de configuración individual del cliente, puede personalizar la mayoría de los valores predeterminados. También puede omitir cualquiera de estos valores de la carga útil. Como alternativa, si los datos correlacionados están disponibles en el extracto de datos de Canvas, también puede configurar campos de metadatos adicionales.
Obtenga más información sobre OneRosterEstructura de datos de categoría de artículo de línea.
Nombre del campo LineItem de OneRoster | Valor predeterminado |
|---|
ID de origen
| UUIDv4 |
título
| {asignación.nombre} |
estado
| "activo" |
descripción
| Importado de Canvas:https://school.instructure.com/cursos/{id_del_curso}/tareas/{id_de_la_tarea} |
resultValueMax
| {asignación.puntos_posibles} |
resultadoValorMín
| 0 |
asignarFecha
| {asignación.desbloquear_en} O {asignación.fecha_de vencimiento_en} |
fecha de vencimiento
| {tarea.con vencimiento_a las} |
clase
| {Objeto de referencia de la clase OneRoster} |
categoría
| {Objeto de referencia de categoría OneRoster} O nulo* |
período de calificación
| nulo O {objeto de referencia de OneRoster academicSession}** |
*ver Notas de implementación de devolución de calificaciones para categorías
**Consulte las notas de implementación de devolución de calificaciones para gradingPeriods.
Ejemplos de configuraciones de carga útil
Ejemplo de carga útil con SourceID |
|---|
{
"lineItem": {
"sourcedId": "799e2caf-728d-4ef6-8ff9-5325e64cecd5”
"status": "active”,
"title": "Tarea 1 del examen de Canvas”,
"description": "Importado desde Canvas:https://school.instructure.com/courses/5582/assignments/135”,
"resultValueMax": 10,
"resultValueMin": 0,
"assignDate": "2021-03-10T23:59:59”,
"dueDate": "2021-03-10T23:59:59”,
"metadatos": {
"vendorId": “"
},
"class": {
"href": "~/ims/oneroster/v1p1/classes/100453379”,
"sourcedId": "100453379”,
"type": “class”
},
"category": {
"href": "~/ims/oneroster/v1p1/categories/C5C3AC8C-8D0F-48EB-96F4-31437B640D16”,
"sourcedId": "C5C3AC8C-8D0F-48EB-96F4-31437B640D16”,
"type": “categoría”
},
"gradingPeriod": null
}
} |
Ejemplo de carga útil sin SourceID |
|---|
{
"lineItem": {
"status": "active",
"title": "Tarea de prueba de Canvas 1",
"description": "Importado de Canvas:https://school.instructure.com/courses/5582/assignments/135”,
"resultValueMax": 10,
"resultValueMin": 0,
"assignDate": "2021-03-10T23:59:59”,
"dueDate": "2021-03-10T23:59:59”,
"metadatos": {
"vendorId": “"
},
"class": {
"href": "~/ims/oneroster/v1p1/classes/100453379”,
"sourcedId": "100453379”,
"type": “class”
},
"categoría": {
"href": "~/ims/oneroster/v1p1/categorías/C5C3AC8C-8D0F-48EB-96F4-31437B640D16”,
"sourcedId": "C5C3AC8C-8D0F-48EB-96F4-31437B640D16”,
"tipo": “categoría”
},
"períodoDeCalificación": nulo
}
} |
Consideraciones sobre la carga útil de resultados
Puede configurar las cargas útiles de resultados incluidas en su sincronización GPB.
El siguiente gráfico muestra solicitudes de elementos de línea configurables. Como parte del proceso de configuración individual del cliente, puede personalizar la mayoría de los valores predeterminados. También puede omitir cualquiera de estos valores de la carga útil. Como alternativa, si los datos correlacionados están disponibles en el extracto de datos de Canvas, también puede configurar campos de metadatos adicionales.
Obtenga más información sobre OneRosterresultados.
Nombre del campo OneRoster | Valor predeterminado |
|---|
ID de origen | {sourcedId} |
elemento de línea | {Objeto de referencia lineItem de OneRoster} |
alumno | {Objeto de referencia de usuario de OneRoster} |
Estado de puntuación | "totalmente calificado" o "no presentado" o "exento" |
puntaje | {envío.puntuación} |
comentario | omitido por defecto* |
puntuaciónFecha | omitido por defecto** |
*Consulte las notas de implementación de devolución de calificaciones para obtener comentarios.
**Consulte las notas de implementación de devolución de calificaciones para obtener información sobre la fecha de puntuación.
Ejemplo de carga útil |
|---|
{
"resultado": {
"sourcedId": "0031e9ee-5bd0-4d80-a5f7-5c14fe75acc0”,
"elemento de línea": {
"href": "~/ims/oneroster/v1p1/elementos de línea/0ea49ae5-4a6b-45d5-a0c2-b01facbfbc5f”,
"sourcedId": "0ea49ae5-4a6b-45d5-a0c2-b01facbfbc5f”,
"tipo": “elemento de línea”
},
"estudiante": {
"href": "~/ims/oneroster/v1p1/students/S100051158”,
"sourcedId": "S100051158”,
"type": “student”
},
"scoreStatus": "completamente calificado”,
"score": 10
}
} |
Montones
En Canvas, un instructor puede asignar puntuaciones negativas e incluso superar la puntuación máxima. Considere cómo su integración gestionará estas posibles situaciones.
En ciertos casos, como en el caso de una exención,Estado de puntuación, su integración debe estar configurada para pasar unanulovalor de la puntuación, de lo contrario un0El valor de la puntuación se pasa al SIS.
Valor de scoreStatus del lienzo | Notas |
|---|
completamente calificado |
submission.workflow_state = calificadoSiempre debe tener una puntuación asociada.
|
no enviado |
envío.falta = verdaderoEn la mayoría de los casos, solo se aprobará si hay una puntuación asociada, pero es posible tener unapuntuación=nulo
|
eximir |
sumisión.excusado = verdaderoLa puntuación seránulopor defecto o0
|