Bei der Konfiguration Ihrer Instructure OneRoster-Integration sollten Sie die Aspekte der Notenrückgabeintegration berücksichtigen. Die Instructure OneRoster-Notenrückgabeintegration (GPB) umfasst Variationen der OneRoster-Spezifikationen, die von verschiedenen SIS-Anbietern gefordert werden.
Bewertungskategorien
Je nach Konfiguration Ihres SIS-Notenbuchs können Sie dieKategorien abrufenAbfrage zur korrekten Synchronisierung von Aufgaben von Canvas mit Ihrem SIS-Notenbuch.
Bewertungszeiträume
Da die meisten SIS-Anbieter die Bewertungszeiträume automatisch auf Basis des Fälligkeitsdatums einer Aufgabe berechnen, müssen Sie diesen Endpunkt möglicherweise nicht in Ihre Notenrückmeldekonfiguration aufnehmen.
LineItem Payload
Sie können Ihre Positionsanforderungen konfigurieren. Erfahren Sie mehr über OneRoster.Datenstruktur der Positionskategorie.
Ergebnisse Nutzlast
Sie können Ihre Positionsanforderungen konfigurieren. Erfahren Sie mehr über OneRoster.ErgebnisseDie
Notiz:Instructure ist ein OneRoster-Nutzer. Definitionen von OneRoster-Nutzern und -Anbietern finden Sie hier:Einführung in OneRosterDie
Bewertungskategorien
Wenn die Instructure OneRoster-Integration eine Notensynchronisierung durchführt,getAllCategoriesDie Anfrage gibt alle SIS-Notenbuch-Bewertungskategorien zurück.
Jede Bewertungskategorie, die nicht die metadata.classIdDas Feld wird als globale Kategorie betrachtet, die in allen Klassen angewendet und verwendet werden kann.
Globale Kategorien
Wenn Ihr SIS-Notenbuch nur globale Bewertungskategorien unterstützt, sollte die Integration auch ohne die Metadatenfelder ordnungsgemäß funktionieren.
Kategorieobjekterweiterung: metadata.classId
Um der OneRoster API v1.1 eine korrektere Zuordnung von Kategorien und anderen Objekten in der Notenrückgabespezifikation zu ermöglichen, ist ein Kategoriefeld erforderlich.
Die untenstehende Erweiterung ermöglicht es der Integration, die für die Notenrückmeldung benötigten SIS-Bewertungskategorien korrekt zu identifizieren. Alle Kategorien, die diese nicht aufweisen,metadata.classIdEs wird davon ausgegangen, dass alle Felder global sind, und für GPB wird der erste Kategoriename verwendet, der mit einem Canvas-Aufgabengruppennamen übereinstimmt.
Wenn Sie sich entscheiden, zu unterstützenmetadata.classIdSie sollten auch eine Filterabfrage für die einschließen.Kategorien abrufenEndpunkt. Dadurch kann die Integration Kategorien für einen einzelnen Abschnitt abrufen.
Kategorieobjekterweiterung |
|---|
{
"categories": [
{
"status": "aktiv",
"title": "Bewertungen",
"sourcedId": "guid",
"href": "URI zur Ressource im SIS",
"metadata": {
"classId": "{class_id}"
},
"dateLastModified": null
}…
]
} |
Endpunktoption: getCategoriesForClass
In Erwartung der OneRoster API 1.2-Spezifikation können Sie Unterstützung für eine neue Funktion hinzufügen.getCategoriesForClassEndpunkt. Dies ermöglicht es der Integration, während einer Notenrückmeldung die verfügbaren SIS-Bewertungskategorien für einen Abschnitt zu identifizieren.
Notiz:Wenn Sie diesen Ansatz implementieren, müssen Sie die Unterstützung für diemetadata.classId Feld.
Keine passenden Kategorien
Ihre Instructure OneRoster-Integration ist möglicherweise so konfiguriert, dass Canvas-Aufgaben mit SIS-Bewertungskategorien synchronisiert werden. Wenn während einer Notensynchronisierung keine übereinstimmenden Kategorien gefunden werden, wird eine Fehlermeldung angezeigt, die darauf hinweist, dass keiner der SIS-Bewertungskategorienamen mit dem Namen der Canvas-Aufgabengruppe übereinstimmt.
Standardkategorie
Ihr SIS kann eine Standardeinstellung enthalten.sourcedIdEine Bewertungskategorie, die in allen SIS-Notenbüchern unterstützt wird. Wenn bei einer Notensynchronisierung von Canvas eine Aufgabe keiner SIS-Bewertungskategorie zugeordnet werden kann, wird sie mit der Standardbewertungskategorie synchronisiert.
Wenn eine gemeinsame KategoriesourcedIdist nicht verfügbar, dieser Wert kann auch gesendet werden alsnullDie
Kategorien werden nicht gesendet
Wenn das Studierendeninformationssystem (SIS) Ihrer Institution Notenbücher ohne Bewertungskategorien unterstützt, kann Ihre Instructure OneRoster-Integration so konfiguriert werden, dass die JSON-Datei der Aufgabenzeile ohne das Kategoriefeld oder mit diesem Feld gesendet wird.„Kategorie“: nullDie Integration kann so eingestellt werden, dass sie immer sendetnulloder senden Sie nurnull wenn keine passende Kategorie gefunden wird.
Alternativ kann Ihre bestehende Integration nicht kategorisierte Aufgabenpositionen automatisch mit der Kategorie „Nicht kategorisiert“ im SIS-Notenbuch synchronisieren. In diesem Fall können Dozenten die Aufgabe in die entsprechende SIS-Kategorie verschieben. Um zu verhindern, dass die Aufgabe erneut in das Feld „Nicht kategorisiert“ verschoben wird, sollte Ihre Integration so konfiguriert sein, dass die manuell zugewiesene Kategorie als fixiertes Feld erkannt wird.
Überschreibende Kategorie
Das Notenbuch Ihres Institutions-SIS ist möglicherweise mit einer immer verwendeten, voreingestellten Standard-Notenkategorie konfiguriert. Um diese Konfiguration zu berücksichtigen, kann Ihre Instructure OneRoster-Integration eine fest codierte Kategorie enthalten.sourcedIdAlle Dozenten-Notenbücher in Ihrem Studierendeninformationssystem müssen diese Kategorie enthalten. Alternativ kann die Integration mit einer überschreibenden Einstellung konfiguriert werden.nullKategoriewert.
Bewertungszeiträume
Bei einer Notensynchronisierung von Canvas berechnen und ordnen die meisten Studierendeninformationssysteme (SIS) automatisch den korrekten Bewertungszeitraum einer Aufgabe zu.FälligkeitsdatumPosition. Diese automatische Berechnung bedeutet, dass dieBewertungszeitraumDer Zeilenposten kann weggelassen oder alsnullDie
Falls dies für Ihre Integration erforderlich ist, einBewertungszeitraumDie Position „lineitem“ kann konfiguriert werden. Bei einer fehlerhaften Konfiguration treten jedoch häufiger Fehler bei der Notensynchronisierung auf.
Erfahren Sie mehr überOneRoster-AkademiesitzungenDie
Überlegungen zur Nutzlast einzelner Positionen
Sie können die Anforderung von Einzelposten so konfigurieren, dass sie in Ihre GPB-Synchronisierungsnutzlast aufgenommen wird.
Die folgende Tabelle zeigt konfigurierbare Zeilenpositionsanforderungen. Im Rahmen der individuellen Clientkonfiguration können Sie die meisten Standardwerte anpassen. Sie können auch einzelne Werte aus der Nutzlast entfernen. Alternativ können Sie, sofern die zugehörigen Daten im Canvas-Datenextrakt verfügbar sind, zusätzliche Metadatenfelder konfigurieren.
Erfahren Sie mehr über OneRosterDatenstruktur der PositionskategorieDie
OneRoster LineItem Feldname | Standardwert |
|---|
sourcedId
| UUIDv4 |
Titel
| {assignment.name} |
Status
| "aktiv" |
Beschreibung
| Importiert von Canvas:https://school.instructure.com/courses/{course_id}/assignments/{assignment_id} |
ErgebniswertMax
| {assignment.points_possible} |
ErgebniswertMin
| 0 |
Datum zuweisen
| {assignment.unlock_at} ODER {assignment.due_at} |
Fälligkeitsdatum
| {assignment.due_at} |
Klasse
| {OneRoster-Klassenreferenzobjekt} |
Kategorie
| {OneRoster-Kategoriereferenzobjekt} ODER null* |
Bewertungszeitraum
| null ODER {OneRoster academicSession-Referenzobjekt}** |
*sehen Hinweise zur Umsetzung der Notenrückgabe für Kategorien
**Siehe Hinweise zur Implementierung der Notenrückgabe für Bewertungszeiträume**
Beispielhafte Nutzlastkonfigurationen
Payload-Beispiel mit SourceID |
|---|
{
"lineItem": {
"sourcedId": "799e2caf-728d-4ef6-8ff9-5325e64cecd5”
"status": "aktiv",
"title": "Canvas-Testaufgabe 1",
"description": "Importiert von 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
}
} |
Payload-Beispiel ohne SourceID |
|---|
{
"lineItem": {
"status": "aktiv",
"title": "Canvas-Testaufgabe 1",
"description": "Importiert von 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
}
} |
Überlegungen zur Nutzlast
Sie können die in Ihrer GPB-Synchronisierung enthaltenen Ergebnisnutzdaten konfigurieren.
Die folgende Tabelle zeigt konfigurierbare Zeilenpositionsanforderungen. Im Rahmen der individuellen Clientkonfiguration können Sie die meisten Standardwerte anpassen. Sie können auch einzelne Werte aus der Nutzlast entfernen. Alternativ können Sie, sofern die zugehörigen Daten im Canvas-Datenextrakt verfügbar sind, zusätzliche Metadatenfelder konfigurieren.
Erfahren Sie mehr über OneRosterErgebnisseDie
OneRoster-Feldname | Standardwert |
|---|
sourcedId | {sourcedId} |
Positionsartikel | {OneRoster lineItem-Referenzobjekt} |
Student | {OneRoster-Benutzerreferenzobjekt} |
Ergebnisstatus | „vollständig bewertet“ oder „nicht eingereicht“ oder „befreit“ |
Punktzahl | {submission.score} |
Kommentar | Standardmäßig ausgelassen* |
Ergebnisdatum | Standardmäßig ausgelassen** |
*Siehe Hinweise zur Implementierung der Notenrückgabe für Kommentare.
**Siehe Hinweise zur Implementierung der Notenrückgabe für scoreDate
Nutzlastbeispiel |
|---|
{
"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": "vollständig bewertet",
"score": 10
}
} |
Ergebnisse
In Canvas können Dozenten sowohl negative Punktzahlen vergeben als auch die maximale Punktzahl überschreiten. Überlegen Sie, wie Ihre Integration mit diesen möglichen Situationen umgehen wird.
In bestimmten Fällen, wie z. B. bei einer BefreiungErgebnisstatusIhre Integration sollte so konfiguriert sein, dass sie einnullPunktzahl, andernfalls ein0Der Score-Wert wird an das SIS übergeben.
scoreStatus-Wert aus Canvas | Anmerkungen |
|---|
vollständig bewertet |
submission.workflow_state = bewertetSollte immer eine Punktzahl zugeordnet sein.
|
nicht eingereicht |
submission.missing = trueMeistens wird die Prüfung nur bestanden, wenn eine Punktzahl zugeordnet ist, aber es ist möglich, dass einePunktzahl=null
|
befreit |
submission.excused = trueDas Ergebnis wird seinnullstandardmäßig oder0
|