Compartilhar via


Formato de Ficheiro CSV SDS V2.1

Pode utilizar ficheiros CSV (valores separados por vírgulas) no formato SDS V2.1 para sincronizar o seu Sistema de Informação Escolar (SIS) com Office 365. Utilizar o formato de ficheiro CSV SDS V2.1 para ingerir as categorias de dados permite-lhe iluminar as principais capacidades de SDS para aprovisionamento. Também o ajuda a melhorar as experiências dos produtos e funcionalidades do Microsoft 365. O formato de ficheiro CSV SDS V2.1 continuará a expandir as categorias de dados que suporta.

Se estiver a utilizar o formato SDS V2.1, os ficheiros têm de estar devidamente formatados. Carregue os ficheiros, com o nome exatamente como detalhado. Os cabeçalhos de coluna são sensíveis às maiúsculas e minúsculas. Os ficheiros CSV têm de estar no formato UTF-8 e em conformidade com RFC. Além disso, não aceitamos quebras de linha nos dados recebidos. Para rever e transferir o conjunto de exemplos de ficheiros CSV SDS V2.1, veja o Repositório do GitHub do SDS.

Importante

Após o carregamento inicial durante a criação do fluxo de entrada, terá de fornecer sempre o mesmo conjunto de ficheiros para carregamentos subsequentes, independentemente das alterações de dados efetuadas nos ficheiros opcionais ou não. Se não o fizer, o sistema determinará que os registos já não estão ativos e os marcará como tal.

Obrigatório: os três ficheiros seguintes têm de ser fornecidos. Se estiver apenas a gerir utilizadores e não classes, só precisa de fornecer estes ficheiros. 

  • orgs.csv

  • users.csv

  • roles.csv

Opcional/Obrigatório: os dois ficheiros seguintes não são necessários se estiver apenas a gerir utilizadores. Se também estiver a gerir turmas e inscrições nas aulas, terá de fornecer os dois ficheiros listados abaixo, juntamente com os três ficheiros acima.

  • classes.csv

  • enrollments.csv

Opcional: os seguintes ficheiros são opcionais e são utilizados para melhorar as experiências. Estes ficheiros não são necessários, a menos que os ficheiros acima tenham referências de dados com base nas notas abaixo. 

  • academicSessions.csv (Se o seu roles.csv, classes.csv ou courses.csv contiver dados de sessão académica, os dados correspondentes devem ser fornecidos para evitar mensagens de erro ao processar dados.)

  • courses.csv (Se os dados do classes.csv contiverem ligações para cursos, os dados correspondentes devem ser fornecidos para evitar mensagens de erro ao processar dados.)

  • demographics.csv

  • userFlags.csv

  • relationships.csv

Cada ficheiro CSV tem de conter dados para os campos indicados "Sim" em "Obrigatório", os campos indicados "Não" são dados "Opcionais". Os cabeçalhos de campo marcados como "Obrigatório" têm de existir nos ficheiros fornecidos ou não serão aceites. Os cabeçalhos de campo marcados como "Opcional" não têm de estar presentes nos ficheiros se não forem transmitidos os dados opcionais correspondentes.

Os campos com valores enumerados definidos como marcados na coluna "Tipos de Dados" têm um conjunto específico de valores que suportam. O conjunto suportado de valores predefinidos para campos Enumeração , veja Lista Predefinida de Valores.

orgs.csv

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

users.csv

Campo Obrigatório? Exemplo Tipo de dados
sourcedId Sim 14001 ID Exclusivo
username Sim cbeane@domain.com Cadeia de caracteres
familyName Sim (apenas se criar utilizadores) Craig Cadeia de caracteres
givenName Sim (apenas se criar utilizadores) 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
sms Não +1234567890 Telefone
número de utilizador Não 14001 Cadeia de caracteres
  • familyName e givenName são necessários para os utilizadores se utilizarem a opção "Criar utilizadores sem correspondência".
  • familyName, givenName e e-mail são necessários para os utilizadores se utilizarem a opção "Associações de contactos de estudantes" para utilizadores que tenham uma função de relação de contacto no relationships.csv. Os utilizadores que são funcionários, mas também contactos, recomenda-se que tenham dois registos de utilizador listados, com o registo de utilizador dos contactos associado ao respetivo endereço de e-mail privado.
  • Espere que os campos telefone e sms sejam formatados com base na norma E.164 em que o caráter de adição é utilizado e executado com êxito pelo número de telefone ou, em vez disso, pelo caráter de adição seguido de código de país, código de área, prefixo de telefone e número de linha.
  • A palavra-passe já não é utilizada para fornecer a palavra-passe predefinida para criar novos utilizadores.

roles.csv

Campo Obrigatório? Exemplo Tipo de dados
userSourcedId Sim 14001 ID Exclusivo
orgSourcedId Sim 10001 ID Exclusivo
role Sim student Enum
sessionSourcedId Não FS2021 ID Exclusivo
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 utilizador associado através do campo "userSourcedId". Isto produz uma dependência no ficheiro users.csv.
  • Requer uma referência à organização associada com o campo "orgSourcedId". Isto produz uma dependência no ficheiro orgs.csv.
  • Se for aprovada: isto requer uma referência aos termos associados (sessões académicas) através do campo "sessionSourcedId". Isto produz uma dependência no ficheiro academicSessions.csv.
  • isPrimary indica se esta função é a função primária (verdadeira) ou secundária (falsa) para essa organização. Se transmitir múltiplas funções, para o mesmo utilizador e a mesma organização, deve haver uma e apenas uma função primária definida como (verdadeira) para cada organização.
  • Valores de data a serem fornecidos no formato ISO8601.
  • Zeros à esquerda "0" em falta no valor de entrada para Enumeração de Nível de Grau, por exemplo "1", corresponderão à Lista de Valores definida (ENUM) "01" e serão armazenados como "01".

classes.csv

Campo Obrigatório? Exemplo Tipo de dados
sourcedId Sim 12001 ID Exclusivo
orgSourcedId Sim 10001 ID Exclusivo
title Sim Informática 101 Cadeia de caracteres
sessionSourcedIds Não FS2021 ID exclusivo[]
courseSourcedId Não C12001 ID Exclusivo
código Não 12001 Cadeia de caracteres
  • Isto requer uma referência à escola (organização) associada através do campo "orgSourcedId". Isto produz uma dependência no ficheiro orgs.csv.
  • Se for aprovada: isto requer uma referência aos termos associados (sessões académicas) através do campo "sessionSourcedIds". Isto produz uma dependência no ficheiro academicSessions.csv.
  • Se for aprovada: se uma turma estiver associada a múltiplas sessões no mesmo Ano Lectivo, por exemplo, Semestre de Outono e Semestre de Primavera, pode fornecer ambos os sourcedId para as sessões registadas. Os valores devem ser combinados numa única cadeia 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 do Grupo do Microsoft 365 para IDs de sessão não suporta várias associações.
  • Se for transmitido: isto requer uma referência ao curso associado através do campo "courseSourcedId". Isto produz uma dependência no ficheiro courses.csv.

enrollments.csv

Campo Obrigatório? Exemplo Tipo de dados
classSourcedId Sim 12001 ID Exclusivo
userSourcedId Sim 14001 ID Exclusivo
role Sim student Enum
  • Isto requer uma referência à classe associada através do campo "classSourcedId". Isto produz uma dependência no ficheiro classes.csv.
  • Isto requer uma referência ao utilizador associado através do campo "userSourcedId". Isto produz uma dependência no ficheiro users.csv.

academicSessions.csv

Arquivado Obrigatório? Exemplo Tipo de dados
sourcedId Sim FS2021 ID Exclusivo
title Sim Semestre de outono Cadeia de caracteres
type Sim semestre Enum
ano escolar Sim 2021 Enum
startDate Sim 2020-08-24 Data
endDate Sim 2020-12-11 Data
  • Espere que os valores de data sejam fornecidos no formato ISO8601.

courses.csv

Campo Obrigatório? Exemplo Tipo de dados
sourcedId Sim C12001 ID Exclusivo
orgSourcedId Sim 10001 ID Exclusivo
title Sim Informática 101 Cadeia de caracteres
código Não CS101 Cadeia de caracteres
schoolYearSourcedId Não Y2021 ID Exclusivo
assunto Não 10 Enum
grade Não estudantes universitários Enum
  • Isto requer uma referência à organização (organização) associada através do campo orgSourcedId. Isto produz uma dependência no ficheiro orgs.csv.
  • Se for aprovada: isto requer uma referência ao registo do ano de sessão académica associado através do campo "schoolYearSourcedId" em que o tipo = schoolYear. Isto produz uma dependência no ficheiro academicSessions.csv.
  • Zeros à esquerda "0" em falta no valor de entrada para Enumeração de Nível de Grau, por exemplo "1", corresponderão à Lista de Valores definida (ENUM) "01" e serão armazenados como "01".

relationships.csv

Campo Obrigatório? Exemplo Tipo de dados
userSourcedId Sim 14001 ID Exclusivo
relationshipUserSourcedId Sim P14001 ID Exclusivo
relationshipRole Sim guardião Enum
  • Se também estiver a sincronizar Relações de Contacto (tutores), tem de incluir um registo para os mesmos no users.csv.
  • Isto requer uma referência ao utilizador associado através do campo "userSourcedId". Isto produz uma dependência no ficheiro users.csv.
  • Isto requer uma referência ao utilizador associado através do campo "relationshipUserSourcedId". Isto produz uma dependência no ficheiro users.csv.
  • Além disso, familyName, givenName e e-mail são necessários para utilizadores com funções de Relação de Contacto.

demographics.csv

Campo Obrigatório? Exemplo Tipo de dados
userSourcedId Sim 14001 ID Exclusivo
sexo Não macho Enum
birthDate Não 2001-07-20 Data
birthCity Não Woodville Cadeia de caracteres
birthState Não WA Enum
birthCountry Não EUA Cadeia de caracteres
ethnicityCodes Não hispanicOrLatinoEthnicity Enumeração[]
códigos de corrida Não demographicRaceTwoOrMoreRaces Enumeração[]
  • Isto requer uma referência ao utilizador associado através do campo "userSourcedId". Isto produz uma dependência no ficheiro users.csv.
  • Vários valores que mapeiam para "raceCodes" devem ser combinados numa única cadeia com os valores entre aspas e separados por vírgulas.

userFlags.csv

Campo Obrigatório? Exemplo Tipo de dados
userSourcedId Sim 14001 ID Exclusivo
flag Sim lep Enum
  • Isto requer uma referência ao utilizador associado através do campo "userSourcedId". Isto produz uma dependência no ficheiro users.csv.