Guías de Canvas (es)Guía de Administración de Canvas Importaciones del SIS¿Cómo formateo los archivos de texto CSV para subir datos del SIS a una cuenta de Canvas?

¿Cómo formateo los archivos de texto CSV para subir datos del SIS a una cuenta de Canvas?

Canvas le permite manualmente crear usuarios, cuentas, términos, cursos, secciones, inscripciones, en grandes cantidades a través de la interfaz de administración.

Este documento hace referencia a la página API de Formato CSV de las importaciones del SIS donde se encuentra la mayoría de la información CSV. Cada archivo CSV es simbiótico con el otro y le dice a Canvas cómo administrar toda la información de la cuenta. Vea diagrama de la relación del SIS.

Cada paso en esta lección proporciona archivos CSV de ejemplo con descripciones de cada campo requerido y opcional. También encontrará un enlace para descargar cada archivo si desea revisar el formato de manera más profunda. Descargue un paquete comprimido de todos los archivos de ejemplo.

Debe practicar la importación de datos en su entorno de prueba de Canvas antes de importar cualquier contenido a su entorno de producción.

Formato de archivo CSV

Para subir datos en grandes cantidades a Canvas, debe crear uno o más archivos de texto CSV. Los archivos CSV pueden ser generados por muchos programas. Los Sistemas de Información Estudiantil (SIS) a menudo tienen un método para generar informes en formato CSV que pueden ser modificados de acuerdo al formato de Canvas. Si no sabe cómo guardar un archivo en formato CSV, consulte la documentación del programa que está utilizando para crear el archivo CSV (ejemplo., Excel).

Cuando se utiliza el formato de Instructure para importar archivos en la Página de importación del SIS, puede importar un archivo de texto CSV o puede comprimir varios archivos en un único archivo ZIP para los datos de importación en grandes cantidades. Si está cargando manualmente archivos por separado, debe cargar los archivos en el orden indicado en esta lección.

Formatear campo CSV

La primera fila de su archivo CSV (encabezado) debe incluir el nombre completo del campo para cada archivo. El orden de las columnas no importa, pero tener las filas ordenadas correctamente es crucial para los archivos como accounts.csv. Cuando cualquiera de estos datos es modificado en la interfaz del usuario (UI), Canvas establecerá los nuevos valores como "adheridos" (sticky). Cuando se realiza una nueva carga básica, los datos existentes en Canvas serán siendo "adheridos" y cualquier dato importado que trate de subir los datos será ignorado.

Una importación puede anular los cambios de la UI sólo si se seleccionan las opciones adecuadas cuando se usa la herramienta de Importación de SIS.

Documentación de API

Los archivos CSV sólo incluyen una serie de campos específicos. Canvas contiene valores adicionales que están disponibles a través de cada API individual. Después de ejecutar los archivos CSV para su institución, la práctica estándar para la mayoría de las instituciones es subir todos los archivos CSV del SIS y luego usar API de Canvas para actualizar los atributos completos del curso y la cuenta. Para más información, vea la documentación de API de Canvas para suarios, cuentas, términos, cursos, secciones, inscripciones y grupos.

users.csv

users.csv

Los usuarios son las personas que tienen cuentas de usuario dentro de una institución. Users.csv agrega personas al sistema como usuarios genéricos. El enrollments.csv asignará un rol (profesor, estudiante, etc.) a estos usuarios. Cuando una cuenta de usuario es "eliminada", todas sus inscripciones también se eliminarán y no podrán iniciar sesión en su cuenta de Canvas. Si todavía desea que un usuario tenga acceso pero que no participe o si desea eliminar sólo los de un curso en particular, entonces debería dejar su cuenta de usuario como "activos" y cambiar su inscripción (en el enrollments.csv) a "completado" o "eliminado", respectivamente.

Descargar un archivo users.csv. con 10 cuentas de usuario de Canvas.

Campos requeridos*

  • * user_id: Es un valor único usado para identificar a alguien con una cuenta en Canvas. Este valor no debe cambiar para el usuario y debe ser único entre todos los usuarios. En la interfaz de usuario, esto se llama ID del SIS y puede estar compuesto por cualquier combinación de caracteres. Puede encontrar este ID del SIS visitando cualquier cuenta de usuario y luego revisar en su "información de inicio de sesión".
  • integration_id: Este es un identificador único secundario útil para integraciones más complejas del SIS. Este identificador no debe cambiar para el usuario y debe ser único en el mundo
  • contraseña: Si la cuenta está configurada para usar LDAP o un protocolo SSO, entonces esto no es necesario. De lo contrario, esto es la contraseña para el 'login_id' anterior. Esta contraseña debe tener al menos 8 caracteres.
  • ssha_password: En lugar de una contraseña de texto sin formato, puede pasar una contraseña previamente hash mediante el esquema de generación de contraseña SSHA en este campo. Si bien es mejor que pasar una contraseña de texto sin formato, debe pedir a los usuarios que cambien su contraseña después de iniciar sesión por primera vez. Aprenda a generar contraseñas SSHA.
  • * login_id: Es el nombre de usuario que se utilizará para acceder a Canvas. Si usted tiene un servicio de autenticación configurado (como LDAP), éste normalmente coincidirá con su nombre de usuario en el sistema remoto. Login_id puede contener letras, números o los siguientes símbolos: - _ = + . @
  • Contraseña: Si la cuenta está configurada para usar LDAP o un protocolo SSO, entonces esta no es necesaria. De lo contrario, esta es la contraseña para el 'login_id' anterior. Si el usuario ya tiene una contraseña (de anterior importación de SIS o diferente), no será sobreescrita. Esta contraseña debe tener al menos 6 caracteres.
  • first_name: Es el nombre (primer nombre) del usuario.
  • last_name: Es el apellido del usuario.
  • full_name: Es el primer nombre y apellidos del usuario.
  • sortable_name: Ésta es la opción clasificable del nombre en Canvas, generalmente se obtiene del nombre del usuario pero se puede modificar para requisitos particulares.
  • Correo electrónico: Ésta es la "dirección de correo electrónico asignada por institución" y también se marcará como la "dirección de correo electrónico predeterminada" para esta cuenta de usuario. Esta dirección de correo electrónico debe proporcionarse incluso si es la misma que el login_id del usuario.
  • * status: Es donde usted puede agregar o eliminar un usuario de Canvas. Marque como "activo" para agregar un usuario o "borrado" para eliminar un usuario existente.

Conflictos de la dirección de correo electrónico

Canvas identifica a los usuarios según la dirección de correo electrónico. Cuando se agregan estudiantes a un curso, Canvas intenta resolver cualquier conflicto de la dirección de correo electrónico cuando el usuario primero inicia sesión en el curso.  

Normalmente las direcciones de correo electrónico son exclusivas para cada estudiante. A veces varios estudiantes pueden compartir una dirección de correo electrónico única. Cuando agrega estudiantes a los cursos a través de la Importación del SIS, Canvas reconoce cuando una dirección de correo electrónico es asignada a más de un estudiante.

  • Si un nuevo ID del SIS está asociado con una dirección de correo electrónico ya asignada a un ID existente del SIS, Canvas envía un correo electrónico a la dirección de correo electrónico.
  • Cuando los usuarios son agregados a una cuenta a través de la Importación del SIS, no recibirán una notificación por correo electrónico a menos que el sistema detecte un usuario duplicado. Sin embargo, si un usuario es añadido o inscrito manualmente, recibirá un correo electrónico notificándole que ha sido agregado o inscrito en un curso nuevo. El estudiante que comparte una dirección de correo electrónico recibirá una notificación diciendo que la dirección de correo electrónico ya está en uso y que debe crear una nueva cuenta en Canvas. Este proceso también puede ser usado al agregar un usuario a una matrícula de curso.

accounts.csv

Una cuenta es una unidad de organización dentro de Canvas (por ejemplo, la cuenta del padre para una institución). Cada cuenta puede contener una jerarquía de subcuentas, como la creación de cuentas para colegios profesionales individuales dentro de una institución o las escuelas individuales dentro de un distrito. Las subcuentas también pueden contener múltiples subcuentas, como cuando un colegio profesional se subdivide en departamentos o programas o es subdivido en niveles o materias.

Descargar un archivo de ejemplo accounts.csv con las siguientes subcuentas:

  • 3 subcuentas dentro de su cuenta principal/raíz. (Artes y Humanidades, Negocios, Matemáticas y Ciencias)
  • 4 subcuentas dentro de la subcuenta de su negocio. (Contabilidad, Informática, Economía y Marketing)
  • 3 subcuentas dentro la subcuenta de Matemáticas & Ciencia. (Biología, Física y Estadística)
  • 1 subcuenta dentro de la subcuenta de Artes y Humanidades. (Artes Visuales)
  • 2 subcuentas dentro de la subcuenta de Artes visuales. (Fotografía y Medios Digitales)

Campos requeridos*

  • * account_id: Es un identificador único utilizado para crear una subcuenta. El archivo courses.csv le permitirá asignar cursos a una id de cuenta en particular. Este identificador único no debe ser cambiado para la cuenta y debe ser universalmente único a través de todas las cuentas. En la interfaz de usuario de Canvas, esto se llama ID del SIS y puede ser modificado en "ajustes" para cada subcuenta respectiva.
  • parent_account_ id: Este identificador indica que una subcuenta debe estar anidada bajo esta cuenta padre. Si este campo está en blanco, entonces la subcuenta se pueden anidar bajo su cuenta principal o raíz. Tenga en cuenta que incluso si todos los valores están en blanco, la columna debe incluirse para distinguir el archivo de la importación de un grupo.
  • * name: Es el nombre de la subcuenta.
  • *status*: Es cómo puede crear o eliminar una subcuenta. Marque como "activo" para agregar una subcuenta o "borrado" para eliminar una subcuenta existente.

terms.csv

Un término proporciona un conjunto predeterminado de fechas de inicio y término de cualquier curso asignado a ese término. Las fechas del término para cursos se pueden administrar manualmente a nivel de curso sin un archivo de importación. Sin embargo, adjuntar un term_id a muchos cursos diferentes asegura que todos los cursos en ese término comiencen/finalicen al mismo tiempo. Las fechas de término cargadas también le ayudarán a ordenar y organizar cursos al visualizar los datos y los informes en la interfaz del Administrador.

Descargar un archivo de ejemplo terms.csv con 10 términos.

Campos requeridos*

  • * term_id: Es un identificador único para el término. El courses.csv le permitirá hacer referencia a este término y debe ser único universalmente a través de todos los términos. En la interfaz de usuario, esto se llama ID del SIS.
  • * name: Es el nombre de su término. Idee una buena convención de nomenclatura para que le sirva para hacer referencia a sus términos fácilmente. Existen muchas herramientas de administración que permiten la búsqueda o consulta de datos por el nombre del término.
  • *status: Es cómo se puede crear o eliminar un término. Marque "activo" para agregar un término o "borrado" para eliminar un término existente.
  • start_date: Es la fecha que comienza el término. El formato debe ser en ISO 8601: AAAA-MM-DDTHH:MM:SS (la "T" puede reemplazarse por un espacio, como se ve en la captura de pantalla de ejemplo.) Por ejemplo, 26 de agosto de 2013 a las 5:00 pm EST se escribiría 2013-08-26T17:00-5:00.
  • end_date: Es la fecha en que el término finaliza. El formato debe ser en ISO 8601: AAAA-MM-DDT HH:MM:SS (la "T" puede reemplazarse por un espacio, como se ve en la captura de pantalla de ejemplo). De forma predeterminada, el acceso de los usuarios se corta a la medianoche en la fecha final indicada, lo que significa que el día anterior es el último día completo en el que los usuarios tienen acceso al término. El mejor método es establecer su fecha de finalización el día después de que el término finaliza.

courses.csv

Un curso es una presentación organizada sobre una materia particular. A veces un curso puede incluir una serie de cursos. Los cursos son colocados dentro de los términos para crear fechas de inicio y término predeterminadas. Sin embargo, si estas fechas incluyen fechas del curso específicas, estas fechas anularán las fechas de acceso estudiantil en el término, identificado por el term_id (si está incluido). El valor de adjuntar un term_id le permitirá ordenar y organizar los cursos visualizando datos e informes, en la Interfaz de Administración. Un term_id puede adjuntarse fácilmente a muchos cursos diferentes que se inician/finalizan al mismo tiempo. Si no vincula un curso a un término, entonces el curso estará vinculado al término llamado "Término predeterminado"

Descargar un archivo ejemplo de courses.csv con 10 cursos; éstas se ubican dentro de sus subcuentas respectivas con un término específico.

Campos requeridos*

  • * course_id: Es un identificador único utilizado para diferenciar cursos dentro de Canvas. Este identificador no debe cambiar para el curso y debe ser único universalmente a través de todos los cursos. En la interfaz de usuario, esto se llama el ID del SIS.
  • * short_name: Es un nombre corto para el curso. En la interfaz de usuario de Canvas se le llama el "código del curso".
  • * long_name: Es un largo nombre (completo) para el curso. (Puede ser el mismo que el nombre corto, pero si ambos están disponibles, proporcionará una mejor experiencia para el usuario al proporcionar ambos).
  • account_id: Es el identificador único de cuenta (desde las accounts.csv) que indica el curso bajo qué subcuenta residirán. Si no se especifica un account_id entonces el curso se unirá a su cuenta principal/raíz.
  • term_id: Es el identificador único término (a partir de terms.csv) que le indica el curso cuándo comienzar y cuándo concluir. Si asocia una term_id con un curso, no necesitas introducir una start-date o end-date.
  • * status: Esto es cómo usted puede crear, eliminar o concluir un curso. Marque como "activo" para añadir un curso o "borrado" para eliminar un curso existente o "terminado" para concluir un curso existente.
  • start_date: Es la fecha que comienza el término. El formato debe ser en ISO 8601: AAAA-MM-DDTHH:MM:SS (la "T" puede reemplazarse por un espacio).
  • end_date: Es la fecha en que el término finaliza. El formato debe ser en ISO 8601: AAAA-MM-DDT HH:MM:SS (la "T" puede reemplazarse por un espacio). De forma predeterminada, el acceso de los usuarios se corta a la medianoche en la fecha final indicada, lo que significa que el día anterior es el último día completo en el que los usuarios tienen acceso al término. El mejor método es establecer su fecha de finalización el día después de que el término finaliza.
  • course_format: Este es el formato del curso. El formato puede ser "en línea", "on_campus" o "mezclado".

sections.csv

Una sección subdivide a los estudiantes dentro de un curso. Las secciones múltiples pueden también cruzarse en un curso, sobre todo si todas las secciones del estudiante están aprendiendo el mismo material del curso. Las secciones múltiples pueden ser colocadas en un curso, pero una sección no puede contener varias secciones. Las secciones heredan las fechas del curso según lo establecido por el término. Sin embargo, si una sección incluye fechas específicas, estas fechas anularán las fechas de acceso del estudiante para el curso y las fechas de comienzo/ finalización del término.  

Si intenta eliminar un curso y los usuarios están asociados a las secciones, debe incluir el parámetro section_id en la importación CSV, así como la sección de IDs del SIS.  

Descargar un archivo ejemplo de sections.csv con las siguientes secciones:

  • 4 secciones en el curso de "Contabilidad de costos  ACCT300"
  • 4 secciones en el curso "ACCT310  Gestión contable"
  • 2 secciones en el curso "BIO101  Introducción a la biología"

Este archivo supone que usted puede tener varias secciones dentro de un curso. Muchas instituciones importan secciones del curso como cursos independientes. Esto puede realizarse al (1) crear un curso de Canvas para cada sección en su courses.csv, luego (2) crear una sola sección en cada uno de estos cursos. Usted puede usar esencialmente los mismos datos para el curso y sección incluyendo el ID del SIS que será el mismo para el course_id y section_id.

Campos requeridos*

  • * section_id: Es un identificador único utilizado para crear secciones dentro de un curso. Este identificador no debe cambiar para la sección y debe ser único universalmente. En la interfaz de usuario, esto se llama ID del SIS.
  • * course_id: Es el identificador único del curso donde la sección será añadida o eliminada.
  • * name: Es el nombre de la sección. Las secciones son ordenadas alfabéticamente por nombre.
  • * status: Es como se puede crear o eliminar una sección dentro de un curso. Marque como "activo" para crear una sección o "borrado" para eliminar una sección existente.
  • start_date: Es la fecha que comienza el término. El formato debe ser en ISO 8601: AAAA-MM-DDTHH:MM:SS (la "T" puede reemplazarse por un espacio).
  • end_date: Es la fecha en que el término finaliza. El formato debe ser en ISO 8601: AAAA-MM-DDT HH:MM:SS (la "T" puede reemplazarse por un espacio). De forma predeterminada, el acceso de los usuarios se corta a la medianoche en la fecha final indicada, lo que significa que el día anterior es el último día completo en el que los usuarios tienen acceso al término. El mejor método es establecer su fecha de finalización el día después de que el término finaliza.

enrollments.csv

Una inscripción es un usuario que ha sido inscrito en un curso bajo un papel específico. Un enrollments.csv le permite asignar roles a los usuarios y colocarlos en los cursos apropiados. Cuando el estado de la inscripción de cualquier usuario está marcado como "completado", se limita al acceso de sólo lectura para ese curso.

Descargar un archivo ejemplo de enrollments.csv con las siguientes inscripciones:

  • 1 usuario como maestro en el curso “Contabilidad de costos  ACCT300”
  • 1 usuario como maestro asistente en el curso “Contabilidad de costos  ACCT300”
  • 1 usuario como diseñador en el curso de "Contabilidad de costos  ACCT300"
  • 3 usuarios como estudiantes en la sección 1 del curso "Contabilidad de costos  ACCT300"
  • 3 usuarios como estudiantes en la sección 2 del curso "Contabilidad de costos  ACCT300"
  • 1 usuario como observador de un estudiante en la sección 1 del curso "Contabilidad de costos  ACCT300"

Campos requeridos*

  • * course_id: (Se requiere si falta la section_id) es un identificador único para el curso donde se matriculará al usuario. Si se inscribe a los estudiantes en el curso en lugar de una sección específica, ingrese el course_id en este campo. De lo contrario, déjelo en blanco.
  • root_account: Éste es el dominio de la cuenta para buscar el usuario.
  • * user_id: Es el identificador único del usuario que será inscrito en los cursos señalados (agregados en user.csv).
  • * role: Éste es el papel que se le asignará a un usuario para el curso señalado. Se inscribe a un usuario para tener cualquiera de los siguientes roles: profesor, diseñador, maestro asistente, estudiante, observador o un papel personalizado que usted definirá. Cada rol tiene un conjunto de permisos que los administradores pueden personalizar en el nivel de cuenta o subcuenta principal/raíz.
  • role_id: (Se requiere si falta el rol)  Es el identificador único para el rol en el que se agregará al usuario como parte de una inscripción.
  • * section_id: (Se requiere si falta el course_id está) Es el identificador único para la sección en la que el usuario estará inscrito. Si inscribe a los estudiantes en una sección específica de un curso, ponga aquí la section_id de la sección. De lo contrario, deje este campo en blanco. Si no se especifica la section_id, se utilizará la sección predeterminada para el curso. Si no existe una sección de forma predeterminada, será creada automáticamente sin ID del SIS.
  • *status: Es cómo se inscribe, concluye, desactiva (hace inactiva) o elimina una inscripción en un curso. Marque como "activo" para inscribir a un usuario en un curso, "completado" para concluir la inscripción de un usuario en un curso o "borrado" para eliminar a un usuario de un curso. Cuando está en un estado "inactivo", un estudiante será agregado al listado del curso para instructores, pero no podrá ver o participar en el curso hasta que la inscripción sea activada.
  • associated_user_id: (Sólo para papel de observador) Es el identificador único del usuario cuya información (incluyendo grados) del observador será capaz de ver. El observador debe estar inscrito en el mismo curso/sección que el usuario que quiere observar. Este campo se omitirá para cualquier rol que no sea observador.

groups.csv

Un grupo puede utilizarse para proporcionar oportunidades de colaboración para los estudiantes, los instructores, los administradores u otros usuarios. Un groups.csv le permite crear grupos a nivel de cuenta. Grupos cargados vía SIS pueden ser actualizados o eliminados vía SIS.

Descargue una muestra de un archivo groups.csv con los siguientes grupos:

  • Administradores
  • Maestros de matemáticas
  • Diseñadores

Campos requeridos *

  • * group_id: Es el identificador único utilizado para hacer referencia a su grupo. No debe cambiar para el grupo y debe ser único en el mundo.
  • account_id: Es el identificador que acopla el grupo a una cuenta (agregada en cuentas.csv). Si no se especifica, el grupo se unirá a la cuenta root.
  • * nombre: Éste es el nombre del grupo.
  • * estado: Éste es el estado del grupo. Marque como "disponible" para establecer que el grupo está abierto para membresía o "borrado" para eliminar el grupo.

groups_membership.csv

Pertenecer a un grupo permite que los usuarios colaboren en actividades en Canvas. Un groups_membership.csv le permite agregar o quitar personas en grandes cantidades en un grupo que haya creado a través de groups.csv.

Descargue una muestra de groups_membership.csv con la siguiente membresía de grupos:

  • 1 usuario aceptado en el grupo de administradores
  • 1 usuario aceptado en el grupo de maestros de matemáticas
  • 1 usuario eliminado en el grupo de maestros de matemáticas

Campos requeridos *

  • * group_id: Es el identificador único utilizado para hacer referencia a su grupo (agregado en groups.csv).
  • * user_id: Es el identificador único del usuario que desea agregar al grupo.
  • * estado: Éste es el estado de los usuarios en el grupo. Marque como "aceptado" para agregar a un usuario en un grupo o "eliminado" para quitar un usuario de un grupo.

xlists.csv

Hacer un listado en otros lugares le permite mover secciones a otro curso. Un archivo de xlist.csv le permite hacer un listado cruzado de las secciones en los cursos existentes y crear una jerarquía de sección.

Se espera que ya exista el ID de la sección y que ya se permitan referencias a otros ids del curso. Si se proporciona una id de sección en este archivo, se trasladará del curso existente a un nuevo id del curso, es decir, si se quita ese nuevo curso o el listado cruzado, la sección volverá a su id de curso anterior. Si xlist_course_id no hace referencia a un curso existente, será creado. Si desea proporcionar más información sobre el curso del listado cruzado, por favor hágalo en courses.csv.

Descargue una muestra de un archivo xlists.csv con los siguientes cursos y secciones:

  • 4 secciones activas en el curso de "ACCT300 - Cost Accounting" listado también en el curso "ACCT310 - Managerial Accounting".

Campos requeridos *

  • * xlist_course_id: Es el identificador del nuevo curso (agregado en courses.csv).
  • * section_id: Es el identificador de la sección (agregado en sections.csv).
  • * estado: Éste es el estado de la sección. Marque como "activa" para marcar la sección activa o "borrada" para quitar la sección.

user_observers.csv

El papel de observador puede ser usado para inscribir a los padres y vincularlos a un estudiante, permitiéndoles ver las calificaciones de los estudiantes y las interacciones del curso. Un user_observers.csv le permite inscribir y enlazar observadores a cada una de las inscripciones del estudiante designado.

Descargue un archivo de muestra de user_observers.csv con las siguientes inscripciones:

  • 2 observadores activos
  • 1 observador eliminado

Campos requeridos *

  • * observer_id: Es el identificador único del observador.
  • * student_id: Es el identificador único del estudiante.
  • * estado: Éste es el estado del observador. Marque como "activo" para inscribir al observador para cada uno de las inscripciones de los estudiantes o "borrado" para quitar todas las inscripciones del observador.