Hensyn til integrering av tilbakemeldinger fra karakterer

Når du konfigurerer Instructure OneRoster-integrasjonen, bør du gjennomgå hensynene knyttet til integrering av tilbakemeldinger for karakterer. Instructure OneRoster-integrasjonen av tilbakemeldinger for karakterer (GPB) inkluderer variasjoner av OneRoster-spesifikasjonene, slik det kreves av ulike SIS-leverandører.

Vurderingskategorier

Avhengig av konfigurasjonen av karakterboken i SIS, kan du tilpassegetCategoriesspørring for å synkronisere oppgaver riktig fra Canvas til SIS-karakterboken din.

Karakterperioder

Fordi de fleste SIS-leverandører automatisk beregner karakterperioder basert på en oppgaves forfallsdato, trenger du kanskje ikke å inkludere dette endepunktet i konfigurasjonen for tilbakesending av karakterer.

Nyttelast for linjeelement

Du kan konfigurere linjeelementforespørslene dine. Finn ut mer om OneRosterdatastruktur for linjeelementkategori.

Resultater Nyttelast

Du kan konfigurere linjeelementforespørslene dine. Finn ut mer om OneRosterresultater.

Note:Instructure er en OneRoster-forbruker. For definisjoner av OneRoster-forbrukere og -leverandører, seIntroduksjon til OneRoster.

Vurderingskategorier

Når Instructure OneRoster-integrasjonen kjører en karaktersynkronisering, vil hentAlleKategorierForespørselen returnerer alle vurderingskategorier i SIS-karakterboken.

Enhver vurderingskategori som ikke inkluderer metadata.klasseId felt regnes som en global kategori som kan brukes i alle klasser.

Globale kategorier

Hvis SIS-karakterboken din bare støtter globale vurderingskategorier, skal integrasjonen fungere som den skal uten metadatafeltene.

Kategoriobjektutvidelse: metadata.classId

For at OneRoster API v1.1 skal kunne knytte kategorier og andre objekter i spesifikasjonen for tilbakesending av karakterer mer korrekt, kreves et kategorifelt.

Utvidelsen nedenfor lar integrasjonen identifisere riktig hvilke SIS-vurderingskategorier som er nødvendige for tilbakesending av karakterer. Alle kategorier som ikke har dettemetadata.klasseIdfelt antas å være globale, og det første kategorinavnet som samsvarer med et Canvas-oppgavegruppenavn brukes for GPB.

Hvis du velger å støttemetadata.klasseId, bør du også inkludere en filterforespørsel for getCategoriesendepunkt. Dette lar integrasjonen hente kategorier for én enkelt seksjon.

Kategoriobjektutvidelse
{ "kategorier": [ { "status": "aktiv", "tittel": "Vurderinger", "sourcedId": "guid", "href": "URI til ressurs i SIS", "metadata": { "classId": "{class_id}” }, "dateLastModified": null }… ] }

Endepunktsalternativ: getCategoriesForClass

I påvente av OneRoster API 1.2-spesifikasjonen kan du legge til støtte for en nyhentKategorierForKlasseendepunkt. Dette gjør at integrasjonen kan identifisere tilgjengelige SIS-vurderingskategorier for en seksjon under en synkronisering av tilbakesending av karakterer.

Note:Hvis du implementerer denne tilnærmingen, trenger du ikke å konfigurere støtte formetadata.klasseIdfelt.

Ingen samsvarende kategorier

Instructure OneRoster-integrasjonen din kan være konfigurert til å synkronisere Canvas-oppgaver med SIS-vurderingskategorier. Hvis ingen samsvarende kategorier blir funnet under en vurderingssynkronisering, vises en feilmelding som indikerer at ingen av navnene i SIS-vurderingskategorien samsvarer med navnene på Canvas-oppgavegruppene.

Standardkategori

SIS-systemet ditt kan inneholde en standardkilde-IDvurderingskategori som støttes i alle SIS-karakterbøker. Hvis en oppgave ikke kan matches med en SIS-vurderingskategori under en vurderingssynkronisering fra Canvas, synkroniseres den med standard vurderingskategori.

Hvis en vanlig kategorikilde-IDikke er tilgjengelig, kan denne verdien også sendes somnull.

Sender ikke kategorier

Hvis institusjonens SIS støtter karakterbøker uten karakterkategorier, kan Instructure OneRoster-integrasjonen konfigureres til å sende oppgavens lineItem JSON uten kategorifeltet eller med«kategori»: nullIntegrasjonen kan velge å alltid sendenull, eller bare sendnullhvis ingen samsvarende kategori finnes.

Alternativt kan din eksisterende integrasjon automatisk synkronisere ukategoriserte oppgavelinjeelementer med SIS-karakterbokens ukategoriserte vurderingskategori. Hvis dette er tilfelle for din integrasjon, kan instruktører flytte oppgaven til riktig SIS-vurderingskategori. For å forhindre at oppgaven synkroniseres på nytt med det ukategoriserte feltet, bør integrasjonen din konfigureres til å gjenkjenne den manuelt tildelte kategorien som et fast felt.

Overstyrende kategori

Institusjonens SIS-karakterbok kan være konfigurert med en forhåndsvalgt standard vurderingskategori som alltid brukes. For å imøtekomme denne konfigurasjonen kan Instructure OneRoster-integrasjonen inkludere en hardkodet kategori.kilde-IDAlle karakterbøker for lærere i SIS-systemet ditt må inkludere denne kategorien. Alternativt kan integrasjonen konfigureres med en overordnetnullkategoriverdi.

Karakterperioder

Under en karaktersynkronisering fra Canvas beregner og tilknytter de fleste SIS-systemer automatisk en oppgaves korrekte karakterperiode ved hjelp avforfallsdatolinjeelement. Denne automatiske beregningen betyr atgraderingsperiodelinjeelementet kan utelates eller sendes somnull.

Hvis integrasjonen din krever det, engraderingsperiodeLinjeelementet kan konfigureres. Hvis det imidlertid er feil konfigurert, vil synkroniseringsfeil for karakterer oppstå oftere.

Lær mer omOneRoster akademiske økter.

Hensyn til nyttelast for linjeelementer

Du kan konfigurere linjeelementforespørsler som skal inkluderes i GPB-synkroniseringsnyttelasten din.

Diagrammet nedenfor viser konfigurerbare linjeelementforespørsler. Som en del av den individuelle klientkonfigurasjonsprosessen kan du tilpasse de fleste standardverdiene. Du kan også utelate noen av disse verdiene fra nyttelasten. Alternativt, hvis de korrelerende dataene er tilgjengelige i Canvas-datauttrekket, kan du også konfigurere flere metadatafelt.

Lær mer om OneRosterdatastruktur for linjeelementkategori.

Navn på OneRoster LIneItem-felt	Standardverdi
`kilde-ID`	UUIDv4
`tittel`	{oppdrag.navn}
`status`	"aktiv"
`beskrivelse`	Importert fra Canvas:https://school.instructure.com/courses/{course_id}/assignments/{assignment_id}
`resultatVerdiMaks`	{oppdrag.poeng_mulig}
`resultatVerdiMin`	0
`tildel dato`	{assignment.unlock_at} ELLER {assignment.due_at}
`forfallsdato`	{oppgave.forfaller_på}
`klasse`	{Referanseobjekt for OneRoster-klasse}
`kategori`	{Referanseobjekt for OneRoster-kategori} ELLER null*
`graderingsperiode`	null ELLER {OneRoster academicSession referanseobjekt}**

*seImplementeringsnotater for tilbakesending av karakterer for kategorier

**se implementeringsnotater for tilbakesending av karakterer for gradingPeriods**

Eksempel på nyttelastkonfigurasjoner

Eksempel på nyttelast med SourceID

{
"lineItem": {
"sourcedId": "799e2caf-728d-4ef6-8ff9-5325e64cecd5”
"status": "aktiv",
"tittel": "Canvas Testoppgave 1",
"beskrivelse": "Importert fra Canvas:https://school.instructure.com/courses/5582/assignments/135”,
"resultatVerdiMax": 10,
"resultatVerdiMin": 0,
"tildelingsdato": "2021-03-10T23:59:59",
"forfallsdato": "2021-03-10T23:59:59",
"metadata": {
"leverandør-ID": “"
},
"klasse": {
"href": "~/ims/oneroster/v1p1/klasser/100453379",
"kilde-ID": "100453379",
"type": “klasse"
},
"kategori": {
"href": "~/ims/oneroster/v1p1/categories/C5C3AC8C-8D0F-48EB-96F4-31437B640D16",
"sourcedId": "C5C3AC8C-8D0F-48EB-96F4-31437B640D16",
"type": “kategori"
},
"graderingsperiode": null
}
}

Eksempel på nyttelast uten kilde-ID

{
"lineItem": {
"status": "aktiv",
"tittel": "Canvas Testoppgave 1",
"beskrivelse": "Importert fra Canvas:https://school.instructure.com/courses/5582/assignments/135”,
"resultatVerdiMax": 10,
"resultatVerdiMin": 0,
"tildelingsdato": "2021-03-10T23:59:59",
"forfallsdato": "2021-03-10T23:59:59",
"metadata": {
"leverandør-ID": “"
},
"klasse": {
"href": "~/ims/oneroster/v1p1/klasser/100453379",
"kilde-ID": "100453379",
"type": “klasse"
},
"kategori": {
"href": "~/ims/oneroster/v1p1/categories/C5C3AC8C-8D0F-48EB-96F4-31437B640D16",
"sourcedId": "C5C3AC8C-8D0F-48EB-96F4-31437B640D16",
"type": “kategori"
},
"graderingsperiode": null
}
}

Hensyn knyttet til resultatnyttelast

Du kan konfigurere resultatnyttelaster som er inkludert i GPB-synkroniseringen din.

Lær mer om OneRosterresultater.

OneRoster-feltnavn	Standardverdi
kilde-ID	{kilde-ID}
linjeelement	{OneRoster lineItem referanseobjekt}
student	{OneRoster-brukerreferanseobjekt}
poengsumStatus	«fullstendig karaktergitt» eller «ikke levert» eller «fritatt»
poengsum	{innsending.poengsum}
kommentar	utelatt som standard*
poengsumDato	utelatt som standard**

*se implementeringsnotater for tilbakesending av karakterer for kommentarer

**se implementeringsnotater for tilbakesending av karakterer for scoreDate

Eksempel på nyttelast

{
"resultat": {
"kildekode": "0031e9ee-5bd0-4d80-a5f7-5c14fe75acc0”,
"linjeelement": {
"href": "~/ims/oneroster/v1p1/linjeelementer/0ea49ae5-4a6b-45d5-a0c2-b01facbfbc5f”,
"kildekode": "0ea49ae5-4a6b-45d5-a0c2-b01facbfbc5f”,
"type": “linjeelement"
},
"student": {
"href": "~/ims/oneroster/v1p1/studenter/S100051158”,
"sourcedId": "S100051158",
"type": “student"
},
"scoreStatus": "fullstendig karaktergitt",
"score": 10
}
}

Poengsummer

I Canvas kan en instruktør tildele negative poengsummer samt overskride den maksimale poengsummen. Vurder hvordan integrasjonen din vil håndtere disse potensielle situasjonene.

I visse tilfeller, som en fritaksordningpoengsumStatus, bør integrasjonen din være konfigurert til å sende ennullpoengsumverdi, ellers en0Poengverdien sendes til SIS.

ScoreStatus-verdi fra Canvas	Notater
fullt gradert	`innsending.arbeidsflytstatus = vurdert`Bør alltid ha en poengsum tilknyttet.
ikke sendt inn	`innsending.mangler = sann` Vil stort sett bare bestå hvis det er en poengsum knyttet til det, men det er mulig å ha en`poengsum=null`
fritatt	`innsending.unnskyldt = sann`Poengsummen vil være`null`som standard eller`0`

Help make the guides even better!

Have a suggestion, spot a typo, or notice something outdated? Sign in and let us know!

Child Item