Når du konfigurerer din Instructure OneRoster-integration, skal du gennemgå overvejelserne vedrørende integration af grade passback. Instructure OneRoster-integrationen af grade passback (GPB) inkluderer variationer af OneRoster-specifikationerne, som krævet af forskellige SIS-udbydere.
Bedømmelseskategorier
Afhængigt af din SIS-karakterbogskonfiguration kan du tilpassehentKategorierforespørgsel for korrekt at synkronisere opgaver fra Canvas til din SIS-karakterbog.
Karakterperioder
Da de fleste SIS-udbydere automatisk beregner karaktergivningsperioder baseret på en opgaves afleveringsfrist, behøver du muligvis ikke at inkludere dette slutpunkt i din konfiguration af karaktertilbagesendelse.
Linjeelementnyttelast
Du kan konfigurere dine linjepostanmodninger. Få mere at vide om OneRosterdatastruktur for linjepostkategori.
Resultater Nyttelast
Du kan konfigurere dine linjepostanmodninger. Få mere at vide om OneRosterresultater.
Note:Instructure er en OneRoster-forbruger. For definitioner af OneRoster-forbrugere og -udbydere, seIntroduktion til OneRoster.
Bedømmelseskategorier
Når Instructure OneRoster-integrationen kører en karaktersynkronisering, vil hentAlleKategorierAnmodningen returnerer alle karakterbogskategorier i SIS.
Enhver karakterkategori, der ikke inkluderermetadata.klasseIdFeltet betragtes som en global kategori, der kan anvendes og bruges i alle klasser.
Globale kategorier
Hvis din SIS-karakterbog kun understøtter globale karakterkategorier, burde integrationen fungere korrekt uden metadatafelterne.
Kategoriobjektudvidelse: metadata.classId
For at OneRoster API v1.1 mere korrekt kan tilknytte kategorier og andre objekter i specifikationen for karakter-passback, kræves der et kategorifelt.
Udvidelsen nedenfor gør det muligt for integrationen korrekt at identificere de SIS-karakterkategorier, der er nødvendige for karaktertilbagesendelse. Alle kategorier, der ikke har dettemetadata.klasseIdfelt antages at være globale, og det første kategorinavn, der matcher et Canvas-opgavegruppenavn, bruges til GPB.
Hvis du vælger at støttemetadata.klasseId, bør du også inkludere en filterforespørgsel forhentKategorierslutpunkt. Dette gør det muligt for integrationen at hente kategorier for en enkelt sektion.
Kategoriobjektudvidelse |
|---|
{
"kategorier": [
{
"status": "aktiv",
"titel": "Vurderinger",
“sourcedId": "guid",
"href": "URI til ressource i SIS",
"metadata": {
"classId": "{class_id}”
},
"dateLastModified": null
}…
]
} |
Slutpunktsindstilling: getCategoriesForClass
Som forberedelse til OneRoster API 1.2-specifikationen kan du tilføje understøttelse af en nyhentKategorierForKlasseslutpunkt. Dette gør det muligt for integrationen at identificere tilgængelige SIS-bedømmelseskategorier for en sektion under en synkronisering af karaktertilbagesendelser.
Note:Hvis du implementerer denne fremgangsmåde, behøver du ikke at konfigurere understøttelse afmetadata.klasseIdfelt.
Ingen matchende kategorier
Din Instructure OneRoster-integration kan være konfigureret til at synkronisere Canvas-opgaver med SIS-karakterkategorier. Hvis der ikke findes nogen matchende kategorier under en karaktersynkronisering, vises en fejlmeddelelse, der angiver, at ingen af SIS-karakterkategorinavnene matcher Canvas-opgavegruppenavnene.
Standardkategori
Dit SIS kan indeholde en standardkilde-IDkarakterkategori, der understøttes i alle SIS-karakterbøger. Hvis en opgave under en karaktersynkronisering fra Canvas ikke kan matches med en SIS-karakterkategori, synkroniseres den med standardkarakterkategorien.
Hvis en fælles kategorikilde-IDikke er tilgængelig, kan denne værdi også sendes somnul.
Sender ikke kategorier
Hvis din institutions SIS understøtter karakterbøger uden karakterkategorier, kan din Instructure OneRoster-integration konfigureres til at sende opgavens lineItem JSON uden kategorifeltet eller med"Kategori": nullIntegrationen kan vælge altid at sendenul, eller kun sendnulhvis der ikke findes nogen matchende kategori.
Alternativt kan din eksisterende integration automatisk synkronisere ukategoriserede opgavelinjeelementer med SIS-karakterbogens ukategoriserede bedømmelseskategori. Hvis dette er tilfældet for din integration, kan instruktører flytte opgaven til den relevante SIS-bedømmelseskategori. For at forhindre opgaven i at synkroniseres igen med det ukategoriserede felt, skal din integration konfigureres til at genkende den manuelt tildelte kategori som et fast felt.
Tilsidesættende kategori
Din institutions SIS-karakterbog kan være konfigureret med en altid anvendt forudvalgt standardkarakterkategori. For at imødekomme denne konfiguration kan din Instructure OneRoster-integration inkludere en hardcodet kategori.kilde-IDAlle karakterbøger for undervisere i dit SIS skal indeholde denne kategori. Alternativt kan integrationen konfigureres med en overordnetnulkategoriværdi.
Karakterperioder
Under en karaktersynkronisering fra Canvas beregner og tilknytter de fleste SIS-systemer automatisk en opgaves korrekte karakterperiode ved hjælp afforfaldsdatolinjepost. Denne automatiske beregning betyder, atkaraktergivningsperiodelinjeelementet kan udelades eller sendes somnul.
Hvis det kræves af din integration, enkaraktergivningsperiodeLinjeelementet kan konfigureres. Hvis det dog er forkert konfigureret, vil der opstå hyppigere fejl ved synkronisering af karakterer.
Lær mere omOneRoster akademiske sessioner.
Overvejelser vedrørende nyttelast for linjeelementer
Du kan konfigurere linjeelementanmodninger, der skal inkluderes i din GPB-synkroniseringsnyttelast.
Diagrammet nedenfor viser konfigurerbare linjepostanmodninger. Som en del af den individuelle klientkonfigurationsproces kan du tilpasse de fleste af standardværdierne. Du kan også udelade en hvilken som helst af disse værdier fra nyttelasten. Alternativt, hvis de korrelerende data er tilgængelige i Canvas-dataudtrækket, kan du også konfigurere yderligere metadatafelter.
Lær mere om OneRosterdatastruktur for linjepostkategori.
OneRoster LIneItem-feltnavn | Standardværdi |
|---|
kilde-ID
| UUIDv4 |
titel
| {opgave.navn} |
status
| "aktiv" |
beskrivelse
| Importeret fra Canvas:https://school.instructure.com/courses/{course_id}/assignments/{assignment_id} |
resultatVærdiMax
| {opgave.point_mulige} |
resultatVærdiMin
| 0 |
tildel dato
| {assignment.unlock_at} ELLER {assignment.due_at} |
forfaldsdato
| {opgave.afleveringsfrist_på} |
klasse
| {OneRoster-klassereferenceobjekt} |
kategori
| {OneRoster kategorireferenceobjekt} ELLER null* |
karaktergivningsperiode
| null ELLER {OneRoster academicSession referenceobjekt}** |
*seImplementeringsnoter for karaktertilbagekobling for kategorier
**Se implementeringsnoter til tilbagesendelse af karakterer for gradingPeriods**
Eksempel på nyttelastkonfigurationer
Eksempel på nyttelast med SourceID |
|---|
{
"lineItem": {
"sourcedId": "799e2caf-728d-4ef6-8ff9-5325e64cecd5”
"status": "aktiv",
"titel": "Canvas Testopgave 1",
"beskrivelse": "Importeret fra Canvas:https://school.instructure.com/courses/5582/assignments/135”,
"resultatVærdiMax": 10,
"resultatVærdiMin": 0,
"tildelingsdato": "2021-03-10T23:59:59”,
"forfaldsdato": "2021-03-10T23:59:59”,
"metadata": {
"leverandørId": “"
},
"klasse": {
"href": "~/ims/oneroster/v1p1/klasser/100453379”,
"kildeId": "100453379”,
"type": “klasse"
},
"kategori": {
"href": "~/ims/oneroster/v1p1/categories/C5C3AC8C-8D0F-48EB-96F4-31437B640D16”,
"sourcedId": "C5C3AC8C-8D0F-48EB-96F4-31437B640D16”,
"type": “kategori"
},
"gradingPeriod": null
}
} |
Eksempel på nyttelast uden kilde-ID |
|---|
{
"lineItem": {
"status": "aktiv",
"titel": "Canvas Testopgave 1",
"beskrivelse": "Importeret fra Canvas:https://school.instructure.com/courses/5582/assignments/135”,
"resultatVærdiMax": 10,
"resultatVærdiMin": 0,
"tildelingsdato": "2021-03-10T23:59:59”,
"forfaldsdato": "2021-03-10T23:59:59”,
"metadata": {
"leverandørId": “"
},
"klasse": {
"href": "~/ims/oneroster/v1p1/klasser/100453379”,
"kildeId": "100453379”,
"type": “klasse"
},
"kategori": {
"href": "~/ims/oneroster/v1p1/categories/C5C3AC8C-8D0F-48EB-96F4-31437B640D16”,
"sourcedId": "C5C3AC8C-8D0F-48EB-96F4-31437B640D16”,
"type": “kategori"
},
"gradingPeriod": null
}
} |
Overvejelser vedrørende resultatnyttelast
Du kan konfigurere resultatdata, der er inkluderet i din GPB-synkronisering.
Diagrammet nedenfor viser konfigurerbare linjepostanmodninger. Som en del af den individuelle klientkonfigurationsproces kan du tilpasse de fleste af standardværdierne. Du kan også udelade en hvilken som helst af disse værdier fra nyttelasten. Alternativt, hvis de korrelerende data er tilgængelige i Canvas-dataudtrækket, kan du også konfigurere yderligere metadatafelter.
Lær mere om OneRosterresultater.
OneRoster-feltnavn | Standardværdi |
|---|
kilde-ID | {sourcedId} |
linjeelement | {OneRoster lineItem referenceobjekt} |
studerende | {OneRoster-brugerreferenceobjekt} |
scoreStatus | "fuldt bedømt" eller "ikke afleveret" eller "fritaget" |
score | {indsendelse.score} |
kommentar | udeladt som standard* |
scoreDato | udeladt som standard** |
*se implementeringsnoter for karaktertilbagesendelse for kommentarer
**se implementeringsnoter for karaktertilbagesendelse for scoreDate**
Eksempel på nyttelast |
|---|
{
"resultat": {
"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"
},
"studerende": {
"href": "~/ims/oneroster/v1p1/studerende/S100051158”,
"sourcedId": "S100051158",
"type": "studerende"
},
"scoreStatus": "fuldt bedømt",
"score": 10
}
} |
Scorer
I Canvas kan en instruktør tildele negative scoreværdier såvel som overskride den maksimale scoreværdi. Overvej, hvordan din integration vil håndtere disse potentielle situationer.
I visse tilfælde, som f.eks. en fritagetscoreStatus, din integration skal være konfigureret til at overføre ennulscoreværdi, ellers en0Scorværdien sendes til SIS.
scoreStatus-værdi fra Canvas | Noter |
|---|
fuldt graderet |
submission.workflow_state = bedømtSkal altid have en tilknyttet score.
|
ikke indsendt |
indsendelse.mangler = sand
Bestås for det meste kun, hvis der er en tilknyttet score, men det er muligt at have enscore=nul
|
fritaget |
indsendelse.undskyldt = sandScoren vil værenulsom standard eller0
|