När du konfigurerar din Instructure OneRoster-integration, granska överväganden för integrering av betygspassback. Instructure OneRosters integrering av betygspassback (GPB) innehåller variationer av OneRoster-specifikationerna, enligt krav från olika SIS-leverantörer.
Betygskategorier
Beroende på din SIS-betygsbokkonfiguration kan du anpassagetCategoriesfråga för att korrekt synkronisera uppgifter från Canvas till din SIS-betygsbok.
Betygsperioder
Eftersom de flesta SIS-leverantörer automatiskt beräknar betygsperioderna baserat på en uppgifts förfallodatum, kanske du inte behöver inkludera denna slutpunkt i din konfiguration för återkoppling av betyg.
Radpostnyttolast
Du kan konfigurera dina radpostförfrågningar. Läs mer om OneRosterdatastruktur för radartikelkategori.
Resultat nyttolast
Du kan konfigurera dina radpostförfrågningar. Läs mer om OneRosterresultat.
Notera:Instructure är en OneRoster-konsument. För definitioner av OneRoster-konsumenter och leverantörer, seIntroduktion till OneRoster.
Betygskategorier
När Instructure OneRoster-integrationen kör en betygssynkronisering, hämta alla kategorierbegäran returnerar alla betygskategorier i SIS-betygsboken.
Alla betygskategorier som inte inkluderar metadata.klassIdfält betraktas som en global kategori som kan tillämpas och användas i alla klasser.
Globala kategorier
Om din SIS-betygsbok bara stöder globala betygskategorier, bör integrationen fungera korrekt utan metadatafälten.
Kategoriobjekttillägg: metadata.classId
För att OneRoster API v1.1 ska kunna associera kategorier och andra objekt i specifikationen för betygsåterkoppling mer korrekt krävs ett kategorifält.
Tillägget nedan gör det möjligt för integrationen att korrekt identifiera de SIS-betygskategorier som behövs för betygsåterkoppling. Alla kategorier som inte har dettametadata.klassIdfält antas vara globala, och det första kategorinamnet som matchar ett Canvas-tilldelningsgruppnamn används för GPB.
Om du väljer att stödjametadata.klassId, bör du också inkludera en filterfråga förgetCategoriesslutpunkt. Detta gör att integrationen kan hämta kategorier för ett enda avsnitt.
Kategoriobjektutvidgning |
|---|
{
"kategorier": [
{
"status": "aktiv",
"titel": "Utvärderingar",
"sourcedId": "guid",
"href": "URI till resurs i SIS",
"metadata": {
"classId": "{class_id}”
},
"dateLastModified": null
}…
]
} |
Slutpunktsalternativ: getCategoriesForClass
Inför OneRoster API 1.2-specifikationen kan du lägga till stöd för en nyhämta kategorier för klassslutpunkt. Detta gör det möjligt för integrationen att identifiera tillgängliga SIS-betygskategorier för ett avsnitt under en synkronisering av betygsåterkoppling.
Notera:Om du implementerar den här metoden behöver du inte konfigurera stöd förmetadata.klassIdfält.
Inga matchande kategorier
Din Instructure OneRoster-integration kan vara konfigurerad för att synkronisera Canvas-uppgifter till SIS-bedömningskategorier. Om inga matchande kategorier hittas under en betygssynkronisering visas ett felmeddelande som indikerar att inget av SIS-bedömningskategorinamnen matchar Canvas-uppgiftsgruppnamnen.
Standardkategori
Ditt SIS kan innehålla en standardinställningkäll-IDbetygskategori som stöds i alla SIS-betygsböcker. Om en uppgift under en betygssynkronisering från Canvas inte kan matchas med en SIS-betygskategori synkroniseras den med standardbetygskategorin.
Om en gemensam kategorikäll-IDinte är tillgängligt kan detta värde också skickas somnull.
Skickar inte kategorier
Om din institutions SIS stöder betygsböcker utan betygskategorier kan din Instructure OneRoster-integration konfigureras att skicka uppgiftens lineItem JSON utan kategorifältet eller med"kategori": nullIntegrationen kan välja att alltid skickanull, eller bara skickanullom ingen matchande kategori hittas.
Alternativt kan din befintliga integration automatiskt synkronisera okategoriserade uppgiftsradobjekt till SIS-betygsbokens okategoriserade bedömningskategori. Om detta är fallet för din integration kan lärare flytta uppgiften till lämplig SIS-bedömningskategori. För att förhindra att uppgiften synkroniseras om till det okategoriserade fältet bör din integration konfigureras att känna igen den manuellt tilldelade kategorin som ett fast fält.
Åsidosättande kategori
Din institutions SIS-betygsbok kan vara konfigurerad med en alltid använd förvald standardbetygskategori. För att hantera denna konfiguration kan din Instructure OneRoster-integration inkludera en hårdkodad kategori.käll-IDAlla lärarbetygsböcker i ditt SIS måste inkludera den här kategorin. Alternativt kan integrationen konfigureras med en övergripandenullkategorivärde.
Betygsperioder
Under en betygssynkronisering från Canvas beräknar och associerar de flesta SIS automatiskt en uppgifts korrekta betygsperiod med hjälp avförfallodatumradartikel. Denna automatiska beräkning innebär attgraderingsperiodradposten kan utelämnas eller skickas somnull.
Om det krävs av din integration, engraderingsperiodRadposten kan konfigureras. Om den är felaktigt konfigurerad kommer dock betygssynkroniseringsfel att uppstå oftare.
Läs mer omOneRoster akademiska sessioner.
Att tänka på vad gäller nyttolast för radposter
Du kan konfigurera radpostförfrågningar så att de inkluderas i din GPB-synkroniseringsnyttolast.
Diagrammet nedan visar konfigurerbara radpostförfrågningar. Som en del av den individuella klientkonfigurationsprocessen kan du anpassa de flesta standardvärdena. Du kan också utelämna något av dessa värden från nyttolasten. Alternativt, om korrelerande data finns tillgängliga i Canvas-dataextraktet, kan du också konfigurera ytterligare metadatafält.
Läs mer om OneRosterdatastruktur för radartikelkategori.
OneRoster LIneItem-fältnamn | Standardvärde |
|---|
käll-ID
| UUIDv4 |
titel
| {uppgift.namn} |
status
| "aktiv" |
beskrivning
| Importerat från Canvas:https://school.instructure.com/courses/{course_id}/assignments/{assignment_id} |
resultatVärdeMax
| {uppgift.poäng_möjliga} |
resultatVärdeMin
| 0 |
tilldeladatum
| {assignment.unlock_at} ELLER {assignment.due_at} |
förfallodatum
| {uppgift.due_at} |
klass
| {Referensobjekt för OneRoster-klassen} |
kategori
| {Referensobjekt för OneRoster-kategori} ELLER null* |
graderingsperiod
| null ELLER {OneRoster academicSession referensobjekt}** |
*seImplementeringsanteckningar för betygsavsändning för kategorier
**se implementeringsanmärkningar för betygsåterkoppling för gradingPeriods
Exempel på nyttolastkonfigurationer
Nyttolastexempel med SourceID |
|---|
{
"lineItem": {
"sourcedId": "799e2caf-728d-4ef6-8ff9-5325e64cecd5”
"status": "aktiv",
"titel": "Canvas Testuppgift 1",
"beskrivning": "Importerad från Canvas:https://school.instructure.com/courses/5582/assignments/135”,
"resultatVärdeMax": 10,
"resultatVärdeMin": 0,
"tilldelningsdatum": "2021-03-10T23:59:59”,
"förfallodatum": "2021-03-10T23:59:59”,
"metadata": {
"leverantörsId": “"
},
"klass": {
"href": "~/ims/oneroster/v1p1/klasser/100453379”,
"källaId": "100453379”,
"typ": “klass"
},
"kategori": {
"href": "~/ims/oneroster/v1p1/categories/C5C3AC8C-8D0F-48EB-96F4-31437B640D16”,
"sourcedId": "C5C3AC8C-8D0F-48EB-96F4-31437B640D16”,
"type": "kategori"
},
"gradingPeriod": null
}
} |
Nyttolastexempel utan käll-ID |
|---|
{
"lineItem": {
"status": "aktiv",
"titel": "Canvas Testuppgift 1",
"beskrivning": "Importerad från Canvas:https://school.instructure.com/courses/5582/assignments/135”,
"resultatVärdeMax": 10,
"resultatVärdeMin": 0,
"tilldelningsdatum": "2021-03-10T23:59:59”,
"förfallodatum": "2021-03-10T23:59:59”,
"metadata": {
"leverantörsId": “"
},
"klass": {
"href": "~/ims/oneroster/v1p1/klasser/100453379”,
"källaId": "100453379”,
"typ": “klass"
},
"kategori": {
"href": "~/ims/oneroster/v1p1/categories/C5C3AC8C-8D0F-48EB-96F4-31437B640D16”,
"sourcedId": "C5C3AC8C-8D0F-48EB-96F4-31437B640D16”,
"typ": "kategori"
},
"graderingsperiod": null
}
} |
Att beakta vid resultatnyttolast
Du kan konfigurera resultatnyttolaster som ingår i din GPB-synkronisering.
Diagrammet nedan visar konfigurerbara radpostförfrågningar. Som en del av den individuella klientkonfigurationsprocessen kan du anpassa de flesta standardvärdena. Du kan också utelämna något av dessa värden från nyttolasten. Alternativt, om korrelerande data finns tillgängliga i Canvas-dataextraktet, kan du också konfigurera ytterligare metadatafält.
Läs mer om OneRosterresultat.
OneRoster-fältnamn | Standardvärde |
|---|
käll-ID | {sourcedId} |
radobjekt | {OneRoster lineItem-referensobjekt} |
student | {OneRoster användarreferensobjekt} |
poängStatus | "fullständigt betygsatt" eller "ej inlämnad" eller "undantagen" |
göra | {inlämning.poäng} |
kommentar | utelämnad som standard* |
poängdatum | utelämnad som standard** |
*se implementeringsanteckningar för betygsåterkoppling för kommentarer
**se implementeringsanmärkningar för betygsåterkoppling för scoreDate
Exempel på nyttolast |
|---|
{
"resultat": {
"sourcedId": "0031e9ee-5bd0-4d80-a5f7-5c14fe75acc0”,
"lineItem": {
"href": "~/ims/oneroster/v1p1/lineItems/0ea49ae5-4a6b-45d5-a0c2-b01facbfbc5f”,
"sourcedId": "0ea49ae5-4a6b-45d5-a0c2-b01facbfbc5f”,
"typ": “lineItem”
},
"student": {
"href": "~/ims/oneroster/v1p1/studenter/S100051158”,
"sourcedId": "S100051158",
"typ": "student"
},
"scoreStatus": "fullständigt betygsatt",
"poäng": 10
}
} |
Poäng
I Canvas kan en instruktör tilldela negativa poängvärden såväl som att överskrida det maximala poängvärdet. Fundera över hur din integration kommer att hantera dessa potentiella situationer.
I vissa fall, som en undantagenpoängStatus, din integration bör konfigureras för att klara ennullpoängvärde, annars en0Poängvärdet skickas till SIS.
poängstatusvärde från Canvas | Anteckningar |
|---|
helt graderad |
inlämning.arbetsflödesstatus = betygsattBör alltid ha en poäng kopplad.
|
inte inlämnad |
inlämning.saknas = sant
Går oftast bara igenom om det finns en poäng kopplad till den, men det är möjligt att ha enpoäng=null
|
befria |
inlämning.ursäkta = santPoängen kommer att varanullsom standard eller0
|