Formato de arquivo CSV do SDS V2.1
Você pode usar arquivos CSV (valor separado por vírgula) no formato SDS V2.1 para sincronizar seu SIS (Sistema de Informações Escolares) com Office 365. Usar o formato de arquivo CSV do SDS V2.1 para ingerir 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 do SDS V2.1 continuará a expandir as categorias de dados compatíveis.
Se você estiver usando o formato SDS V2.1, os arquivos devem ser formatados adequadamente. Carregue os arquivos, nomeados exatamente como detalhados. Os cabeçalhos de coluna são sensíveis a maiúsculas de minúsculas. Os arquivos CSV devem estar em formato UTF-8 e em conformidade com RFC. Além disso, não aceitamos quebras de linha nos dados de entrada. Para examinar e baixar o conjunto de exemplos 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ê precisará sempre fornecer o mesmo conjunto de arquivos para uploads subsequentes, independentemente das alterações de dados feitas nos arquivos opcionais ou não. Se você não fizer isso, o sistema determinará que os registros não estão mais ativos e os marcarão como tal.
Necessário: os três arquivos a seguir devem ser fornecidos. Se você estiver apenas gerenciando usuários e não classes, você só precisará fornecer esses arquivos.
orgs.csv
users.csv
roles.csv
Opcional/Obrigatório: os dois arquivos a seguir não são necessários se você estiver apenas gerenciando usuários. Se você também estiver gerenciando classes e registros de classe, você precisará fornecer os dois arquivos listados abaixo, juntamente com os três arquivos acima.
classes.csv
enrollments.csv
Opcional: os seguintes são arquivos opcionais e são usados para aprimorar experiências. Esses arquivos não são necessários, a menos que os arquivos acima tenham referências de dados com base nas anotações abaixo.
academicSessions.csv (se 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 seus dados classes.csv contiver 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 anotados como 'Sim' em 'Obrigatório', os campos observados 'Não' são dados 'Opcional'. Os cabeçalhos de campo marcados como 'Obrigatórios' devem existir nos arquivos fornecidos ou não serão aceitos. Os cabeçalhos de campo marcados como "Opcional" não devem estar presentes nos arquivos se não passarem 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 compatíveis. O conjunto com suporte de valores padrão para campos Enum vê Lista padrão de valores.
orgs.csv
| Campo | Obrigatório? | Exemplo | Tipo de dados |
|---|---|---|---|
| sourcedId | Sim | 10001 | ID exclusiva |
| nome | Sim | Faculdade de Engenharia | Cadeia de caracteres |
| type | Sim | 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 criar usuários) | Craig | Cadeia de caracteres |
| givenName | Sim (somente se criar usuários) | Beane | Cadeia de caracteres |
| activeDirectoryMatchId | Não | craig.beane@domain.com | Cadeia de caracteres |
| Não | cbeane@domain.com | ||
| phone | Não | +1234567890 | Telefone |
| Sms | Não | +1234567890 | Telefone |
| userNumber | Não | 14001 | Cadeia de caracteres |
- familyName e givenName são necessários para os usuários se estiverem usando a opção "Criar usuários incompatíveis".
- familyName, givenName e email são necessários para os usuários se estiverem usando a opção "Associações de contato de estudante" para usuários que têm uma função de relacionamento de contato em relationships.csv. Usuários que são funcionários, mas também contatos, é recomendável que eles tenham dois registros de usuário listados, com o registro de usuário de contatos associado ao endereço de email privado.
- Espere que os campos de telefone e SMS sejam formatados com base no padrão E.164 em que o caractere plus é usado e bem-sucedido pelo número de telefone, ou melhor, o caractere plus seguido pelo código do país, código de área, prefixo telefônico e número de linha.
- A senha não é mais usada para fornecer 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'. Isso produz uma dependência do arquivo users.csv.
- Requer uma referência à organização associada usando o campo 'orgSourcedId'. Isso produz uma dependência do arquivo orgs.csv.
- Se aprovado: isso requer uma referência aos termos associados (sessões acadêmicas) usando o campo 'sessionSourcedId'. Isso produz uma dependência do arquivo academicSessions.csv.
- isPrimary indica se essa função é a função primária (true) ou secundária (false) para essa organização. Se passar 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.
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'. Isso produz uma dependência do arquivo orgs.csv.
- Se aprovado: isso requer uma referência aos termos associados (sessões acadêmicas) usando o campo 'sessionSourcedIds'. Isso produz uma dependência do arquivo academicSessions.csv.
- Se aprovada: 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 cercados por aspas e separados por vírgulas.
- A associação a várias sessionSourcedIds é armazenada somente no Data Lake.
- O atributo de extensão do Grupo 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'. Isso produz uma dependência do 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'. Isso produz uma dependência do arquivo classes.csv.
- Isso requer uma referência ao usuário associado usando o campo 'userSourcedId'. Isso produz uma dependência do arquivo users.csv.
academicSessions.csv
| Arquivado | Obrigatório? | Exemplo | Tipo de dados |
|---|---|---|---|
| sourcedId | Sim | FS2021 | ID exclusiva |
| title | Sim | Semestre de outono | Cadeia de caracteres |
| type | Sim | Semestre | 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 no formato ISO8601.
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 | Y2021 | ID exclusiva |
| assunto | Não | 10 | Enum |
| grade | Não | Graduação | Enum |
- Isso requer uma referência à organização associada (org) usando o campo orgSourcedId. Isso produz uma dependência do arquivo orgs.csv.
- Se aprovado: isso requer uma referência ao registro do ano de sessão acadêmica associado usando o campo 'schoolYearSourcedId' em que o tipo = schoolYear. Isso produz uma dependência do arquivo academicSessions.csv.
relationships.csv
| Campo | Obrigatório? | Exemplo | Tipo de dados |
|---|---|---|---|
| userSourcedId | Sim | 14001 | ID exclusiva |
| relationshipUserSourcedId | Sim | P14001 | 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'. Isso produz uma dependência do arquivo users.csv.
- Isso requer uma referência ao usuário associado usando o campo 'relationshipUserSourcedId'. Isso produz uma dependência do arquivo users.csv.
- Além disso, familyName, givenName e email são necessários para usuários que têm 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 | hispanicOrLatinoEthnicity | Enum[] |
| raceCodes | Não | demographicRaceTwoOrMoreRaces | Enum[] |
- Isso requer uma referência ao usuário associado usando o campo 'userSourcedId'. Isso produz uma dependência do arquivo users.csv.
- Vários valores mapeados para 'raceCodes' devem ser combinados em uma única cadeia de caracteres com os valores cercados por 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'. Isso produz uma dependência do arquivo users.csv.