Este tópico explica as convenções e os requisitos para os formatos de arquivo D2L Standard CSV.
Formatos aceitos para arquivos D2L Standard CSV
Os formatos de arquivos aceitos pelo CSV padrão D2L são:
- Organizações
- Usuários
- Inscrições
- Atributos do Painel do gerente e dos grupos de aprendizagem
- Manifesto (necessário ao usar a versão 1.1 ou versões posteriores do CSV padrão da D2L)
Formato de arquivo zip para arquivos D2L Standard CSV
Os arquivos CSV devem ser combinados em um arquivo zip. A convenção de nomenclatura recomendada para um arquivo zip é:
- D2LStdCSV-{YYYYmmddHHMMSS}.zip
|
Observação: só é possível carregar arquivos .zip (diferencia maiúsculas de minúsculas) para o SFTP. |
Os arquivos são processados em ordem alfabética. A D2L recomenda que arquivos individuais no arquivo compactado sejam ordenados da seguinte forma:
- organizações
- usuários
- inscrições
- atributos
Convenções de nomenclatura recomendadas para arquivos D2L Standard CSV
A convenção de nomenclatura recomendada para arquivos individuais em um arquivo .zip é:
- 01 - Other - {YYYYmmddHHMMSS}.csv
- 02 - Departments - {YYYYmmddHHMMSS}.csv
- 03 - Semesters - {YYYYmmddHHMMSS}.csv
- 04 - Templates - {YYYYmmddHHMMSS}.csv
- 05 - Offerings - {YYYYmmddHHMMSS}.csv
- 06 - Sections - {YYYYmmddHHMMSS}.csv
- 07 - Users - {YYYYmmddHHMMSS}.csv
- 08 - Enrollments - {YYYYmmddHHMMSS}.csv
- 09 - Attributes - {YYYYmmddHHMMSS}.csv
- manifest.json
|
Observação: o 01 - Other CSV é usado para processar unidades organizacionais personalizadas fora da estrutura organizacional padrão da D2L e requer o D2L Standard CSV versão 2.0 ou superior. |
Regras comuns de conteúdo de arquivos CSV
- Os valores dos arquivos diferenciam maiúsculas de minúsculas.
- Um valor em branco é representado por duas vírgulas sem espaços entre elas. Por exemplo:
- ,, indica valor em branco
- , , indica um caractere de espaço, que é analisado como um valor inválido.
-
Os arquivos CSV devem ter um cabeçalho (primeira linha) que deve ser uma correspondência exata (maiúsculas/minúsculas e vírgulas).
- Os arquivos CSV precisam estar codificados no formato UTF-8.
- Os arquivos CSV devem conter dados diferenciais do SIS (deltas), em vez de pacotes de dados completos do SIS.
-
Enviar uma ação de ATUALIZAÇÃO quando o objeto não existir resulta em uma solicitação de CRIAÇÃO. O comportamento comum é usar apenas as ações de ATUALIZAÇÃO e EXCLUSÃO.
- Os arquivos CSV e o manifesto devem ser compactados em uma pasta zip.
- Um manifesto é necessário ao usar a versão 1.1 ou versões posteriores do CSV Padrão da D2L. O manifesto é um arquivo JSON que anuncia a versão do CSV padrão D2L que você está usando. Para obter mais informações, consulte o tópico Manifesto.
-
Como prática recomendada, não inclua Informações de identificação pessoal (PII), como números de previdência social, nos IDs Definidos da Organização dos usuários.
Regras para Unidades Organizacionais
Os tipos de unidade organizacional listados abaixo são compatíveis com o D2L Standard CSV:
- Outras unidades organizacionais (unidades organizacionais personalizadas fora da estrutura organizacional padrão da D2L são compatíveis com o D2L Standard CSV versão 2.0 ou superior)
- Departamentos
- Semestres
- Modelos de curso
- Ofertas de curso
- Seções
O processamento dessas unidades organizacionais cria a estrutura da organização na instância do Brightspace.
Regras:
- O Brightspace pode aceitar quantas unidades organizacionais forem necessárias.
- As organizações devem ser enviadas pelo menos uma vez para ensinar ao D2L Standard CSV quais unidades organizacionais podem ser controladas. Quando a integração passa a controlar uma unidade organizacional, todas as alterações futuras nessa unidade devem ser feitas apenas por meio da integração do CSV padrão da D2L para garantir a propriedade correta dos dados.
- Ao enviar vários tipos de unidades organizacionais em um arquivo CSV, certifique-se de que a hierarquia seja respeitada no arquivo (por exemplo, Departamentos deve ser enviados antes dos Modelos do curso). Se você não enviar uma unidade organizacional principal antes de criar a secundária, a criação da unidade organizacional secundária apresentará falha.
- Se enviar relacionamentos do usuário, certifique-se de que a hierarquia de auditores e/ou pais/responsáveis seja respeitada no arquivo (por exemplo, pais/responsáveis precisam ser enviados antes de alunos). Deixar de fazer isso resultará na falha da relação.
- A convenção de nomenclatura para o nome e o código da unidade organizacional deve seguir a descrita no SIS.
- Os nomes e códigos de unidade organizacional poderão ser fornecidos no estado em que se encontram por meio de arquivos CSV, desde que atendam aos requisitos de caracteres ilegais do Brightspace e sejam exclusivos em diferentes unidades organizacionais.
- Os códigos da unidade organizacional são limitados a 50 caracteres. Se eles forem mais longos, o código da unidade organizacional será truncado automaticamente para 50 e poderá levar à duplicação de códigos da unidade organizacional no Brightspace ou à falha em criar uma unidade organizacional.
- Os códigos de unidade organizacional não são compatíveis com os seguintes caracteres: , : % & # * ? < > | \ " ' e espaços iniciais ou finais.
O D2L Standard CSV pode fazer o seguinte:
- Criar uma nova unidade organizacional, caso ainda não exista uma.
- Mapear para uma unidade organizacional existente se ela tiver sido criada por uma fonte que não seja o D2L Standard CSV e a opção de mapear para existente estiver selecionada na configuração.
- Atualizar o nome de uma unidade organizacional que ele controla.
- Atribua e remova unidades organizacionais personalizadas como a versão principal de outras unidades organizacionais personalizadas, departamentos, semestres, modelos de curso, ofertas de curso e seções de curso (aplicável ao D2L Standard CSV versão 2.0 ou superior).
- Modelo de curso: atribuir e atualizar o departamento principal com base no código do departamento.
- 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 e as datas. Desativar ofertas de curso.
- Seção do curso: excluir uma seção do curso cancelará automaticamente a inscrição dos usuários na seção excluída.
- Excluir uma unidade organizacional que ele controla.
O D2L Standard CSV não pode fazer o seguinte:
- Atualizar códigos de unidade organizacional.
- Exclui unidades organizacionais criadas manualmente, a menos que elas tenham sido associadas com o CSV padrão da D2L.
- Exclui uma unidade organizacional se ela tiver unidades secundárias vinculadas a ela (as secundárias devem ser excluídas primeiro). Uma exceção ocorre se as seções forem configuradas para exclusão na interface – as ofertas de curso podem ser excluídas se uma seção estiver vinculada a elas.
Regras para usuários
Os registros do usuário podem criar, atualizar, desativar ou excluir usuários no Brightspace. O tipo de registro do usuário também pode criar, atualizar ou excluir os relacionamentos entre principal-secundário no Brightspace.
Regras
- Os usuários precisam ser enviados pelo menos uma vez para ensinar à integração para quais deles ela pode criar, atualizar, excluir e gerenciar inscrições.
- Nome e Sobrenome não suportam os seguintes caracteres: \ / : * ? " < > | @ , ;
- O Nome de usuário e o ID Definido da Organização não suportam os seguintes caracteres: / : * ? " < > | ' , ;
- O endereço de e-mail não suporta os seguintes caracteres: ( ) < > [ ] | \ ; : , “
O D2L Standard CSV pode:
- Criar um novo usuário e inscrevê-lo na organização.
- Mapear um usuário para um usuário existente com o mesmo ID definido da organização ou nome de usuário.
- Atualizar o nome de usuário, o nome, o sobrenome, a senha e o e-mail.
- Atualize o nome preferencial e o sobrenome preferencial (D2L Standard CSV versão 2.0 ou posterior).
- Atualizar sobrenome classificável (D2L Standard CSV versão 2.1 ou posterior).
- Atualizar pronomes (D2L Standard CSV versão 3.0 ou posterior).
- Não é necessário informar a senha. Aliás, recomenda-se NÃO enviar a senha se estiver usando SSO (Single-Sign-On, autenticação única).
- Atualizar a função no nível da organização.
- Ativar, desativar ou excluir um usuário.
- Criar, atualizar ou excluir relacionamentos pai/responsável-filho para o Brightspace para Pais e Responsáveis (D2L Standard CSV versão 1.1 ou posterior).
- Atualizar um relacionamento auditor-auditado (D2L Standard CSV versão 2.0 ou posterior).
O D2L Standard CSV não:
- Atualiza Org Defined ID, no entanto, isso pode ser feito manualmente na Interface de administração do IPSIS.
- Exclui usuários criados manualmente, a menos que estejam associados ao D2L Standard CSV.
|
Observação: para usuários em países como Países Baixos, Bélgica e Sri Lanka, alguns sobrenomes (como Van der Speigle ou Van Gogh) têm um ou mais prefixos (conhecidos em holandês como Tussenvoegsel) que fazem parte do sobrenome formal. Em alguns casos, o sobrenome classificável não deve incluir esses prefixos. Os administradores podem indicar se o Sobrenome legal de um usuário difere do Sobrenome classificável. Se os clientes incluírem um Sobrenome classificável, o Brightspace usará o Sobrenome classificável ao colocar as listas de usuários em ordem alfabética. O Sobrenome classificável está disponível no D2L Standard CSV versão 2.1 ou superior. |
Regras para inscrições
O processamento dos registros de inscrição inscreve usuários em uma unidade organizacional específica do Brightspace ou cancela sua inscrição.
Regras:
Os registros de inscrição devem ser enviados quando forem feitas alterações no sistema de informações.
- Um cancelamento de inscrição deve ser enviado apenas uma vez. O reenvio do mesmo registro de cancelamento de inscrição gera um aviso no log de seu IPSIS.
- Ao usar seções em ofertas de curso, forneça registros de inscrição somente para seções. A inscrição na oferta de curso é implícita e tratada pelo IPSIS.
- Enviar registros de inscrição para ofertas de curso e seções, mas enviar cancelamentos de inscrição apenas para seções, pode fazer com que os usuários sejam reinscritos incorretamente nas ofertas de curso durante a mesclagem do curso.
O D2L Standard CSV pode:
- Inscrever e cancelar a inscrição de usuários em unidades organizacionais (versão 2.0 ou superior), ofertas de curso e seções.
- Inscrever e cancelar a inscrição apenas nas seções do curso (versão 1.0 e 1.1).
Regras para atributos do painel do gerente e dos grupos de aprendizado
Com o D2L Standard CSV, os atributos do Painel do Gerente e dos Grupos de Aprendizado podem:
- Estabelecer a estrutura de subordinação usada no Painel do Gerente.
- Permitir que regras de associação automática sejam criadas nos Grupos de Aprendizado.
Os atributos do Painel do Gerente e dos Grupos de Aprendizado via D2L Standard CSV não podem:
- Criar novas contas de usuário.