如何使用 OneRoster 1.0 CSV 文件 (经典) 部署学校数据同步

重要

到 2024 年底,学校数据同步 (经典) 体验将替换为 新的学校数据同步体验 。 我们建议你开始计划下一年回到学校的新体验 的过渡

可以将逗号分隔值 (CSV) 文件与学校数据同步 (SDS) 配合使用,将学生信息系统 (SIS) 数据导入和同步到Office 365。 SDS 可以将学生、教师、学校、分区和名单信息从 SIS 同步到Microsoft Entra ID和Office 365。 使用此方法,你将从 SIS 数据导出或创建 用于学校数据同步的 OneRoster CSV 文件 ,设置同步配置文件,并将 CSV 文件上传到 SDS 进行处理。

本文内容:

开始之前

在使用 CSV 导入方法开始与 SDS 同步之前,请阅读 SDS 概述。 此外,若要完成此过程,必须安装 Microsoft SDS 工具包。 此工具可帮助你转换 CSV 导出、添加和更新在 SIS 和 Office 365 之间同步的用户,还可用于验证 CSV 文件数据。 有关详细信息,请参阅 安装 SDS 工具包

请确保满足以下先决条件:

  • 教育版租户Office 365

  • 全局管理员凭据

  • 启用了学校数据同步 (计划 1)

    注意

    第三方应用程序提供商可以通过其应用访问通过 SDS 提供的数据,因此应仅同步要提供给这些第三方的数据。

将 OneRoster 1.0 CSV 文件转换为 SDS 格式

必须先将 OneRoster 格式的 CSV 文件转换为 SDS 格式,然后才能创建 SDS 同步配置文件并导入 CSV 文件。 按照以下步骤完成此转换过程。

  1. 将 OneRoster 1.0 CSV 文件保存在 C:\temp 目录中。

  2. 安装 SDS 工具包。

  3. 创建名为 c:\temp\csvs 的子文件夹。

  4. 创建名为 c:\temp\sdslogs 的子文件夹。

  5. 使用以下语法运行 Convert-OneRosterToMicrosoftSDS 命令:

    Convert-OneRosterToMicrosoftSDS -onerosterfolderpath "c:\\temp" -sdsfolderpath "c:\\temp\\csvs" -logpath "c:\\temp\\logs"
    
  6. 转到 c:\temp\csvs 目录,验证是否存在新的 SDS 转换文件。

创建同步配置文件并导入转换后的 CSV 文件

按照以下步骤导入已转换的文件并创建同步配置文件。 同步配置文件是 SDS 用于同步计划上传的 CSV 数据的选项和设置的逻辑组。 可以在单个Office 365租户中创建多个同步配置文件。

SDS 访问和首次登录

  • 若要访问 SDS 管理员门户,请启动 Web 浏览器,导航到 sds.microsoft.com,选择“登录”,然后输入 Microsoft 365 全局管理员帐户凭据。

创建同步配置文件并上传 OneRoster 1.0 CSV 文件

  1. 登录后,在左侧导航中选择“ + 添加配置文件 ”以创建同步配置文件。

    添加配置文件。

  2. “选择连接类型” 页上,根据需要填写表单。 完成后,选择“ 开始”。

    选择“连接类型”。

    注意

    OneRoster CSV 没有选项。 如果使用 OneRoster 文件格式,请选择 CSV 文件:SDS 格式。

  3. “同步选项” 页上,选择相应的选项以创建新用户或同步现有用户。 然后选择“ 上传文件” 以上传六个 SDS CSV 文件。 上传后,根据需要完成页面上的选择,然后选择“ 下一步”。

    注意

    如果运行用于创建新用户的选项并希望采用 V2.1 CSV,我们发布了一个工具,可帮助你准备支持 V2.1 CSV 格式,作为回到学校过渡的一部分。 在创建用户之前,请参阅更新定位点 ID

    同步选项。

    • 现有用户 - 如果已在 O365 租户中为 CSV 文件中包含的每个学生和教师创建用户帐户,请选择此选项。

    • 新用户 - 如果希望 SDS 为 CSV 文件中包含的每个学生和教师创建用户帐户,请选择此选项。

    • “上传文件”按钮 - 选择此按钮可上传六个 CSV 文件。 上传后,SDS 将执行一些简短的验证测试,以确保文件的格式正确。 如果验证通过,文件将上传到同步配置文件。

    • 学校属性 - 上传 CSV 文件后,将自动选择 School.csv 中包含的属性。 应验证此处选择的属性是否与 School.csv

    • 节属性 - 上传 CSV 文件后,将自动选择 Student.csv 中包含的属性。 应验证此处选择的属性是否与 School.csv

    • 团队创建选项 – 选中此框可确保 SDS 为每个同步的课堂创建 Microsoft 365 组和课堂团队。 如果未选中该框,则 SDS 将仅创建Microsoft 365 组。

    • 替换不支持的特殊字符 - 选中此框将允许 SDS 在同步运行时自动替换不支持的特殊字符。 特殊字符将替换为“_”,并且不再在该对象的同步过程中导致错误。

    • 课堂组显示名称的同步选项 - 选中此框将允许教师在第一次同步后控制分区显示名称,并阻止 SDS 覆盖教师所做的分区 DisplayName 更改。

    • 延迟学生访问 - 启用此选项可让你设置 SDS 同步成员身份的日期,并使学生能够查看其课程。 禁用此选项可立即同步学生。

    • 何时应停止同步? - 你通常需要在学年或学期结束时执行此操作。 SDS 停止同步配置文件后,可以选择根据需要清理与此配置文件关联的类。

  4. “教师选项” 页上,选择适当的标识匹配选项,确认已选择教师属性,然后选择“ 下一步”。

    SDS 将检查,以确保选择正确格式的属性和选项。 例如,如果与 UserPrincipalName 匹配,则必须选择一个源目录属性,该属性的格式为 UserPrincipalName (prefix@domain.com) 或者必须选择将域追加到源目录属性以确保格式正确。 如果所选内容的格式不正确,无法完成匹配,则会在页面上看到红色错误。

    教师选项。

    • 主键 (源目录) - 这是 CSV 文件中用于 SDS 标识匹配的教师属性。 观看标识匹配视频,详细了解如何选择适当的源目录属性,以及如何为教师正确配置标识匹配设置。

    • 主键 (目标目录) - 这是Microsoft Entra ID中用于 SDS 标识匹配的用户属性。 观看标识匹配视频,详细了解如何选择适当的目标目录属性,以及如何为教师正确配置标识匹配设置。

    • 域 (可选) - 这是一个可选域值,可添加到所选源目录属性以完成教师标识匹配。 如果需要匹配 UserPrincipalName 或 Mail 属性,则必须在字符串中包含域。 源属性必须已包含域,或者可以使用下拉菜单将相应的域追加到源属性。

  5. 在“ 学生选项” 页上,选择适当的标识匹配选项,确认已选择学生属性,然后选择“ 下一步”。

    SDS 将检查,以确保选择正确格式的属性和选项。 例如,如果与 UserPrincipalName 匹配,则必须选择一个源目录属性,该属性的格式为 UserPrincipalName (prefix@domain.com) 或者必须选择将域追加到源目录属性以确保格式正确。 如果所选内容的格式不正确,无法完成匹配,则会在页面上看到红色错误。

    学生选项。

    • 主键 (源目录) - 这是 CSV 文件中用于 SDS 标识匹配的学生属性。 观看标识匹配视频,详细了解如何选择适当的源目录属性,以及如何为教师正确配置标识匹配设置。

    • 主键 (目标目录) - 这是Microsoft Entra ID中用于 SDS 标识匹配的用户属性。 观看标识匹配视频,了解有关如何选择适当的目标目录属性以及正确配置学生的标识匹配设置的其他信息。

    • 域 (可选) - 这是一个可选域值,可添加到所选源目录属性以完成学生标识匹配。 如果需要匹配 UserPrincipalName 或 Mail 属性,则必须在字符串中包含域。 源属性必须已包含域,或者可以使用此下拉菜单将相应的域追加到源属性。

  6. 在“ 审阅 ”页上,确保已做出适当的选择。 如果不需要其他更改,请选择“ 创建配置文件”。 创建同步配置文件后,SDS 将开始预同步验证过程。 如果在此过程中发现任何错误,可以选择修复这些错误并重新上传文件,然后再单击“恢复同步”按钮并启动实际同步过程。 如果收到错误并选择不更新它们,则仍可以选择恢复同步而不解决错误。

    “审阅”页。

若要在设置同步配置文件后帮助自动执行同步过程,可以 安装 SDS 工具包。 此工具可帮助你在 OneRoster CSV 文件和Office 365之间创建自动同步计划,还可用于验证 CSV 文件数据。 有关详细信息,请参阅安装 Microsoft 学校数据同步 工具包。

视频:如何匹配同步的源和目标属性

有关同步逻辑匹配成功和失败的各种示例,watch标识匹配视频:

SDS 概述

用于 SDS 的 OneRoster CSV 文件

如何使用 CSV v2.1 格式的 CSV 文件部署 SDS

如何使用 CSV V1 格式的 CSV 文件部署 SDS

如何使用 CSV V2 格式的 CSV 文件部署 SDS

如何使用 Clever 格式的 CSV 文件部署 SDS

SDS 错误