Bij het configureren van uw Instructure OneRoster-integratie dient u rekening te houden met de overwegingen met betrekking tot de grade passback-integratie. De Instructure OneRoster grade passback (GPB)-integratie omvat varianten van de OneRoster-specificaties, zoals vereist door verschillende SIS-leveranciers.
Beoordelingscategorieën
Afhankelijk van de configuratie van uw SIS-cijferlijst kunt u de volgende instellingen aanpassen:getCategoriesDeze query zorgt ervoor dat opdrachten correct worden gesynchroniseerd van Canvas naar uw SIS-cijferboek.
Beoordelingsperioden
Omdat de meeste SIS-aanbieders de beoordelingsperioden automatisch berekenen op basis van de inleverdatum van een opdracht, hoeft u dit eindpunt mogelijk niet in uw configuratie voor het terugsturen van cijfers op te nemen.
Regelitem Payload
U kunt uw regelitemverzoeken configureren. Lees meer over OneRoster.regelitem categorie datastructuur.
Resultaten Payload
U kunt uw regelitemverzoeken configureren. Lees meer over OneRoster.resultaten.
Opmerking:Instructure is een OneRoster-consument. Voor definities van OneRoster-consumenten en -providers, zie deIntroductie tot OneRoster.
Beoordelingscategorieën
Wanneer de Instructure OneRoster-integratie een cijfersynchronisatie uitvoert, gebeurt er het volgende:getAllCategoriesDe aanvraag retourneert alle beoordelingscategorieën van het SIS-cijferboek.
Elke beoordelingscategorie die de volgende niet omvat:metadata.classIdHet veld wordt beschouwd als een globale categorie die in alle klassen kan worden toegepast en gebruikt.
Wereldwijde categorieën
Als uw SIS-cijferboek alleen globale beoordelingscategorieën ondersteunt, zou de integratie correct moeten werken zonder de metadatavelden.
Uitbreiding van categorieobjecten: metadata.classId
Om ervoor te zorgen dat de OneRoster API v1.1 categorieën en andere objecten in de cijferterugkoppeling correcter aan elkaar kan koppelen, is een categorieveld vereist.
De onderstaande extensie zorgt ervoor dat de integratie de SIS-beoordelingscategorieën correct kan identificeren die nodig zijn voor het terugkoppelen van cijfers. Categorieën die deze extensie niet hebben, worden niet correct herkend.metadata.classIdEr wordt aangenomen dat velden globaal zijn, en de eerste categorienaam die overeenkomt met een Canvas-opdrachtgroepnaam wordt gebruikt voor GPB.
Als u ervoor kiest om te steunenmetadata.classIdJe moet ook een filterquery toevoegen voor degetCategorieseindpunt. Dit maakt het voor de integratie mogelijk om categorieën voor een enkele sectie op te halen.
Categorie Object Uitbreiding |
|---|
{
"categorieën": [
{
"status": "actief",
"titel": "Beoordelingen",
"sourcedId": "guid",
"href": "URI naar bron in SIS",
"metadata": {
"classId": "{class_id}"
},
"laatst gewijzigd": null
}…
]
} |
Eindpuntoptie: getCategoriesForClass
In afwachting van de OneRoster API 1.2-specificatie kunt u ondersteuning toevoegen voor een nieuwe functionaliteit.getCategoriesForClasseindpunt. Dit maakt het voor de integratie mogelijk om tijdens een synchronisatie van cijferterugkoppeling de beschikbare SIS-beoordelingscategorieën voor een sectie te identificeren.
Opmerking:Als u deze aanpak implementeert, hoeft u geen ondersteuning voor de te configureren.metadata.classId veld.
Geen overeenkomende categorieën gevonden
Uw Instructure OneRoster-integratie kan zo geconfigureerd zijn dat Canvas-opdrachten worden gesynchroniseerd met SIS-cijfercategorieën. Als er tijdens een cijfersynchronisatie geen overeenkomende categorieën worden gevonden, wordt een foutmelding weergegeven die aangeeft dat geen van de SIS-cijfercategorienamen overeenkomt met de Canvas-opdrachtgroepnamen.
Standaardcategorie
Uw SIS kan een standaardwaarde bevatten.sourcedIdEen beoordelingscategorie die wordt ondersteund in alle SIS-cijferboeken. Als een opdracht tijdens een synchronisatie vanuit Canvas niet kan worden gekoppeld aan een SIS-beoordelingscategorie, wordt deze gesynchroniseerd met de standaardbeoordelingscategorie.
Als het een gemeenschappelijke categorie betreftsourcedIdis niet beschikbaar, deze waarde kan ook worden verzonden alsnull.
Categorieën niet verzenden
Als het SIS van uw instelling cijferlijsten zonder beoordelingscategorieën ondersteunt, kan uw Instructure OneRoster-integratie worden geconfigureerd om de lineItem JSON van de opdracht te verzenden zonder het categorieveld of mét“categorie”: nullDe integratie kan ervoor kiezen om altijd te verzenden.null, of alleen verzendennullals er geen overeenkomende categorie wordt gevonden.
Als alternatief kan uw bestaande integratie ongecategoriseerde opdrachtregels automatisch synchroniseren met de ongecategoriseerde beoordelingscategorie in het SIS-cijferboek. In dat geval kunnen docenten de opdracht naar de juiste SIS-beoordelingscategorie verplaatsen. Om te voorkomen dat de opdracht opnieuw naar het ongecategoriseerde veld wordt gesynchroniseerd, moet uw integratie zo worden geconfigureerd dat de handmatig toegewezen categorie als een vast veld wordt herkend.
Voorrangscategorie
Het SIS-cijferboek van uw instelling is mogelijk geconfigureerd met een altijd gebruikte, vooraf geselecteerde standaardbeoordelingscategorie. Om deze configuratie te ondersteunen, kan uw Instructure OneRoster-integratie een vastgelegde categorie bevatten.sourcedIdAlle cijferlijsten van docenten in uw SIS moeten deze categorie bevatten. Als alternatief kan de integratie worden geconfigureerd met een overschrijvende instelling.nullcategoriewaarde.
Beoordelingsperioden
Tijdens het synchroniseren van cijfers vanuit Canvas berekenen en koppelen de meeste SIS-systemen automatisch de juiste beoordelingsperiode aan een opdracht.deadlineregelitem. Deze automatische berekening betekent dat debeoordelingsperioderegelitem kan worden weggelaten of verzonden alsnull.
Indien vereist door uw integratie, eenbeoordelingsperiodeDe regelitems kunnen worden geconfigureerd. Als ze echter onjuist zijn geconfigureerd, zullen er vaker synchronisatiefouten met de cijfers optreden.
Leer meer overOneRoster academische sessies.
Overwegingen met betrekking tot de laadcapaciteit van de afzonderlijke posten
U kunt regelitemverzoeken configureren die u in uw GPB-synchronisatiepayload wilt opnemen.
Onderstaande grafiek toont configureerbare regelitemverzoeken. Als onderdeel van het individuele clientconfiguratieproces kunt u de meeste standaardwaarden aanpassen. U kunt ook een of meer van deze waarden uit de payload weglaten. Als de bijbehorende gegevens beschikbaar zijn in de Canvas-gegevensextractie, kunt u bovendien extra metadatavelden configureren.
Leer meer over OneRoster.regelitem categorie datastructuur.
OneRoster LineItem Veldnaam | Standaardwaarde |
|---|
sourcedId
| UUIDv4 |
titel
| {assignment.name} |
status
| "actief" |
beschrijving
| Geïmporteerd vanuit Canvas:https://school.instructure.com/courses/{course_id}/assignments/{assignment_id} |
resultaatWaardeMax
| {assignment.points_possible} |
resultaatWaardeMin
| 0 |
toewijzingsdatum
| {assignment.unlock_at} OF {assignment.due_at} |
deadline
| {opdracht_vervaldatum} |
klas
| {OneRoster klasse referentieobject} |
categorie
| {OneRoster categorie referentieobject} OF null* |
beoordelingsperiode
| null OF {OneRoster academicSession referentieobject}** |
*zien Implementatie-instructies voor het teruggeven van cijfers voor categorieën
**Zie de implementatie-instructies voor het teruggeven van cijfers voor gradingPeriods**
Voorbeelden van payloadconfiguraties
Payloadvoorbeeld met SourceID |
|---|
{
"lineItem": {
"sourcedId": "799e2caf-728d-4ef6-8ff9-5325e64cecd5"
"status": "actief",
"title": "Canvas Testopdracht 1",
"description": "Geïmporteerd vanuit 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
}
} |
Payloadvoorbeeld zonder SourceID |
|---|
{
"lineItem": {
"status": "actief",
"title": "Canvas Testopdracht 1",
"description": "Geïmporteerd vanuit 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"
},
"categorie": {
"href": "~/ims/oneroster/v1p1/categories/C5C3AC8C-8D0F-48EB-96F4-31437B640D16”,
"sourcedId": "C5C3AC8C-8D0F-48EB-96F4-31437B640D16”,
"type": "categorie"
},
"beoordelingsperiode": null
}
} |
Overwegingen met betrekking tot de resultaatpayload
U kunt de resultaatpayloads configureren die in uw GPB-synchronisatie worden opgenomen.
Onderstaande grafiek toont configureerbare regelitemverzoeken. Als onderdeel van het individuele clientconfiguratieproces kunt u de meeste standaardwaarden aanpassen. U kunt ook een of meer van deze waarden uit de payload weglaten. Als de bijbehorende gegevens beschikbaar zijn in de Canvas-gegevensextractie, kunt u bovendien extra metadatavelden configureren.
Leer meer over OneRoster.resultaten.
OneRoster-veldnaam | Standaardwaarde |
|---|
sourcedId | {sourcedId} |
regelitem | {OneRoster lineItem referentieobject} |
student | {OneRoster gebruikersreferentieobject} |
scoreStatus | "volledig beoordeeld" of "niet ingediend" of "vrijgesteld" |
score | {inzending.score} |
opmerking | standaard weggelaten* |
scoreDatum | standaard weggelaten** |
*Zie de implementatie-instructies voor het doorgeven van cijfers voor opmerkingen.
**Zie de implementatie-instructies voor het doorgeven van cijfers voor scoreDate**
Voorbeeld van een payload |
|---|
{
"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": "volledig beoordeeld",
"score": 10
}
} |
Scores
In Canvas kan een docent negatieve punten toekennen en de maximale score overschrijden. Bedenk hoe uw integratie met deze mogelijke situaties omgaat.
In bepaalde gevallen, zoals bij een vrijstelling,scoreStatusUw integratie moet zo geconfigureerd zijn dat deze een parameter doorgeeft.nullscorewaarde, anders een0De scorewaarde wordt doorgegeven aan het SIS.
scoreStatus-waarde uit Canvas | Notities |
|---|
volledig beoordeeld |
inzending.workflow_status = beoordeeldEr moet altijd een score aan verbonden zijn.
|
niet ingediend |
inzending ontbreekt = waarMeestal slagen ze alleen als er een score aan verbonden is, maar het is mogelijk om eenscore=null
|
vrijstellen |
indiening.gevrijwaard = waarDe score zal zijnnullstandaard of0
|