Canvas vous permet de créer en masse manuellement des utilisateurs, des comptes, des échéances, des cours, des sections, des inscriptions et des identifiants via l'interface Administrateur.
Ce document mentionne la page API au format du CSV des importations SIS où se trouvent la majorité des informations CSV. Chaque fichier CSV est en symbiose avec un autre et dit à Canvas comment gérer toutes les informations du compte. Afficher le diagramme de relation SIS.
Dans cette leçon, vous trouverez des exemples de fichier CSV avec les descriptions de chaque champ obligatoire et optionnel. Vous trouverez également un lien pour télécharger chaque fichier si vous souhaitez étudier de plus près le formatage. Téléchargez un package zippé de tous les fichiers exemples. Si un lien de téléchargement de fichier CSV ne fonctionne pas, essayez de l'ouvrir dans un nouvel onglet.
Vous devriez tester l'importation de données dans votre environnement de test de Canvas avant d'importer des contenus dans votre environnement de production.
Format de fichier CSV
Afin de télécharger en masse des données dans Canvas, vous devez créer un ou plusieurs fichiers texte CSV. Les fichiers CSV peuvent être générés par de nombreux programmes. Le système d'information sur les élèves (SIS) dispose souvent d'une méthode de génération de rapports au format CSV qui peuvent être modifiés pour s'adapter au format requis par Canvas. Si vous ne savez pas comment sauvegarder un fichier au format CSV, veuillez consulter la documentation du programme que vous utilisez pour créer votre ficher CSV (par ex. Excel).
Lorsque vous utilisez le format Infrastructure pour importer les fichiers dans la page d'Import SIS, vous avez la possibilité d'importer un fichier texte CSV individuel, ou pouvez compresser plusieurs fichiers dans une arche ZIP unique afin de réaliser un import groupé des données. Si vous transférer manuellement des fichiers individuels, ces derniers doivent l'être dans l'ordre indiqué dans cette leçon.
Formatage champs CSV
Il est impératif que la première ligne de votre fichier CSV (en-tête) comprenne le nom complet de champ de chaque fichier. L'ordre des colonnes n'a pas d'importance, mais avoir un ordre de lignes correct est crucial pour les fichiers comme les comptes.csv.
Champs adhésifs
Par défaut, certains changements effectués sur l'interface utilisateur ne sont pas écrasés par les futures importations SIS. Ils sont alors décrits comme « adhésifs ». Tous les champs adhésifs sont identifiés dans ce document. Vous pouvez écraser ces champs en paramétrant override_sis_stickiness dans l'API ou en cochant la case « Écraser les changements d'interface utilisateur » dans la page d'importations SIS.
Documentation API
Les fichiers CSV comprennent uniquement un ensemble spécifique de champs. Canvas contient des valeurs supplémentaires qui sont disponibles par l'entremise de chaque API individuel. Après avoir exécuté les fichiers CSV pour votre institution, une pratique courante pour la majorité des institutions est de télécharger tous les fichiers SIS CSV, puis d'utiliser l'API de Canvas pour mettre à jour le compte et les attributs du cours dans leur intégralité. Pour plus d'informations, consultez la documentation de l'API de Canvas concernant les utilisateurs, les comptes, les trimestres, les cours, les sections, les inscriptions et les groupes. Les importations SIS peuvent également être gérées à l'aide de l'API des importations SIS.
Les utilisateurs sont les personnes qui ont des comptes d'utilisateurs au sein d'une institution. Le fichier utilisateurs.csv ajoute des personnes dans le système en tant qu'utilisateurs génériques. Le fichier enrollments.csv attribuera un rôle (enseignant, élève, etc.) à ces utilisateurs. Lorsqu'un compte utilisateur est supprimé toutes les inscriptions de cet utilisateur seront également supprimées et ils ne pourra plus se connecter à son compte Canvas. Si vous souhaitez toujours que l'utilisateur puisse continuer à se connecter, mais qu'il ne participe plus ou si vous souhaitez seulement le supprimer d'un cours spécifique, vous devrez alors laisser le compte utilisateur sur actif et passer son inscription (dans inscriptions.csv) sur finie ou supprimée, respectivement.
Téléchargez un fichier exemple users.csv avec 10 comptes d'utilisateur Canvas.
Champ requis* | Champ adhésif^
Canvas identifie les utilisateurs par l’adresse mail. Lorsque les élèves sont ajoutés à un cours, Canvas tente de corriger tout conflit sur l'adresse mail, lorsque l'utilisateur se connecte au cours pour la première fois.
Les adresses mail sont généralement personnelles pour chaque élève. Parfois, des élèves peuvent partager une même adresse mail. Lors de l'ajout d'élèves à des cours via l'importation SIS, Canvas identifie lorsqu'une adresse mail est attribuée à plusieurs élèves.
Un compte représente une unité de l'organisation au sein de Canvas (par exemple, le compte parent pour une institution). Chaque compte peut contenir une hiérarchie de sous-comptes, tels que la création de comptes pour les collèges individuels au sein d'une institution, ou pour chaque école au sein d'un district. Les sous-comptes peuvent également contenir plusieurs sous-comptes, comme quand un collège se subdivise en départements ou programmes, ou quand une école se subdivise en niveaux de notes ou sujets.
Téléchargez un fichier exemple accounts.csv avec les sous-comptes suivants :
Champ requis* | Champ adhésif^
Un trimestre fournit un ensemble par défaut de dates de début et de fin aux cours assignés à ce trimestre. Les dates de ce trimestre de cours peuvent être gérées manuellement au niveau du cours sans un fichier d'importation. Toutefois, relier un term_id à plusieurs cours différents assure que tous les cours de ce trimestre commenceront/finiront en même temps. Les dates de trimestre téléchargées vous aideront également à classer et à organiser des cours en visualisant les données et les rapports dans l'interface Administrateur.
Téléchargez un fichier exemple terms.csv avec 10 trimestres
Champ requis* | Champ adhésif^
Un cours est la présentation organisée d'un sujet particulier. Parfois, un cours peut inclure une série de cours. Les cours sont placés dans les trimestres pour créer des dates de début et de fin par défaut. Toutefois, si un cours comprend des dates précises de cours, ces dates remplacent les dates d'accès des élèves au cours du trimestre, identifiées par le term_id (si inclus). L'intérêt de lier un term_id est que vous pourrez classer et organiser les cours en visualisant les données et les rapports, dans l'interface Administrateur. Un term_id peut être facilement lié à plusieurs cours différents qui commencent/finissent en même temps. Si vous ne liez pas un cours à un trimestre, alors ce cours sera lié au trimestre appelé Trimestre par défaut.
Si votre institution a activé les Projets de cours, vous pouvez utiliser un courses.csv pour ajouter des cours associés à un Projet de cours. Veuillez noter que le Projet de cours doit être créé et activé en tant que Projet de cours avant que des cours associés ne puissent être ajoutés.
Téléchargez un fichier exemple courses.csv avec 10 cours ; ils sont intégrés à leurs sous-comptes respectifs pendant un trimestre spécifique.
Champ requis* | Champ adhésif^
Une section subdivise les élèves dans un cours. Plusieurs sections peuvent aussi être communes à un cours, surtout si toutes les sections d'élèves apprennent le même matériau de cours. Plusieurs sections peuvent être placées dans un cours, mais une section ne peut pas contenir plusieurs sections. Les sections héritent des dates de cours telles que fixées par le trimestre. Toutefois, si une section comprend des dates précises, ces dates remplaceront les dates d'accès des élèves au cours et les dates de début et/ou de fin.
Si vous essayez de supprimer un cours et que les utilisateurs sont associés à des sections, vous aurez besoin d'inclure le paramètre section_id dans l'importation CSV ainsi que les ID SIS de la section.
Téléchargez un fichier exemple sections.csv avec les sections suivantes :
Ce fichier suppose que vous pouvez avoir plusieurs sections à l'intérieur d'un même cours. De nombreuses institutions importent les sections de cours comme des cours distincts. Cela peut être fait par (1) la création d'un cours Canvas pour chaque section dans votre cours.csv, puis (2) la création d'une section unique dans chacun de ces cours. Vous pouvez principalement utiliser les mêmes données pour le cours et la section, y compris l'ID SIS qui sera le même pour à la fois cours_id et section_id.
Champ requis* | Champ adhésif^
Une inscription représente un utilisateur qui a été inscrit à un cours dans un rôle spécifique. Une inscription.csv vous permet d'attribuer des rôles aux utilisateurs et de les placer dans les cours appropriés. Lorsque le statut de l'inscription des utilisateurs est marqué comme terminé, ils seront limités à un accès en lecture seule à ce cours.
Téléchargez un fichier exemple enrollments.csv avec les inscriptions suivantes :
Champ requis*
Les catégories de groupe vous permettent d'organiser des groupes dans Canvas Un fichier group_categories.csv vous permet de créer des catégories de groupe au niveau du compte ou du cours. Dans l'interface utilisateur, les catégories de groupe sont appelées ensembles de groupes.
Téléchargez un fichier exemple de group_categories.csv avec les catégories de groupes suivantes :
Champ requis* | Champ adhésif^
Un groupe peut être utilisé pour renforcer les opportunités de collaboration pour les élèves, les instructeurs, les administrateurs ou les autres utilisateurs. Un fichier groups.csv vous permet également de créer des groupes au niveau du compte et des groupes au niveau du cours. Les groupes transférés via SIS ne peuvent être mis à jour ou supprimés que via SIS.
Téléchargez un fichier exemple groups.csv avec les groupes suivantes :
Champ requis* | Champ adhésif^
L'adhésion à un groupe permet aux utilisateurs de participer aux activités dans Canvas. Un groups_membership.csv vous permet d'ajouter ou de supprimer en masse des personnes à un groupe que vous avez créé via groups.csv.
Téléchargez un fichier exemple de groups_membership.csv avec les adhésions aux groupes suivantes :
Champ requis*
Les listes croisées vous permettent de déplacer des sections dans un autre cours. Un fichier xlist.csv vous permettra de croiser des sections dans des cours existants et de créer une hiérarchie des sections.
Les ID de sections sont censés déjà exister et déjà référencer d'autres ID de cours. Si un ID de section est fourni dans ce fichier, il sera déplacé vers un nouvel ID de cours de façon à ce que le nouveau cours ou sa liste croisée soit déplacés. La section retrouvera alors son ID de cours précédent. Si xlist_course_id ne contient aucun cours existant, il sera créé. Si vous souhaitez fournir plus d'informations sur sur le cours croisé, faites-le dans le fichier courses.csv.
Téléchargez un exemple de fichier xlists.cvs avec les cours et sections suivants :
Champ requis*
Le rôle d'Observateur peut être utilisé pour inscrire les parents et les relier à un élève, ce qui leur permet d'afficher les notes de leurs élèves et les interactions du cours. Un user_observers.csv vous permet d'inscrire et de lier des observateurs à chacune des inscriptions de l'élève désigné.
Téléchargez un fichier exemple user_observers.csv avec les inscriptions suivantes :
Champ requis*
Le fichier logins.csv vous permet de créer ou de mettre à jour les informations d'identification de vos utilisateurs. Ces identifiants peuvent uniquement être ajoutés à des utilisateurs existants. Les identifiants peuvent être supprimés à l'aide du fichier users.csv.
Téléchargez un fichier exemple logins.csv avec les trois identifiants d'utilisateurs.
Champ requis* | Champ adhésif^
Remarques :
Les administrateurs gèrent les paramètres d'un compte entier ou d'un sous-compte. Un admins.csv vous permet de désigner des utilisateurs dans Canvas en tant qu'administrateurs de compte ou d'autres rôles personnalisés de compte ou sous-compte.
Téléchargez un fichier exemple admins.csv avec les administrateurs suivants :
Champ requis*
Un identifiant SIS est un identifiant unique pour un objet dans Canvas. Un change_sis_id.csv vous permet de convertir en masse des identifiants SIS pour les comptes, les trimestres, les cours, les sections, les groupes ou les utilisateurs existants.
Téléchargez un fichier exemple change_sis_id.csv avec les modifications des identifiants SIS suivants :
Champ requis*