Formato de arquivo CSV SDS V2.1

Você pode usar arquivos CSV (valor separado por vírgula) no formato School Data Sync (SDS) V2.1 para sincronizar seu Sistema de Informações Escolares (SIS) com o Office 365. Usar o formato de arquivo CSV SDS V2.1 para assimilar as categorias de dados permite que você ilumine os principais recursos do SDS para provisionamento. Ele também ajuda você a aprimorar experiências para os produtos e recursos do Microsoft 365. O formato de arquivo CSV SDS V2.1 continua a expandir as categorias de dados com suporte.

Se você estiver usando o formato SDS V2.1, os arquivos deverão ser formatados adequadamente. Carregue os arquivos, nomeados exatamente como detalhados. Os cabeçalhos de coluna diferenciam maiúsculas de minúsculas. Os arquivos CSV devem estar no formato UTF-8 e em conformidade com RFC. Também não aceitamos quebras de linha em dados de entrada. Para examinar e baixar o conjunto de exemplo de arquivos CSV do SDS V2.1, consulte o Repositório GitHub do SDS.

Importante

Após o upload inicial durante a criação do fluxo de entrada, você precisa sempre fornecer o mesmo conjunto de arquivos para uploads subsequentes, independentemente de serem alterações de dados feitas nos arquivos opcionais ou não. Caso contrário, o sistema determina que os registros não estão mais ativos e os marca como tal.

Obrigatório: Os três arquivos a seguir devem ser fornecidos. Se você estiver gerenciando apenas usuários e não classes, só precisará fornecer esses arquivos. 

  • orgs.csv

  • users.csv

  • roles.csv

Opcional/Obrigatório: os dois arquivos a seguir não são obrigatórios se você estiver apenas gerenciando usuários. Se você também estiver gerenciando classes e registros de classe, precisará fornecer esses dois arquivos listados, juntamente com os três arquivos.

  • classes.csv

  • enrollments.csv

Opcional: os arquivos a seguir são opcionais e são usados para aprimorar experiências. Esses arquivos não são necessários, a menos que os arquivos mencionados anteriormente tenham referências de dados com base nas anotações. 

  • academicSessions.csv (Se sua roles.csv, classes.csv ou courses.csv contiver dados de sessões acadêmicas, os dados correspondentes deverão ser fornecidos para evitar mensagens de erro ao processar dados.)

  • courses.csv (Se seus dados classes.csv contiverem links para cursos, os dados correspondentes devem ser fornecidos para evitar mensagens de erro ao processar dados.)

  • demographics.csv

  • userFlags.csv

  • relationships.csv

Cada arquivo CSV deve conter dados para os campos marcados como "Sim" em "Obrigatório", e os campos marcados como "Não" são dados "Opcionais". Os cabeçalhos de campo marcados como 'Obrigatório' devem existir nos arquivos fornecidos ou não serão aceitos. Os cabeçalhos de campo marcados como 'Opcionais' não precisam estar presentes nos arquivos se não estiverem passando os dados opcionais correspondentes.

Os campos com valores enumerados definidos, conforme marcado na coluna 'Tipos de dados', têm um conjunto específico de valores com suporte. O conjunto de valores padrão com suporte para campos Enum consulte Lista de valores padrão.

orgs.csv

Campo Obrigatório? Exemplo Tipo de dados
sourcedId Sim 10001 ID exclusiva
nome Sim Faculdade de Engenharia Cadeia de caracteres
type Sim a faculdade Enum
parentSourcedId Não 10000 ID exclusiva

users.csv

Campo Obrigatório? Exemplo Tipo de dados
sourcedId Sim 14001 ID exclusiva
username Sim cbeane@domain.com Cadeia de caracteres
familyName Sim (somente se estiver criando usuários) Craig Cadeia de caracteres
givenName Sim (somente se estiver criando usuários) Beane Cadeia de caracteres
activeDirectoryMatchId Não craig.beane@domain.com Cadeia de caracteres
email Não cbeane@domain.com Email
phone Não +1234567890 Telefone
Mensagem SMS Não +1234567890 Telefone
userNumber Não 14001 Cadeia de caracteres
  • familyName e givenName são obrigatórios para os usuários que usam a opção para 'Criar usuários não correspondentes'.
  • familyName, givenName e email são obrigatórios para os usuários que usam a opção 'Associações de contato do aluno' para usuários que têm uma função de relação de contato no relationships.csv. Para usuários que são funcionários e também contatos, recomendamos que eles tenham dois registros de usuário listados, com o registro de usuário dos contatos associado ao seu endereço de email privado.
  • Espere que os campos telefone e sms sejam formatados com base no padrão E.164. O caractere de adição é sucedido pelo número de telefone ou o caractere de adição é seguido pelo código do país, código de área, prefixo de telefone e número de linha.
  • A senha não é mais usada para fornecer a senha padrão para a criação de novos usuários.

roles.csv

Campo Obrigatório? Exemplo Tipo de dados
userSourcedId Sim 14001 ID exclusiva
orgSourcedId Sim 10001 ID exclusiva
role Sim student Enum
sessionSourcedId Não FS2021 ID exclusiva
grade Não PS1 Enum
isPrimary Não verdadeiro Booliano
roleStartDate Não 2020-08-24 Data
roleEndDate Não 2020-12-11 Data
  • Requer uma referência ao usuário associado usando o campo 'userSourcedId' e produz uma dependência no arquivo users.csv.
  • Requer uma referência à organização associada usando o campo 'orgSourcedId' e produz uma dependência no arquivo orgs.csv.
  • Se aprovado: Isso requer uma referência aos termos associados (sessões acadêmicas) usando o campo 'sessionSourcedId' e produz uma dependência no arquivo academicSessions.csv.
  • isPrimary indica se essa função é a principal (verdadeira) ou secundária (falsa) dessa organização. Se estiver passando várias funções, para o mesmo usuário e a mesma organização, DEVE haver uma, e apenas uma, função primária definida como (true) para cada organização.
  • Valores de data a serem fornecidos no formato ISO8601.
  • Zeros à esquerda '0' ausentes no valor de entrada para ENUM de nível de série, por exemplo, '1' corresponderá à Lista de Valor definida (ENUM) '01' e é armazenado como '01'.

classes.csv

Campo Obrigatório? Exemplo Tipo de dados
sourcedId Sim 12001 ID exclusiva
orgSourcedId Sim 10001 ID exclusiva
title Sim Ciência da Computação 101 Cadeia de caracteres
sessionSourcedIds Não FS2021 ID exclusiva
courseSourcedId Não C12001 ID exclusiva
código Não 12001 Cadeia de caracteres
  • Isso requer uma referência à escola associada (org) usando o campo 'orgSourcedId' e produz uma dependência no arquivo orgs.csv.
  • Se aprovado: Isso requer uma referência aos termos associados (sessões acadêmicas) usando o campo 'sessionSourcedIds' e produz uma dependência no arquivo academicSessions.csv.
  • Se aprovado: Se uma classe estiver associada a várias sessões no mesmo ano acadêmico, por exemplo, semestre de outono e semestre de primavera, você poderá fornecer ambos os sourcedId para as sessões no registro. Os valores devem ser combinados em uma única cadeia de caracteres, com os valores entre aspas e separados por vírgulas.
    • A associação a várias sessionSourcedIds é armazenada apenas no Data Lake.
    • O atributo de extensão de Grupo do Microsoft 365 para IDs de sessão não dá suporte a várias associações.
  • Se aprovado: Isso requer uma referência ao curso associado usando o campo 'courseSourcedId' e produz uma dependência no arquivo courses.csv.

enrollments.csv

Campo Obrigatório? Exemplo Tipo de dados
classSourcedId Sim 12001 ID exclusiva
userSourcedId Sim 14001 ID exclusiva
role Sim student Enum
  • Isso requer uma referência à classe associada usando o campo 'classSourcedId' e produz uma dependência no arquivo classes.csv.
  • Isso requer uma referência ao usuário associado usando o campo 'userSourcedId' e produz uma dependência no arquivo users.csv.

academicSessions.csv

Campo Obrigatório? Exemplo Tipo de dados
sourcedId Sim FS2021 ID exclusiva
title Sim Semestre de outono Cadeia de caracteres
type Sim semestral Enum
schoolYear Sim 2021 Enum
startDate Sim 2020-08-24 Data
endDate Sim 2020-12-11 Data
  • Espere que os valores de data sejam fornecidos em ISO8601 formato.

courses.csv

Campo Obrigatório? Exemplo Tipo de dados
sourcedId Sim C12001 ID exclusiva
orgSourcedId Sim 10001 ID exclusiva
title Sim Ciência da Computação 101 Cadeia de caracteres
código Não CS101 Cadeia de caracteres
schoolYearSourcedId Não Ano 2021 ID exclusiva
assunto Não 10 Enum
grade Não estudante universitário Enum
  • Isso requer uma referência à organização associada (org) usando o campo orgSourcedId e produz uma dependência no arquivo orgs.csv.
  • Se aprovado: Isso requer uma referência ao registro do ano da sessão acadêmica associado usando o campo 'schoolYearSourcedId' em que o tipo = schoolYear. Isso produz uma dependência no arquivo academicSessions.csv.
  • Zeros à esquerda '0' ausentes no valor de entrada para ENUM de nível de série, por exemplo, '1' corresponderá à Lista de Valor definida (ENUM) '01' e é armazenado como '01'.

relationships.csv

Campo Obrigatório? Exemplo Tipo de dados
userSourcedId Sim 14001 ID exclusiva
relationshipUserSourcedId Sim Pág. 14001 ID exclusiva
relationshipRole Sim guardião Enum
  • Se você também estiver sincronizando Relações de Contato (guardiões), deverá incluir um registro para eles no users.csv.
  • Isso requer uma referência ao usuário associado usando o campo 'userSourcedId' e produz uma dependência no arquivo users.csv.
  • Isso requer uma referência ao usuário associado usando o campo 'relationshipUserSourcedId' e produz uma dependência no arquivo users.csv.
  • Além disso, familyName, givenName e email são necessários para usuários com funções de Relacionamento de Contato.

demographics.csv

Campo Obrigatório? Exemplo Tipo de dados
userSourcedId Sim 14001 ID exclusiva
sexo Não masculino Enum
birthDate Não 2001-07-20 Data
birthCity Não Woodenville Cadeia de caracteres
birthState Não WA Enum
birthCountry Não EUA Cadeia de caracteres
ethnicityCodes Não hispânicoOuLatinoEtnia Enum
códigos de corrida Não demoRaçaDoisOuMaisRaças Enum
  • Isso requer uma referência ao usuário associado usando o campo 'userSourcedId' e produz uma dependência no arquivo users.csv.
  • Os valores múltiplos mapeados para 'raceCodes' devem ser combinados em uma única cadeia de caracteres com os valores entre aspas e separados por vírgulas.

userFlags.csv

Campo Obrigatório? Exemplo Tipo de dados
userSourcedId Sim 14001 ID exclusiva
flag Sim LEP Enum
  • Isso requer uma referência ao usuário associado usando o campo 'userSourcedId' e produz uma dependência no arquivo users.csv.