Lors de la configuration de votre intégration Instructure OneRoster, tenez compte des considérations relatives à l'intégration du retour des notes. L'intégration du retour des notes (GPB) d'Instructure OneRoster comprend des variantes des spécifications OneRoster, selon les exigences des différents fournisseurs de systèmes d'information scolaire (SIS).
Catégories de notation
En fonction de la configuration de votre système d'information scolaire (SIS), vous pouvez personnaliser lesobtenirCatégoriesrequête permettant de synchroniser correctement les devoirs de Canvas avec votre carnet de notes SIS.
Périodes d'évaluation
Étant donné que la plupart des fournisseurs de systèmes d'information scolaire calculent automatiquement les périodes de notation en fonction de la date d'échéance d'un devoir, vous n'aurez peut-être pas besoin d'inclure ce point de terminaison dans votre configuration de retour des notes.
Charge utile LineItem
Vous pouvez configurer vos demandes de postes de travail. En savoir plus sur OneRosterstructure de données de catégorie d'article.
Charge utile des résultats
Vous pouvez configurer vos demandes de postes de travail. En savoir plus sur OneRosterrésultats.
Note:Instructure est un consommateur OneRoster. Pour les définitions de consommateur et de fournisseur OneRoster, consultez la documentation.Introduction à OneRoster.
Catégories de notation
Lorsque l'intégration Instructure OneRoster effectue une synchronisation des notes, legetAllCategoriesLa requête renvoie toutes les catégories de notation du carnet de notes SIS.
Toute catégorie de notation qui n'inclut pas métadonnées.classIdLe champ est considéré comme une catégorie globale qui peut être appliquée et utilisée dans toutes les classes.
Catégories globales
Si votre système d'information scolaire (SIS) ne prend en charge que les catégories de notation globales, l'intégration devrait fonctionner correctement sans les champs de métadonnées.
Extension d'objet de catégorie : metadata.classId
Pour permettre à l'API OneRoster v1.1 d'associer plus correctement les catégories et autres objets dans la spécification de retour des notes, un champ de catégorie est requis.
L'extension ci-dessous permet à l'intégration d'identifier correctement les catégories de notation du SIS nécessaires au retour des notes. Toutes les catégories qui ne possèdent pas cette extension seront ignorées.métadonnées.classIdLes champs sont considérés comme globaux, et le premier nom de catégorie correspondant à un nom de groupe de devoirs Canvas est utilisé pour GPB.
Si vous choisissez de soutenirmétadonnées.classId, vous devriez également inclure une requête de filtre pour le obtenirCatégoriesPoint de terminaison. Cela permet à l'intégration d'extraire les catégories d'une seule section.
Extension d'objet de catégorie |
|---|
{
"categories": [
{
"status": "active",
"title": "Évaluations",
"sourcedId": "guid",
"href": "URI de la ressource dans le SIS",
"metadata": {
"classId": "{class_id}"
},
"dateLastModified": null
}…
]
} |
Option de point de terminaison : getCategoriesForClass
En prévision de la spécification de l'API OneRoster 1.2, vous pouvez ajouter la prise en charge d'une nouvelleobtenirCategoriesForClasspoint de terminaison. Cela permet à l'intégration d'identifier les catégories de notation SIS disponibles pour une section lors d'une synchronisation de retour de notes.
Note:Si vous mettez en œuvre cette approche, vous n'avez pas besoin de configurer la prise en charge demétadonnées.classId champ.
Aucune catégorie correspondante
Votre intégration Instructure OneRoster peut être configurée pour synchroniser les devoirs Canvas avec les catégories de notation du système d'information scolaire (SIS). Lors d'une synchronisation des notes, si aucune catégorie correspondante n'est trouvée, un message d'erreur s'affiche indiquant qu'aucun nom de catégorie de notation du SIS ne correspond aux noms des groupes de devoirs Canvas.
Catégorie par défaut
Votre système d'information scolaire (SIS) peut inclure une valeur par défautsourcedIdCatégorie de notation prise en charge par tous les carnets de notes du système d'information scolaire (SIS). Lors d'une synchronisation des notes depuis Canvas, si une tâche ne peut être associée à une catégorie de notation du SIS, elle est synchronisée avec la catégorie de notation par défaut.
Si une catégorie communesourcedIdn'est pas disponible, cette valeur peut également être envoyée commenul.
Catégories non envoyées
Si le système d'information scolaire de votre établissement prend en charge les carnets de notes sans catégories de notation, votre intégration Instructure OneRoster peut être configurée pour envoyer le JSON lineItem de l'affectation sans le champ catégorie ou avec« catégorie » : nulL'intégration peut choisir d'envoyer systématiquement nul, ou seulement envoyer nulsi aucune catégorie correspondante n'est trouvée.
Il est également possible que votre intégration existante synchronise automatiquement les éléments de ligne de devoir non catégorisés avec la catégorie de notation « Non catégorisé » du carnet de notes du système d'information scolaire (SIS). Dans ce cas, les enseignants peuvent déplacer le devoir vers la catégorie de notation appropriée du SIS. Pour éviter que le devoir ne soit resynchronisé avec le champ « Non catégorisé », votre intégration doit être configurée pour reconnaître la catégorie attribuée manuellement comme un champ permanent.
Catégorie prioritaire
Le système d'information scolaire (SIS) de votre établissement peut être configuré avec une catégorie de notation par défaut présélectionnée et toujours utilisée. Pour prendre en charge cette configuration, votre intégration Instructure OneRoster peut inclure une catégorie codée en dur.sourcedIdTous les carnets de notes des enseignants dans votre système d'information scolaire doivent inclure cette catégorie. L'intégration peut également être configurée avec une valeur de remplacement.nulvaleur de la catégorie.
Périodes d'évaluation
Lors d'une synchronisation des notes depuis Canvas, la plupart des systèmes d'information scolaire (SIS) calculent et associent automatiquement la période de notation correcte d'un devoir en utilisant ledate d'échéanceligne de commande. Ce calcul automatique signifie que lepériode d'évaluationL'élément de ligne peut être omis ou envoyé tel quelnul.
Si votre intégration l'exige, unpériode d'évaluationLes éléments de ligne peuvent être configurés. Cependant, une configuration incorrecte entraînera plus fréquemment des erreurs de synchronisation des notes.
Apprenez-en davantage sursessions académiques OneRoster.
Considérations relatives à la charge utile des éléments de ligne
Vous pouvez configurer les requêtes de ligne à inclure dans votre charge utile de synchronisation GPB.
Le graphique ci-dessous présente les requêtes de lignes configurables. Lors de la configuration individuelle du client, vous pouvez personnaliser la plupart des valeurs par défaut. Vous pouvez également omettre certaines de ces valeurs de la charge utile. Par ailleurs, si les données correspondantes sont disponibles dans l'extraction de données Canvas, vous pouvez configurer des champs de métadonnées supplémentaires.
Apprenez-en davantage sur OneRosterstructure de données de catégorie d'article.
Nom du champ OneRoster LineItem | Valeur par défaut |
|---|
sourcedId
| UUIDv4 |
titre
| {assignment.name} |
statut
| "actif" |
description
| Importé depuis Canvas :https://school.instructure.com/courses/{course_id}/assignments/{assignment_id} |
valeur_résultatMax
| {assignment.points_possible} |
valeur_résultatMin
| 0 |
assignerDate
| {assignment.unlock_at} OU {assignment.due_at} |
date d'échéance
| {assignment.due_at} |
classe
| {Objet de référence de classe OneRoster} |
catégorie
| {Objet de référence de catégorie OneRoster} OU null* |
période d'évaluation
| null OU {objet de référence OneRoster academicSession}** |
*voir Notes de mise en œuvre du retour d'information des notes pour les catégories
**Voir les notes d'implémentation du renvoi des notes pour gradingPeriods
Exemples de configurations de charge utile
Exemple de charge utile avec SourceID |
|---|
{
"lineItem": {
"sourcedId": "799e2caf-728d-4ef6-8ff9-5325e64cecd5"
"status": "active",
"title": "Canvas Test Assignment 1",
"description": "Importé 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",
"metadata": {
"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": "category"
},
"gradingPeriod": null
}
} |
Exemple de charge utile sans SourceID |
|---|
{
"lineItem": {
"status": "active",
"title": "Devoir Canvas Test 1",
"description": "Importé 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",
"metadata": {
"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": "category"
},
"gradingPeriod": null
}
} |
Considérations relatives à la charge utile des résultats
Vous pouvez configurer les charges utiles de résultats incluses dans votre synchronisation GPB.
Le graphique ci-dessous présente les requêtes de lignes configurables. Lors de la configuration individuelle du client, vous pouvez personnaliser la plupart des valeurs par défaut. Vous pouvez également omettre certaines de ces valeurs de la charge utile. Par ailleurs, si les données correspondantes sont disponibles dans l'extraction de données Canvas, vous pouvez configurer des champs de métadonnées supplémentaires.
Apprenez-en davantage sur OneRosterrésultats.
Nom du champ OneRoster | Valeur par défaut |
|---|
sourcedId | {sourcedId} |
ligneItem | {Objet de référence OneRoster lineItem} |
étudiant | {Objet de référence utilisateur OneRoster} |
scoreStatut | « entièrement noté », « non soumis » ou « exempté » |
score | {soumission.score} |
commentaire | omis par défaut* |
date de score | omis par défaut** |
*Voir les notes de mise en œuvre du retour des notes pour plus de commentaires
**Voir les notes d'implémentation du retour des notes pour la date de score
Exemple de charge utile |
|---|
{
"result": {
"sourcedId": "0031e9ee-5bd0-4d80-a5f7-5c14fe75acc0",
"lineItem": {
"href": "~/ims/oneroster/v1p1/lineItems/0ea49ae5-4a6b-45d5-a0c2-b01facbfbc5f",
"sourcedId": "0ea49ae5-4a6b-45d5-a0c2-b01facbfbc5f",
"type": "lineItem"
},
"student": {
"href": "~/ims/oneroster/v1p1/students/S100051158",
"sourcedId": "S100051158",
"type": "étudiant"
},
"scoreStatus": "entièrement noté",
"score": 10
}
} |
Scores
Dans Canvas, un enseignant peut attribuer des notes négatives et dépasser la note maximale. Réfléchissez à la manière dont votre intégration gérera ces situations potentielles.
Dans certains cas, comme une exemptionscoreStatut, votre intégration doit être configurée pour transmettre unnulvaleur de score, sinon une0La valeur du score est transmise au SIS.
Valeur scoreStatus du canevas | Notes |
|---|
entièrement noté |
soumission.état_flux_de_travail = notéIl devrait toujours y avoir un score associé.
|
non soumis |
soumission.manquant = vraiLa plupart du temps, la réussite dépendra de la présence d'une note, mais il est possible d'avoir unscore=null
|
exempter |
soumission.excused = vraiLe score sera de
nulpar défaut ou0
|