Como eu formato arquivos de texto CSV para enviar dados SIS para uma conta do Canvas?

O Canvas permite que você importe arquivos CSV para criar manualmente usuários, contas, períodos, cursos, seções, matrículas e logins em massa através da interface de Administração.

Este documento refere-se à página API do Formato CSV de Importação do SIS onde a maioria das informações sobre CSV estão localizadas. Cada arquivo CSV é simbiótico com outro e informam ao Canvas como administrar todas as informações para a conta. Veja o diagrama da relação do SIS.

Arquivos de amostra

Cada etapa desta lição fornece detalhes sobre os arquivos CSV e descrições de cada campo obrigatório e opcional. Cada etapa também inclui um link para download de um arquivo CSV de amostra. Os arquivos de amostra contêm todos os campos obrigatórios e também podem conter campos opcionais. Além disso, você pode fazer o download de um pacote compactado com todos os arquivos de amostra. Se os links do CSV não forem baixados, tente abrir o link em uma nova guia.

Você deve praticar a importação de dados em seu ambiente de teste do Canvas antes de importar qualquer conteúdo para seu ambiente de produção.

Formato do arquivo CSV

Para carregar dados em massa no Canvas, você deve criar um ou mais arquivos de texto CSV. Arquivos CSV podem ser gerados por diversos programas. Sistemas de Informação Estudantil (Student Information Systems SIS) frequentemente possuem um método para gerar relatórios em formato CSV que podem ser modificados para se adequar ao formato requerido pelo Canvas. Se você não sabe como salvar um arquivo em formato CSV, consulte a documentação para o programa que estiver utilizando ao criar seu arquivo CSV (por ex., Excel).

Ao usar o formato da Instructure para importar arquivos na página de importação do SIS, você pode importar um arquivo de texto CSV individual ou você pode comprimir vários arquivos em um único arquivo ZIP para a importação de dados em massa. Se você estiver enviando arquivos individuais manualmente, os arquivos devem ser enviados na ordem mostrada nesta lição.

Formatação do Campo CSV

A primeira fileira de seu arquivo CSV (cabeçalho) deve incluir o nome do campo completo para cada arquivo. A ordem das colunas não importa, mas organizar as fileiras adequadamente é essencial para arquivos como accounts.csv.

Campos adesivos

Por padrão, certas alterações feitas na interface de usuário não são sobregravadas por futuras importações SIS e são especificadas como sendo adesivas. Todos os campos adesivos estão identificados no documento. É possível ignorar esses campos ao configurar override_sis_stickiness na API ou selecionar a caixa de seleção Substituir as alterações da UI (Override UI changes) na página Importação SIS (SIS Import).

Documentação da API

Os arquivos CSV só incluem um conjunto específico de campos. O Canvas contém valores adicionais disponíveis por cada API individual. Após executar os arquivos CSV para sua instituição, a prática padrão para a maioria das instituição é enviar todos os arquivos CSV do SIS e, em seguida, usar a API do Canvas para atualizar todos os atributos do curso e da conta. Para mais informações, visualize Documentação da API do Canvas para Usuários, Contas, Períodos, Cursos, Turmas, Matrículas e Grupos. Importações do SIS também podem ser gerenciadas usando o API de importações do SIS.

users.csv

Os usuários são as pessoas que têm contas de usuário em uma instituição. O arquivo users.csv adiciona pessoas no sistema como usuários genéricos. O arquivo enrollments.csv irá atribuir uma função (professor, estudante, etc.) para esses usuários. Quando uma conta de usuário é excluída, todas as matrículas serão excluídas também e o usuário não poderá se conectar na conta Canvas. Se você ainda quiser que o usuário consiga se conectar, mas sem participar ou se você quiser apenas excluí-lo de um curso específico, então, deixe a conta de usuário como ativa e altere a matrícula (no arquivo enrollments.csv) para concluído ou excluído, respectivamente.

Baixe um arquivo de amostra users.csv com 10 contas de usuário do Canvas.

Campo obrigatório* | Campo adesivo^

  • user_id*: Esse é um valor único utilizado para identificar qualquer um com uma conta no Canvas. Esse valor não deve ser alterado para o usuário e deve permanecer único entre todos os usuários. Na interface de usuário, esse campo é chamado SIS ID e pode ser composto por qualquer combinação de caracteres. Você pode encontrar esse SIS ID visitando qualquer conta de usuário e então visualizando sua Informação de Autenticação (Login Information).
  • integration_id: Este é um identificador único secundário útil para integrações SIS mais complexas. Este identificador não deve ser alterado para o usuário, e deve ser mundialmente único.
  • login_id*^: Esse é o nome de usuário que será utilizando para entrar no Canvas. Se você tem um serviço de autenticação configurado (como LDAP), esse campo tipicamente irá coincidir com o seu nome de usuário no sistema remoto. Login_id pode conter letras, números ou qualquer um dos seguintes símbolos:  - _ = + . @
  • senha:  Se uma conta é configurada para usar LDAP ou qualquer outro protocolo de Single-Sign-On (SSO), então esse campo não é requerido. Caso contrário, essa é a senha para o “login_id” acima. Essa senha deve ter pelo menos 8 caracteres.
  • ssha_password: Em vez de uma senha em texto simples, você pode usar uma senha pré-hasheada utilizando o esquema de geração da senha SSHA neste campo. Apesar de ser melhor do que utilizar uma senha com texto simples, você ainda deve incentivar os usuários a alterarem suas senhas após se conectarem pela primeira vez. Saiba como gerar senhas SSHA.
  • authentication_provider_id: Este é o provedor de autenticação com o qual o login é associado. Logins associados a um provedor específico só podem ser usados com esse provedor. Provedores antigos (LDAP, CAS, SAML) pesquisarão logins associados com eles ou logins não associados. Novos provedores só buscarão logins explicitamente associados a eles. Isso pode ser a ID inteira do provedor ou o tipo do provedor (em qualquer caso, ele encontrará o primeiro provedor correspondente).  
  • first_name^:  Esse é o primeiro nome do usuário. Se presente, usado para construir full_name e/ou sortable_name.
  • last_name^:  Esse é o sobrenome (último) do usuário. Se presente, usado para construir full_name e/ou sortable_name.
  • full_name^: Esse é o nome e sobrenome do usuário. Omita first_name e last_name se isso for fornecido.
  • sortable_name^: Esta é a opção de nomes ordenáveis no Canvas, normalmente determinados a partir do nome de usuário, mas podem ser personalizáveis.
  • short_name^: Esse é o nome de usuário exibido, normalmente determinado a partir do nome de usuário, mas pode ser personalizado.
  • email:  Esse é o "endereço de e-mail atribuído pela instituição" e também será marcado como "endereço de e-mail padrão" para esta conta de usuário. Esse endereço de e-mail ainda deve permanecer mesmo que seja o mesmo que o login_id do usuário.
  • pronomes Se pronomes pessoais estiverem ativados, esses são os pronomes pessoais exibidos após o nome de um usuário no Canvas. O campo de pronomes aceita todos os pronomes, mesmo que não tenham sido criados na página Configurações da Conta.
  • declared_user_type: Esse tipo de usuário declarado pode ser administrative, observer, staff, student, student_other ou teacher. Pode passar "<delete>" para remover o tipo de usuário declarado do usuário.
  • canvas_password_notification: O padrão é falso. Quando true, o usuário é notificado para configuração de senha se o authentication_provider_id for Canvas. Se a sua instituição não tiver uma integração com o Canvas SIS, esse campo é necessário para notificar os novos usuários sobre suas contas criadas.
  • home_account: Definir home_account como true criará um novo usuário na conta de destino para a importação do SIS e mesclará outro usuário existente de outra conta dentro do consórcio com um integration_id correspondente. Será ignorado, a menos que a conta de destino esteja associada a um consórcio de mesclagem automática.
  • status*^:  Esse é o campo onde você pode adicionar ou remover usuários do Canvas. Marque como ativo para adicionar um usuár, suspenso para suspender um usuário, ou excluído para remover um usuário existente.

Conflitos de Endereço de E-mail

O Canvas identifica usuários por endereço de e-mail. Quando os alunos são adicionados a um curso, o Canvas tenta conciliar qualquer conflito de endereço de e-mail quando o usuário acessa o curso pela a primeira vez.

Normalmente, endereços de e-mail são exclusivos para cada aluno. Às vezes, vários estudantes podem partilhar um endereço de e-mail único. Quando estiver adicionando os estudantes de cursos através de importação do SIS, o Canvas reconhece quando um endereço de e-mail está atribuído a mais de um aluno.

  • Se um novo ID SIS está associado com um endereço de e-mail já atribuído a um ID SIS existente, o Canvas envia um e-mail para o endereço de e-mail.
  • Quando os usuários são adicionados a uma conta através de importação SIS, eles não receberão uma notificação por e-mail, a menos que o sistema detecte um usuário duplicado. No entanto, se um usuário é adicionado ou matriculado manualmente, eles receberão um e-mail notificando-os que foram adicionados ou matriculados em um curso novo. O aluno que compartilha um endereço de e-mail receberá uma notificação de que o endereço de e-mail já está em uso e é convidado para criar uma nova conta no Canvas. Esse processo também pode ser aplicado ao adicionar um usuário a uma inscrição de curso.

accounts.csv

Uma conta é uma unidade de organização no Canvas (por ex., a conta pai para uma instituição). Cada conta pode conter uma hierarquia de subcontas, como criar contas para faculdades individuais em uma instituição, ou para escolas individuais em um distrito. Subcontas também podem conter várias subcontas, como quando uma faculdade subdivide-se em departamentos ou programas, ou uma escola subdivide-se em níveis escolares ou matérias.

Baixe um arquivo accounts.csv de exemplo com as seguintes subcontas:

  • 3 subcontas em sua conta principal/conta raiz. (Artes & Humanidades, Negócios, Matemática & Ciência) (Arts & Humanities, Business, Math & Science)
  • 4 subcontas em sua subconta Negócios. (Contabilidade, Ciência da Computação, Economia e Marketing) (Accounting, Computer Science, Economics e Marketing)
  • 3 subcontas em sua subconta Matemática & Ciência. (Biologia, Física e Estatística) (Biology, Physics e Statistics)
  • 1 subconta em sua subconta Artes & Humanidades. (Artes Visuais) (Visual Arts)
  • 2 subcontas em sua subconta Artes Visuais. (Fotografia e Mídia Digital) (Photography e Digital Media)

Campo obrigatório* | Campo adesivo^

  • account_id*:  Esse é um identificador único para criar uma subconta. O arquivo courses.csv irá permitir que você faça a atribuição de um curso para um id de conta (account_id) específico. Esse identificador único não pode ser mudado para a conta e deve ser globalmente único entre todas as contas. Na Interface de Usuário do Canvas (UI), esse campo é chamado SIS ID e pode ser modificado visitando as Configurações para cada subconta respectivamente.
  • parent_account_id*^: Esse identificador indica que uma subconta deve ser alinhada abaixo de sua conta pai. Se esse campo estiver em branco, então a subconta será alinhada abaixo de sua conta raiz ou conta principal. Observe que mesmo se os valores estiverem em branco, a coluna deve ser incluída para diferenciar o arquivo de uma importação de grupo.
  • name*^:  Esse é o nome para a subconta.
  • status*: É assim que você pode criar ou remover uma subconta. Marque como active (ativo) para adicionar uma subconta ou deleted (excluído) para remover uma subconta existente.
  • integration_id: Este é um identificador único secundário útil para integrações SIS mais complexas. Esse identificador não deve ser alterado para a conta e deve ser globalmente único.

terms.csv

Um período oferece um conjunto padrão de datas iniciais e finais para qualquer curso atribuído ao período. As datas do período para os cursos podem ser administradas manualmente no nível do curso sem um arquivo de importação. No entanto, anexar um term_id para muitos cursos diferentes garante que todos os cursos nesse período irão começar/terminar ao mesmo tempo. As datas do período enviadas também irão ajudar você a ordenar e organizar os cursos ao exibir dados e relatórios na interface do Administrador.

Baixe um arquivo terms.csv de exemplo com 10 períodos.

Campo obrigatório* | Campo adesivo (Sticky Field)^

  • term_id*:  Esse é um identificador único para o período. O arquivo courses.csv permite a você referenciar esse term_id para que saiba quando seus cursos irão começar e quando irão ser concluídos. Esse identificador não pode ser mudado para um período e deve ser globalmente único entre todos os períodos. Na interface de usuário, esse é chamado SIS ID.
  • nome*^:  Esse é o nome do seu período. Iniciar com uma boa convenção de nomes irá ajudá-lo a referenciar facilmente seus períodos.  Existem diversas ferramentas de administração que permitem a você procurar ou consultar dados pelo nome do período.
  • status*:  É assim que você pode criar ou remover um período. Marque como active (ativo) para adicionar um período ou deleted (excluído) para remover um período existente.
  • start_date^:  Essa é a data inicial do período. O formato deve ser do ISO 8601: AAAA-MM-DDTHH:MM:SSZ ("T" pode ser substituído por um espaço, como pode se ver na captura de tela de exemplo.) Por exemplo, 26 de agosto de 2013 às 17h EST seria escrito como 2013-08-26T17:00-5:00.
  • end_date^:  Essa é a data de término do período. O formato deve ser do ISO 8601: AAAA-MM-DDTHH:MM:SSZ ("T" pode ser substituído por um espaço, como pode se ver na captura de tela de exemplo.) Por padrão, o acesso do usuário é cortado à meia-noite na data de término indicada, significando que o dia anterior é o último dia inteiro que os usuários têm acesso ao período. A melhor prática é definir sua data final para o dia após o término do período.
  • integration_id: Este é um identificador único secundário útil para integrações SIS mais complexas. Esse identificador não deve ser alterado para o prazo e deve ser globalmente único.
  • date_override_enrollment_type: Isso permite que você defina ou remova datas iniciais e finais para um tipo específico de matrícula dentro de um período existente. Quando definido, todas as colunas exceto term_id, status, start_date e end_date são ignoradas para a linha. Se status estiver definido para ativo, as datas do período serão aplicáveis apenas às matrículas do tipo dado. Se status estiver definido para excluído, as datas atualmente definidas serão removidas para o tipo de matrícula fornecido. Tipo de matrícula pode ser definido para StudentEnrollment, TeacherEnrollment, TaEnrollment ou DesignerEnrollment.

courses.csv

Um curso é uma apresentação organizada sobre um assunto específico. Às vezes um curso pode incluir uma série de cursos. Os cursos são colocados em períodos para criar datas inicias e finais padrão. No entanto, se um curso inclui datas de cursos específicas, essas datas irão substituir as datas de acesso do estudante no período, identificado por term_id (se incluído). A importância de anexar um term_id é que você poderá ordenar e organizar os cursos ao exibir dados e relatórios, na interface do Administrador. Um term_id pode ser facilmente anexado à muitos cursos diferentes que começam/terminam ao mesmo tempo. Se você não vincular um curso à um período, o curso será vinculado ao período chamado "Período Padrão".

Se a sua instituição habilitou Cursos de Modelo, é possível usar courses.csv para adicionar cursos associados a um curso de modelo. Note que o curso de modelo deve ser criado e habilitado como um curso de modelo antes da adição de cursos associados puder ser realizada.

Baixe um arquivo courses.csv de exemplo com 10 cursos; eles estão localizados em suas subcontas respectivas em um período específico.

Campo obrigatório* | Campo adesivo (Sticky Field)^

  • course_id*:  Esse é um identificador único usado para diferenciar cursos no Canvas. Esse identificador não pode ser mudado para um curso e deve ser globalmente único entre todos os cursos. Na interface de usuário, esse é chamado SIS ID.
  • short_name*^:  Esse é um nome curto para o curso. Na Interface de Usuário do Canvas esse campo também é chamado de Código do curso (Course Code) ou Código de referência (Reference Code).
  • long_name*^:  Esse é o nome longo (completo) para o curso. (Ele pode ser o mesmo que o nome curto, mas se ambos estão disponíveis, ele irá fornecer uma melhor experiência para o usuário quando os dois forem fornecidos.)
  • account_id^:  Este é o identificador exclusivo da conta de ID SIS (de accounts.csv) que conta ao curso sob qual subconta ele residirá. Se um account_id não for especificado para um novo curso, o curso será anexado à sua conta principal/raiz. A ID SIS pode ser encontrada nas configurações da subconta.
  • term_id^:  Esse é um identificador único de período (do arquivo terms.csv) que diz quando o curso deve começar e quando deve concluir. Se associado um term_id com o curso, não será necessário que você insira uma data inicial (start_date) ou data final (end_date).
  • status*^:  Esse é o status do curso, também conhecido como workflow_state. Esse campo permite que você crie, remova, conclua ou publique um curso. Marque como ativo para adicionar um curso, excluído para remover um curso existente, concluído para concluir um curso existente ou publicado para publicar um curso existente.
  • integration_id: Este é um identificador único secundário útil para integrações SIS mais complexas. Esse identificador não deve ser alterado para o curso e deve ser globalmente único.
  • start_date^:  Essa é a data em que o curso se inicia. O formato deve ser do ISO 8601: AAAA-MM-DDTHH:MM:SSZ ("T" pode ser substituído por um espaço.)
  • end_date^:  Essa é a data em que o curso é concluído. O formato deve ser do ISO 8601: AAAA-MM-DDTHH:MM:SSZ ("T" pode ser substituído por um espaço). Por padrão, o acesso do usuário é cortado à meia-noite na data de término indicada, significando que o dia anterior é o último dia completo que os usuários têm acesso ao curso. A melhor prática é definir sua data final para o dia após o término do curso.
  • course_format: Este é o formato para o curso. O formato pode ser online (on-line), on_campus, ou blended (misto).
  • blueprint_course_id: Esta é a ID do curso do curso de modelo para o qual você deseja adicionar um curso associado. Para remover o link do Curso de Modelo, você pode colocar ‘dissociate’ no lugar da ID. Na interface de usuário, essa é a ID SIS do curso de modelo.
  • homeroom_course: Isso é usado para designar cursos de homeroom para contas do Canvas for Elementary. Requer que a configuração do Canvas for Elementary seja ativada.

sections.csv

Uma turma subdivide estudantes em um curso. Várias turmas também podem ser adicionadas em um curso, especialmente se todas as turmas do estudante estiverem aprendendo o mesmo material de curso. Várias turmas podem ser colocadas em um curso, mas um turma não pode ser colocada em várias turmas. As turmas herdam as datas do curso, conforme definidas pelo período. No entanto, se uma turma incluir datas específicas, essas datas irão substituir as datas de acesso do estudante para as datas iniciais e finais do curso e do período.

Se você estiver tentando excluir um curso e os usuários estiverem associados com seções, você precisa incluir o parâmetro section_id na importação do CSV, assim como nos SIS IDs da turma.

Baixe um arquivo sections.csv de exemplo com as seguintes seções:

  • 4 turmas no curso ACCT300 - Cost Accounting (ACCT300 - Contabilidade de Custos)
  • 4 turmas no curso ACCT310 - Managerial Accounting (ACCT310 - Managerial Accounting - Contabilidade Gerencial)
  • 2 turmas no curso BIO101 - Intro to Biology (BIO101 - Introdução à Biologia)

Este arquivo supõe que você tem várias turmas em um curso. Muitas instituições importam turmas de cursos como cursos separados. Isto pode ser feito ao (1) criar um curso do Canvas para cada turma no seu arquivo courses.csv, em seguida (2) criar uma única turma em cada um desses cursos. Você pode usar essencialmente os mesmos dados para o curso e turma, incluindo o SIS ID que será o mesmo para o course_id e section_id.

Campo obrigatório* | Campo adesivo (Sticky Field)^

  • section_id*:  Esse é um identificador único usado para criar turmas em um curso. Esse identificador não pode ser alterado para a turma e deve ser globalmente único. Na interface de usuário, esse é chamado SIS ID.
  • course_id*^:  Esse é um identificador exclusivo do curso onde as turmas serão adicionadas ou excluídas (adicionado em courses.csv).
  • nome*^:  Esse é o nome da turma. Turmas são ordenadas alfabeticamente pelo nome.
  • status*:  É assim que você pode criar ou remover uma turma de um curso. Marque como active (ativo) para criar uma turma ou deleted (excluído) para remover uma seção existente.
  • integration_id: Este é um identificador único secundário útil para integrações SIS mais complexas. Esse identificador não pode ser alterado para a turma e deve ser globalmente único.
  • start_date^:  Essa é a data de início da turma. O formato deve ser do ISO 8601: AAAA-MM-DDTHH:MM:SSZ ("T" pode ser substituído por um espaço).
  • end_date^:  Essa é a data de finalização da turma. O formato deve ser do ISO 8601: AAAA-MM-DDTHH:MM:SSZ ("T" pode ser substituído por um espaço). Por padrão, o acesso do usuário é cortado à meia-noite na data de término indicada, significando que o dia anterior é o último dia completo que os usuários têm acesso à turma. A melhor prática é definir sua data final para o dia após o término da turma.

enrollments.csv

Uma matrícula é um usuário que foi matriculado em um curso sob uma função específica. Um arquivo enrollment.csv permite que você atribua funções aos usuários e os coloque em cursos apropriados. Quando o status da matrícula de qualquer usuário for marcado como concluído (completed), ele estará limitado ao acesso somente leitura para esse curso.

Nota: Os arquivos CSV de matrícula no SIS que incluem os valores start_date e end_date substituem as datas do período, as datas do curso e as datas da seção.

Baixe um arquivo enrollments.csv de exemplo com as seguintes matrículas:

  • 1 usuário como professor no curso ACCT300 - Cost Accounting (ACCT300 - Contabilidade de Custo)
  • 1 usuário como auxiliar de professor no curso ACCT300 - Cost Accounting
  • 1 usuário como designer no curso ACCT300 - Cost Accounting
  • 3 usuários como alunos na turma 1 do curso ACCT300 - Cost Accounting
  • 3 usuários como alunos na turma 2 do curso ACCT300 - Cost Accounting
  • 1 usuário como um observador de um aluno na turma 1 do curso ACCT300 - Cost Accounting

Campo obrigatório* | Campo adesivo (Sticky Field)^

  • course_id*:  (Requerido se o campo section_id estiver ausente) Esse é um identificador exclusivo para o curso em que o usuário será matriculado (adicionado em courses.csv). Se estudantes são matriculados em um curso ao invés de matriculados em uma seção específica, coloque o course_id neste campo. Caso contrário, deixe em branco.
  • root_account: Esse é o domínio da conta para pesquisar pelo usuário.
  • start_date^: Esta é a data de início da matrícula. Para que start_date entre em vigor, end_date também precisa ser preenchido. O formato deve ser do ISO 8601: AAAA-MM-DDTHH:MM:SSZ.
  • end_date^: Esta é a data de término da matrícula. Para que end_date entre em vigor, start_date também precisa ser preenchido. O formato deve ser do ISO 8601: AAAA-MM-DDTHH:MM:SSZ.
  • user_id*:  Esse é o identificador único do usuário que será matriculado nos cursos designados. (adicionado em users.csv). Se user_integration_id estiver presente, esse campo será ignorado.
  • user_integration_id*: (Requerido se o campo user_id estiver ausente) Esse é o identificador secundário do usuário (adicionado em users.csv como integration_id).
  • role*:  Essa é a função a que o usuário será designado para um curso. Você matricula um usuário para qualquer uma das funções a seguir: professor, autor, professor assistente (ta), aluno, observador ou função personalizada definida por você.  Cada função tem um conjunto de permissões que Administradores podem personalizar na conta principal/raiz ou nível de subconta.
  • role_id*: (Exigido se a função estiver ausente) Esse é o identificador único para a função em que o usuário será adicionado como parte de uma matrícula.
  • section_id*:  (Requerido se o campo course_id não for inserido) Esse é um identificador exclusivo para a turma em que o usuário será matriculado (adicionado em sections.csv). Se usuários são matriculados em uma seção específica de um curso, coloque o campo section_id da seção aqui. Caso contrário, deixe em branco. Se nenhum section_id é especificado, o section_id padrão para o curso será usado. Se a turma padrão não for definida, uma turma será automaticamente criada sem um SIS ID.
  • status*: É assim que você matricula, conclui uma matrícula, desativa (torna inativa) ou remove uma matrícula em um curso. Marque como active (ativo) para matricular um usuário em um curso, completed (concluído) para concluir a matrícula de um usuário em um curso, inactive (inativo) para desativar o usuário no curso e deleted (excluído) para remover um usuário de um curso. Quando estiver em um estado ‘inativo’ (inactive), um aluno será listado na lista do curso para os instrutores, mas ele não poderá visualizar ou participar do curso até que sua matrícula seja ativada.  
  • associated_user_id:  (Somente função de observador) Este é o identificador exclusivo do usuário cujas informações (incluindo notas) o observador poderá visualizar. O observador deve estar matriculado no mesmo curso/turma que o usuário que você gostaria que ele observasse. Este campo será ignorado para qualquer função diferente de observador.
  • limit_section_privileges: Isso é como designar que a matrícula permitirá que o usuário apenas veja e interaja com usuários matriculados na turma fornecida pela course_section_id. Este campo tem como padrão falso. Limitar que os alunos interajam por turma afeta apenas as Colaborações, Chat, Pessoas e Conversas. Ao matricular instrutores e assistentes de professores, as limitações da turma permitem que tais usuários avaliem os alunos na(s) sua(s) mesma(s) turma(s). Tópicos de discussões e Páginas não são afetadas por limitações da turma e podem ser visualizados pode qualquer aluno. Essas áreas de funcionalidades poderiam ser restringidas ao criar conteúdos em grupos de cursos.
  • notifique: É assim que você opta por enviar uma notificação ao(s) usuário(s) inscrito(s) quando eles se inscrevem em um curso.

Nota: O campo root_account é recomendado ao identificar usuários em uma conta confiável.

group_categories.csv

As categorias do Grupo permitem que você organize grupos no Canvas. Um group_categories.csv permite que você crie categorias de grupos no nível da conta ou curso. Na interface de usuário, as categorias de grupos são chamadas de conjuntos de grupos.

Baixe uma amostra do arquivo group_categories.csv com as seguintes categorias de grupos:

  • Grupos do administrador
  • Grupos de designer
  • Grupos de Projeto do histórico

Campo obrigatório* | Campo adesivo (Sticky Field)^

  • group_category_id: Este é o identificador usado para fazer referência à categoria do grupo. O identificador não deve ser alterado para a categoria do grupo e deve ser globalmente único.
  • account_id: Este é o identificador que conecta a categoria do grupo a uma conta (adicionada em accounts.csv). Se nenhuma conta ou curso for especificado, o grupo será anexado à conta raiz.
  • course_id: Este é o identificador que conecta a categoria do grupo a um curso (adicionado em courses.csv). Se nenhum curso ou conta for especificado, o grupo será anexado à conta raiz.
  • category_name*^: Este é o nome da categoria do grupo.
  • status*: Este é o status da categoria do grupo. Marque como ativo (active) para criar a categoria do grupo ou excluído (deleted) para excluir a categoria do grupo.

groups.csv

Um grupo pode ser usado para fornecer oportunidades de colaboração para estudantes, instrutores, administradores ou outros usuários. Um groups.csv permite que você crie grupos de nível de conta e nível do curso. Grupos carregados através do SIS só podem ser atualizados ou excluídos através do SIS.

Baixe um arquivo de groups.csv de amostra com os seguintes grupos:

  • Administradores
  • Professores de Matemática
  • Designers

Campo obrigatório* | Campo adesivo (Sticky Field)^

  • group_id*: Este é o identificador exclusivo usado para fazer referência a seu grupo. Ele não deve mudar para o grupo e deve ser exclusivo.
  • group_category_id: Este é o identificador da categoria do grupo (adicionado em group_categories.csv) em que você está adicionando um grupo. Se nenhuma categoria do grupo for especificada, o grupo será colocado na categoria padrão do grupo para a conta definida ou curso. Se nenhuma conta ou curso for especificada, o grupo será colocado na categoria padrão do grupo para a conta raiz.
  • account_id: Este é o identificador que conecta o grupo a uma conta (adicionada em accounts.csv). Se nenhum for especificado, o grupo será conectado à conta raiz.
  • course_id: Este é o identificador que conecta o grupo a um curso (adicionado em courses.csv). Se nenhum curso ou conta for especificado, o grupo será anexado à conta raiz.
  • nome*^: Este é o nome do grupo.
  • status*: Este é o status do grupo. Marque como disponível (available) para definir o grupo como aberto para a adesão ou excluído (deleted) para excluir o grupo.

groups_membership.csv

Associação (Membership) é um grupo que permite usuários colaborarem em atividades no Canvas. O groups_membership.csv permite que você faça adição ou remoção em massa de pessoas a um grupo que você criou pelo groups.csv.

Download de uma amostra do arquivo groups_membership.csv com as seguintes associações de grupos:

  • 1 usuário aceito no grupo Administradores
  • 1 usuário aceito no grupo Professores de Matemática
  • 1 usuário excluído no grupo Professores de Matemática

Campo Obrigatório*

  • group_id*: Este é o identificador único utilizado para referenciar seu grupo (adicionado no groups.csv).
  • user_id*: Este é o identificador exclusivo do usuário que você quer adicionar ao grupo (adicionado em users.csv).
  • status*: Este é o estado dos usuários no grupo. Marque como aceito (accepted) para adicionar um usuário ao grupo ou excluído (deleted) para remover um usuário de um grupo.

xlists.csv

Lista cruzada permite você mover turmas para outro curso. O arquivo xlist.csv permite que você faça listas cruzadas de turmas em cursos existentes e criar uma hierarquia de turmas.

É experado que existam ids de turmas e já referenciando outros ids de cursos. Se um id de turma é fornecido neste arquivo, ele será movido de seu id existente de curso para um novo id de curso, tal como se um novo curso é removido ou a lista cruzada removida, esta turma irá ser revertida para o id de curso anterior. Se o campo xlist_course_id não fizer referência a um curso existente, ele será criado. Se você deseja fornecer maiores informações sobre lista cruzada de curso, por favor faça em courses.csv.

Download de um arquivo de exemplo xlists.csv com os seguintes cursos e turmas:

  • 4 turmas ativas do curso ACCT300 - Contabilidade de Custo (ACCT300 - Cost Accounting) cruzado com o curso ACCT310 - Contabilidade Gerencial (ACCT310 - Managerial Accounting)

Campo Obrigatório*

  • xlist_course_id*: Esse é o identificador do novo curso (adicionado em courses.csv).
  • section_id*: Esse é o identificador da turma (adicionado em sections.csv).
  • status*: Esse é o status da turma. Marque como ativo (active) para tornar a turma ativa ou excluído (deleted) para remover a turma.

user_observers.csv

A função de observador pode ser usada para matricular pais e conectá-los a um estudante, permitindo a eles visualizar as notas do estudante e interações do curso. O arquivo user_observers.csv permite que você matricule e conecte observadores a cada uma das matrículas dos estudantes designados.

Download de um arquivo de exemplo user_observers.csv com as seguintes matrículas:

  • 2 observadores ativos
  • 1 observador excluído

Campo Obrigatório*

  • observer_id*: Esse é o identificador exclusivo do observador (adicionado como user_id em users.csv).
  • student_id*: Esse é o identificador exclusivo do aluno (adicionado como user_id em users.csv).
  • status*: Esse é o status do observador. Marque como active (ativo) para matricular o observador para cada uma das matrículas do aluno ou deleted (excluído) para remover todas as matrículas do observador.

logins.csv

O logins.csv permite que você crie ou atualize credenciais de logins para usuários. Logins só podem ser adicionados a usuários existentes. Logins podem ser removidos usando o users.csv.

Baixe um arquivo de amostra logins.csv com três logins de usuários.

Campo obrigatório*  | Campo adesivo (Sticky Field)^

  • user_id*: Esse é o identificador único do usuário (referenciado em enrollments.csv). Esse valor não deve ser alterado para o usuário e deve permanecer único entre todos os usuários. Chamou a ID SIS na interface de usuário do Canvas.
  • integration_id: Este é um identificador único secundário útil para integrações SIS mais complexas. Esse valor não deve ser alterado para o usuário e deve permanecer único entre todos os usuários. Este campo deve ser deixado em branco ao mesclar usuários com IDs de integração correspondentes.
  • login_id*: Esse é o nome que o usuário usaria para entrar no Canvas. Para serviços configurados de autenticação, como LDAP, este será o nome de usuário do sistema remoto.
  • senha: Essa é a senha que o usuário usará para entrar no Canvas. Este campo não deve ser preenchido para contas configuradas para LDAP ou SSO.
  • ssha_password: Esta é uma senha gerada com um esquema de geração SSHA pré-hasheada.
  • authentication_provider_id: Este é o provedor de autenticação com o qual o login é associado.
  • existing_user_id^: Esta é a ID SIS do usuário, conforme encontrado em users.csv.
  • existing_integration_id^: Esta é a ID de integração do usuário, conforme encontrado em users.csv.
  • existing_canvas_user_id^: Esta é a ID do Canvas do usuário.
  • root_account: Esta é a conta do domínio para o usuário.
  • email: Este é o endereço de e-mail do usuário.

Notas:

  • Um de existing_user_id, existing_integration_id ou existing_canvas_user_id é requerido para uma importação bem-sucedida de logins.csv.
  • O campo root_account é obrigatório ao identificar usuários em uma conta de confiança (por ex., ao fazer a lista cruzada de usuários em contas dentro de uma conta de confiança).

admins.csv

Os Administradores gerenciam as configurações para uma conta inteira ou subconta. Um admins.csv permite a designação de usuários no Canvas como administradores da conta ou outra conta personalizada ou funções de subconta.

Baixe um arquivo de amostra admins.csv com os seguintes administradores:

  • 2 administradores de conta ativos
  • 1 administrador de conta excluída
  • 2 funções de conta personalizada

Campo Obrigatório*

  • user_id*: Essa é a ID exclusiva do usuário que você gostaria de designar como um administrador (adicionado em users.csv).
  • account_id*: Esse é o identificador exclusivo da conta em que você gostaria que o administrador residisse (adicionado em accounts.csv). Se essa coluna for deixada em branco, o usuário residirá na conta raiz. Essa coluna é sempre obrigatória, mesmo se o valor estiver em branco.  
  • role_id*: (obrigatório se a função estiver ausente) Esta é a ID da função, a ID padrão ou uma ID personalizada definida pela conta.
  • role*: (obrigatório se role_id estiver ausente) Este é o nome da função, função padrão do Administrador da Conta ou uma função personalizada definida pela conta. Se você estiver adicionando um administrador da conta, formate o campo para ler 'AccountAdmin'. Se você estiver adicionando uma função personalizada, formate o campo exatamente como ele aparece na interface de usuário do Canvas.
  • status*: Esse é o status do administrador. Marque como active (ativo) para criar um administrador ativo ou deleted (excluído) para remover um administrador.
  • root_account: Esse é o domínio da conta para pesquisar pelo usuário.

change_sis_id.csv

Uma ID do SIS (SIS ID) é um identificador exclusivo para um objeto no Canvas. Um change_sis_id.csv permite que você altere em massa SIS IDs para contas, períodos, cursos, turmas, grupos ou usuários existentes.

Baixe um arquivo de amostra change_sis_id.csv com as seguintes alterações de SIS ID:

  • 1 alteração de SIS ID do usuário
  • 1 alteração de SIS ID do curso
  • 1 alteração de SIS ID do período

Campo Obrigatório*

  • old_id*: Esse é o SIS ID atual do objeto.
  • new_id*: Esse é o SIS ID desejado do objeto. O novo SIS ID deve ser atualmente exclusivo ao tipo de objeto e a conta raiz.
  • type*: Este é o tipo de objeto. Tipo pode ser conta, período, curso, turma, grupo ou usuário.