Instalar o kit de ferramentas do School Data SyncInstall the School Data Sync Toolkit

Observação

Este kit de ferramentas será preterido em breve.This toolkit will be deprecated soon. Sugerimos que você carregue seus arquivos CSV usando o conector de fluxo do SDS.We suggest you upload your CSV files using the SDS Flow Connector. Instruções detalhadas podem ser encontradas na automação de sincronização de arquivo CSVDetailed instructions can be found at CSV File Sync Automation

Você pode usar o kit de ferramentas do School Data Sync para validar seus arquivos CSV e verificar se há erros, realizar uma sincronização CSV manual do PowerShell e automatizar o processo de sincronização do CSV para atender às suas necessidades.You can use the School Data Sync Toolkit to validate your CSV files and check for errors, perform a manual CSV sync from PowerShell, and automate the CSV sync process to meet your needs.

Neste tópico:In this topic:

Instalar o kit de ferramentas do Microsoft School Data SyncInstall the Microsoft School Data Sync Toolkit

  1. Baixar a ferramenta do Microsoft School Data Sync ToolkitDownload the tool from Microsoft School Data Sync Toolkit

  2. Clique duas vezes na ferramenta para executar o assistente.Double-click the tool to run the wizard.

  3. Na página Bem-vindo, clique em Próximo.On the Welcome page, choose Next.

    Escolha Próximo na página de Bem-vindo da configuração do kit de ferramentas do Microsoft School Data Sync

  4. Aceite o contrato de licença > clique em Próximo, escolha um caminho de instalação e, em seguida, escolha Próximo.Accept the license agreement > click Next, choose an installation path, and then choose Next.

    Escolha o caminho de instalação para o kit de ferramentas do Microsoft School Data Sync

  5. Escolha Instalar > Concluir.Choose Install > Finish.

Recursos do kit de ferramentas do School Data SyncCapabilities of the School Data Sync Toolkit

Depois de ter instalado o kit de ferramentas e seu perfil inicial tiver sido criado no portal de sincronização de dados da escola, você poderá usar o script a seguir para carregar arquivos CSV adicionais regularmente ou conforme o necessário.After you have installed the toolkit and your initial profile has been created in the School Data Sync Portal, you can use the following script to upload additional CSV files on a regular or as-needed basis. O instalador permite que você execute vários cmdlets de uma sessão de administrador do PowerShell no seu computador, para ajudá-lo a implantar o School Data Sync com êxito.The installer allows you to run several cmdlets from an admin PowerShell session on your computer, to help you deploy School Data Sync successfully. Consulte as seções a seguir para obter uma descrição e um caso de uso de cada cmdlet.See the following sections for a description and use case for each cmdlet.

Observação

Será necessário instalar uma versão específica do AzCopy para que os carregamentos de arquivo funcionem.You will need to install a specific version of AzCopy for the file uploads to work. O link para o instalador do AZCopy está aqui.The link to the AZCopy installer is here.

Usar o kit de ferramentas do School Data Sync para validar os dados do arquivo CSV (Pré-sincronização)Use the School Data Sync Toolkit to validate CSV file data (Pre-sync)

Para usar o kit de ferramentas para validar arquivos CSV antes de carregar os arquivos para sincronização, abra o PowerShell como Administrador e use o cmdlet Start-CsvFilesValidation como descrito pela seguinte sintaxe e exemplos.To use the toolkit to validate CSV files before you upload the files for synchronization, open PowerShell as an Administrator and use the Start-CsvFilesValidation cmdlet as described by the following syntax and examples.

Sintaxe Start-CsvFilesValidationStart-CsvFilesValidation syntax

Use o cmdlet Start-CsvFilesValidation para validar arquivos CSV para um determinado perfil de sincronização.Use the Start-CsvFilesValidation cmdlet to validate CSV files for a given sync profile.


Start-CsvFilesValidation -CsvFolderPath <String> -ProfileName <String> -UserName <String>
ParâmetroParameter DescriçãoDescription
CsvFolderPathCsvFolderPath
Caminho para a pasta que contém os arquivos CSV.Path to the folder containing the CSV files.
ProfileNameProfileName
Nome do perfil que você criou no School Data Sync para os CSVs que deseja validar.Name of the profile you've created in School Data Sync for the CSVs you want to validate.
UserNameUserName
Nome de usuário da conta de administração com direitos de administração global para o locatário do Office 365.User name of the admin account with Global admin rights for the Office 365 tenant.

O exemplo a seguir executa a validação do lado do cliente dos arquivos CSV localizados no diretório c:\temp do computador local, para um perfil chamado "School1", usando a conta de administração global de admin@contoso.com.The following example performs client-side validation of CSV files located in the c:\temp directory of the local computer, for a profile called "School 1", using the global admin account of admin@contoso.com.

Start-CsvFilesValidation -CsvFolderPath "c:\\temp" -ProfileName "School 1" -UserName admin@contoso.com

Usar o kit de ferramentas do School Data Sync para sincronizar arquivos CSVUse the School Data Sync Toolkit to sync CSV files

Para carregar e sincronizar arquivos CSV com o School Data Sync, abra o PowerShell como Administrador e use o cmdlet Send-CsvFiles conforme descrito pela seguinte sintaxe e exemplo.To upload and sync CSV files with School Data Sync, open PowerShell as an Administrator and use the Send-CsvFiles cmdlet as described by the following syntax and example.

Sintaxe Send-CsvFilesSend-CsvFiles syntax

Use o cmdlet Send-CsvFiles para carregar e sincronizar arquivos CSV para um determinado perfil de sincronização.Use the Send-CsvFiles cmdlet to upload and sync CSV files for a given sync profile.


Send-CsvFiles -CsvFolderPath <String> -ProfileName <String> -UserName <String>
ParâmetroParameter DescriçãoDescription
CsvFolderPathCsvFolderPath
Caminho para a pasta que contém os arquivos CSV.Path to the folder containing the CSV files.
ProfileNameProfileName
Nome do perfil que você criou no School Data Sync para os CSVs que deseja validar.Name of the profile you've created in School Data Sync for the CSVs you want to validate.
UserNameUserName
Nome de usuário da conta de administração com direitos de administração global para o locatário do Office 365.User name of the admin account with Global admin rights for the Office 365 tenant.

O exemplo a seguir carrega e sincroniza um conjunto de arquivos CSV localizados no diretório c:\temp do computador local, para um perfil chamado "School1", usando a conta de administração global de admin@contoso.com.The following example uploads and syncs a set of CSV files located in the c:\temp directory of the local computer, for a profile called "School 1", using the global admin account of "admin@contoso.com.


Send-CsvFiles -CsvFolderPath "c:\\temp" -ProfileName "School 1" -UserName "admin@contoso.com"

Usar o kit de ferramentas do School Data Sync para configurar uma sincronização CSV automatizadaUse the School Data Sync Toolkit to configure automated CSV sync

Você pode agendar sincronizações automáticas autônomas entre seus arquivos CSV armazenados localmente e seu perfil SDS Sync no Office 365. Para fazer isso, abra o PowerShell como Administrador e use o cmdlet Add-CsvFileSyncTask conforme descrito pela seguinte sintaxe e exemplos. Depois que a tarefa agendada estiver sido concluída, você pode monitorar o progresso e o histórico dessas sincronizações automatizadas ao revisar a tarefa agendada recentemente no Agendador de Tarefas. Esta tarefa programada será executada diariamente à meia-noite, a menos que você modifique a hora de início usando o parâmetro abaixo.You can schedule unattended automated syncs between your CSV files stored locally and your SDS Sync Profile in Office 365. To do this, open PowerShell as an Administrator and use the Add-CsvFileSyncTask cmdlet as described by the following syntax and examples. After the scheduled task is complete, you can monitor the progress and history of these automated syncs by reviewing the newly created scheduled task in Task Scheduler. This scheduled task will run daily at midnight, unless you modify the start time using the parameter below.

Ao executar esse comando, será solicitado que você realize a autenticação. O primeiro prompt de autenticação exigirá suas credenciais de Administração Global e já conterá o nome de usuário especificado no comando abaixo, no parâmetro do nome de usuário. Depois de inserir sua senha e clicar em Enter, você receberá um segundo prompt de autenticação básica. Aqui você deve inserir o nome de usuário e a senha do administrador local, que serão as credenciais usadas para executar a tarefa agendada, cada vez que ela for iniciada diariamente. Se você incluir o parâmetro StoreCredentials, as credenciais da conta de administrador local serão armazenadas no Credential Manager e continuarão a funcionar enquanto a senha permanecer inalterada. Se você não especificar o parâmetro StoreCredentials, você receberá um token de autenticação, que possui uma vida útil máxima de 90 dias. Isso exigirá que você execute o comando novamente depois que o token de autorização expirar e não será mais possível autenticar enquanto executa a tarefa agendada.When you run this command, you will be prompted to authenticate. The first authentication prompt will require your Global Admin credentials and will already contain the username you specify in the command below, under the username parameter. After you enter your password and click Enter, you will then receive a second, basic authentication prompt. Here you should enter the local administrator username and password, which will be the credentials used to run the scheduled task, each time it starts daily. If you include the StoreCredentials parameter, the local administrator account credentials will be stored in Credential Manager, and continue to work as long as the password remains unchanged. If you do not specify the StoreCredentials parameter, you will be granted an auth token, which has a maximum lifetime of 90 days. This will require that you run the command again after the auth token expires and is no longer able to authenticate while running the scheduled task.

Sintaxe Add-CsvFileSyncTaskAdd-CsvFileSyncTask syntax

Use o cmdlet Add-CsvFileSyncTask para carregar e sincronizar arquivos CSV para um determinado perfil de sincronização.Use the Add-CsvFileSyncTask cmdlet to upload and sync CSV files for a given sync profile.


Add-CsvFileSyncTask -CSVFolderPath <path to csv file location> -ProfileName <name of sync profile in SDS> -LogPath <path to store logs> -UserName <global admin account> -Validate -RedirectOutput
ParâmetroParameter DescriçãoDescription
CSVFolderPathCSVFolderPath
Caminho para a pasta que contém os arquivos CSV que serão sincronizados regularmente.Path to the folder containing the CSV files that will be regularly synced.
ProfileNameProfileName
Nome do perfil de sincronização SDS em que você está sincronizando arquivos CSV.Name of the SDS Sync Profile you are syncing the CSV Files against.
UserNameUserName
Nome principal de usuário da Conta de Administrador Global a ser usado com o SDS.UserPrincipalName of the Global Admin Account to be used with SDS.
LogPathLogPath
Caminho para o diretório onde você gostaria de armazenar seus arquivos de log de validação.Path to the directory where you would like to store your validation log files.
RedirectOutputRedirectOutput
Permitirá que a saída do parâmetro de validação seja escrita para o diretório especificado. Isso é necessário se você deseja rever os resultados do parâmetro de validação.Will allow the output of the validate parameter to be written out to the specified directory. This is required if you want to review the results of the validate parameter.
ValidarValidate
Execute a tarefa de validação antes de cada sincronização. Cria um arquivo no diretório Logpath se o parâmetro RedirectOutput também estiver incluído.Run the validation task prior to each sync. Creates a file in the Logpath directory if the RedirectOutput parameter is also included.
TaskUserNameTaskUserName
Nome de usuário do administrador local no sistema.Username of the local administrator on the system.
TaskStartTimeTaskStartTime
Hora do dia em que a tarefa agendada será iniciada.Time of day the scheduled task will begin.
StoreCredentialsStoreCredentials
Cria uma entrada no Credential Manager para executar a tarefa agendada. A credencial permanece válida e continua a funcionar, a menos que a senha associada a esta conta expire.Creates an entry in Credential Manager to run the scheduled task. The credential remains valid and continues to work, unless the password associated with this account expires.

O exemplo a seguir cria uma tarefa agendada de sincronização automatizada para arquivos CSV localizados na pasta C:\temp, em um perfil de sincronização chamado SDSSync, cria arquivos de log de validação na pasta C:\temp\logs e define o diretório C:\temp\SDS\Logs como o local para todos os arquivos de log gerados. Este comando também executa o processo de validação para os CSVs antes que a sincronização comece e salve a saída de validação no mesmo diretório c:\temp\logs.The following example creates an automated sync scheduled task for CSV files located in the C:\temp folder, on a sync profile called SDSSync, creates validation log files in the C:\temp\logs folder, and sets the C:\temp\SDS\Logs directory as the location for all log files generated. This command also runs the validation process for the CSVs before the sync begins and saves the validation output in the same c:\temp\logs directory.

Add-CsvFileSyncTask -CSVFolderPath "C:\\temp" -ProfileName "SDSSync" -LogPath "C:\\temp\\logs" -UserName admin@contoso.com -Validate -RedirectOutput

Use o kit de ferramentas do School Data Sync para converter arquivos do OneRosterUse the School Data Sync Toolkit to convert OneRoster CSV files

Você pode usar o kit de ferramentas para converter arquivos CSV do OneRoster e sincronizá-los com o School Data Sync. Para fazer isso, abra o PowerShell como administrador e use o cmdlet Convert-OneRosterToMicrosoftSDS conforme descrito na sintaxe e no exemplo a seguir.You can use the Toolkit to convert OneRoster CSV Files and sync them with School Data Sync. To do this, open PowerShell as an Administrator and use the Convert-OneRosterToMicrosoftSDS cmdlet as described by the following syntax and example. Depois que a conversão estiver concluída, você poderá sincronizar os arquivos CSV por meio do SDS, seguindo nossa orientação padrão de sincronização de CSV.After the conversion is complete, you can then sync those CSV files through SDS, following our standard CSV sync guidance.

Sintaxe Convert-OneRosterToMicrosoftSDSConvert-OneRosterToMicrosoftSDS syntax

Use o cmdlet Convert-OneRosterToMicrosoftSDS para carregar e sincronizar arquivos CSV para um determinado perfil de sincronização.Use the Convert-OneRosterToMicrosoftSDS cmdlet to upload and sync CSV files for a given sync profile.

Convert-OneRosterToMicrosoftSDS -OneRosterFolderPath <String> -SDSFolderPath <String> -LogPath <String>
ParâmetroParameter DescriçãoDescription
OneRosterFolderPathOneRosterFolderPath
Caminho para a pasta que contém os arquivos CSV exportados do OneRoster.Path to the folder containing the CSV files exported from OneRoster.
SDSFolderPathSDSFolderPath
Caminho para a pasta onde os arquivos CSV convertidos serão criados.Path to the folder where the converted CSV files will be created.
LogPathLogPath
Caminho para a pasta onde deseja que o registro seja armazenado nessas ações.Path to the folder where you want logging stored on these actions.

O exemplo a seguir converte um conjunto de arquivos CSV do OneRoster localizados na pasta C:\temp\OneRoster, cria um novo conjunto de arquivos CSV localizados no diretório C:\temp\SDS do computador local e define o diretório C:\temp\SDS\Logs como o local para todos os arquivos de log gerados.The following example converts a set of OneRoster CSV files located in the C:\temp\OneRoster folder, creates a new set of CSV files located in the C:\temp\SDS directory of the local computer, and sets the C:\temp\SDS\Logs directory as the location for all log files generated.

Convert-OneRosterToMicrosoftSDS -OneRosterFolderPath "C:\\temp\\OneRoster" -SDSFolderPath "C:\\temp\\SDS" -LogPath "C:\\temp\\SDS\\logs"

Use o kit de ferramentas do School Data Sync para validar dados do arquivo CSV (Pós-sincronização)Use the School Data Sync Toolkit to validate CSV file data (Post-sync)

Para usar o kit de ferramentas para validar arquivos CSV após carregar e sincronizar um conjunto de arquivos CSV, abra o PowerShell como Administrador e use o cmdlet Compare-DirectoryToCSVFiles como descrito pela seguinte sintaxe e exemplos.To use the toolkit to validate CSV files after you upload and sync a set of CSV files, open PowerShell as an Administrator and use the Compare-DirectoryToCSVFiles cmdlet as described by the following syntax and examples.

Sintaxe Compare-DirectoryToCSVFilesCompare-DirectoryToCSVFiles syntax

Use o cmdlet Compare-DirectoryToCSVFiles para validar arquivos CSV para um determinado perfil de sincronização.Use the Compare-DirectoryToCSVFiles cmdlet to validate CSV files for a given sync profile.


Compare-DirectoryToCSVFiles -CsvFolderPath <String> -ProfileName <String> -UserName <String>
ParâmetroParameter DescriçãoDescription
CsvFolderPathCsvFolderPath
Caminho para a pasta que contém os arquivos CSV.Path to the folder containing the CSV files.
ProfileNameProfileName
Nome do perfil que você criou no School Data Sync para os CSVs que deseja validar.Name of the profile you've created in School Data Sync for the CSVs you want to validate.
UserNameUserName
Nome de usuário da conta de administração com direitos de administração global para o locatário do Office 365.User name of the admin account with Global admin rights for the Office 365 tenant.

O exemplo a seguir executa a validação do lado do cliente dos arquivos CSV localizados no diretório c:\temp do computador local, para um perfil chamado "School1", usando a conta de administração global de "admin@contoso.com".The following example performs client side validation of CSV files located in the c:\temp directory of the local computer, for a profile called "School 1", using the global admin account of "admin@contoso.com".


Compare-DirectoryToCsvFiles -CsvFolderPath "c:\\temp" -ProfileName "School 1" -UserName "admin@contoso.com"

Solução de problemas: não é possível executar a sincronização automatizada no kit de ferramentas do School Data SyncTroubleshooting: Unable to run the Automated Sync within the School Data Sync Toolkit

Etapa 1.Step 1. Excluir a tarefa no Agendador de tarefas.Delete the task in task scheduler.

Etapa 2.Step 2. Abra o PowerShell como administrador e execute:Open Powershell as an administrator and run:


Add-CsvFileSyncTask -CSVFolderPath “path to csv file location” -ProfileName “name of sync profile in SDS” -LogPath “path to store logs” -UserName “global admin account” -RedirectOutput  

Etapa 3.Step 3. Se ocorrerem erros, baixe o AZCopy mais recente aqui.If errors occur, please download the newest AZCopy from here.

Etapa 4.Step 4. Tente executar o comando acima novamente.Attempt to run the above command again.

Etapa 5.Step 5. Após a execução do comando, vá para o Agendador de tarefas e abra a tarefa e verifique dentro dos logs.After the command runs, go to the Task Scheduler and open the task and verify within the logs.

Visão geral do School Data SyncOverview of School Data Sync

Arquivos CSV para o School Data SyncCSV files for School Data Sync

Como implantar o School Data Sync usando arquivos CSVHow to deploy School Data Sync by using CSV files

Como implantar o School Data Sync usando a sincronização do PowerSchoolHow to deploy School Data Sync by using PowerSchool Sync

Como implantar o School Data Sync usando arquivos CSV no formato inteligenteHow to deploy School Data Sync by using CSV files in the Clever format

Como implantar o School Data Sync usando arquivos CSV do OneRosterHow to deploy School Data Sync by using OneRoster CSV files

Erros do SDSSDS Errors

Solução de problemas do SDSSDS Troubleshooting