Wie formatiere ich CSV-Textdateien zum Hochladen von SIS-Daten in ein Canvas-Konto?

In Canvas können Sie über die Admin-Oberfläche Benutzer*innen, Konten, Semester, Kurse, Abschnitte, Einschreibungen und Anmeldungen manuell erstellen.

Dieses Dokument verweist auf die Seite CSV-Format-API für SIS-Importe, auf der sich der Großteil der CSV-Informationen befindet. Jede CSV-Datei steht in Zusammenhang mit einer anderen und teilt Canvas mit, wie alle Informationen für das Konto zu verwalten sind. Sehen Sie sich das SIS-Beziehungsdiagramm an.

Jeder Schritt in dieser Lektion enthält Beispiel-CSV-Dateien mit Beschreibungen der einzelnen erforderlichen und optionalen Felder. Sie finden auch einen Link zum Herunterladen jeder Datei, wenn Sie sich die Formatierung genauer ansehen möchten. Laden Sie eine ZIP-Datei mit allen Beispieldateien herunter. Wenn die CSV-Dateien nicht über die Links heruntergeladen werden können, versuchen Sie, den Link in einer neuen Registerkarte zu öffnen.

Sie sollten den Import von Daten in Ihrer Canvas-Testumgebung üben, bevor Sie Inhalte in Ihre Produktionsumgebung importieren.

CSV-Dateiformat

Um Daten in großen Mengen in Canvas hochzuladen, müssen Sie eine oder mehrere CSV-Textdateien erstellen.  CSV-Dateien können mit vielen Programmen erstellt werden. Studenteninformationssysteme (SIS) verfügen häufig über eine Methode zur Erstellung von Berichten im CSV-Format, die an das von Canvas benötigte Format angepasst werden kann. Wenn Sie nicht wissen, wie Sie eine Datei im CSV-Format speichern, sehen Sie bitte in der Dokumentation des Programms nach, mit dem Sie Ihre CSV-Dateien erstellen (z. B. Excel).

Wenn Sie das Instructure-Format für den Import von Dateien auf der Seite SIS-Import verwenden, können Sie eine einzelne CSV-Textdatei importieren oder mehrere Dateien in einer einzigen ZIP-Datei komprimieren, um Daten in großen Mengen zu importieren. Wenn Sie einzelne Dateien manuell hochladen, müssen die Dateien in der in dieser Lektion gezeigten Reihenfolge hochgeladen werden.

CSV-Feldformatierung

Die erste Zeile Ihrer CSV-Datei (Kopfzeile) muss den vollständigen Feldnamen für jede Datei enthalten. Die Reihenfolge der Spalten spielt keine Rolle, aber die richtige Reihenfolge der Zeilen ist für Dateien wie „accounts.csv“ entscheidend.

Unveränderliche Felder

Standardmäßig werden bestimmte Änderungen, die von Benutzer*innen vorgenommen werden, von zukünftigen SIS-Importen nicht überschrieben. Diese sind als „sticky“ gekennzeichnet. Alle „sticky“-Felder sind in diesem Dokument aufgeführt. Sie können diese Felder überschreiben, indem Sie override_sis_stickiness in der API festlegen oder das Kontrollkästchen „UI-Änderungen außer Kraft setzen“ auf der Seite SIS-Import aktivieren.

API-Dokumentation

CSV-Dateien enthalten nur eine bestimmte Anzahl von Feldern. Canvas enthält zusätzliche Werte, die über jede einzelne API verfügbar sind. Nachdem Sie die CSV-Dateien für Ihre Institution ausgeführt haben, ist es bei den meisten Institutionen üblich, alle SIS-CSV-Dateien hochzuladen und dann die Canvas-API zu verwenden, um alle Konto- und Kursattribute zu aktualisieren. Weitere Informationen finden Sie in der Canvas-API-Dokumentation für Benutzer*innen, Konten, Semester, Kurse, Abschnitte, Einschreibungen und Gruppen. SIS-Importe können auch über die SIS-Import-API verwaltet werden.

users.csv

Benutzer*innen sind Personen, die über Benutzerkonten innerhalb einer Institution verfügen. Die Datei „users.csv“ fügt Personen als generische Benutzer*innen in das System ein. Die Datei „enrollments.csv“ weist diesen Benutzer*innen eine Rolle zu (Lehrende, Studierende, usw.) Wenn ein Benutzerkonto gelöscht wird, werden auch alle damit verbundenen Einschreibungen gelöscht und die Person kann sich nicht mehr bei ihrem Canvas-Konto anmelden. Wenn Sie möchten, dass sich die Person weiterhin einloggen, aber nicht mehr teilnehmen kann, oder wenn Sie sie nur aus einem bestimmten Kurs löschen möchten, dann sollten Sie ihr Benutzerkonto aktiv lassen und ihre Einschreibung (in der Datei „enrollments.csv“) auf abgeschlossen bzw. gelöscht ändern.

Laden Sie die Beispieldatei „users.csv“ mit 10 Benutzer*innen von Canvas herunter.

Erforderliches Feld* | Sticky Field^

  • user_id*: Dies ist ein eindeutiger Wert, der zur Identifizierung von Personen mit einem Konto in Canvas verwendet wird. Dieser Wert darf sich nicht ändern und muss für alle Benutzer*innen eindeutig sein. In der Benutzeroberfläche wird dies als SIS-ID bezeichnet, die aus einer beliebigen Kombination von Zeichen bestehen kann. Sie finden diese SIS-ID, indem Sie ein beliebiges Benutzerkonto aufrufen und sich dessen Anmeldeinformationen ansehen.
  • integration_id: Dies ist eine zweite eindeutige Kennung, die für komplexere SIS-Integrationen nützlich ist. Diese Kennung darf sich für die Person nicht ändern und muss dateiübergreifend eindeutig sein.
  • login_id*^Dies ist der Benutzername, mit sich eine Person bei Canvas anmeldet. Wenn Sie einen Authentifizierungsdienst konfiguriert haben (z. B. LDAP), stimmt dieser in der Regel mit dem Benutzernamen im Remote-System überein. Die „login_id“ kann Buchstaben, Zahlen oder die folgenden Symbole enthalten:  - _ = + . @
  • password:  Wenn das Konto für die Verwendung von LDAP oder eines SSO-Protokolls konfiguriert ist, ist dies nicht erforderlich. Andernfalls ist dies das Kennwort für die obige „login_id“. Dieses Kennwort muss mindestens 8 Zeichen lang sein.
  • ssha_password: Anstelle eines Klartext-Kennworts können Sie in diesem Feld auch ein vorgehashtes Kennwort angeben, das mit dem Generierungsschema für SSHA-Kennwörter erstellt wurde. Das ist zwar besser als ein Klartext-Kennwort, aber Sie sollten Benutzer*innen trotzdem dazu anhalten, ihr Passwort nach der ersten Anmeldung zu ändern. Erfahren Sie, wie Sie SSHA-Kennwörter generieren können.
  • authentication_provider_id: Dies ist der Authentifizierungsanbieter, mit dem die Anmeldung verknüpft ist. Logins, die mit einem bestimmten Anbieter verbunden sind, können nur mit diesem Anbieter verwendet werden. Ältere Anbieter (LDAP, CAS, SAML) suchen nach Logins, die mit ihnen verknüpft sind, oder nach nicht verknüpften Logins. Neue Anbieter suchen nur nach Logins, die explizit mit ihnen verknüpft sind. Dies kann die ganzzahlige ID oder der Typ des Anbieters sein (in letzterem Fall wird nach dem ersten übereinstimmenden Anbieter gesucht).  
  • first_name^:  Dies ist der Vorname der Benutzerin bzw. des Benutzers. Falls vorhanden, wird er verwendet, um „full_name“ und/oder „sortable_name“ zu erstellen.
  • last_name^:  Dies ist der Nachname der Benutzerin bzw. des Benutzers. Falls vorhanden, wird er verwendet, um „full_name“ und/oder „sortable_name“ zu erstellen.
  • full_name^: Dies ist sowohl der Vor- als auch der Nachname der Benutzerin bzw. des Benutzers. Lassen Sie „first_name“ und „last_name“ weg, wenn dies angegeben wird.
  • sortable_name^: Dies ist die Option für den sortierbaren Namen in Canvas, der normalerweise aus dem Namen der Benutzerin bzw. des Benutzers abgeleitet wird, aber angepasst werden kann.
  • short_name^: Dies ist der Anzeigename der Benutzerin bzw. des Benutzers, der in der Regel aus dem Benutzernamen abgeleitet wird, aber auch angepasst werden kann.
  • email:  Dies ist die von der Institution zugewiesene E-Mail-Adresse, die auch als Standard-E-Mail-Adresse für dieses Benutzerkonto markiert wird. Diese E-Mail-Adresse sollte auch dann angegeben werden, wenn sie mit der „login_id“ der Benutzerin bzw. des Benutzers identisch ist.
  • pronouns: Wenn persönliche Pronomen aktiviert sind, sind dies die persönlichen Pronomen, die in Canvas hinter dem Namen angezeigt werden. Das Feld „Pronomen“ akzeptiert alle Pronomen, auch wenn sie nicht auf der Seite Kontoeinstellungen erstellt wurden.
  • declared_user_type: Dieser deklarierte Benutzertyp kann entweder „administrative“ (Admin), „observer“ Beobachter*in, „staff“ (Personal), „student“ (Studierende*r), „student_other“ (anderer Studierende*r) oder „teacher“ (Lehrende*r) sein. Kann „<delete>“ übergeben, um den deklarierten Benutzertyp von dem/ der Benutzer*in zu entfernen.
  • canvas_password_notification: Der Standardwert ist „false“. Falls „true“, wird die Person bezüglich der Einrichtung des Passworts benachrichtigt, wenn die „authentication_provider_id“ Canvas ist.
  • home_account: Wenn Sie „home_account“ auf true setzen, wird im Zielkonto ein neuer Benutzer für den SIS-Import angelegt und ein bereits vorhandener Benutzer aus einem anderen Konto innerhalb des Konsortiums wird mit einer passenden „integration_id“ verknüpft. Wird ignoriert, es sei denn, das Zielkonto ist mit einem Konsortium mit automatischer Verknüfpung verbunden.
  • status*^:  Hier können Sie Benutzer*innen in Canvas hinzufügen oder entfernen. Verwenden Sie die Markierungen aktiv, um Benutzer*innen hinzuzufügen, suspendiert, um Benutzer*innen zu suspendieren, oder gelöscht, um bestehende Benutzer*innen zu entfernen.

 

E-Mail-Adressenkonflikte

Canvas identifiziert Benutzer*innen anhand ihrer E-Mail-Adresse. Wenn Studierende zu einem Kurs hinzugefügt werden, versucht Canvas, eventuelle E-Mail-Adresskonflikte auszugleichen, wenn sich die Person zum ersten Mal in den Kurs einloggt.

Normalerweise sind E-Mail-Adressen für Studierende eindeutig. Es kann jedoch vorkommen, dass mehrere Studierende eine gemeinsame E-Mail-Adresse haben. Beim Hinzufügen von Studierenden zu Kursen über den SIS-Import erkennt Canvas, wenn eine E-Mail-Adresse mehr als einem Studierenden zugewiesen ist.

  • Wenn eine neue SIS-ID mit einer E-Mail-Adresse verknüpft wird, die bereits einer bestehenden SIS-ID zugewiesen ist, sendet Canvas eine E-Mail an diese E-Mail-Adresse.
  • Wenn Benutzer*innen über den SIS-Import zu einem Konto hinzugefügt werden, erhalten sie keine E-Mail-Benachrichtigung, es sei denn, das System erkennt einen doppelten Eintrag. Wenn Benutzer*innen jedoch manuell hinzugefügt oder eingeschrieben werden, erhalten sie eine E-Mail, die sie darüber informiert, dass sie zu einem neuen Kurs hinzugefügt oder eingeschrieben wurden. Die Studierende, die eine E-Mail-Adresse weitergeben, erhalten eine Benachrichtigung, dass die E-Mail-Adresse bereits verwendet wird und werden aufgefordert, ein neues Konto in Canvas zu erstellen. Dieser Vorgang kann auch beim Hinzufügen von Benutzer*innen zu einem Kurs angewandt werden.

accounts.csv

Ein Konto ist eine Organisationseinheit in Canvas (z. B. das übergeordnete Konto für eine Institution). Jedes Konto kann eine Hierarchie von Unterkonten enthalten, z. B. Konten für einzelne Abteilungen innerhalb einer Institution oder für einzelne Schulen innerhalb eines Bezirks. Unterkonten können auch mehrere Unterkonten enthalten, z. B. wenn eine Hochschule in Abteilungen oder Programme oder eine Schule in Klassenstufen oder Fächer unterteilt ist.

Laden Sie die Beispieldatei accounts.csv mit den folgenden Unterkonten herunter:

  • 3 Unterkonten innerhalb Ihres Stammkontos. (Kunst & Geisteswissenschaften, Wirtschaft, Mathematik & Naturwissenschaften)
  • 4 Unterkonten innerhalb des Unterkontos „Wirtschaft“. (Buchhaltung, Informatik, Wirtschaft und Marketing)
  • 3 Unterkonten innerhalb des Unterkontos „Mathematik & Naturwissenschaften“. (Biologie, Physik und Statistik)
  • 1 Unterkonto innerhalb des Unterkontos „Kunst & Geisteswissenschaften“. (Bildende Kunst)
  • 2 Unterkonten innerhalb des Unterkontos „Visuelle Künste“. (Fotografie, und Digitale Medien)

Erforderliches Feld* | Sticky Field^

  • account_id*:  Dies ist eine eindeutige Kennung, die zur Erstellung eines Unterkontos verwendet wird. Die Datei „courses.csv“ ermöglicht es Ihnen, Kurse einer bestimmten Konto-ID zuzuordnen. Diese eindeutige Kennung darf sich für das Konto nicht ändern und muss global für alle Konten eindeutig sein. In der Canvas-Benutzeroberfläche wird diese Kennung als SIS-ID bezeichnet und kann in den Einstellungen des jeweiligen Unterkontos geändert werden.
  • parent_account_id*^: Diese Kennung gibt an, dass ein Unterkonto unter diesem übergeordneten Konto eingeordnet werden soll. Wenn dieses Feld leer ist, wird das Unterkonto unter Ihrem Stammkonto oder Hauptkonto eingeordnet. Beachten Sie, dass die Spalte auch dann enthalten sein muss, wenn alle Werte leer sind, damit die Datei von einem Gruppenimport unterschieden werden kann.
  • name*^:  Dies ist der Name des Unterkontos.
  • status*: So können Sie ein Unterkonto erstellen oder entfernen. Verwenden Sie die Markierungen aktiv, um ein Unterkonto hinzuzufügen oder gelöscht, um ein bestehendes Unterkonto zu entfernen.
  • integration_id: Dies ist eine zweite eindeutige Kennung, die für komplexere SIS-Integrationen nützlich ist. Diese Kennung darf sich für das Konto nicht ändern und muss dateiübergreifend eindeutig sein.

terms.csv

Ein Semester gibt jedem Kurs, der diesem Semester zugeordnet ist, ein Standardstart- und -enddatum vor. Die Semesterdaten für Kurse können auf Kursebene manuell verwaltet werden, ohne dass eine Importdatei erforderlich ist. Wenn Sie jedoch eine „term_id“ vielen verschiedenen Kursen zuordnen, wird sichergestellt, dass alle Kurse in diesem Semester zur gleichen Zeit beginnen und enden. Hochgeladene Semesterdaten helfen Ihnen auch beim Sortieren und Organisieren von Kursen, wenn Sie Daten und Berichte in der Verwaltungsoberfläche anzeigen.

Laden Sie die Datei „term.csv“ als Beispiel mit 10 Semestern herunter.

Erforderliches Feld* | „Sticky“ Feld^

  • term_id*:  Dies ist ein eindeutiger Bezeichner für das Semester. In der Datei „courses.csv“ können Sie auf diese „term_id“ verweisen, damit Ihre Kurse wissen, wann sie beginnen und wann sie enden sollen. Diese Kennung darf sich für das Semester nicht ändern und muss dateiübergreifend eindeutig sein. In der Benutzeroberfläche wird dies als SIS-ID bezeichnet.
  • name*^:  Dies ist der Name des Semesters. Legen Sie eine passende Namenskonvention fest, mit der Sie Ihre Semester leicht referenzieren können.  Es gibt viele Verwaltungstools, mit denen Sie Daten anhand des Semesternamens suchen oder abfragen können.
  • status*:  So können Sie ein Semester erstellen oder entfernen. Verwenden Sie die Markierungen aktiv, um ein Semester hinzuzufügen oder gelöscht, um ein bestehendes Semester zu entfernen.
  • start_date^:  Dies ist das Datum, an dem das Semester beginnt. Das Format sollte ISO 8601 sein: YYYY-MM-DDTHH:MM:SSZ (Das T kann durch ein Leerzeichen ersetzt werden, wie im Beispiel-Screenshot zu sehen). Zum Beispiel würde der 26. August 2013 um17:00 Uhr EST wie folgt geschrieben: 2013-08-26T17:00-5:00
  • end_date^:  Dies ist das Datum, an dem das Semester endet. Das Format sollte ISO 8601 sein: YYYY-MM-DDTHH:MM:SSZ (Das T kann durch ein Leerzeichen ersetzt werden, wie im Beispiel-Screenshot zu sehen). Standardmäßig wird der Zugriff am angegebenen Enddatum um Mitternacht beendet, d. h. der Vortag ist der letzte volle Tag, an dem Benutzer*innen Zugriff auf das Semester haben. Am besten legen Sie das Enddatum auf den Tag nach dem Ende des Semesters fest.
  • integration_id: Dies ist eine zweite eindeutige Kennung, die für komplexere SIS-Integrationen nützlich ist. Diese Kennung darf sich für die Person nicht ändern und muss systemübergreifend eindeutig sein.
  • date_override_enrollment_type: Auf diese Weise können Sie Start- und Enddaten für einen bestimmten Einschreibungstyp innerhalb eines bestehenden Semesters festlegen oder entfernen. Wenn diese Option gesetzt ist, werden alle Spalten außer „term_id, status“, „start_date“ und „end_date“ für diese Zeile ignoriert. Wenn der Status auf aktiv gesetzt ist, gelten die Semesterdaten nur für Einschreibungen des angegebenen Typs. Wenn der Status auf gelöscht gesetzt ist, werden die aktuell gesetzten Daten für den angegebenen Einschreibungstyp entfernt. Der Einschreibungstyp kann auf StudentEnrollment, TeacherEnrollment, TaEnrollment oder DesignerEnrollment gesetzt werden.

courses.csv

Ein Kurs ist eine organisierte Präsentation zu einem bestimmten Thema. Manchmal kann ein Kurs eine Reihe von Kursen umfassen. Kurse werden in Semester eingeordnet, um standardmäßige Start- und Enddaten zu erzeugen. Wenn ein Kurs jedoch bestimmte Kursdaten enthält, haben diese Daten Vorrang vor den Zugriffsdaten der Studierenden auf das Semester, die durch die „term_id“ (falls vorhanden) identifiziert werden. Wenn Sie eine „term_id“ anhängen, können Sie die Kurse sortieren und organisieren, wenn Sie Daten und Berichte in der Verwaltungsoberfläche anzeigen. Eine „term_id“ kann leicht mit vielen verschiedenen Kursen verknüpft werden, die zur gleichen Zeit beginnen/enden. Wenn Sie einen Kurs nicht mit einem Semester verknüpfen, wird er mit dem Standardsemester verknüpft.

Wenn Ihre Institution Musterkurse aktiviert hat, können Sie die Dateie „courses.csv“ verwenden, um mit einem Musterkurs verknüpfte Kurse hinzuzufügen. Bitte beachten Sie, dass der Musterkurs erstellt und als solcher aktiviert werden muss, bevor Kurse verknüpft werden können.

Laden Sie die Beispieldatei „courses.csv“ mit 10 Kursen herunter, die sich in ihren jeweiligen Unterkonten in einem bestimmten Semester befinden.

Erforderliches Feld* | „Sticky“ Feld^

  • course_id*:  Dies ist eine eindeutige Kennung, die zur Unterscheidung von Kursen in Canvas verwendet wird. Diese Kennung darf sich für den Kurs nicht ändern und muss über alle Kurse hinweg eindeutig sein. In der Benutzeroberfläche wird dies als SIS-ID bezeichnet.
  • short_name*^:  Dies ist ein Kurzname für den Kurs. In der Canvas-Benutzeroberfläche wird dies auch als Kurscode oder Referenzcode bezeichnet.
  • long_name*^:  Dies ist der lange (vollständige) Name für den Kurs. (Dieser kann mit dem Kurznamen übereinstimmen, aber wenn beide verfügbar sind, ist es für die Benutzer*innen angenehmer, beide anzugeben).
  • account_id^:  Dies ist die eindeutige SIS-ID bzw. Kontokennung (aus der „accounts.csv“), die dem Kurs mitteilt, unter welchem Unterkonto er geführt wird. Wenn für einen neuen Kurs keine Konto-ID angegeben wird, wird der Kurs mit Ihrem Haupt-/Stammkonto verknüpft. Die SIS-ID finden Sie in den Einstellungen des Unterkontos.
  • term_id^:  Dies ist die eindeutige Semesterkennung (aus der „terms.csv“), die dem Kurs mitteilt, wann er beginnen und wann er enden soll. Wenn Sie eine „term_id“ mit einem Kurs verknüpfen, müssen Sie kein Start- oder Enddatum eingeben.
  • status*^:  Auf diese Weise können Sie einen Kurs erstellen, entfernen, beenden oder veröffentlichen. Verwenden Sie die Markierungen aktiv, um einen Kurs hinzuzufügen, gelöscht, um einen bestehenden Kurs zu entfernen, abgeschlossen, um einen bestehenden Kurs zu beenden, oder veröffentlicht, um einen bestehenden Kurs zu veröffentlichen.
  • integration_id: Dies ist eine zweite eindeutige Kennung, die für komplexere SIS-Integrationen nützlich ist. Diese Kennung darf sich für den Kurs nicht ändern und muss dateiübergreifend eindeutig sein.
  • start_date^:  Dies ist das Datum, an dem der Kurs beginnt. Das Format sollte ISO 8601 sein: YYYY-MM-DDTHH:MM:SSZ (Das T kann durch ein Leerzeichen ersetzt werden.)
  • end_date^:  Dies ist das Datum, an dem der Kurs endet. Das Format sollte ISO 8601 sein: YYYY-MM-DDTHH:MM:SSZ (Das T kann durch ein Leerzeichen ersetzt werden.) Standardmäßig wird der Zugriff am angegebenen Enddatum um Mitternacht beendet, d. h. der Vortag ist der letzte volle Tag, an dem Benutzer*innen Zugriff auf den Kurs haben. Am besten legen Sie das Enddatum auf den Tag nach dem Ende des Kurses fest.
  • course_format: Dies ist das Format des Kurses. Das Format kann online, on_campus, oder blended (gemischt) sein.
  • blueprint_course_id: Dies ist die Kurs-ID des Musterkurses, zu dem Sie einen verknüpften Kurs hinzufügen möchten. Um die Verknüpfung mit dem Musterkurs zu entfernen, können Sie anstelle der ID 'dissociate' angeben. In der Benutzer*in ist dies die SIS-ID des Musterkurses.
  • homeroom_course: Dies wird verwendet, um Homeroom-Kurse für Canvas für den Primarbereich zu kennzeichnen. Erfordert die Aktivierung der Einstellung „Canvas für den Primarbereich“.

sections.csv

Ein Abschnitt unterteilt Studierende innerhalb eines Kurses. Es können auch mehrere Abschnitte in einem Kurs zusammengefasst werden, insbesondere wenn alle Studierenden den gleichen Stoff lernen. In einen Kurs können mehrere Abschnitte eingefügt werden, aber ein Abschnitt kann nicht mehrere Abschnitte enthalten. Abschnitte übernehmen die Kursdaten, die durch das Semester festgelegt wurden. Wenn ein Abschnitt jedoch bestimmte Daten enthält, haben diese Daten Vorrang vor den Zugangsdaten der Studierenden für den Kurs und den Anfangs- und/oder Enddaten des Semesters.

Wenn Sie versuchen, einen Kurs zu löschen und die Benutzer*innen mit Abschnitten verbunden sind, müssen Sie den Parameter „section_id“ sowie die SIS-IDs der Abschnitte in den CSV-Import aufnehmen.

Laden Sie die Beispieldatei „sections.csv“ mit den folgenden Abschnitten herunter:

  • 4 Abschnitte im Kurs ACCT300 – Kostenrechnung
  • 4 Abschnitte im Kurs ACCT310 – Buchhaltung für die Verwaltung
  • 2 Abschnitte im Kurs BIO101 – Einführung in die Biologie

Diese Datei geht davon aus, dass Sie mehrere Abschnitte innerhalb eines Kurses haben können. Viele Institutionen importieren Kursabschnitte als separate Kurse. Sie können dies tun, indem Sie (1) für jeden Abschnitt in der Datei „courses.csv“ einen Canvas-Kurs erstellen und dann (2) in jedem dieser Kurse einen einzelnen Abschnitt erstellen. Sie können im Wesentlichen dieselben Daten für den Kurs und den Abschnitt verwenden, einschließlich der SIS-ID, die sowohl für die „course_id“ als auch für die „section_id“ gleich sein wird.

Erforderliches Feld* | „Sticky“ Feld^

  • section_id*:  Dies ist eine eindeutige Kennung, die zur Erstellung von Abschnitten in einem Kurs verwendet wird. Diese Kennung darf sich für den Abschnitt nicht ändern und muss dateiübergreifend eindeutig sein. In der Benutzeroberfläche wird dies als SIS-ID bezeichnet.
  • course_id*^:  Dies ist die eindeutige Kennung des Kurses, für den der Abschnitt hinzugefügt oder gelöscht werden soll (in „courses.csv“ hinzugefügt).
  • name*^:  Dies ist der Name des Abschnitts. Die Abschnitte sind alphabetisch nach Namen geordnet.
  • status*:  Auf diese Weise können Sie einen Abschnitt innerhalb eines Kurses erstellen oder entfernen. Verwenden Sie die Markierungen aktiv, um einen Abschnitt hinzuzufügen oder gelöscht, um einen bestehenden Abschnitt zu entfernen.
  • integration_id: Dies ist eine zweite eindeutige Kennung, die für komplexere SIS-Integrationen nützlich ist. Diese Kennung darf sich für den Abschnitt nicht ändern und muss dateiübergreifend eindeutig sein.
  • start_date^:  Dies ist das Datum, an dem der Abschnitt beginnt. Das Format sollte ISO 8601 sein: YYYY-MM-DDTHH:MM:SSZ (Das T kann durch ein Leerzeichen ersetzt werden.)
  • end_date^:  Dies ist das Datum, an dem der Abschnitt endet. Das Format sollte ISO 8601 sein: YYYY-MM-DDTHH:MM:SSZ (Das T kann durch ein Leerzeichen ersetzt werden.) Standardmäßig wird der Zugriff am angegebenen Enddatum um Mitternacht beendet, d. h. der Vortag ist der letzte volle Tag, an dem Benutzer*innen Zugriff auf den Abschnitt haben. Am besten legen Sie das Enddatum auf den Tag nach dem Ende des Abschnitts fest.

enrollments.csv

Mit Einschreibungen werden Benutzer*innen mit einer bestimmten Rolle in einen Kurs eingeschrieben. Mit der Datei „enrollments.csv“ können Sie Benutzer*innen Rollen zuweisen und sie den entsprechenden Kursen zuordnen. Wenn der Einschreibungsstatus einer Person als abgeschlossen markiert ist, hat sie für diesen Kurs nur noch Lesezugriff.

Hinweis: CSV-Dateien für die SIS-Einschreibung, die die Werte „start_date“ und „end_date“ enthalten, haben Vorrang vor Semesterdaten, Kursdaten und Abschnittsdaten.

Laden Sie die Beispieldatei „enrollments.csv“ mit den folgenden Einschreibungen herunter:

  • 1 Person als Lehrende*r im Kurs ACCT300 – Kostenrechnung
  • 1 Person als Lehrassistent*in im Kurs ACCT300 – Kostenrechnung
  • 1 Person als Designer*in ACCT300 – Kostenrechnung
  • 3 Personen als Studierende in Abschnitt 1 des Kurses ACCT300 – Kostenrechnung
  • 3 Personen als Studierende in Abschnitt 2 des Kurses ACCT300 – Kostenrechnung
  • 1 Person als Beobachter*in eines/einer Studierenden in Abschnitt 1 des Kurses ACCT300 – Kostenrechnung

Erforderliches Feld* | „Sticky“ Feld^

  • course_id*:  (Erforderlich, wenn die „section_id“ fehlt) Dies ist eine eindeutige Kennung für den Kurs, für den die Benutzer*in eingeschrieben wird (in „courses.csv“ hinzugefügt). Wenn Sie Studierende in den Kurs und nicht in einen bestimmten Abschnitt einschreiben, geben Sie die „course_id“ in dieses Feld ein. Andernfalls lassen Sie es leer.
  • root_account: Dies ist die Domäne des Kontos, in dem der/die Benutzer*in gesucht wird.
  • start_date^: Dies ist das Datum, an dem die Einschreibung beginnt. Damit „start_date„ wirksam wird, muss auch „end_date“ ausgefüllt werden. Das Format sollte ISO 8601 sein: YYYY-MM-DDTHH:MM:SSZ.
  • end_date^: Dies ist das Enddatum der Registrierung. Damit „end_date“ wirksam wird, muss auch „start_date“ ausgefüllt werden. Das Format sollte ISO 8601 sein: YYYY-MM-DDTHH:MM:SSZ.
  • user_id*:  Dies ist die eindeutige Kennung der Benutzerin bzw. des Benutzers, die in den vorgesehenen Kursen eingeschrieben wird (in „users.csv“ hinzugefügt). Wenn die „user_integration_id“ vorhanden ist, wird dieses Feld ignoriert.
  • user_integration_id*: (Erforderlich, wenn die „user_id“ fehlt) Dies ist die sekundäre eindeutige Kennung des Benutzers*in (in „users.csv“ als „integration_id“ hinzugefügt).
  • role*:  Dies ist die Rolle, die einem/einer Benutzer*in für den vorgesehenen Kurs zugewiesen wird. Sie können Benutzer*innen in eine der folgenden Rollen einschreiben: Lehrende, Designer*in, Lehrassistent*in, Studierende, Beobachter*in oder eine benutzerdefinierte Rolle.  Jede Rolle verfügt über eine Reihe von Berechtigungen, die Admins auf der Ebene des Haupt-/Stammkontos oder des Unterkontos anpassen können.
  • role_id*: (Erforderlich, wenn die Rolle fehlt) Dies ist die eindeutige Kennung für die Rolle, in der der/die Benutzer*in im Rahmen einer Einschreibung hinzugefügt wird.
  • section_id*:  (Erforderlich, wenn die „course_id“ fehlt) Dies ist die eindeutige Kennung für den Abschnitt, in den der/die Benutzer*in eingeschrieben wird (in „sections.csv“ hinzugefügt). Wenn Sie Studierende in einen bestimmten Abschnitt eines Kurses einschreiben, geben Sie hier die „section_id“ des Abschnitts ein. Andernfalls lassen Sie das Feld leer. Wenn keine „section_id“ angegeben wird, wird der Standardabschnitt für den Kurs verwendet. Wenn es keinen Standardabschnitt gibt, wird automatisch ein Abschnitt ohne SIS-ID erstellt.
  • status*: Auf diese Weise können Sie Benutzer*innen in einen Kurs einschreiben, aus abgeschlossen setzen, deaktivieren (inaktiv machen) oder die Einschreibung aufheben. Verwenden Sie die Markierungen aktiv, um eine Person in einen Kurs einzuschreiben, abgeschlossen, um die Einschreibung in einen Kurs zu beenden, inaktiv, um den/die Benutzer*in im Kurs zu deaktivieren, und gelöscht, um eine Person aus einem Kurs zu entfernen. Studierende mit dem Status „inaktiv“ werden in der Kursliste für Lehrende aufgeführt, können den Kurs aber nicht einsehen oder daran teilnehmen, bis die Einschreibung aktiviert wird.  
  • associated_user_id:  (Nur Beobachter*in) Dies ist die eindeutige Kennung der Person, deren Informationen (einschließlich Noten) dem/der Beobachter*in angezeigt werden können. Die Beobachter*in sollte in demselben Kurs/Abschnitt eingeschrieben sein wie die Person, die beobachtet werden soll. Dieses Feld wird für alle Rollen außer Beobachter*in ignoriert.
  • limit_section_privileges: Auf diese Weise können Sie festlegen, dass der/die Benutzer*in nur die Personen sehen und mit ihnen interagieren kann, die in dem durch die „course_section_id“ angegebenen Abschnitt eingeschrieben sind. Dieses Feld ist standardmäßig auf „false“ eingestellt. Die Beschränkung der Interaktion von Studierenden nach Abschnitt wirkt sich nur auf die Bereiche Collaborations, Chat, Teilnehmer und Conversations aus. Wenn Sie Lehrende und Assistent*innen einschreiben, können diese Personen Studierende in ihren Abschnitten benoten. Diskussionsthemen und Seiten sind von den Abschnittsbeschränkungen nicht betroffen und können von jedem Studierenden eingesehen werden. Diese Funktionsbereiche können durch die Erstellung von Inhalten in Kursgruppen eingeschränkt werden.
  • notify: So senden Sie eine Benachrichtigung an die Benutzer*innen, die in einen Kurs eingeschrieben sind.

group_categories.csv

Mit Gruppenkategorien können Sie Gruppen in Canvas organisieren. Mit einer Datei namens „group_categories.csv“ können Sie Gruppenkategorien auf Konto- oder Kursebene erstellen. In der Benutzeroberfläche werden die Gruppenkategorien als Gruppensets bezeichnet.

Laden Sie die Beispieldatei „group_categories.csv“ mit den folgenden Gruppenkategorien herunter:

  • Admin-Gruppen
  • Designer-Gruppen
  • Gruppen im Geschichtsprojeckt

Erforderliches Feld* | „Sticky“ Feld^

  • group_category_id: Dies ist die Kennung, die zur Referenzierung der Gruppenkategorie verwendet wird. Diese Kennung darf sich für die Gruppenkategorie nicht ändern und muss dateiübergreifend eindeutig sein.
  • account_id: Dies ist die Kennung, mit der die Gruppenkategorie mit einem Konto verknüpft werden (hinzugefügt in „accounts.csv“). Wenn kein Konto oder Kurs angegeben wird, wird die Gruppe dem Stammkonto zugeordnet.
  • course_id: Dies ist die Kennung, mit der die Gruppenkategorie mit einem Kurs verknüpft wird (hinzugefügt in „courses.csv“). Wenn kein Kurs oder Konto angegeben wird, wird die Gruppe dem Stammkonto zugeordnet.
  • category_name*^: Das ist der Name der Gruppenkategorie.
  • status*: Dies ist der Status der Gruppenkategorie. Verwenden Sie die Markierungen aktiv, um die Gruppenkategorie zu erstellen oder gelöscht, um die Gruppenkategorie zu löschen.

groups.csv

Eine Gruppe kann genutzt werden, um Studierenden, Lehrenden, Admins oder anderen Benutzer*innen Möglichkeiten zur Zusammenarbeit zu bieten. Mit der Datei „groups.csv“ können Sie Gruppen auf Kurs- und Kontoebene erstellen. Über SIS hochgeladene Gruppen können nur über SIS aktualisiert oder gelöscht werden.

Laden Sie die Beispieldatei „groups.csv“ mit den folgenden Gruppen herunter:

  • Admins
  • Mathematik-Lehrende
  • Designer

Erforderliches Feld* | „Sticky“ Feld^

  • group_id*: Dies ist die eindeutige Kennung, mit der Sie Ihre Gruppe referenzieren können. Diese Kennung darf sich für die Gruppe nicht ändern und muss dateiübergreifend eindeutig sein.
  • group_category_id: Dies ist die Kennung der Gruppenkategorie (hinzugefügt in „group_categories.csv“), zu der Sie eine Gruppe hinzufügen. Wenn keine Gruppenkategorie angegeben wird, wird die Gruppe in die Standardgruppenkategorie für das definierte Konto oder den definierten Kurs eingefügt. Wenn kein Konto oder Kurs angegeben ist, wird die Gruppe in die standardmäßige Gruppenkategorie des Stammkontos eingefügt.
  • account_id: Dies ist die Kennung, die die Gruppe mit einem Konto verbindet (hinzugefügt in „accounts.csv“ hinzugefügt). Wenn keine Angabe gemacht wird, wird die Gruppe dem Stammkonto zugeordnet.
  • course_id: Dies ist die Kennung, die die Gruppe mit einem Kurs verknüpft (hinzugefügt in „courses.csv“). Wenn kein Kurs oder Konto angegeben wird, wird die Gruppe dem Stammkonto zugeordnet.
  • name*^: Dies ist der Name der Gruppe.
  • status*: Dies ist der Status der Gruppe. Verwenden Sie die Markierungen verfügbar, um die Mitgliedschaft für die Gruppe zu öffnen, oder gelöscht, um die Gruppe zu löschen.

groups_membership.csv

Die Mitgliedschaft in einer Gruppe ermöglicht es Benutzer*innen, an Aktivitäten in Canvas mitzuarbeiten. Mit der Datei „groups_membership.csv“ können Sie einer Gruppe, die Sie mithilfe der Datei „groups.csv“ erstellt haben, mehrere Personen hinzufügen oder entfernen.

Laden Sie die Beispieldatei „groups_membership.csv“ mit den folgenden Gruppenmitgliedschaften herunter:

  • 1 akzeptierte(r) Benutzer*in in der Gruppe Admins
  • 1 akzeptierte(r) Benutzer*in in der Gruppe Mathe-Lehrende
  • 1 gelöschte(r) Benutzer*in in der Gruppe Mathe-Lehrende

Erforderliches Feld*

  • group_id*: Dies ist die eindeutige Kennung, mit der Sie Ihre Gruppe referenzieren können (hinzugefügt in „groups.csv“).
  • user_id*: Dies ist die eindeutige Kennung des Benutzers bzw. der Benutzerin, den/die Sie der Gruppe hinzufügen möchten (hinzugefügt in „users.csv“).
  • status*: Dies ist der Status der Benutzer*innen in der Gruppe. Verwenden Sie die Markierungen akzeptiert, um Benutzer*innen zu einer Gruppe hinzuzufügen oder gelöscht, um Benutzer*innen aus einer Gruppe zu entfernen.

xlists.csv

Mit Cross-Listing können Sie Abschnitte in einen anderen Kurs verschieben. Mit der Datei „xlist.csv“ können Sie Abschnitte in bestehende Kurse einfügen und eine Abschnittshierarchie erstellen.

Es wird erwartet, dass die Abschnitts-IDs bereits existieren und auf andere Kurs-IDs verweisen. Wenn in dieser Datei die ID eines Abschnitts angegeben ist, wird er von seiner bestehenden Kurs-ID zu einer neuen Kurs-ID verschoben. Wenn dieser neue Kurs entfernt oder das Cross-Listing aufgehoben wird, kehrt der Abschnitt zu seiner vorherigen Kurs-ID zurück. Wenn die „xlist_course_id“ nicht auf einen bestehenden Kurs verweist, wird dieser erstellt. Wenn Sie weitere Informationen über den Cross-Listing-Kurs bereitstellen möchten, tun Sie dies bitte in der Datei „courses.csv“.

Laden Sie die Beispieldatei „xlists.csv“ mit den folgenden Kursen und Abschnitten herunter:

  • 4 aktive Abschnitte des Kurses ACCT300 – Kostenrechnung, die in den Kurs ACCT310 - Buchhaltung für die Verwaltung überführt wurden

Erforderliches Feld*

  • xlist_course_id*: Dies ist die Kennung des neuen Kurses (hinzugefügt in „courses.csv“).
  • section_id*: Dies ist die Kennung des Abschnitts (hinzugefügt in „sections.csv“).
  • status*: Dies ist der Status des Abschnitts. Verwenden Sie die Markierungen aktiv, um den Abschnitt zu aktivieren, oder gelöscht, um den Abschnitt zu entfernen.

user_observers.csv

Mit der Beobachterrolle können Eltern eingeschrieben und mit einem Studierenden verknüpft werden, so dass sie die Noten und Kursinteraktionen ihres Studierenden einsehen können. Mit der Datei „user_observers.csv“ können Sie Beobachter*innen für die jeweiligen Studierenden einschreiben und mit ihnen verknüpfen.

Laden Sie die Beispieldatei „user_observers.csv“ mit den folgenden Einschreibungen herunter:

  • 2 aktive Beobachter*innen
  • 1 gelöschte Beobachter*in

Erforderliches Feld*

  • observer_id*: Dies ist die eindeutige Kennung der Beobachterin bzw. des Beobachters (hinzugefügt als „user_id“ in „users.csv“).
  • student_id*: Dies ist die eindeutige Kennung des/der Studierenden (hinzugefügt als „user_id“ in „users.csv“).
  • status*: Dies ist der Status der Beobachterin bzw. des Beobachters. Verwenden Sie die Markierungen aktiv, um den/die Beobachter*in für alle Einschreibungen des Studierenden einzuschreiben, oder gelöscht, um alle Einschreibungen des Beobachters bzw. der Beobachterin zu entfernen.

logins.csv

Mit der Datei „logins.csv“ können Sie Anmeldedaten für Benutzer*innen erstellen oder aktualisieren. Logins können nur zu bestehenden Benutzer*innen hinzugefügt werden. Logins können mit der Datei „users.csv“ entfernt werden.

Laden Sie die Beispieldatei „logins.csv“ mit den drei Benutzer-Logins herunter.

Erforderliches Feld* | „Sticky“ Feld^

  • user_id*: Dies ist die eindeutige Kennung der Benutzers bzw. der Benutzerin (referenziert in „enrollments.csv“). Dieser Wert darf sich für den/die Benutzer*in nicht ändern und muss für alle Benutzer*innen eindeutig sein. In der Benutzer*in von Canvas wird er als SIS-ID bezeichnet.
  • integration_id: Dies ist eine zweite eindeutige Kennung, die für komplexere SIS-Integrationen nützlich ist. Dieser Wert darf sich für den/die Benutzer*in nicht ändern und muss für alle Benutzer*innen eindeutig sein. Dieses Feld sollte leer bleiben, wenn Benutzer*innen mit übereinstimmenden Integrations-IDs zusammengeführt werden.
  • login_id*: Dies ist der Name, den der/die Benutzer*in für die Anmeldung bei Canvas verwenden würde. Bei konfigurierten Authentifizierungsdiensten, wie z. B. LDAP, ist dies der Benutzername aus dem Remote-System.
  • password: Dies ist das Passwort, mit dem sich der/die Benutzer*in bei Canvas anmeldet. Dieses Feld sollte bei Konten, die für LDAP oder SSO konfiguriert sind, nicht ausgefüllt werden.
  • ssha_password: Dies ist ein Passwort, das mit einem vorverschlüsselten SSHA-Generierungsschema erstellt wurde.
  • authentication_provider_id: Dies ist der Authentifizierungsanbieter, mit dem die Anmeldung verknüpft ist.
  • existing_user_id^: Dies ist die SIS-ID des Benutzers bzw. der Benutzerin, wie sie in der Datei „users.csv“ zu finden ist.
  • existing_integration_id^: Dies ist die Integrations-ID des Benutzers bzw. der Benutzerin, wie sie in der „users.csv“ zu finden ist.
  • existing_canvas_user_id^: Dies ist die Canvas-ID des Benutzers bzw. der Benutzerin.
  • root_account: Dies ist die Domäne des Kontos des Benutzers bzw. der Benutzerin.
  • email: Dies ist die E-Mail-Adresse des Benutzers bzw. der Benutzerin.

Hinweise:

  • Für einen erfolgreichen Import der Datei „logins.csv“ ist eines der Felder „existing_user_id“, „existing_integration_id“ oder „existing_canvas_user_id“ erforderlich.
  • Das Feld „root_account“ ist erforderlich, wenn Benutzer*innen in einem Treuhandkonto identifiziert werden (z. B. wenn Sie Benutzer*innen in einem Treuhandkonto kontenübergreifend auflisten).

admins.csv

Admins verwalten die Einstellungen für ein ganzes Konto oder Unterkonto. Mit der Datei „admins.csv“ können Sie Benutzer*innen in Canvas als Kontoadministrator*innen festlegen oder andere benutzerdefinierte Konto- oder Unterkontorollen zuweisen.

Laden Sie die Beispieldatei „admins.csv“ mit den folgenden Admins herunter:

  • 2 aktive Kontoadmins
  • 1 gelöschter Kontoadmin
  • 2 aktive benutzerdefinierte Kontorollen

Erforderliches Feld*

  • user_id*: Dies ist die eindeutige ID des Benutzers bzw. der Benutzerin, den/die Sie als Admin festlegen möchten (hinzugefügt in „users.csv“).
  • account_id*: Dies ist die eindeutige Kennung des Kontos, in dem sich der Admin befinden soll (hinzugefügt in „accounts.csv“). Wenn Sie diese Spalte leer lassen, wird der/die Benutzer*in im Stammkonto geführt. Diese Spalte ist immer erforderlich, auch wenn der Wert leer ist.  
  • role_id*: (erforderlich, wenn die Rolle fehlt) Dies ist die ID der Rolle, entweder die Standard-ID oder eine vom Konto definierte benutzerdefinierte ID.
  • role*: (erforderlich, wenn „role_id“ fehlt) Dies ist der Name der Rolle, entweder die Standardrolle Konto-Admin oder eine vom Konto definierte benutzerdefinierte Rolle. Wenn Sie einen Konto-Admin hinzufügen, formatieren Sie das Feld so, dass es „AccountAdmin“ lautet. Wenn Sie eine benutzerdefinierte Rolle hinzufügen, formatieren Sie das Feld genau so, wie es in der Canvas-Benutzeroberfläche erscheint.
  • status*: Dies ist der Status des Admins. Verwenden Sie die Markierungen aktiv, um einen aktiven Admin zu erstellen oder gelöscht, um einen Admin zu entfernen.
  • root_account: Dies ist die Domäne des Kontos, in dem der/die Benutzer*in gesucht wird.

change_sis_id.csv

Eine SIS-ID ist ein eindeutiger Bezeichner für ein Objekt in Canvas. Mit der Datei „change_sis_id.csv“ können Sie SIS-IDs für bestehende Konten, Semester, Kurse, Abschnitte, Gruppen oder Benutzer*innen ändern.

Laden Sie die Beispieldatei „change_sis_id.csv“ mit den folgenden SIS-ID-Änderungen herunter:

  • 1 Änderung der Benutzer-SIS-ID
  • 1 Änderung der Kurs-SIS-ID
  • 1 Änderung der Semester-SIS-ID

Erforderliches Feld*

  • old_id*: Dies ist die aktuelle SIS-ID des Objekts.
  • new_id*: Dies ist die gewünschte SIS-ID des Objekts. Die neue SIS-ID muss für den Objekttyp und das Stammkonto derzeit eindeutig sein.
  • type*: Dies ist der Typ des Objekts. Der Typ kann Konto, Semester, Kurs, Abschnitt, Gruppe oder Benutzer*in sein.