Os arquivos do OneRoster devem ser arquivos de texto no formato CSV (Comma Separated Values, valores separados por vírgula), codificados em UTF-8. Para gerar esses arquivos, acesse seus dados do Sistema de informações do aluno usando suas ferramentas de exportação, seguindo as instruções do fornecedor. Entre em contato com o provedor do seu SIS para obter orientação sobre a extração de dados para o formato CSV OneRoster.
O Brightspace dá suporte à especificação OneRoster v1.1. Os administradores podem carregar pacotes compatíveis com o OneRoster 1.1 com os dados necessários da lista, como escolas, classes, usuários e inscrições, e ver os resultados no Brightspace.
O CSV OneRoster dá suporte aos seguintes arquivos e os processa na ordem listada:
- manifest.csv
- academicsessions.csv
- orgs.csv
- courses.csv
- classes.csv
- users.csv
- enrollments.csv
Usar os arquivos CSV OneRoster
As seções a seguir fornecem uma descrição de alto nível dos tipos de arquivo CSV OneRoster. Para obter mais informações, consulte Mapeamentos de dados do CSV OneRoster.
Arquivo CSV de manifesto obrigatório
Você deve incluir um arquivo de manifesto com cada pacote. O manifesto contém a versão e a lista de arquivos que você está enviando para o Brightspace, e mostra se os dados da lista indicam se o pacote contém conteúdo delta (apenas alterações feitas desde a última atualização) ou em massa (todos os arquivos).
Tipos de arquivo CSV de sessões acadêmicas, organizações, cursos e classes
A integração do CSV OneRoster pode criar e atualizar os níveis da organização listados na seção Entenda o mapeamento de tipos de dados entre o OneRoster e o Brightspace do tópico Preparação para a integração do CSV OneRoster. Você deve gerenciar os níveis de organização que não aparecerem na lista fora da integração do OneRoster.
Siga as convenções de nomenclatura (Nome/Código) definidas em seu SIS para unidades organizacionais. O Brightspace aceita qualquer número de unidades organizacionais e você pode incluir seus nomes e códigos em arquivos CSV, desde que eles cumpram as restrições do Brightspace em relação a caracteres inválidos.
Envie níveis organizacionais pelo menos uma vez para especificar quais unidades organizacionais o IPSIS pode controlar. Reenvie arquivos de unidade organizacional somente quando precisar adicioná-los ou atualizá-los na estrutura organizacional do ambiente de aprendizagem.
O CSV OneRoster pode:
- Criar uma nova unidade organizacional, caso ainda não exista uma
- Fazer o mapeamento a uma unidade organizacional existente, caso ela tenha sido criada por uma origem diferente
- Atualizar o nome ou o código de uma unidade organizacional que ele controla
- Modelo do curso: atribuir e atualizar as escolas principais com base no código da escola
- Oferta de curso: atribuir e atualizar as escolas principais com base no código da escola
- Oferta de curso: atribuir e atualizar o modelo de curso e o semestre principais com base no código principal
- Oferta de curso: atualizar todos os detalhes do curso, incluindo o nome da oferta de curso
- Atualizará os códigos das unidades organizacionais
- Copiar o conteúdo do curso no novo curso
- Excluir uma unidade organizacional se o arquivo delta for enviado com o status tobedeleted e a unidade organizacional não tiver inscrições
O CSV OneRoster não pode fazer o seguinte:
- Excluir as unidades organizacionais criadas manualmente, a menos que elas tenham sido mapeadas ao CSV OneRoster
- Excluirá uma unidade organizacional se ela tiver unidades secundárias vinculadas (as secundárias devem ser excluídas primeiro)
Tipo do arquivo CSV de usuários
O processamento do tipo de usuário cria, atualiza ou desativa usuários no Brightspace. Envie dados de usuários pelo menos uma vez para instruir o IPSIS sobre quais perfis de usuário ele pode criar ou atualizar ou cujas inscrições ele pode gerenciar. O Brightspace inscreve os usuários automaticamente na escola.
O CSV OneRoster pode:
- Criar um novo usuário
- Se existir um usuário com o mesmo OrgDefinedID ou o mesmo Nome de usuário, ele poderá ser mapeado para o usuário existente
- Atualizar o nome, o sobrenome, a senha e o e-mail
- Atualizar a função do nível da organização
- Ativar ou desativar um usuário
- Atualizar o ID definido da organização ou o nome de usuário
- Inscrever ou cancelar a inscrição de usuários em unidades organizacionais superiores
O CSV OneRoster não:
Tipo de arquivo CSV de inscrições
O processamento do tipo de inscrição inscreve ou cancela a inscrição dos usuários no Brightspace no nível da seção do curso. Envie inscrições somente quando ocorrerem alterações em seu sistema de informações para manter o Brightspace atualizado. Envie um cancelamento de inscrição apenas uma vez, pois o reenvio gerará avisos no log do IPSIS.
O CSV OneRoster pode:
- Inscrever ou cancelar a inscrição de usuários nas ofertas de curso e seções
O CSV OneRoster não pode:
- Inscrever usuários em outros níveis organizacionais (exceto usando o registro do usuário conforme mencionado acima)
Limitações e pressuposições
Cancelamentos de inscrições em unidades organizacionais superiores
O termo "unidade organizacional superior" refere-se a qualquer unidade organizacional na hierarquia acima de uma oferta de curso, como a escola onde o curso é oferecido. Os usuários geralmente são inscritos tanto na oferta do curso quanto na escola correspondente, que serve como a unidade organizacional superior.
- Para habilitar os cancelamentos de inscrição usando a integração do OneRoster, na página Administração do IPSIS, selecione Cancelar a inscrição de usuários de organizações do Sistema de informações do aluno se eles não estiverem mais associados a elas no Sistema de informações do aluno.
- A integração do OneRoster não pode cancelar a inscrição de usuários de unidades organizacionais superiores criadas antes da versão de junho de 2024/20.24.6 ou de inscrições criadas manualmente no Brightspace.
- O cancelamento da inscrição de um usuário com uma função em cascata em uma unidade organizacional superior pode remover seu acesso a várias unidades organizacionais secundárias.
Caracteres não suportados
O código da unidade organizacional vem dos seguintes campos do CSV:
- Sessões acadêmicas: título
- Cursos: título ou courseCode
- Classes: título ou classCode
- Organizações: nome ou identificador
Os caracteres a seguir não são suportados atualmente para o código da unidade organizacional:
- \ (barra invertida)
- : (dois-pontos)
- * (asterisco)
- ? (ponto de interrogação)
- “ ” (aspas de abertura e fechamento)
- < > (sinais de menos que e maior que)
- | (barra vertical)
- ‘ (apóstrofo)
- # (sinal de cerquilha)
- , (vírgula)
- % (sinal de porcentagem)
- & ("e" comercial)
Todos os Códigos da unidade organizacional são truncados com um comprimento máximo de 50 caracteres.
Processar arquivos CSV
Compacte arquivos CSV em ZIP antes de enviá-los para o Brightspace. Você pode carregar o arquivo ZIP:
- Manualmente: arraste e solte o arquivo na interface Administração do IPSIS > Painel.
- Automaticamente: carregue o arquivo ZIP para o site SFTP definido durante sua configuração inicial. O Brightspace verifica o site SFTP a cada dez minutos.