提供的示例演示了学期数据馈送的构成,可满足多种使用案例所需。以下示例使用了为满足使用案例所需的最简单数据馈送。还有更多学期馈送标题可用于创建成员记录 - 分析您机构的信息系统以及注册要求和规划,可帮助确定正确填充 Learn 以满足数据和学期(关联的课程/组织)生命周期目的所需的数据深度。

这些示例基于集成配置 UI 中可见的默认 Learn 设置。更改这些配置元素将导致示例结果发生更改。有关这些设置的说明,请访问 SIS 框架概述。此外,除非另有说明,否则假定集成已配置为对所有传入数据使用相同的数据源。


关于学期对象

学期对象为组织和控制对课程和组织的访问提供了另一种有用的方法。使用学期对象控制课程访问学期指定的设置时,会覆盖那些在课程数据上提供的设置,这意味着,如果您在课程级别指定起始日期或结束日期和持续时间,则这些设置将被关联学期中指定的这些设置所取代。

本主题介绍了如何使用快照平面文件来创建和管理学期对象,并提供了在课程数据馈送中使用学期对象的单个示例。

快照平面文件数据管理

SIS 框架支持通过 UI 馈送上传以及由 Learn 系统提供的一组 URL 来进行快照平面文件数据馈送上传。

通过系统管理员数据集成学生信息系统集成 UI 中的集成菜单,访问 HTTP 信息并上传馈送文件。

在这两种情况下,数据操作的行为是由集成配置和选定操作类型驱动的。选择的数据操作类型将控制如何“解释”馈送中的数据,每个 URL 将提供不同的结果来满足您的集成的预期目标。

这些示例使用了快照框架 UI 上传馈送文件功能。要了解自动化或使用命令行/编程操作,请参阅快照平面文件自动化

操作

可以向 Learn 提供数据,之后可以进行更新、删除或修改,因此,您可以从最简单的数据集开始,在您机构的数据需求发生变化时进行补充。

通过 UI 和 HTTP 可以访问以下操作:

操作说明
存储按集成配置存储更新提供的记录。

使用此操作类型时,馈送文件中包含的数据会在该集成所拥有的所有数据源中存储或更新(按配置设置)。

要详细了解数据“所有权”,请参阅 SIS 框架概述。要详细了解数据源密钥,请参阅数据源密钥概述

刷新存储、更新禁用在馈送和 Learn 中的记录。

此操作会存储或更新在数据馈送中包含的数据,同时禁用未包含在数据馈送(与跨所有数据源的集成相关联)中的数据。

删除禁用提供的记录。

此操作将根据每个集成设置禁用包含在数据馈送中的记录,这些数据馈送与跨所有数据源的集成相关联。

与学期操作关联的对象包括:

学期存储、完全刷新、删除、按数据源进行完全刷新

提供的示例是使用快照框架 UI 上传馈送文件功能进行演示的。要了解自动化或使用命令行/编程操作,请参阅快照平面文件自动化

关于数据源密钥的提醒

所有数据对象都支持更改数据源密钥的功能(以便对该数据集进行分组),并可用于更改关联的数据源 - 注:这不是基于框架的数据馈送中的必填字段,除非特别指出,提供的示例会假定集成已配置为使用单个数据源。请参阅数据源密钥概述

有关字段映射的说明

字段映射使您可以在传入数据存储到 Learn 之前对其进行更改。这样,您就可以完全控制所存储的数据,并且在提供的 SIS 数据不足的情况下,允许您符合 Learn 特定规则(例如:当在数据馈送中未提供密码时,创建用户密码)。

应用于学期对象字段时,关联的脚本将按对象来运行,并且在数据存储在 Learn 之前对其进行更改或提供。有关字段映射的完整说明,请查看快照平面文件自定义字段映射

学期示例

在较高层次上,您可以确定三种 SIS 集成数据馈送模式,这些模式可以应用于所有学期数据操作,而选择的模式取决于您可以提供的数据。

  • 使用单个馈送文件,您可以利用单独的过程来存储和更新记录(存储),以禁用(删除)记录
  • 使用单个馈送文件,您可以存储、更新和禁用(刷新)记录
  • 利用文件组合,您可以用一种文件进行存储,用另一种文件进行禁用。

最后,这不是 SIS 馈送模式,但值得一提的是,您也可以利用 UI 中提供的数据源管理工具,单独基于 DSK 进行禁用和清除。当以此方式管理 SIS 提供的数据时,应格外谨慎。当清除那些过去从未或将来不再通过 SIS 或测试操作的结果提供的数据时,此功能非常有用。

基础要点:学期

所有学期对象都需要一组基本信息来建立。请参阅快照平面文件数据格式快照平面文件标题描述了解此详细信息。

简要数据

在 Learn 中创建成员帐户所需的最小数据集或标题包括:

  • EXTERNAL_TERM_KEY - 此学期记录的唯一标识符。
  • DATA_SOURCE_KEY - 此记录的数据集的唯一标识符。注意:这可以在馈送中提供,也可以通过集成配置提供
  • NAME - 与学期相关联的名称。请注意,由于这是搜索学期记录时要搜索的内容,因此使用一个便于区分学期的命名约定,可能会很有帮助。例如:使用“艺术和科学秋季 2013”而不是“秋季”

每个集成配置的 SIS 框架提供非必填字段的默认值或忽略非必填字段。对于学期馈送,并非必需的三个有用数据点是 DESCRIPTIONAVAILABLE_INDROW_STATUS,这些数据点的操作方式与其他 Learn 对象的操作方式相同。此外,要使用学期对象来控制课程访问,您将使用 START_DATEEND_DATE 数据点。下面的使用案例将对此进行介绍。

快照平面文件标题描述对上述每个标题进行了详细介绍。

添加学期对象

要使用学期对象来控制课程可用性,您必须先创建学期对象。

添加学期信息有两种情况。第一种情况是额外存储成员信息,从而导致添加或更新记录,这会在数据馈送中相应显示。第二种情况是刷新 Learn 中已存在的学期信息,从而导致新增或更新现有记录,这会在数据文件中相应显示,同时会禁用在学期数据文件中不存在的现有 Learn 记录。

存储操作示例

示例 1:创建学期

您希望向 LEARN 添加 2013-2014 学年的学期,而不会影响现有记录。您需要为医学院和艺术科学学院提供不同的学期。

您已将集成配置为对所有传入数据使用相同的数据源。

先决条件

无。

最低数据馈送要求

EXTERNAL_TERM_KEY
NAME

解决方案

创建一个 terms.txt 数据文件,其中包含您希望添加到系统中的每个学期的必填标题和关联数据。例如:

EXTERNAL_TERM_KEY|NAME

AS_FA.2013|Arts and Sciences Fall 2013
AS_WI.2014|Arts and Sciences Winter 2014
AS_SP.2014|Arts and Sciences Spring 2014
AS_SU.2014|Arts and Sciences Summer 2014
MED_T1.2013|School of Medicine Term 1 2013
MED_T2.2014|School of Medicine Term 2 2013
MED_T3.2014|School of Medicine Term 3 2013

使用该 UI,利用存储操作,通过学期数据类型上传包含上述名称的文件。将创建学期记录,您可以通过系统管理员成员工具查找该记录。

后置条件

为两个学校创建的学期对象包括:4 个用于艺术和科学学院,3 个用于医学院。

示例 2:更新学期

您希望添加和更新 2013-2014 学年的学期,而不会影响现有记录。此外,您还需要明确控制学期记录的可用性和已启用状态。艺术和科学学院的每个学期有不同的开始日期和结束日期,因此,您要为学校的每个学期设置起始日期和结束日期,以控制关联课程的可见性。

您已将集成配置为对所有传入数据使用相同的数据源。

先决条件

无。

最低数据馈送要求

EXTERNAL_TERM_KEY
NAME
AVAILABILITY_IND
DURATION
END_DATE
ROW_STATUS
START_DATE

解决方案

创建一个 terms.txt 数据文件,其中包含您希望添加到系统(或在系统中更新)中的每个学期的必填标题和关联数据。

要正确使用 START_DATE 和 END_DATE,还必须指定持续时间(范围),例如:

EXTERNAL_TERM_KEY|NAME|START_DATE|END_DATE|DURATION|AVAILABLE_IND|ROW_STATUS
AS_FA.2013|Arts and Sciences Fall 2013|20130915|20131205|RANGE|Y|ENABLED
AS_WI.2014|Arts and Sciences Winter 2014|20140103|20140418|RANGE|Y|ENABLED
AS_SP.2014|Arts and Sciences Spring 2014|20140420|20140520|RANGE|Y|ENABLED
AS_SU.2014|Arts and Sciences Summer 2014|20140608|20140820|RANGE|Y|ENABLED
MED_T1.2013|School of Medicine Term 1 2013|20130801|20131215|RANGE|Y|ENABLED
MED_T2.2014|School of Medicine Term 2 2014|20140110|20140602|RANGE|Y|ENABLED
MED_T3.2014|School of Medicine Term 3 2014|20140603|20140818|RANGE|Y|ENABLED

后置条件

创建或更新学期对象,明确设置学期记录的可用性以及每个学期的开始和结束时间。与课程关联时,相关联的学期将控制课程的可见性。

刷新操作示例

示例:创建或禁用学期

您希望为 2013-2014 学年添加和更新学期,而不再要求禁用记录。此外,您还需要明确控制学期记录的可用性和已启用状态。艺术和科学学院的每个学期有不同的学期开始日期和结束日期,因此,您要为学校的每个学期设置起始日期和结束日期,以控制关联课程的可见性。

您已将集成配置为对所有传入数据使用相同的数据源。

先决条件

无。

最低数据馈送要求

EXTERNAL_TERM_KEY
NAME
AVAILABILITY_IND
DURATION
END_DATE
ROW_STATUS
START_DATE

解决方案

创建一个 terms.txt 数据文件,其中包含您希望添加到系统(或在系统中更新)中的每个学期的必填标题和关联数据。

要正确使用 START_DATE 和 END_DATE,还必须指定持续时间(范围)。例如:

EXTERNAL_TERM_KEY|NAME|START_DATE|END_DATE|DURATION|AVAILABLE_IND|ROW_STATUS
AS_FA.2013|Arts and Sciences Fall 2013|20130915|20131205|RANGE|Y|ENABLED
AS_WI.2014|Arts and Sciences Winter 2014|20140103|20140418|RANGE|Y|ENABLED
AS_SP.2014|Arts and Sciences Spring 2014|20140420|20140520|RANGE|Y|ENABLED
AS_SU.2014|Arts and Sciences Summer 2014|20140608|20140820|RANGE|Y|ENABLED
MED_T1.2013|School of Medicine Term 1 2013|20130801|20131215|RANGE|Y|ENABLED
MED_T2.2014|School of Medicine Term 2 2014|20140110|20140602|RANGE|Y|ENABLED
MED_T3.2014|School of Medicine Term 3 2014|20140603|20140818|RANGE|Y|ENABLED

后置条件

COMPLETE_REFRESH
将创建或更新包含在数据文件中的学期记录,以明确地设置学期记录的可用性,并提供与这些学期相关联的课程可用范围,即何时可用 (start_date) 以及何时变为不可用 (end_date)。与所有 COMPLETE_REFRESH 操作一样,将禁用未包含在提交的数据集中的所有记录 (data feed:ROW_STATUS=DISABLED, database:ROWSTATUS=0).

COMPLETE_REFRESH_BY_DATA_SOURCE
将创建或更新包含在数据文件中的学期记录,以明确地设置学期记录的可用性,并提供与这些学期相关联的课程可用范围,即何时可用 (start_date) 以及何时变为不可用 (end_date)。与所有 COMPLETE_REFRESH_BY_DATA_SOURCE 操作一样,未包含在提交的数据中、并且具有与集成已配置数据源匹配的数据源密钥的所有记录都将被禁用 (data feed:ROW_STATUS=DISABLED, database:ROWSTATUS=0)。与集成配置的数据源不相关联的学期记录不受影响。

在课程馈送中使用学期

组织和课程共享相同的学期管理模式。提供的示例将重点放在课程学期对象的使用上。

虽然可以使用学期对象控制课程的可用性、持续时间、日期、可用性和行状态,但可以将相同的设置应用到与学期对象相关联的课程小组。学期是课程馈送中的可选数据元素。
应根据所选的用于将数据发送给 Learn 的操作来预期正常操作结果。

示例:管理可用性

在该示例中,您为艺术和科学学院的每个 2014 学期创建了学期对象,现在,医学院希望使用这些学期对象来管理每个学校的某些课程的可用性。

先决条件

您已创建要将课程关联到的学期对象。不存在任何前置条件;将创建课程并将其与提供的学期相关联,或使用学期关联进行更新,如 TERMDURATION 类型所说明。

最低数据馈送要求

EXTERNAL_COURSE_KEY
COURSE_ID
COURSE_NAME
DURATION
TERM_KEY

解决方案

创建一个 termmanagedcourses.txt 数据文件,其中包含您希望添加到系统(或在系统中更新)的每个课程的必填标题和关联数据。

要正确利用 START_DATEEND_DATE,还必须指定 DURATION (RANGE)。例如:

EXTERNAL_COURSE_KEY|COURSE_ID|COURSE_NAME|DURATION|TERM_KEY
AHIST.101-01.03.FA2013|AHIST.101-01.03.FA2013|Art History 101|TERM|AS_FA.2013
AHIST.101-01.03.WI2013|AHIST.101-01.03.WI2013|Art History 101|TERM|AS_WI.2014
AHIST.101-01.03.SP2013|AHIST.101-01.03.SP2013|Art History 101|TERM|AS_SP.2014
AHIST.101-01.03.SU2013|AHIST.101-01.03.SU2013|Art History 101|TERM|AS_SU.2014
ANAT.100-01.T1|ANAT.100-01.T1|Basic Anatomy|TERM|MED_T1.2013
ANAT.100-01.T2|ANAT.200-01.T2|Intermediate Anatomy|TERM|MED_T2.2014
ANAT.100-01.T3|ANAT.300-01.T3|Advanced Anatomy|TERM|MED_T3.2014

后置条件

将创建或更新数据馈送中的课程,这些课程将对用户可见,如同与每个课程相关联的学期的参数要求。对其他系统数据的影响取决于用于将数据加载到 Learn 的操作:

存储
当使用存储时,其他数据不受影响 - 只会添加或更新数据馈送中包含的数据。

完全刷新
当使用完全刷新时,会添加或更新文件中包含的数据,因此由此数据源管理的不在数据文件中(无论数据源是哪个)的所有其他数据都将被禁用。

按数据源进行完全刷新
当使用按数据源进行完全刷新时,会添加或更新文件中包含的数据源数据 - 此数据源管理的所有其他数据以及与此集成的已配置数据源关联的所有其他数据都将被禁用。不包含在馈送文件中且与集成数据源不关联的数据不受影响。


了解详细信息

SIS 框架概述

快照平面文件标题描述

快照平面文件数据格式

快照平面文件自动化