Quando si configura l'integrazione Instructure OneRoster, è necessario esaminare le considerazioni relative all'integrazione del passback dei voti. L'integrazione del passback dei voti (GPB) di Instructure OneRoster include varianti delle specifiche OneRoster, come richiesto dai vari provider SIS.
Categorie di valutazione
A seconda della configurazione del registro dei voti SIS, è possibile personalizzareOttieni categoriequery per sincronizzare correttamente i compiti da Canvas al registro dei voti SIS.
Periodi di valutazione
Poiché la maggior parte dei provider SIS calcola automaticamente i periodi di valutazione in base alla data di scadenza di un compito, potrebbe non essere necessario includere questo endpoint nella configurazione del passback della valutazione.
Carico utile dell'elemento di linea
Puoi configurare le tue richieste di articoli. Scopri di più su OneRosterstruttura dati della categoria lineitem.
Risultati Payload
Puoi configurare le tue richieste di articoli. Scopri di più su OneRosterrisultati.
Nota:Instructure è un consumatore OneRoster. Per le definizioni di consumatore e fornitore OneRoster, consultareIntroduzione a OneRoster.
Categorie di valutazione
Quando l'integrazione Instructure OneRoster esegue una sincronizzazione dei voti, ilottieni tutte le categoriela richiesta restituisce tutte le categorie di valutazione del registro SIS.
Qualsiasi categoria di valutazione che non includa ilmetadati.classIdIl campo è considerato una categoria globale che può essere applicata e utilizzata in tutte le classi.
Categorie globali
Se il registro dei voti SIS supporta solo categorie di valutazione globali, l'integrazione dovrebbe funzionare correttamente senza i campi dei metadati.
Estensione dell'oggetto categoria: metadata.classId
Per consentire all'API OneRoster v1.1 di associare più correttamente le categorie e altri oggetti nella specifica di passback dei voti, è obbligatorio un campo categoria.
L'estensione sottostante consente all'integrazione di identificare correttamente le categorie di valutazione SIS necessarie per il passaggio di valutazione. Tutte le categorie che non dispongono di questa estensionemetadati.classIdsi presume che i campi siano globali e che per GPB venga utilizzato il primo nome di categoria che corrisponde al nome di un gruppo di assegnazione Canvas.
Se scegli di supportaremetadati.classId, dovresti anche includere una query di filtro per ilOttieni categorieendpoint. Ciò consente all'integrazione di estrarre categorie per una singola sezione.
Estensione dell'oggetto di categoria |
|---|
{
"categories": [
{
"status": "attivo",
"title": "Valutazioni",
"sourcedId": "guid",
"href": "URI della risorsa nel SIS",
"metadata": {
"classId": "{class_id}"
},
"dateLastModified": null
}…
]
} |
Opzione endpoint: getCategoriesForClass
In previsione della specifica OneRoster API 1.2, è possibile aggiungere il supporto per un nuovogetCategoriesForClassendpoint. Ciò consente all'integrazione di identificare le categorie di valutazione SIS disponibili per una sezione durante una sincronizzazione di passback della valutazione.
Nota:Se si implementa questo approccio, non è necessario configurare il supporto permetadati.classId campo.
Nessuna categoria corrispondente
L'integrazione Instructure OneRoster potrebbe essere configurata per sincronizzare le assegnazioni Canvas nelle categorie di valutazione SIS. Durante la sincronizzazione delle valutazioni, se non vengono trovate categorie corrispondenti, viene visualizzato un messaggio di errore che indica che nessuno dei nomi delle categorie di valutazione SIS corrisponde ai nomi dei gruppi di assegnazioni Canvas.
Categoria predefinita
Il tuo SIS potrebbe includere un valore predefinitosourcedIdCategoria di valutazione supportata in tutti i registri SIS. Durante una sincronizzazione dei voti da Canvas, se un compito non può essere abbinato a una categoria di valutazione SIS, verrà sincronizzato con la categoria di valutazione predefinita.
Se una categoria comunesourcedIdnon è disponibile, questo valore può anche essere inviato comenull.
Categorie non inviate
Se il SIS del tuo istituto supporta registri di valutazione senza categorie di valutazione, l'integrazione Instructure OneRoster può essere configurata per inviare il JSON lineItem dell'assegnazione senza il campo categoria o con“categoria”: nullL'integrazione può scegliere di inviare semprenull, o inviare solonullse non viene trovata alcuna categoria corrispondente.
In alternativa, l'integrazione esistente potrebbe sincronizzare automaticamente le voci di riga dell'assegnazione non categorizzate con la categoria di valutazione non categorizzata del registro SIS. In questo caso, gli insegnanti possono spostare l'assegnazione nella categoria di valutazione SIS appropriata. Per evitare che l'assegnazione venga risincronizzata con il campo non categorizzato, l'integrazione deve essere configurata in modo da riconoscere la categoria assegnata manualmente come campo fisso.
Categoria sovrascritta
Il registro dei voti SIS del tuo istituto può essere configurato con una categoria di valutazione predefinita, sempre utilizzata. Per supportare questa configurazione, l'integrazione di Instructure OneRoster può includere una categoria hardcoded.sourcedIdTutti i registri dei docenti nel tuo SIS devono includere questa categoria. In alternativa, l'integrazione può essere configurata con un overridenullvalore di categoria.
Periodi di valutazione
Durante una sincronizzazione dei voti da Canvas, la maggior parte dei SIS calcola e associa automaticamente il periodo di valutazione corretto di un compito utilizzandoscadenzalineitem. Questo calcolo automatico significa che ilperiodo di valutazionelineitem può essere omesso o inviato comenull.
Se richiesto dalla tua integrazione, unperiodo di valutazionelineitem può essere configurato. Tuttavia, se configurato in modo errato, gli errori di sincronizzazione dei voti si verificheranno più frequentemente.
Scopri di più suSessioni accademiche OneRoster.
Considerazioni sul carico utile di LineItem
È possibile configurare le richieste di elementi di riga da includere nel payload di sincronizzazione GPB.
Il grafico sottostante mostra le richieste di elementi di riga configurabili. Come parte del processo di configurazione del singolo client, è possibile personalizzare la maggior parte dei valori predefiniti. È anche possibile omettere uno qualsiasi di questi valori dal payload. In alternativa, se i dati correlati sono disponibili nell'estrazione dati Canvas, è anche possibile configurare campi di metadati aggiuntivi.
Scopri di più su OneRosterstruttura dati della categoria lineitem.
Nome del campo OneRoster LineItem | Valore predefinito |
|---|
sourcedId
| UUIDv4 |
titolo
| {nome.assegnazione} |
stato
| "attivo" |
descrizione
| Importato da Canvas:https://school.instructure.com/courses/{course_id}/assignments/{assignment_id} |
risultatoValoreMassimo
| {assegnazione.punti_possibili} |
risultatoValoreMin
| 0 |
assegnaData
| {assignment.unlock_at} OPPURE {assignment.due_at} |
scadenza
| {assegnazione.scadenza_alle} |
classe
| {Oggetto di riferimento della classe OneRoster} |
categoria
| {Oggetto di riferimento alla categoria OneRoster} O null* |
periodo di valutazione
| null O {oggetto di riferimento academicSession OneRoster}** |
*Vedere note sull'implementazione del passback di grado per le categorie
**vedere le note di implementazione del passback dei voti per i periodi di valutazione
Esempi di configurazioni del carico utile
Esempio di payload con SourceID |
|---|
{
"lineItem": {
"sourcedId": "799e2caf-728d-4ef6-8ff9-5325e64cecd5”
"status": "attivo”,
"title": "Assegnazione test Canvas 1”,
"description": "Importato da 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
}
} |
Esempio di payload senza SourceID |
|---|
{
"lineItem": {
"status": "attivo",
"title": "Compito di prova Canvas 1",
"description": "Importato da 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
}
} |
Considerazioni sul carico utile dei risultati
È possibile configurare i payload dei risultati inclusi nella sincronizzazione GPB.
Il grafico sottostante mostra le richieste di elementi di riga configurabili. Come parte del processo di configurazione del singolo client, è possibile personalizzare la maggior parte dei valori predefiniti. È anche possibile omettere uno qualsiasi di questi valori dal payload. In alternativa, se i dati correlati sono disponibili nell'estrazione dati Canvas, è anche possibile configurare campi di metadati aggiuntivi.
Scopri di più su OneRosterrisultati.
Nome del campo OneRoster | Valore predefinito |
|---|
sourcedId | {sourcedId} |
elemento di linea | {Oggetto di riferimento OneRoster lineItem} |
studente | {Oggetto di riferimento utente OneRoster} |
punteggioStato | "completamente valutato" o "non presentato" o "esente" |
punto | {punteggio di invio} |
commento | omesso per impostazione predefinita* |
punteggioData | omesso per impostazione predefinita** |
*vedere le note di implementazione del passback di valutazione per i commenti
**vedere le note di implementazione del passaggio di voto per scoreDate
Esempio di carico 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": "student"
},
"scoreStatus": "completamente valutato",
"score": 10
}
} |
Punteggi
In Canvas, un docente può assegnare punteggi negativi o superare il punteggio massimo. Valuta come la tua integrazione gestirà queste potenziali situazioni.
In certi casi, come un esentepunteggioStato, la tua integrazione dovrebbe essere configurata per passare unnullvalore del punteggio, altrimenti un0il valore del punteggio viene trasmesso al SIS.
Valore scoreStatus da Canvas | Note |
|---|
completamente classificato |
submission.workflow_state = valutato
Dovrebbe sempre essere associato un punteggio.
|
non inviato |
submission.missing = true
Di solito si supera l'esame solo se è associato un punteggio, ma è possibile avere unpunteggio=nullo
|
esonerare |
submission.excused = true
Il punteggio sarànullper impostazione predefinita o0
|