安装学校数据同步工具包

注意

此工具包将很快弃用。 建议使用 SDS 流连接器上传 CSV 文件。 可在 CSV 文件同步自动化中找到详细说明。 此外,此工具包不适用于 V2.1 CSV 文件。

可以使用学校数据同步工具包验证 CSV 文件并检查错误,从 PowerShell 执行手动 CSV 同步,并自动执行 CSV 同步过程以满足你的需求。

本文内容:

安装 Microsoft 学校数据同步工具包

  1. Microsoft 学校数据同步 Toolkit 下载工具

  2. 双击该工具运行向导。

  3. 在“欢迎”页上,选择“下一步”

    在 Microsoft SChool 数据同步工具包设置的欢迎页上选择“下一步”。

  4. 接受许可协议 > 选择 “下一步”,选择安装路径,然后选择 “下一步”。

    选择Microsoft 学校数据同步工具包的安装路径。

  5. 选择“安装”>“完成”

学校数据同步工具包的功能

安装工具包并在学校数据同步门户中创建初始配置文件后,可以使用以下脚本定期或根据需要上传更多 CSV 文件。 通过安装程序,可以从计算机上的管理员 PowerShell 会话运行多个 cmdlet,以帮助你成功部署学校数据同步。 有关每个 cmdlet 的说明和用例,请参阅以下部分。

注意

需要安装特定版本的 AzCopy 才能使文件上传正常工作。 此处提供了指向 AZCopy 安装程序的链接。

使用学校数据同步工具包验证 CSV 文件数据(预同步)

要在上传文件进行同步前使用工具包验证 CSV 文件,请以管理员身份打开 PowerShell,然后使用以下语法和示例所述的 Start-CsvFilesValidation cmdlet。

Start-CsvFilesValidation 语法

使用 Start-CsvFilesValidation cmdlet 验证给定同步配置文件的 CSV 文件。


Start-CsvFilesValidation -CsvFolderPath <String> -ProfileName <String> -UserName <String>
参数 说明
CsvFolderPath
包含 CSV 文件的文件夹的路径。
ProfileName
为要验证的 CSV 在学校数据同步中创建的配置文件的名称。
UserName
具有 Office 365 租户全局管理员权限的管理员帐户的用户名。

以下示例使用全局管理员帐户 admin@contoso.com对位于本地计算机 c:\temp 目录中的 CSV 文件执行客户端验证,该文件名为“School 1”。

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

使用学校数据同步工具包同步 CSV 文件

要使用学校数据同步上传和同步 CSV 文件,请以管理员身份打开 PowerShell,然后使用以下语法和示例所述的 Send-CsvFiles cmdlet。

Send-CsvFiles 语法

使用 Send-CsvFiles cmdlet 上传和同步给定同步配置文件的 CSV 文件。


Send-CsvFiles -CsvFolderPath <String> -ProfileName <String> -UserName <String>
参数 说明
CsvFolderPath
包含 CSV 文件的文件夹的路径。
ProfileName
为要验证的 CSV 在学校数据同步中创建的配置文件的名称。
UserName
具有 Office 365 租户全局管理员权限的管理员帐户的用户名。

以下示例使用全局管理员帐户为名为“School 1”的配置文件上传并同步位于本地计算机 c:\temp 目录中的admin@contoso.com一组 CSV 文件。


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

使用学校数据同步工具包配置自动 CSV 同步

可以在本地存储的 CSV 文件与Office 365中的 SDS 同步配置文件之间计划无人参与的自动同步。 为此,请以管理员身份打开 PowerShell,并使用以下语法和示例所述的Add-CsvFileSyncTask cmdlet。 完成计划任务后,可以通过查看任务计划程序中新创建的计划任务来监视这些自动同步的进度和历史记录。 除非使用下面的参数修改开始时间,否则此计划任务将每天午夜运行。

运行此命令时,系统会提示你进行身份验证。 第一个身份验证提示需要全局管理员凭据,并且将包含在以下命令中指定的用户名,位于用户名参数下。 输入密码并选择 Enter 后,你将收到第二个基本身份验证提示。 此处应输入本地管理员用户名和密码,这些用户名和密码是用于运行计划任务的凭据,每次每天启动。 如果包含 StoreCredentials 参数,则本地管理员帐户凭据将存储在凭据管理器中,并且只要密码保持不变,就可以继续工作。 如果未指定 StoreCredentials 参数,将被授予身份验证令牌,其最长生存期为 90 天。 这需要在身份验证令牌过期后再次运行该命令,并且在运行计划任务时不再能够进行身份验证。

Add-CsvFileSyncTask 语法

使用 Add-CsvFileSyncTask cmdlet 上传并同步给定同步配置文件的 CSV 文件。


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
参数 说明
CSVFolderPath
包含将定期同步的 CSV 文件的文件夹的路径。
ProfileName
要针对其同步 CSV 文件的 SDS 同步配置文件的名称。
UserName
要用于 SDS 的全局管理员帐户的 UserPrincipalName。
LogPath
要存储验证日志文件的目录的路径。
RedirectOutput
将允许将验证参数的输出写出到指定的目录。 如果要查看验证参数的结果,则需要这样做。
验证
在每次同步之前运行验证任务。如果还包括 RedirectOutput 参数,则在 Logpath 目录中创建文件。
TaskUserName
系统上本地管理员的用户名。
TaskStartTime
计划任务开始的时间。
StoreCredentials
在凭据管理器中创建一个条目以运行计划任务。 除非与此帐户关联的密码过期,否则凭据将保持有效并继续工作。

以下示例在名为 SDSSync 的同步配置文件上为 C:\temp 文件夹中的 CSV 文件创建自动同步计划任务,在 C:\temp\logs 文件夹中创建验证日志文件,并将 C:\temp\SDS\Logs 目录设置为生成的所有日志文件的位置。 此命令还会在同步开始之前运行 CSV 的验证过程,并将验证输出保存在同一 c:\temp\logs 目录中。

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

使用学校数据同步工具包转换 OneRoster CSV 文件

可以使用工具包转换 OneRoster CSV 文件,并将其与学校数据同步同步。为此,请以管理员身份打开 PowerShell,并按以下语法和示例所述使用Convert-OneRosterToMicrosoftSDS cmdlet。 转换完成后,可以按照标准 CSV 同步指南,通过 SDS 同步这些 CSV 文件。

Convert-OneRosterToMicrosoftSDS语法

使用Convert-OneRosterToMicrosoftSDS cmdlet 上传和同步给定同步配置文件的 CSV 文件。

Convert-OneRosterToMicrosoftSDS -OneRosterFolderPath <String> -SDSFolderPath <String> -LogPath <String>
参数 说明
OneRosterFolderPath
包含从 OneRoster 导出的 CSV 文件的文件夹的路径。
SDSFolderPath
将在其中创建转换的 CSV 文件的文件夹的路径。
LogPath
存储这些操作的日志记录的文件夹的路径。

以下示例转换位于 C:\temp\OneRoster 文件夹中的一组 OneRoster CSV 文件,创建位于本地计算机 C:\temp\SDS 目录中的新 CSV 文件集,并将 C:\temp\SDS\Logs 目录设置为生成的所有日志文件的位置。

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

使用学校数据同步工具包验证 CSV 文件数据(后期同步)

要在上传和同步一组 CSV 文件前使用此工具包验证 CSV 文件,请以管理员身份打开 PowerShell,然后使用以下语法和示例所述的 Compare-DirectoryToCSVFiles cmdlet。

Compare-DirectoryToCSVFiles 语法

使用 Compare-DirectoryToCSVFiles cmdlet 验证给定同步配置文件的 CSV 文件。


Compare-DirectoryToCSVFiles -CsvFolderPath <String> -ProfileName <String> -UserName <String>
参数 说明
CsvFolderPath
包含 CSV 文件的文件夹的路径。
ProfileName
为要验证的 CSV 在学校数据同步中创建的配置文件的名称。
UserName
具有 Office 365 租户全局管理员权限的管理员帐户的用户名。

以下示例使用全局管理员帐户admin@contoso.com“School 1”对位于本地计算机 c:\temp 目录中的 CSV 文件执行客户端验证。


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

故障排除:无法在学校数据同步工具包中运行自动同步

步骤 1. 删除任务计划程序中的任务。

步骤 2. 以管理员身份打开 PowerShell 并运行:


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  

第 3 步。 如果发生错误,请从此处下载最新的 AZCopy

步骤 4. 尝试再次运行上述命令。

步骤 5. 命令运行后,转到任务计划程序,打开任务并在日志中进行验证。

学校数据同步概述

学校数据同步适用的 CSV 文件

如何使用 CSV 文件部署学校数据同步

如何使用 PowerSchool 同步部署学校数据同步

如何使用 Clever 格式的 CSV 文件部署学校数据同步

如何使用 OneRoster CSV 文件部署学校数据同步

SDS 错误

SDS 疑难解答