需要注意的是,在本文档中,使用术语“快照”与从 SIS 中提取存储在平面文件(而非快照控制器中)然后 Learn 加以使用的时间点数据一般流程有关。
快照通过 SIS 框架快照中以下两种支持的集成类型(参阅:数据格式),采用 SIS 配置的时间点数据进行集成:快照 XML 和快照平面文件(或分隔数据)。后者(即快照平面文件)是“不断发展”的支持格式,将接收用于支持新数据对象的更新。快照 XML 将仅接收维护更新。
这两种快照集成类型的处理都是通过 HTTP 将数据文件发布到相应的端点。
支持的数据
数据对象 | 快照平面文件支持 | 快照 XML 支持 |
---|---|---|
用户 | 是 | 是 |
课程 | 是 | 是 |
成员 (注册和职员指定) | 是 | 是 |
目录类别 | 是 | 是 |
组织 | 是 | 是 |
观察员 | 是 | 是 |
机构角色 | 是 | 是 |
节点 | 是 | |
交叉列出的课程 | 是 | |
学期 | 是 | |
标准(以“课程属性”表示) | 是 |
要求
SIS 能够通过相应的分隔符为所选的集成类型(快照 XML 或快照平面文件)生成格式经过设置的数据。
值得重申的一点是,快照控制器和快照 XML 数据格式不应该是首选的集成选项,因为它们只接收维护更新,而不是新的对象支持或功能开发。应该期望,在未来的某个时候,将会发布一项有关支持取消的公告,从而为客户端调整提供充足的时间。
请参阅数据示例中的 Enterprise 1.1 示例部分,请注意,数据格式在两种受支持的 Enterprise 1.1 样式(标准和 Vista)之间略有不同。
设置:快照集成类型
除了熟悉任何 SIS 集成所涉及的数据外,快照集成集成类型的设置还要求掌握 SIS 功能和端点方面的知识,以了解所选快照类型所支持的数据对象是否符合客户端的集成目标。另外,还需要了解特定文件格式。您可以按以下步骤创建快照集成,导航到 Learn 系统管理员 SIS 集成 UI:数据集成 > 学生信息系统集成
以下步骤对两种快照集成类型来说都是相同的,集成类型选择的关键差异是:数据是 XML(选择快照 XML)还是分隔的(快照平面文件)。
- 选择创建集成。
选择快照 XML 或快照平面文件。在下一个屏幕上,选择配置选项。
要进行高级配置(如数据映射),必须将集成设为“测试”或“活动”状态
- 集成名称:输入快照 XML 或快照平面文件。
- 描述(可选):输入您要描述集成的任何内容;例如:“测试快照 XML”或“测试快照平面文件”。
- 共享用户名与共享密码用于数据发布操作。
- 设置集成状态:
- 非活动 - 集成不进行处理。
- 活动 - 集成进行处理并更新 Learn 数据。
- 测试 - 集成进行处理,但不更新 Learn。
- 设置日志详细程度级别 - 对于“测试”,我们建议选择“所有诊断和调试消息”。对于“活动”,我们建议使用较低级别的设置,如“仅错误”或“错误和警告”。
- 选择用于此集成的数据源密钥 (DSK)。您可以选择使用特定的现有 DSK,创建新密钥,或使用馈送中提供的数据源。注意:在所有情况下,必须先创建 DSK,然后系统才能处理数据馈送。
- 只有快照平面文件才支持对父节点的管理。做出相应选择,以满足您的目的。
- 选择通过此集成处理的对象及如何处理奇偶校验。一般来说,默认值都没有问题。注意:您可能具有多种集成类型,每种类型用于处理可用集成对象的唯一子集。
- 选择提交,您的新快照集成会显示在集成列表中。
必须再完成一步操作才能支持快照集成,即配置 SIS 系统以将数据发布到 Learn,或者配置应用程序服务器端 cron/批处理任务以将数据发布到 Learn。请注意,快照端点是需要执行的任务所特有的。
应用程序服务器端向 Learn 发布数据是使用 CURL 或 cron/批处理任务触发的类似应用程序完成的:
curl -k -w %{http_code} -H "Content-Type:text/plain" -u SHARED_USERNAME:SHARED_PASSWORD --data-binary @PATH_TO_TEST_FILE ENDPOINT_URL
替换以下内容:
SHARED_USERNAME,替换为共享用户名
SHARED_PASSWORD,替换为共享密码
PATH_TO_TEXT_FILE,替换为 xml 数据文件的路径
将 ENDPOINT_URL 替换为端点 URL。
您可以查看服务器上的端点列表,方法是:从平面文件集成的上下文菜单转到“HTTP 信息”页面:
系统管理员 (Building Block) > 数据集成 > 学生信息系统集成 >(您的集成的上下文菜单)> Http 信息
如果它受中间层应用程序或 SIS 支持,则数据可以直接发布到遵循上述协议的端点。
完成上述操作并已启用 SIS 来生成数据和发布或保存到文件以供发布到 Learn 之后,您应开始查看集成的日志。
评估数据并确定您是否需要使用可用数据对象的“高级配置/字段映射”做出调整。请查看示例结尾部分的“字段映射”部分,了解此功能的描述。
要详细了解如何处理数据文件,请参阅快照平面文件自动化。
快照集成
快照集成基于符合特定目的的数据集。例如,为了管理系统中的用户或课程。在两种支持的类型(即快照 XML 和快照平面文件)中,只有快照平面文件是最新的,能与支持的 Learn 数据对象保持一致。
与所有“基于文件的”集成类型(快照和 Enterprise 1.1 类型)一样,有两个使用这些文件中数据的流程,即使用 GUI“上传馈送文件”或使用 http 数据传输(例如:cURL)。如果是 http 数据传输,则可以使用 cron 或批处理任务来触发操作。另外,如果它受 SIS 或中间层支持,则可以直接发布数据流。
每项操作都是通过特定端点实现的。应用程序服务器的这些端点可通过菜单中的集成“HTTP 信息”链接访问。
创建数据文件
- 在管理员工具的集成下,选择数据集成。
- 选择学生信息系统集成。
- 如果您要手动创建文件,请从下拉菜单创建集成中选择快照平面文件。
- 输入集成名称(必填)。您可以选择输入描述。
- 您可以通过输入共享用户名和共享密码来增强安全性。这更常用于发布到端点。
- 在馈送文件分隔符中,选择用于分隔数据文件中各字段的字符。
- 在集成状态中,选择“非活动”、“活动”或“测试”。
- 在日志详细程度中,选择您希望日志的详细程度。
数据支持区域允许您执行逻辑数据分段。例如,如果两个不同的校园有两个不同的学生信息系统,则可以对这两个单独的校园进行分段。或者,如果您想为不同学术学期的数据进行分段。
- 在 Learn 数据源中,可以选择是在入站数据中定义数据源,还是对所有新入站数据使用相同的 Learn 数据源。
- 您可以选择输入批处理 UID 前缀。这用于为此集成所创建的对象添加标识符前缀,以避免 ID 冲突。不建议在为此集成创建数据后修改此选项。
- 在父层次结构节点中选择节点位置。
例如,在高级配置中,您可以使用一系列选项来处理批处理中不存在特定记录的情况。对于此用例,我们将默认选择保持不变。
输入数据后,选择提交。这将为集成创建文件。
为集成上传数据文件:
- 在管理员面板的集成下,选择数据集成。
- 选择学生信息系统集成。
- 选择要上传的文件对应的菜单。选择上传馈送文件。
- 在数据类型菜单中,选择数据类型。集成最常见的选项包括层次结构节点(如果您的文件代表层次结构)、课程关联、组织关联和用户关联。
- 对于操作类型,最常见的选项为存储。
- 在执行完整数据比较时,如果要删除不在文件中的内容,请使用完全刷新。请谨慎使用此选项。
- 使用删除可删除要上传的记录。
- 选择提交。
您可以查看 SIS 日志以确认是否已添加它。对于较大的文件,上传可能需要几分钟时间。选择工具和实用工具下的日志,然后选择 SIS 日志。
快照端点
平面文件的快照操作端点
使用此信息设置 SIS,以便将快照平面文件的馈送文件发布到您的集成。存储的对象将继续存在,并保留其数据。已删除的对象会被移除。“完全刷新”会删除不包含在馈送文件中的所有现有对象。将特定对象类型的文件发布到非匹配端点将会失败。例如:将课程数据文件发布到人员端点将会失败。
禁用课程将会禁用该课程中的成员。这是新行为。
您也可以在 Blackboard Learn 用户界面中查找操作的端点 URL。导航到管理员面板 >“数据集成”>“学生信息系统集成”。找到相应集成,打开其菜单并选择“HTTP 信息”。系统会列出该集成的端点 URL。
操作 | 端点 URL |
---|---|
课程 - 存储 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/course/store |
课程 - 完全刷新 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/course/refresh |
课程 - 按 DSK 完成刷新 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/course/refreshlegacy |
课程 - 删除 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/course/delete |
课程关联 - 存储 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/courseassociation/store |
课程关联 - 完全刷新 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/courseassociation/refresh |
课程关联 - 按 DSK 完成刷新 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/courseassociation/refreshlegacy |
课程关联 - 删除 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/courseassociation/delete |
课程类别 - 存储 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/coursecategory/store |
课程类别 - 完全刷新 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/coursecategory/refresh |
课程类别 - 按 DSK 完成刷新 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/coursecategory/refreshlegacy |
课程类别 - 删除 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/coursecategory/delete |
课程类别成员 - 存储 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/coursecategorymembership/store |
课程类别成员 - 完全刷新 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/coursecategorymembership/refresh |
课程类别成员 - 按 DSK 完成刷新 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/coursecategorymembership/refreshlegacy |
课程类别成员 - 删除 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/coursecategorymembership/delete |
课程成员 - 存储 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/membership/store |
课程成员 - 完全刷新 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/membership/refresh |
课程成员 - 按 DSK 完成刷新 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/membership/refreshlegacy |
课程成员 - 删除 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/membership/delete |
课程标准关联 - 存储 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/standardsassociation/store |
课程标准关联 - 完全刷新 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/standardsassociation/refresh |
课程标准关联 - 按 DSK 完成刷新 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/standardsassociation/refreshlegacy |
课程标准关联 - 删除 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/standardsassociation/delete |
层次结构节点 - 存储 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/node/store |
层次结构节点 - 完全刷新 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/node/refresh |
层次结构节点 - 按 DSK 完成刷新 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/node/refreshlegacy |
层次结构节点 - 删除 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/node/delete |
旁听者关联 - 存储 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/associateobserver/store |
旁听者关联 - 完全刷新 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/associateobserver/refresh |
旁听者关联 - 按 DSK 完成刷新 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/associateobserver/refreshlegacy |
旁听者关联 - 删除 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/associateobserver/delete |
组织 - 存储 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/organization/store |
组织 - 完全刷新 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/organization/refresh |
组织 - 按 DSK 完成刷新 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/organization/refreshlegacy |
组织 - 删除 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/organization/delete |
组织关联 - 存储 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/organizationassociation/store |
组织关联 - 完全刷新 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/organizationassociation/refresh |
组织关联 - 按 DSK 完成刷新 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/organizationassociation/refreshlegacy |
组织关联 - 删除 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/organizationassociation/delete |
组织类别 - 存储 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/organizationcategory/store |
组织类别 - 完全刷新 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/organizationcategory/refresh |
组织类别 - 按 DSK 完成刷新 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/organizationcategory/refreshlegacy |
组织类别 - 删除 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/organizationcategory/delete |
组织类别成员 - 存储 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/organizationcategorymembership/store |
组织类别成员 - 完全刷新 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/organizationcategorymembership/refresh |
组织类别成员 - 按 DSK 完全刷新 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/organizationcategorymembership/refreshlegacy |
组织类别成员 - 删除 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/organizationcategorymembership/delete |
组织成员 - 存储 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/organizationmembership/store |
组织成员 - 完全刷新 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/organizationmembership/refresh |
组织成员 - 按 DSK 完成刷新 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/organizationmembership/refreshlegacy |
组织成员 - 删除 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/organizationmembership/delete |
人员 - 存储 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/person/store |
人员 - 完全刷新 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/person/refresh |
人员 - 按 DSK 完成刷新 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/person/refreshlegacy |
人员 - 删除 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/person/delete |
学期 - 存储 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/term/store |
学期 - 完全刷新 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/term/refresh |
学期 - 按 DSK 完成刷新 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/term/refreshlegacy |
学期 - 删除 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/term/delete |
用户关联 - 存储 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/userassociation/store |
用户关联 - 完全刷新 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/userassociation/refresh |
用户关联 - 按 DSK 完成刷新 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/userassociation/refreshlegacy |
用户关联 - 删除 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/userassociation/delete |
用户次要机构角色 - 存储 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/secondaryinstrole/store |
用户次要机构角色 - 完全刷新 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/secondaryinstrole/refresh |
用户次要机构角色 - 按 DSK 完成刷新 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/secondaryinstrole/refreshlegacy |
用户次要机构角色 - 删除 | https://<servername.domain.edu>/webapps/bb-data-integration-flatfile-BB<DATABASEIDENTIFIER>/endpoint/secondaryinstrole/delete |
如果您熟悉旧版快照,则 SIS 框架平面文件类型除了为支持的新数据对象添加标题外,不会更改格式。要了解详情,请参阅快照平面文件数据格式和快照平面文件示例。
XML 的快照操作端点
使用此信息设置 SIS,以便将 XML 馈送文件发布至该集成。存储的对象将继续存在,并保留其数据。已删除的对象会被移除。“完全刷新”会删除不包含在馈送文件中的所有现有对象。发布包含错误对象类型的对象将会失败。
操作 | 端点 |
---|---|
使用记录状态 | https://<servername.domain.edu>/webapps/bb-data-integration-ss-xml-BB<DATABASEIDENTIFIER>/endpoint |
完全刷新 | https://<servername.domain.edu>/webapps/bb-data-integration-ss-xml-BB<DATABASEIDENTIFIER>/endpoint/refresh |
仅删除 | https://<servername.domain.edu>/webapps/bb-data-integration-ss-xml-BB<DATABASEIDENTIFIER>/endpoint/delete |