Sincronizar contatos pais e responsáveis no SDS

Visão Geral

O School Data Sync (SDS) dá suporte à ingestão de vários elementos de dados para fins primários de provisionamento de objetos e entidades do Microsoft 365 e para habilitar e enriquecer o Insights. Um dos elementos de dados com suporte para sincronização no SDS são os dados pai e guardião. Este documento descreve o processo de sincronização pai e guardião e os vários casos de uso e considerações para sincronizar esse conjunto de dados no Microsoft 365.

Por que as escolas ingerem dados de contato dos pais e responsáveis?

Quando o resumo semanal de emails do responsável em tarefas está habilitado no Teams, o aplicativo Tarefas envia emails semanalmente para pais e responsáveis, contendo uma exibição resumida das tarefas da semana anterior e tarefas da próxima semana para cada classe.
Integrações de aplicativos de terceiros: os dados de contato dos pais e responsáveis estão disponíveis para aplicativos de terceiros por meio da API relatedContacts no MS Graph. A disponibilização dos dados por meio do Graph permite que as organizações criem e forneçam suas próprias experiências e casos de uso para os dados de contato dos pais e responsáveis.

Quais dados pai e responsável têm suporte?

O SDS dá suporte à ingestão de informações básicas de contato sobre pais e responsáveis, incluindo:

Nome
Nome da família
Endereço de email
Número de telefone
ID
Função do contato relacionado
ID de Estudante relacionada

Onde e como os dados são armazenados no Entra ID?

O SDS grava os dados pai e responsável ingeridos no Substrate em um armazenamento de dados oculto no objeto de usuário de cada aluno.
Esses dados básicos de contato NÃO são gravados como Contatos de Email padrão no Exchange Online. Essa escolha foi para impedir que todos os usuários do locatário vissem todos os pais e suas informações de contato relacionadas ao SDS ingerir os dados.
Os dados só são disponibilizados para o Teams no Microsoft 365 para os três primeiros cenários mencionados anteriormente e também disponibilizados para aplicativos de terceiros por meio da API relatedContacts no MS Graph. A API requer permissões somente de aplicativo concedidas pelo administrador, o que significa que os usuários finais dentro do locatário não têm permissão para consultar o MS Graph para ver ou acessar qualquer um dos dados de contato dos pais e responsáveis, protegendo a privacidade dos pais e responsáveis.

Como fazer para sincronizar os dados pai e responsável?

Sincronizar dados pai e responsável no SDS é fácil. Esta seção explica como sincronizar pais e responsáveis com base no ponto de partida e no método de sincronização usado:

Arquivos CSV do SDS v2.1

Se você estiver sincronizando dados com o SDS usando o formato CSV do SDS v2.1, deverá incluir outro arquivo csv, relationships.csv. Portanto, você precisaria de quatro arquivos CSV no total: orgs.csv, users.csv, roles.csve relationships.csv.

O userSourcedId no relationships.csv corresponde ao valor sourcedId do aluno relacionado no users.csv. O atributo relationshipUserSourcedId corresponde ao pai relacionado no arquivo users.csv .
Se você incluir o número de telefone dos pais e responsáveis, deverá incluir os dados no formato E164, sem parênteses ou espaços, incluindo o símbolo de adição na frente da cadeia de caracteres. Por exemplo, formate números de telefone como +[código do país][código de área][número de telefone], como +12223334444.
Em caso de dúvidas, entre em contato conosco por meio do Suporte do Microsoft Education.

SDS v1 CSV Files

Se você estiver sincronizando dados com o SDS usando o formato CSV do SDS v1, deverá incluir dois arquivos CSV extras, user.csv e guardianrelationship.csv.

API do OneRoster

Comunicamos orientações para suporte geral à API OneRoster a todos os provedores atuais. Você pode ajudar acompanhando e solicitando que seu provedor inclua suporte para incluir dados de contatos como parte da integração de dados. Compartilhe o artigo Diretrizes de Integração para Provedores de API OneRoster para SDS com seu provedor para que eles possam atualizar o suporte e trabalhar com a equipe de Engenharia de Implantação do SDS para validar o suporte e atualizar seu perfil.
Para ingerir por meio da API do OneRoster, com base nos recursos de dados opcionais com suporte do seu provedor, você verá o botão de alternância selecionado Ativado (padrão) para Incluir dados de contatos .
- Se a alternância estiver desativada e indisponível para ativar, significa que o perfil do provedor atualmente não dá suporte ao fornecimento dos dados opcionais.
- Depois que o suporte for adicionado pelo seu provedor, você poderá editar sua configuração para selecionar o botão de alternância para Ativado para incluir os dados na execução subsequente.

Enviando dados de contato com o objeto de usuário Student

Para gravar os dados de contato encaminhados com os objetos de usuário aluno, você precisa garantir que sua configuração Gerenciar dados tenha a alternância Associações de contatos do aluno para Ativado para incluir os dados na execução subsequente.

Funções de pai e guardião

O SDS dá suporte a várias funções para pais e responsáveis, conforme listado abaixo. Há suporte apenas para as funções de pai e responsável . Se você ingerir usuários com as outras funções no SDS, eles não estarão disponíveis. Se você pretende que a pessoa apareça e esteja disponível, não use uma destas funções:

Relativo
Assessor
Doutor
Outros

Status – ativo versus inativo

Quando o SDS adiciona cada pai e responsável à coleção de contatos relacionados no armazenamento de dados de substrato oculto do usuário de cada aluno, cada pai e responsável é marcado como ativo. Se você remover um pai ou responsável dos dados para importar na próxima sincronização, eles serão marcados como inativos. Esse status pode ser exibido na página de pessoas de cada aluno no SDS. Somente pais e responsáveis com um status ativo são mostrados como disponíveis. O SDS não exclui automaticamente os registros pai e guardião se você parar de enviar dados em sincronizações subsequentes. Confira a próxima seção para obter detalhes sobre como excluir pais.

Excluindo pais

O SDS adiciona todos os pais e responsáveis à coleção de contatos relacionados no objeto de usuário de cada aluno quando eles são ingeridos. Quando o objeto de usuário do aluno é excluído, todos os contatos correspondentes que a SDS armazenou ao longo do tempo também são excluídos. Se você precisar remover um contato relacionado sem excluir o objeto de usuário do aluno, a equipe do SDS publicou um script do PowerShell para ajudar nesse processo. Se precisar de ajuda para executar o script do PowerShell, entre em contato com nossa equipe de suporte em https://aka.ms/sdssupport. Depois que o contato for removido com sucesso do Substrato, certifique-se de remover o mesmo pai ou responsável de todos os uploads subsequentes para evitar adicioná-los novamente ao diretório.

Removendo dados pai e responsável

Os dados pai e guardião são armazenados no repositório do substrato do Azure. Esse local é de difícil acesso, requer permissões de aplicativo e também é restrito para que você não possa remover uma única entrada. Para remover um único pai ou responsável que foi sincronizado com um aluno, você deve remover todos os registros e, em seguida, adicionar novamente os registros que deseja associar ao aluno.

Essas etapas ajudam você a executar o script a seguir e remover dados Pai e Responsável.

O365-EDU-Tools/SDS Scripts/Reset-Guardians.ps1 em master · OfficeDev/O365-EDU-Tools (github.com)

Importante

Este script usa o módulo Microsoft Graph PowerShell. Ele não será executado no ISE do PowerShell.

Criar um certificado

Para executar o script, você precisa primeiro criar um aplicativo no Microsoft Entra ID e fornecer um certificado para acessar as informações. Encontre as etapas, comandos e detalhes do certificado autoassinado neste artigo sobre como criar um certificado público autoassinado para autenticar seu aplicativo.

Abra o PowerShell no modo de administrador.
Navegue até o local a partir do qual você está trabalhando. Neste exemplo, é C:\TEMP\Reset_Guardians_Script.
Abra a página a seguir para obter as etapas sobre como criar o comando. Insira o primeiro comando e lembre-se de alterar o nome do certificado. É recomendável usar o botão Copiar para facilitar o comando completo.
Neste exemplo, definimos o nome do certificado como parentResetScript.
Altere o local da pasta antes de executar o comando.
Neste exemplo, usamos a mesma pasta em que estamos atualmente.

Criando um aplicativo

O aplicativo é como determinamos as permissões e o acesso para o script.

Navegue até o centro de administração do Microsoft Entra ID e, em seguida, Identidade | Aplicações |Registros de aplicativo.
Selecione Novo registro para iniciar o processo de criação.
Insira um nome para o aplicativo. Neste exemplo, é o Aplicativo de Redefinição Pai. Não precisamos preencher nenhuma outra configuração nesta página.
Copie e salve a ID do aplicativo (cliente). Ele é usado para executar o script mais tarde.
Selecione Permissões de API em Gerenciar.
Selecione Adicionar uma permissão.
Selecione Microsoft Graph.
Selecione Permissões de aplicativos.
Pesquise e selecione o usuário. ReadWrite.All e EDURoster.ReadWrite.All e selecione Adicionar permissões na parte inferior depois que ambos forem selecionados.
Selecione Conceder consentimento do administrador para (nome do locatário) e confirme.
Navegue até Certificados & Segredos no lado esquerdo em Gerenciar.
Selecione a guia Certificados e, em seguida, Carregar certificado.
Navegue até o certificado que criamos no primeiro estágio.
Selecione Adicionar.
Por fim, copie a impressão digital.

Como executar o script Reset_Guardians.ps1

Para executar o script, você precisa de sua ID de locatário e do script que pode ser encontrado aqui: O365-EDU-Tools/SDS Scripts/Reset-Guardians.ps1 em master · OfficeDev/O365-EDU-Tools (github.com)

Para localizar sua ID de locatário, vá para a guia Visão geral no Microsoft Entra ID.
Abra o repositório GitHub e baixe o script. Neste exemplo, ele é baixado para a mesma pasta que contém o certificado.
Esse script pode ser executado de várias maneiras. Se você abrir o script usando um editor de texto como o Bloco de Notas, poderá ver os diferentes métodos que podem ser usados. Neste exemplo, nós o executamos em relação a todos os alunos.

Para executar o script, você pode copiar o último exemplo e substituir os campos por nossas novas informações do aplicativo e ID do locatário.

\Reset-Guardians.ps1 -clientId "{Application (client) ID}" -certificateThumbprint "{Certificate Thumbprint}" -tenantId "{Tenant ID}" ## Replace the field including the { }

Depois de pressionar Enter, digite R e pressione Enter. Se feito corretamente, o script se conecta ao Graph e começa a extrair os alunos e inicia o processo de remoção. Quanto mais alunos, mais tempo o script leva para ser executado.
Depois que todos os alunos forem extraídos, ele solicitará a confirmação da remoção dos dados dos pais e responsáveis. Para continuar, digite y.
Aqui está um exemplo de como o script aparece ao remover os dados.