Canvas biedt de mogelijkheid om CSV-bestanden te importeren om handmatig in bulk gebruikers, accounts, semesters, cursussen, secties, inschrijvingen en inloggegevens aan te maken via de beheerdersinterface.
Dit document verwijst naar de SIS Import CSV Format API-pagina , waar de meeste CSV-informatie te vinden is. Elk CSV-bestand werkt samen met de andere bestanden en vertelt Canvas hoe de informatie voor het account beheerd moet worden. Bekijk het SIS-relatiediagram .
Voorbeeldbestanden
Elke stap in deze les bevat details over de CSV-bestanden en beschrijvingen van elk verplicht en optioneel veld. Elke stap bevat ook een link om een voorbeeld-CSV-bestand te downloaden. Voorbeeldbestanden bevatten alle verplichte velden en kunnen ook optionele velden bevatten. Daarnaast kunt u een gecomprimeerd pakket met alle voorbeeldbestanden downloaden . Als de CSV-links niet downloaden, probeer de link dan in een nieuw tabblad te openen.
Het is raadzaam om eerst te oefenen met het importeren van gegevens in uw Canvas-testomgeving voordat u inhoud importeert naar uw productieomgeving.
CSV-bestandsformaat
Om grote hoeveelheden gegevens naar Canvas te uploaden, moet u een of meer CSV-tekstbestanden aanmaken. CSV-bestanden kunnen door veel programma's worden gegenereerd. Studenteninformatiesystemen (SIS) bieden vaak een methode voor het genereren van rapporten in CSV-formaat die kunnen worden aangepast aan het formaat dat Canvas vereist. Weet je niet hoe je een bestand in CSV-formaat opslaat? Raadpleeg dan de documentatie van het programma dat je gebruikt om je CSV-bestand te maken (bijvoorbeeld Excel).
Wanneer u het Instructure-formaat gebruikt voor het importeren van bestanden op de SIS-importpagina , kunt u een afzonderlijk CSV-tekstbestand importeren of meerdere bestanden comprimeren tot één ZIP-bestand om gegevens in bulk te importeren. Als u handmatig afzonderlijke bestanden uploadt, moeten de bestanden worden geüpload in de volgorde die in deze les wordt getoond.
CSV-veldopmaak
De eerste rij van uw CSV-bestand (de header) moet de volledige veldnaam voor elk bestand bevatten. De volgorde van de kolommen maakt niet uit, maar de juiste volgorde van de rijen is cruciaal voor bestanden zoals accounts.csv.
Kleverige velden
Standaard worden bepaalde wijzigingen in de gebruikersinterface niet overschreven door toekomstige SIS-importen en worden deze als 'sticky' gemarkeerd. Alle 'sticky' velden worden in dit document beschreven. U kunt deze velden overschrijven door override_sis_stickiness in de API in te stellen of door het selectievakje 'UI-wijzigingen overschrijven' aan te vinken op de SIS-importpagina .
API-documentatie
CSV-bestanden bevatten slechts een specifieke set velden. Canvas bevat aanvullende waarden die beschikbaar zijn via de afzonderlijke API's. Na het verwerken van de CSV-bestanden voor uw instelling is het voor de meeste instellingen standaard om alle SIS CSV-bestanden te uploaden en vervolgens de Canvas API te gebruiken om alle account- en cursuskenmerken bij te werken. Raadpleeg voor meer informatie de Canvas API-documentatie voor gebruikers, accounts, semesters, cursussen, secties, inschrijvingen en groepen. SIS-importen kunnen ook worden beheerd met behulp van de SIS Imports API .
Let op: de kopregel in uw CSV-bestanden bepaalt welke gegevensvelden Canvas verwerkt. Hoewel de SIS-importhandleidingen alle ondersteunde velden vermelden, hoeft uw CSV-bestand alleen de kolommen te bevatten die u momenteel bijwerkt. Als een ondersteund veld ontbreekt in uw bestand, kunt u de kopregel handmatig toevoegen aan de eerste regel.
gebruikers.csv
Gebruikers zijn de personen die een gebruikersaccount hebben binnen een instelling. Het bestand users.csv voegt personen toe aan het systeem als generieke gebruikers. Het bestand enrollments.csv wijst een rol (docent, student, enz.) toe aan deze gebruikers. Wanneer een gebruikersaccount wordt verwijderd , worden ook alle bijbehorende inschrijvingen verwijderd en kan de gebruiker niet meer inloggen op zijn of haar Canvas-account. Als u wilt dat de gebruiker nog steeds kan inloggen, maar niet kan deelnemen, of als u de gebruiker alleen wilt verwijderen uit een specifieke cursus, laat u het gebruikersaccount actief en wijzigt u de inschrijving (in enrollments.csv) naar respectievelijk 'voltooid' of ' verwijderd' .
Download een voorbeeld van een users.csv-bestand met 10 Canvas-gebruikersaccounts.
Verplicht veld*| Plakkerig veld^
- gebruikers-ID*Dit is een unieke waarde die wordt gebruikt om iedereen met een Canvas-account te identificeren. Deze waarde mag niet veranderen voor de gebruiker en moet uniek zijn voor alle gebruikers. In de gebruikersinterface wordt dit de SIS-ID genoemd en kan het bestaan uit elke willekeurige combinatie van tekens. U kunt deze SIS-ID vinden door naar een gebruikersaccount te gaan en vervolgens de inloggegevens te bekijken.
- integration_id: Dit is een secundaire unieke identificatiecode die nuttig is voor complexere SIS-integraties. Deze identificatiecode mag niet veranderen voor de gebruiker en moet wereldwijd uniek zijn.
- login_id*^:
- Wachtwoord: Als het account is geconfigureerd voor gebruik met LDAP of een SSO-protocol, is dit niet vereist. Anders is dit het wachtwoord voor de hierboven genoemde 'login_id'. Dit wachtwoord moet minimaal 8 tekens lang zijn.
- ssha_password: In plaats van een wachtwoord in platte tekst kunt u in dit veld een vooraf gehasht wachtwoord opgeven dat gebruikmaakt van het SSHA-wachtwoordgeneratieschema . Hoewel dit beter is dan een wachtwoord in platte tekst, is het raadzaam gebruikers aan te moedigen hun wachtwoord te wijzigen na de eerste keer inloggen.
- authentication_provider_id: Dit is de authenticatieprovider waarmee de login is gekoppeld. Logins die aan een specifieke provider zijn gekoppeld, kunnen alleen met die provider worden gebruikt. Oudere providers (LDAP, CAS, SAML) zoeken naar logins die aan hen zijn gekoppeld, of naar niet-gekoppelde logins. Nieuwe providers zoeken alleen naar logins die expliciet aan hen zijn gekoppeld. Dit kan de integer-ID van de provider zijn, of het type provider (in dat geval wordt de eerst overeenkomende provider gevonden).
- first_name^: Dit is de opgegeven (voor)naam van de gebruiker. Indien aanwezig, wordt deze gebruikt om full_name en/of sortable_name samen te stellen.
- last_name^: Dit is de achternaam van de gebruiker. Indien aanwezig, wordt deze gebruikt om full_name en/of sortable_name samen te stellen.
- full_name^: Dit is zowel de voornaam als de achternaam van de gebruiker. Laat first_name en last_name weg als deze zijn opgegeven.
- sortable_name^ : Dit is de sorteerbare naamoptie in Canvas, die meestal wordt afgeleid van de gebruikersnaam, maar die kan worden aangepast.
- short_name^: Dit is de weergavenaam van de gebruiker, meestal afgeleid van de gebruikersnaam, maar deze kan worden aangepast.
- E-mailadres: Dit is het door de instelling toegewezen e-mailadres en zal ook worden gemarkeerd als het standaard e-mailadres voor dit gebruikersaccount. Dit e-mailadres moet nog steeds worden opgegeven, zelfs als het hetzelfde is als de login_id van de gebruiker.
- Voornaamwoorden^: Als persoonlijke voornaamwoorden zijn ingeschakeld, worden deze na de naam van een gebruiker in Canvas weergegeven. Het veld voor voornaamwoorden accepteert alle voornaamwoorden, zelfs als ze niet zijn aangemaakt op de pagina Accountinstellingen.
- declared_user_type: Dit opgegeven gebruikerstype kan administrator, observer, staff, student, student_other of teacher zijn. Je kunt "<delete>" doorgeven om het opgegeven gebruikerstype van de gebruiker te verwijderen.
- canvas_password_notification: Deze waarde is standaard onwaar. Indien waar, wordt de gebruiker op de hoogte gesteld van de wachtwoordinstelling als de authentication_provider_id canvas is. Als uw instelling geen Canvas SIS-integratie heeft, is dit veld verplicht om nieuwe gebruikers te informeren over hun aangemaakte accounts.
- home_account: Als home_account op true wordt ingesteld, wordt een nieuwe gebruiker aangemaakt in het doelaccount voor de SIS-import en wordt een bestaande gebruiker van een ander account binnen het consortium met een overeenkomende integration_id samengevoegd. Deze instelling wordt genegeerd, tenzij het doelaccount is gekoppeld aan een consortium met automatische samenvoeging.
- status*^:Hier kunt u een gebruiker toevoegen of verwijderen uit Canvas. Markeer als actief om een gebruiker toe te voegen, als opgeschort om een gebruiker op te schorten of als verwijderd om een bestaande gebruiker te verwijderen.
Let op: CSV-bestanden hoeven niet alle mogelijke velden te bevatten. Om een succesvolle import te garanderen, moet uw bestand alle verplichte headers bevatten. Optionele headers (zoals integration_id of authentication_provider_id) hoeven alleen te worden opgenomen als u gegevens voor die specifieke velden aanlevert.
Conflicten in e-mailadressen
Canvas identificeert gebruikers aan de hand van hun e-mailadres. Wanneer studenten aan een cursus worden toegevoegd, probeert Canvas eventuele conflicten met e-mailadressen op te lossen wanneer de gebruiker voor het eerst inlogt op de cursus.
Normaal gesproken is een e-mailadres uniek voor elke student. Soms delen meerdere studenten echter één e-mailadres. Wanneer je studenten via een importfunctie in het studenteninformatiesysteem (SIS) aan cursussen toevoegt, herkent Canvas wanneer een e-mailadres aan meer dan één student is toegewezen.
- Als een nieuw SIS-ID wordt gekoppeld aan een e-mailadres dat al is toegewezen aan een bestaand SIS-ID, stuurt Canvas een e-mail naar dat e-mailadres.
- Wanneer gebruikers via SIS-import aan een account worden toegevoegd, ontvangen ze geen e-mailmelding, tenzij het systeem een dubbele gebruiker detecteert. Als een gebruiker echter handmatig wordt toegevoegd of ingeschreven, ontvangt hij of zij een e-mail met de melding dat hij of zij is toegevoegd aan of ingeschreven voor een nieuwe cursus. De student die een e-mailadres deelt, ontvangt een melding dat het e-mailadres al in gebruik is en wordt uitgenodigd een nieuw account aan te maken in Canvas. Dit proces kan ook van toepassing zijn bij het toevoegen van een gebruiker aan een cursusinschrijving.
accounts.csv
Een account is een organisatie-eenheid binnen Canvas (bijvoorbeeld het hoofdaccount voor een instelling). Elk account kan een hiërarchie van subaccounts bevatten, zoals accounts voor individuele faculteiten binnen een instelling, of voor individuele scholen binnen een district. Subaccounts kunnen ook meerdere subaccounts bevatten, bijvoorbeeld wanneer een faculteit is onderverdeeld in afdelingen of opleidingen, of een school is onderverdeeld in leerjaren of vakken.
Download een voorbeeld van een accounts.csv-bestand met de volgende subaccounts:
- 3 subaccounts binnen je hoofdaccount. (Kunst & Geesteswetenschappen, Bedrijfskunde, Wiskunde & Wetenschappen)
- 4 subaccounts binnen uw bedrijfsaccount. (Accountancy, Informatica, Economie en Marketing)
- 3 subaccounts binnen je subaccount voor wiskunde en wetenschappen. (Biologie, Natuurkunde en Statistiek)
- 1 subaccount binnen je subaccount voor Kunst en Geesteswetenschappen. (Beeldende Kunsten)
- 2 subaccounts binnen je subaccount voor Beeldende Kunst. (Fotografie en Digitale Media)
Verplicht veld*| Plakkerig veld^
- account_id*:Dit is een unieke identificatiecode die wordt gebruikt om een subaccount aan te maken. Met het bestand courses.csv kunt u cursussen toewijzen aan een specifiek account-ID. Deze unieke identificatiecode mag niet veranderen voor het account en moet wereldwijd uniek zijn voor alle accounts. In de Canvas-interface wordt dit de SIS-ID genoemd en kan deze worden gewijzigd via de instellingen van het betreffende subaccount.
- parent_account_id*^: Deze identificatie geeft aan dat een subaccount onder dit hoofdaccount moet worden geplaatst. Als dit veld leeg is, wordt het subaccount onder uw hoofdaccount geplaatst. Houd er rekening mee dat zelfs als alle waarden leeg zijn, de kolom moet worden opgenomen om het bestand te onderscheiden van een groepsimport.
- naam*^ : Dit is de naam voor het subaccount.
- status*:Zo kunt u een subaccount aanmaken of verwijderen. Markeer als actief om een subaccount toe te voegen of als verwijderd om een bestaand subaccount te verwijderen.
- integration_id: Dit is een secundaire unieke identificatiecode die nuttig is voor complexere SIS-integraties. Deze identificatiecode mag niet veranderen voor het account en moet wereldwijd uniek zijn.
terms.csv
Een semester biedt een standaard set begin- en einddatums voor elke cursus die aan dat semester is toegewezen. Semesterdatums voor cursussen kunnen handmatig op cursusniveau worden beheerd zonder een importbestand. Door echter een term_id aan meerdere cursussen te koppelen, zorgt u ervoor dat alle cursussen in dat semester op hetzelfde moment beginnen en eindigen. Geüploade semesterdatums helpen u ook bij het sorteren en organiseren van cursussen wanneer u gegevens en rapporten bekijkt in de beheerdersinterface.
Download een voorbeeld-csv-bestand met 10 termen.
Verplicht veld*| Plakkerig veld^
- term_id*: Dit is een unieke identificatiecode voor het semester. Het bestand courses.csv stelt je in staat om naar deze term_id te verwijzen, zodat je cursussen weten wanneer ze moeten beginnen en wanneer ze moeten eindigen. Deze identificatiecode mag gedurende het semester niet veranderen en moet wereldwijd uniek zijn voor alle semesters. In de gebruikersinterface wordt dit de SIS ID genoemd.
- naam*^: Dit is de naam van uw term. Bedenk een goede naamgevingsconventie waarmee u uw termen gemakkelijk kunt terugvinden. Er zijn veel beheertools waarmee u gegevens kunt zoeken of opvragen op basis van de termnaam.
- status*: Zo kunt u een term aanmaken of verwijderen. Markeer als actief om een term toe te voegen of als verwijderd om een bestaande term te verwijderen.
- start_date^: Dit is de datum waarop het semester begint. Het formaat moet volgens ISO 8601 zijn: JJJJ-MM-DDTHH:MM:SSZ (De T mag worden vervangen door een spatie, zoals te zien is in de voorbeeldschermafbeelding.) Bijvoorbeeld: 26 augustus 2013 om 17:00 uur EST wordt geschreven als 2013-08-26T17:00-5:00
- end_date^: Dit is de datum waarop de termijn eindigt. Het formaat moet volgens ISO 8601 zijn: JJJJ-MM-DDTHH:MM:SSZ (de T mag worden vervangen door een spatie, zoals te zien is in de voorbeeldschermafbeelding). Standaard wordt de toegang voor gebruikers om middernacht op de door u aangegeven einddatum afgesloten. Dit betekent dat de vorige dag de laatste volledige dag is waarop gebruikers toegang hebben tot de termijn. Het is aan te raden de einddatum in te stellen op de dag na het einde van de termijn.
- integration_id: Dit is een secundaire unieke identificatiecode die nuttig is voor complexere SIS-integraties. Deze identificatiecode mag gedurende de looptijd niet veranderen en moet wereldwijd uniek zijn.
- date_override_enrollment_type: Hiermee kunt u begin- en einddatums instellen of verwijderen voor een specifiek inschrijvingstype binnen een bestaande periode. Indien ingesteld, worden alle kolommen behalve term_id, status, start_date en end_date genegeerd voor de betreffende rij. Als de status is ingesteld op 'actief', zijn de periodedatums alleen van toepassing op inschrijvingen van het opgegeven type. Als de status is ingesteld op 'verwijderd', worden de momenteel ingestelde datums verwijderd voor het opgegeven inschrijvingstype. Het inschrijvingstype kan worden ingesteld op StudentEnrollment, TeacherEnrollment, TaEnrollment of DesignerEnrollment.
cursussen.csv
Een cursus is een georganiseerde presentatie over een bepaald onderwerp. Soms kan een cursus uit meerdere cursussen bestaan. Cursussen worden in semesters geplaatst om standaard begin- en einddata te creëren. Als een cursus echter specifieke cursusdata bevat, hebben deze data voorrang op de toegangsdata voor studenten in het betreffende semester, die worden geïdentificeerd door de term_id (indien aanwezig). Het toevoegen van een term_id is handig omdat u hiermee de cursussen kunt sorteren en organiseren bij het bekijken van gegevens en rapporten in de beheerdersinterface. Een term_id kan eenvoudig aan meerdere cursussen worden gekoppeld die op hetzelfde moment beginnen en eindigen. Als u een cursus niet aan een semester koppelt, wordt de cursus gekoppeld aan het semester met de naam 'Standaardsemester'.
Als uw instelling blauwdrukcursussen heeft ingeschakeld, kunt u een courses.csv-bestand gebruiken om gekoppelde cursussen aan een blauwdrukcursus toe te voegen. Houd er rekening mee dat de blauwdrukcursus eerst moet zijn aangemaakt en als zodanig moet zijn ingeschakeld voordat gekoppelde cursussen kunnen worden toegevoegd.
Download een voorbeeldbestand courses.csv met 10 cursussen; deze bevinden zich in hun respectievelijke subaccounts binnen een specifiek semester.
Verplicht veld*| Plakkerig veld^
- cursus_id*:Dit is een unieke identificatiecode die wordt gebruikt om cursussen binnen Canvas van elkaar te onderscheiden. Deze identificatiecode mag niet veranderen voor de cursus en moet wereldwijd uniek zijn voor alle cursussen . In de gebruikersinterface wordt dit de SIS-ID genoemd.
- korte_naam*^: Dit is een korte naam voor de cursus. In de Canvas-interface wordt dit ook wel de cursuscode of referentiecode genoemd.
- lange_naam*^: Dit is de volledige naam van de cursus. (Deze kan hetzelfde zijn als de korte naam, maar als beide beschikbaar zijn, is het voor de gebruiker prettiger om beide te vermelden.)
- account_id^: Dit is de unieke SIS ID-accountidentificatiecode (uit het accounts.csv-bestand) die aangeeft onder welk subaccount de cursus valt. Als er geen account_id is opgegeven voor een nieuwe cursus, wordt de cursus gekoppeld aan uw hoofdaccount. De SIS ID is te vinden in de instellingen van het subaccount.
- term_id^: Dit is de unieke term-identificatiecode (uit terms.csv) die aangeeft wanneer de cursus moet beginnen en eindigen. Als u een term_id aan een cursus koppelt, hoeft u geen startdatum of einddatum in te voeren.
- status*^: Dit is de status van de cursus, ook wel bekend als de workflowstatus. Met dit veld kunt u een cursus aanmaken, verwijderen, afronden of publiceren. Markeer als actief om een cursus toe te voegen, als verwijderd om een bestaande cursus te verwijderen, als voltooid om een bestaande cursus af te ronden of als gepubliceerd om een nieuwe of bestaande cursus te publiceren.
- integration_id: Dit is een secundaire unieke identificatiecode die nuttig is voor complexere SIS-integraties. Deze identificatiecode mag gedurende de cursus niet veranderen en moet wereldwijd uniek zijn.
- start_date^: Dit is de datum waarop de cursus begint. Het formaat moet volgens ISO 8601 zijn: JJJJ-MM-DDTHH:MM:SSZ (De T mag worden vervangen door een spatie.)
- end_date^: Dit is de datum waarop de cursus eindigt. Het formaat moet volgens ISO 8601 zijn: JJJJ-MM-DDTHH:MM:SSZ (de T mag worden vervangen door een spatie). Standaard wordt de toegang voor gebruikers om middernacht op de door u aangegeven einddatum afgesloten. Dit betekent dat de dag ervoor de laatste volledige dag is waarop gebruikers toegang hebben tot de cursus. Het is aan te raden de einddatum in te stellen op de dag na het einde van de cursus.
- course_format : Dit is de vorm van de cursus. De vorm kan online , op de campus of blended zijn.
- blueprint_course_id : Dit is de cursus-ID van de blauwdrukcursus waaraan u een gekoppelde cursus wilt toevoegen. Om de koppeling met de blauwdrukcursus te verwijderen, kunt u 'dissociate' in plaats van de ID doorgeven. In de gebruikersinterface is dit de SIS-ID van de blauwdrukcursus.
- homeroom_course: Hiermee kunt u mentorlessen toewijzen aan Canvas voor basisschoolaccounts. Hiervoor moet de Canvas voor basisschool-instelling ingeschakeld zijn.
secties.csv
Een sectie verdeelt studenten binnen een cursus. Meerdere secties kunnen ook in één cursus worden opgenomen, vooral als alle studenten in de verschillende secties dezelfde cursusstof leren. Meerdere secties kunnen in één cursus worden geplaatst, maar een sectie kan geen andere secties bevatten. Secties nemen de cursusdata over zoals die door het semester zijn vastgesteld. Als een sectie echter specifieke data bevat, hebben deze data voorrang op de toegangsdata voor studenten tot de cursus en de begin- en/of einddatum van het semester.
Als u een cursus wilt verwijderen en de gebruikers zijn gekoppeld aan secties, moet u de parameter section_id en de SIS-ID's van de secties opnemen in de CSV-import.
Download een voorbeeld van het bestand sections.csv met de volgende secties:
- 4 onderdelen van de cursus ACCT300 - Kostenboekhouding
- 4 onderdelen van de cursus ACCT310 - Management Accounting
- 2 onderdelen van de cursus BIO101 - Inleiding tot de biologie
Dit bestand gaat ervan uit dat u meerdere secties binnen één cursus kunt hebben. Veel instellingen importeren cursussecties als aparte cursussen. Dit kan worden gedaan door (1) voor elke sectie in uw courses.csv een Canvas-cursus aan te maken en vervolgens (2) in elk van deze cursussen een aparte sectie aan te maken. U kunt in principe dezelfde gegevens gebruiken voor de cursus en de sectie, inclusief de SIS-ID, die hetzelfde zal zijn voor zowel de course_id als de section_id.
Verplicht veld*| Plakkerig veld^
- sectie_id*:Dit is een unieke identificatiecode die wordt gebruikt om secties binnen een cursus aan te maken. Deze identificatiecode mag niet veranderen voor de betreffende sectie en moet wereldwijd uniek zijn. In de gebruikersinterface wordt dit de SIS-ID genoemd.
- cursus_id*^: Dit is de unieke identificatiecode van de cursus waaraan het onderdeel wordt toegevoegd of verwijderd (toegevoegd in courses.csv).
- naam*^: Dit is de naam van de sectie. De secties zijn alfabetisch geordend op naam.
- status*:Zo kunt u een sectie binnen een cursus aanmaken of verwijderen. Markeer als actief om een sectie aan te maken of als verwijderd om een bestaande sectie te verwijderen.
- integration_id: Dit is een secundaire unieke identificatiecode die nuttig is voor complexere SIS-integraties. Deze identificatiecode mag niet veranderen binnen de sectie en moet wereldwijd uniek zijn.
- start_date^: Dit is de datum waarop de sectie begint. Het formaat moet volgens ISO 8601 zijn: JJJJ-MM-DDTHH:MM:SSZ (de T mag worden vervangen door een spatie).
- end_date^: Dit is de datum waarop de sectie eindigt. Het formaat moet volgens ISO 8601 zijn: JJJJ-MM-DDTHH:MM:SSZ (de T mag worden vervangen door een spatie). Standaard wordt de toegang voor gebruikers om middernacht op de door u aangegeven einddatum afgesloten, wat betekent dat de vorige dag de laatste volledige dag is waarop gebruikers toegang hebben tot de sectie. Het is aan te raden de einddatum in te stellen op de dag na het einde van de sectie.
Opmerking: Bij het importeren van sectie-CSV-bestanden worden bestaande integration_id waarden behouden als de kolom integration_id niet in het importbestand is opgenomen. Om een integration_id te verwijderen, moet deze expliciet worden verwijderd met behulp van het bestand change_sis_id.csv .
enrollments.csv
Een inschrijving is een gebruiker die is ingeschreven voor een cursus onder een specifieke rol. Met een enrollments.csv-bestand kunt u rollen toewijzen aan gebruikers en ze in de juiste cursussen plaatsen. Wanneer de inschrijvingsstatus van een gebruiker is gemarkeerd als 'voltooid', krijgt die gebruiker alleen leesrechten voor die cursus.
Let op: CSV-bestanden met SIS-inschrijvingen die start_date- en end_date-waarden bevatten, overschrijven de semesterdatums, cursusdatums en sectiedatums.
Download een voorbeeldbestand met inschrijvingen (enrollments.csv) met de volgende inschrijvingen:
- 1 gebruiker als docent in de cursus ACCT300 - Kostenboekhouding
- 1 gebruiker als assistent in de cursus ACCT300 - Kostenboekhouding
- 1 gebruiker als ontwerper in de cursus ACCT300 - Kostenboekhouding
- 3 gebruikers als studenten in sectie 1 van de cursus ACCT300 - Kostenboekhouding
- 3 gebruikers als studenten in sectie 2 van de cursus ACCT300 - Kostenboekhouding
- 1 gebruiker als observator van een student in sectie 1 van de cursus ACCT300 - Kostenboekhouding
Verplicht veld*| Plakkerig veld^
- course_id*: (Vereist als de section_id ontbreekt) Dit is een unieke identificatiecode voor de cursus waar de gebruiker wordt ingeschreven (toegevoegd in courses.csv). Als u studenten inschrijft voor de cursus in plaats van een specifieke sectie, vul dan de course_id in dit veld in. Laat het anders leeg.
- root_account : Dit is het domein van het account waarmee naar de gebruiker gezocht moet worden.
- start_date^: Dit is de startdatum van de inschrijving. Om start_date te laten gelden, moet ook end_date worden ingevuld. Het formaat moet voldoen aan ISO 8601 : JJJJ-MM-DDTHH:MM:SSZ.
- end_date^: Dit is de einddatum van de inschrijving. Om end_date te laten gelden, moet ook start_date worden ingevuld. Het formaat moet volgens ISO 8601 zijn: JJJJ-MM-DDTHH:MM:SSZ.
- gebruikers-ID*:Dit is de unieke identificatiecode van de gebruiker die wordt ingeschreven voor de betreffende cursussen (toegevoegd in users.csv). Als de user_integration_id aanwezig is, wordt dit veld genegeerd.
- user_integration_id*: (Vereist als de user_id ontbreekt)Dit is de secundaire unieke identificatiecode van de gebruiker (toegevoegd in users.csv als de integration_id).
- rol*:Dit is de rol die aan een gebruiker wordt toegewezen voor de betreffende cursus. U kunt een gebruiker inschrijven met een van de volgende rollen: docent, ontwerper, assistent, student, waarnemer of een aangepaste rol die u zelf definieert. Elke rol heeft een set machtigingen die beheerders kunnen aanpassen op het niveau van het hoofdaccount of subaccount.
- rol_id*: (Vereist als de rol ontbreekt)Dit is de unieke identificatiecode voor de rol waaraan de gebruiker wordt toegevoegd als onderdeel van een inschrijving.
- sectie_id*:(Vereist als de course_id ontbreekt) Dit is de unieke identificatiecode voor de sectie waarin de gebruiker wordt ingeschreven (toegevoegd in sections.csv). Als u studenten inschrijft voor een specifieke sectie van een cursus, vul dan hier de section_id van de sectie in. Laat dit veld anders leeg. Als er geen section_id is opgegeven, wordt de standaardsectie van de cursus gebruikt. Als er geen standaardsectie bestaat, wordt er automatisch een aangemaakt zonder SIS-ID.
- status*: Zo kunt u een inschrijving voor een cursus registreren, afronden, deactiveren (inactief maken) of verwijderen. Markeer als 'actief' om een gebruiker in te schrijven voor een cursus, als ' afgerond ' om de inschrijving van een gebruiker voor een cursus af te ronden, als 'inactief' om de gebruiker uit de cursus te deactiveren en als ' verwijderd ' om een gebruiker uit een cursus te verwijderen. Wanneer een student de status 'inactief' heeft, wordt deze wel weergegeven in de cursuslijst voor docenten, maar kan de student de cursus niet bekijken of eraan deelnemen totdat de inschrijving is geactiveerd.
- associated_user_id: (Alleen voor de rol van observator) Dit is de unieke identificatiecode van de gebruiker wiens informatie (inclusief cijfers) de observator kan inzien. De observator moet ingeschreven zijn voor dezelfde cursus/sectie als de gebruiker die hij of zij wil observeren. Dit veld wordt genegeerd voor elke rol behalve die van observator.
- limit_section_privileges: Hiermee geef je aan dat de gebruiker na inschrijving alleen gebruikers kan zien en mee kan communiceren die zijn ingeschreven in de sectie die wordt aangegeven door course_section_id. Dit veld heeft standaard de waarde false. Het beperken van interactie tussen studenten op basis van sectie is alleen van invloed op samenwerkingen, chat, personen en gesprekken. Bij het inschrijven van docenten en assistenten kunnen zij studenten in hun eigen sectie(s) beoordelen. Discussieonderwerpen en pagina's worden niet beïnvloed door sectiebeperkingen en kunnen door elke student worden bekeken. Deze functionaliteiten kunnen worden beperkt door content aan te maken in cursusgroepen.
- Notificatie: Hiermee kunt u een melding sturen naar de ingeschreven gebruiker(s) wanneer zij zich voor een cursus inschrijven.
Opmerking: Het veld root_account wordt aanbevolen bij het identificeren van gebruikers in een vertrouwd account .
groep_categorieën.csv
Met groepscategorieën kunt u groepen in Canvas organiseren. Een bestand group_categories.csv stelt u in staat om groepscategorieën aan te maken op account- of cursusniveau. In de gebruikersinterface worden groepscategorieën 'groepsets' genoemd.
Download een voorbeeldbestand group_categories.csv met de volgende groepscategorieën:
- Beheerdersgroepen
- Ontwerpersgroepen
- Geschiedenisprojectgroepen
Verplicht veld*| Plakkerig veld^
- groep_categorie_id:Dit is de identificatiecode die wordt gebruikt om naar de groepscategorie te verwijzen. De identificatiecode mag niet veranderen voor de groepscategorie en moet wereldwijd uniek zijn.
- account_id: Dit is de identificatiecode die de groepscategorie aan een account koppelt (toegevoegd in accounts.csv). Als er geen account of cursus is opgegeven, wordt de groep aan het hoofdaccount gekoppeld.
- course_id: Dit is de identificatiecode die de groepscategorie aan een cursus koppelt (toegevoegd in courses.csv). Als er geen cursus of account is opgegeven, wordt de groep aan het hoofdaccount gekoppeld.
- categorie_naam*^ : Dit is de naam van de groepscategorie.
- status*:Dit is de status van de groepscategorie. Markeer als actief om de groepscategorie aan te maken of als verwijderd om de groepscategorie te verwijderen.
groepen.csv
Een groep kan worden gebruikt om samenwerkingsmogelijkheden te bieden aan studenten, docenten, beheerders of andere gebruikers. Met een groups.csv-bestand kunt u groepen aanmaken op cursus- en accountniveau . Groepen die via SIS zijn geüpload, kunnen alleen via SIS worden bijgewerkt of verwijderd.
Download een voorbeeld van het bestand groups.csv met de volgende groepen:
- Beheerders
- Wiskundeleraren
- Ontwerpers
Verplicht veld*| Plakkerig veld^
- groep_id*:Dit is de unieke identificatiecode waarmee uw groep wordt aangeduid. Deze code mag niet veranderen voor de groep en moet wereldwijd uniek zijn.
- group_category_id: Dit is de identificatiecode van de groepscategorie (toegevoegd in group_categories.csv) waaraan u een groep toevoegt. Als er geen groepscategorie is opgegeven, wordt de groep geplaatst in de standaardgroepscategorie voor het gedefinieerde account of de gedefinieerde cursus. Als er geen account of cursus is opgegeven, wordt de groep geplaatst in de standaardgroepscategorie voor het hoofdaccount.
- account_id: Dit is de identificatiecode waarmee de groep aan een account wordt gekoppeld (toegevoegd in accounts.csv). Indien geen identificatiecode is opgegeven, wordt de groep aan het hoofdaccount gekoppeld.
- course_id: Dit is de identificatiecode waarmee de groep aan een cursus wordt gekoppeld (toegevoegd in courses.csv). Als er geen cursus of account is opgegeven, wordt de groep aan het hoofdaccount gekoppeld.
- naam*^: Dit is de naam van de groep.
- status*:Dit is de status van de groep. Markeer als beschikbaar om de groep open te stellen voor lidmaatschap of als verwijderd om de groep te verwijderen.
groups_membership.csv
Lidmaatschap van een groep stelt gebruikers in staat om samen te werken aan activiteiten in Canvas. Met een groups_membership.csv-bestand kunt u in één keer mensen toevoegen aan of verwijderen uit een groep die u via groups.csv hebt aangemaakt.
Download een voorbeeld van het bestand groups_membership.csv met de volgende groepslidmaatschappen:
- 1 gebruiker geaccepteerd in de beheerdersgroep
- 1 geaccepteerde gebruiker in de groep Wiskundedocenten
- 1 gebruiker verwijderd uit de groep Wiskundedocenten
Verplicht veld*
- groep_id*:Dit is de unieke identificatiecode waarmee naar uw groep wordt verwezen (toegevoegd in groups.csv).
- gebruikers-ID*:Dit is de unieke identificatiecode van de gebruiker die u aan de groep wilt toevoegen (toegevoegd in users.csv).
- status*:Dit is de status van de gebruikers in de groep. Markeer als ' geaccepteerd' om een gebruiker aan een groep toe te voegen of als 'verwijderd' om een gebruiker uit een groep te verwijderen.
xlists.csv
Met cross-listing kunt u secties naar een andere cursus verplaatsen. Een xlist.csv-bestand stelt u in staat om secties in bestaande cursussen te integreren en een sectiehiërarchie te creëren.
Er wordt verwacht dat de sectie-ID's al bestaan en al verwijzen naar andere cursus-ID's. Als er een sectie-ID in dit bestand wordt opgegeven, wordt deze verplaatst van de bestaande cursus-ID naar een nieuwe cursus-ID. Als die nieuwe cursus wordt verwijderd of de cross-listing wordt opgeheven, krijgt de sectie de oorspronkelijke cursus-ID terug. Als xlist_course_id niet verwijst naar een bestaande cursus, wordt deze aangemaakt. Wilt u meer informatie over de cross-listed cursus opgeven, doe dit dan in courses.csv.
Download een voorbeeld van een xlists.csv-bestand met de volgende cursussen en secties:
- 4 actieve onderdelen van de cursus ACCT300 - Kostenboekhouding zijn ook opgenomen in de cursus ACCT310 - Managementboekhouding
Verplicht veld*
- xlist_course_id*:Dit is de identificatiecode van de nieuwe cursus (toegevoegd in courses.csv).
- sectie_id*:Dit is de identificatiecode van de sectie (toegevoegd in sections.csv).
- status*:Dit is de status van de sectie. Markeer als actief om de sectie te activeren of als verwijderd om de sectie te verwijderen.
user_observers.csv
De observatorrol kan worden gebruikt om ouders te registreren en te koppelen aan een leerling, zodat ze de cijfers en interacties van hun kind in de lessen kunnen bekijken. Met een bestand user_observers.csv kunt u observatoren registreren en koppelen aan elk van de inschrijvingen van de betreffende leerling.
Download een voorbeeld van het bestand user_observers.csv met de volgende inschrijvingen:
- 2 actieve waarnemers
- 1 verwijderde waarnemer
Verplicht veld*
- observer_id*:Dit is de unieke identificatiecode van de waarnemer (toegevoegd als user_id in users.csv).
- student_id*:Dit is de unieke identificatiecode van de student (toegevoegd als user_id in users.csv).
- status*:Dit is de status van de observator. Markeer als actief om de observator voor elke inschrijving van de student te registreren, of als verwijderd om alle inschrijvingen van de observator te verwijderen.
logins.csv
Met het bestand logins.csv kunt u inloggegevens voor gebruikers aanmaken of bijwerken. Inloggegevens kunnen alleen worden toegevoegd aan bestaande gebruikers. Inloggegevens kunnen worden verwijderd met behulp van het bestand users.csv.
Download een voorbeeld van een logins.csv-bestand met drie gebruikersaanmeldingen.
Verplicht veld*| Plakkerig veld^
- gebruikers-ID*:Dit is de unieke identificatiecode van de gebruiker (zoals vermeld in enrollments.csv). Deze waarde mag niet veranderen voor de gebruiker en moet uniek zijn voor alle gebruikers. In de Canvas-gebruikersinterface wordt dit de SIS ID genoemd.
- integration_id: Dit is een secundaire unieke identificatiecode die nuttig is voor complexe SIS-integraties. Deze waarde mag niet veranderen voor de gebruiker en moet uniek zijn voor alle gebruikers. Dit veld moet leeg worden gelaten bij het samenvoegen van gebruikers met overeenkomende integratie-ID's.
- login_id*:Dit is de naam waarmee de gebruiker zich aanmeldt bij Canvas. Voor geconfigureerde authenticatieservices, zoals LDAP, is dit de gebruikersnaam van het externe systeem.
- Wachtwoord: Dit is het wachtwoord waarmee de gebruiker zich bij Canvas kan aanmelden. Dit veld hoeft niet te worden ingevuld voor accounts die zijn geconfigureerd voor LDAP of SSO.
- ssha_password: Dit is een wachtwoord dat is gegenereerd met een vooraf gehasht SSHA-schema.
- authentication_provider_id: Dit is de authenticatieprovider waarmee de login is gekoppeld.
- existing_user_id^: Dit is de SIS-ID van de gebruiker, zoals gevonden in users.csv.
- existing_integration_id^: Dit is de integratie-ID van de gebruiker, zoals te vinden in users.csv.
- existing_canvas_user_id^: Dit is de Canvas ID van de gebruiker.
- root_account: Dit is het domeinaccount van de gebruiker.
- e-mail: Dit is het e-mailadres van de gebruiker.
Opmerkingen:
- existing_user_id, existing_integration_id, or existing_canvas_user_id*: (vereist voor een succesvolle import van logins.csv)
- root_account*: (vereist bij het identificeren van gebruikers in eenvertrouwde rekeningbijvoorbeeld bij het koppelen van gebruikers aan meerdere accounts binnen een vertrouwd account.
- status*: (vereist bij het uitvoeren van een SIS-import met behulp van logins.csv)
admins.csv
Beheerders beheren de instellingen voor een volledig account of subaccount. Met een admins.csv-bestand kunt u gebruikers in Canvas aanwijzen als accountbeheerders of andere aangepaste account- of subaccountrollen.
Download een voorbeeld van een admins.csv-bestand met de volgende beheerders:
- 2 actieve accountbeheerders
- 1 verwijderde beheerdersaccount
- 2 actieve aangepaste accountrollen
Verplicht veld*
- gebruikers-ID*: Dit is de unieke ID van de gebruiker die u als beheerder wilt aanwijzen (toegevoegd in users.csv).
- account_id*: Dit is de unieke identificatiecode van het account waarin u de beheerder wilt onderbrengen (toegevoegd in accounts.csv). Als deze kolom leeg wordt gelaten, bevindt de gebruiker zich in het hoofdaccount. Deze kolom is altijd verplicht, zelfs als de waarde leeg is.
- rol_id*: (vereist als de rol ontbreekt)Dit is de ID van de rol, ofwel de standaard-ID of een aangepaste ID die door het account is gedefinieerd.
- rol*: (vereist als role_id ontbreekt)Dit is de naam van de rol, ofwel de standaardrol 'Accountbeheerder' of een aangepaste rol die door het account is gedefinieerd. Als u een accountbeheerder toevoegt, formatteer het veld dan zodat er 'AccountAdmin' staat. Als u een aangepaste rol toevoegt, formatteer het veld dan exact zoals het in de Canvas-interface wordt weergegeven.
- status*: Dit is de status van de beheerder. Markeer als actief om een actieve beheerder aan te maken of als verwijderd om een beheerder te verwijderen.
- root_account: Dit is het domein van het account waarmee naar de gebruiker gezocht moet worden.
change_sis_id.csv
Een SIS-ID is een unieke identificatiecode voor een object in Canvas. Met een change_sis_id.csv-bestand kunt u SIS-ID's in bulk wijzigen voor bestaande accounts, semesters, cursussen, secties, groepen of gebruikers.
Download een voorbeeld van het bestand change_sis_id.csv met de volgende SIS ID-wijzigingen:
- 1 gebruiker SIS ID wijziging
- 1 cursus SIS ID-wijziging
- 1 termijn SIS ID-wijziging
Verplicht veld*
- oude_id*: Dit is de huidige SIS-ID van het object.
- nieuwe_id*: Dit is de gewenste SIS-ID van het object. De nieuwe SIS-ID moet uniek zijn voor het objecttype en het root-account.
- type*: Dit is het type object. Het type kan account, termijn, cursus, sectie, groep of gebruiker zijn.