您可以在每个客户端连接级别配置 Instructure OneRoster 集成选项。
在您的集成 alpha 测试阶段,Instructure 将与您合作,为您的机构建立推荐的默认配置设置。
了解更多排班服务配置 和 排班整合最佳实践。
笔记:Instructure 是 OneRoster 的消费者。有关 OneRoster 消费者和提供者的定义,请参阅[此处]。OneRoster简介。
并发性
并发数是指同时运行的端点数量。并发数设置为 3 时,最多可以配置三个独立的并发端点。例如,您可以使用以下方法:获取条款,获取教师,获取类端点同时连接。
了解更多关于配置的信息学校特定名册终点允许同时进行注册数据同步。
笔记:Instructure 并未对分页应用并发性。因此,数据加载速度取决于最慢的端点响应时间和单线程分页速度之和。
错误处理
错误处理与显示错误代码的配置有关。
关注 OneRoster错误处理规范此外,建议您在开头加上您的SIS名称。imsx_description这样一来,集成功能就可以自动向最终用户显示具有指导意义的错误描述。
排除的端点
排除的端点是指未包含在 API 调用中的端点。
如果两个接口返回相同的数据集,则排除其中一个数据集以减少 API 调用次数。例如:获取所有学术课程 和 获取所有条款可能提供相同的数据集,因此只需在端点配置中包含其中一个即可。
在集成 alpha 测试期间,请将任何排除的端点通知 Instructure。
了解更多关于 OneRoster 的信息端点配置。
筛选查询
使用筛选查询来筛选数据同步中包含的数据。您可以为每个作业配置筛选查询,从而支持批量数据同步和增量数据同步。
在集成 alpha 测试期间,请将您为 OneRoster 配置的筛选查询告知 Instructure。
了解更多关于 OneRoster 的信息筛选查询此外,了解更多增量同步实现要求。
分页
由于对SIS的API调用可能会请求大量数据,分页功能可以使API查询结果有序显示。为了减少HTTP流量并缩短同步时间,建议将分页配置为每次最多支持1000条记录。
了解更多关于 OneRoster 的信息分页要求。
笔记: 虽然不推荐,但如果超时次数不太多,Instructure 可以支持将所有请求的数据包含在单个 API 调用中的实现方式。
重试
重试次数是指集成尝试调用 API 的次数。Instructure OneRoster 集成最多会尝试三次 API 调用,三次后才会出错。每次尝试之间都会有延迟,延迟倍数可以增加重试之间的延迟时间。
根据以下示例配置,API 调用将尝试最多三次,第一次出错后等待 5 秒,第二次出错后等待 15 秒。如果第三次调用失败,则集成作业失败。
示例重试配置 | 解释 |
|---|
“defaultRetries”: 2
| 3次尝试 |
“defaultDelay”: 5000
| 5秒 |
“defaultDelayMultiplier”:3
| 15秒 |
暂停
当 API 请求到 Web 服务器的耗时超过网站服务器的等待时间时,就会发生超时。如有必要,您可以增加网站服务器的等待时间(例如 2 分钟以上)。但是,如果可能,您应该调整集成方式,使其响应更快(例如,响应时间少于 20 秒)。