如何使用 OneRoster® 1.1 API 部署学校数据同步

OneRoster® 是一种行业标准格式，用于交换学生信息系统 (SIS) 数据，OneRoster® REST API 是我们通过 SDS 服务将对象从 SISes® 同步到 Microsoft 365 的方法。 使用此同步方法，可以使用 SIS 提供的基于 REST 的 OneRoster 1.1 API 直接连接到 SIS，并直接同步数据，而不是使用 CSV 文件。 使用 OneRoster® API 引入以下数据类别，可以启动用于预配的核心 SDS 功能。 它还使你能够增强下面列出的 Microsoft 365 (Microsoft 365) 产品和功能的体验。

若要使用 OneRoster® Sync 方法设置 SDS，请按照本文中详述的说明进行操作。

本文内容：

• 先决条件
• 视频：如何匹配同步的源和目标属性

先决条件

在使用 OneRoster® Sync 方法开始与 SDS 同步之前，请阅读 SDS 概述 并确保满足以下先决条件：

• 教育版租户Office 365

• 全局管理员权限

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

  注意

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

观看视频

SDS 访问和首次登录

1. 若要访问 SDS 管理员门户启动专用 Web 浏览器，请导航到 sds.microsoft.com，然后使用 Microsoft 365 全局管理员帐户登录。

创建同步配置文件并同步 SIS 数据

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

2. 在 “选择连接类型 ”页上，选择“OneRoster API”，然后从 “选择提供程序” 下拉菜单中选择 SIS 集成提供程序。 完成后，选择“ 开始”。
   

   

• 命名此配置文件 - 输入同步配置文件的名称。 此名称将用于标识 SDS 仪表板中的同步配置文件，在配置文件设置完成后无法更改。
• 选择同步方法 - 在显示的可用同步方法之间进行选择。 如果使用 OneRoster 进行同步，请选择“通过 API 同步方法连接”，然后选择“OneRoster 1.1 API”作为服务选择。

3. 在 “同步选项” 页上，选择相应的选项以创建新用户或同步现有用户。 然后根据需要在页面上完成选择。
   

注意

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

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

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

• Web 访问 URL - 这是 PowerSchool SIS 的基 URL，可通过 Internet 访问。

• 客户端 ID - 这是本文安装 适用于 PowerSchool 的 REST API 插件 部分中记录的客户端 ID。

• 客户端密码 - 这是本文安装 适用于 PowerSchool 的 REST API 插件 部分中记录的客户端密码。

• 选择要同步的学校 - 此选项允许选择要从 OneRoster 同步的学校。

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

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

• 筛选非活动属性 - 选中此框将仅同步活动记录。

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

• 替换不受支持的字符 - 选中此框将自动将不受支持的字符替换为受支持的字符。

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

• 延迟学生访问 - 启用此选项可让你设置学生查看其课程的未来日期。 禁用此选项可允许学生立即查看其课程。

• 何时应停止同步此配置文件？ - 你通常需要在学年结束时执行此操作。 停止同步此配置文件后，可以选择停用与此配置文件关联的类。

注意

目前，具有混合格式的单个租户 (即，将 V1 和 V2 同步配置文件主动运行且两者都设置为“同步到见解”) 将不起作用。

注意

正在等待 SIMS 和 Infinite Campus 提供程序支持同步到见解。

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

• 主键 (目标目录) - 这是 Azure AD 中用于 SDS 标识匹配的用户属性。 观看标识匹配视频，详细了解如何选择适当的目标目录属性，以及如何为教师正确配置标识匹配设置。
• 域 (可选) - 这是一个可选域值，可添加到所选源目录属性以完成教师标识匹配。 如果需要匹配 UserPrincipalName 或 Mail 属性，则必须在字符串中包含域。 源属性必须已包含域，或者可以使用此下拉菜单将相应的域追加到源属性。
• 主键 (源目录) - 这是 OneRoster 中用于 SDS 标识匹配的教师属性。 观看标识匹配视频，详细了解如何选择适当的源目录属性，以及如何为教师正确配置标识匹配设置。

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

• 主键 (源目录) - 这是 OneRoster 中用于 SDS 标识匹配的学生属性。 观看标识匹配视频，详细了解如何选择适当的源目录属性，以及如何为教师正确配置标识匹配设置。
• 主键 (目标目录) - 这是 Azure AD 中用于 SDS 标识匹配的用户属性。 观看标识匹配视频，了解有关如何选择适当的目标目录属性以及为学生正确配置标识匹配设置的其他信息。
• 域 (可选) - 这是一个可选域值，可添加到所选源目录属性以完成学生标识匹配。 如果需要匹配 UserPrincipalName 或 Mail 属性，则必须在字符串中包含域。 源属性必须已包含域，或者可以使用下拉菜单将相应的域追加到源属性。

6. 在“ 审阅 ”页上，确保已做出适当的选择。 如果不需要其他更改，请选择“ 创建配置文件”。

OneRoster API 的筛选状态

• 学生和注册 - SDS 根据学校关联和状态同步某些学生。

  • 已同步
    • 活动
  • 未同步
    • 要删除

• 教师 - SDS 根据学校关联和状态同步某些学生。

  • 已同步
    • 活动
  • 未同步
    • 要删除

• 课堂 - SDS 根据学校关联和教职员工类型同步某些课程。

  • 已同步
    • 活动
  • 未同步
    • 要删除

• 学校 - SDS 根据学校关联和教职员工类型同步某些学校。

  • 已同步
    • 活动
  • 未同步
    • 要删除

  

视频：OneRoster API 部署

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

有关同步逻辑匹配成功和失败的各种示例，请观看标识匹配视频：

相关文章

SDS 概述