如果您熟悉旧版快照(命令行快照工具),则 SIS 框架平面文件类型除了为支持的新数据对象添加标题以及要求包含一些之前的可选字段外,不会更改格式。

适用于旧版快照的这个相同顺序规则同样适用于快照平面文件,简单地说,馈送不会成功,除非符合依赖关系。例如,成员馈送不会成功,直到用户馈送和课程馈送(包含与成员相关的对象)得到处理,或者子课程可能无法绑定到父课程,直到创建了主课程(父)。这种逻辑也适用于学期和节点。

另请注意,在处理发布到端点的数据时的系统行为可通过集成编辑页面进行配置。

有关 URL 及其功能的完整描述,请参阅快照平面文件


切换到 Learn 的 ANGEL 客户端

Learn 与 ANGEL 数据馈送格式之间存在一些差异。这些差异在 ANGEL 到 LEARN 数据映射知识路径中调用。

集成数据中可接受的字符集

核心数据字段中包含的安全字符集包括:

A-Z a-z 0-9 . ' , " : ! ? $ @ [ ] { } - _ *

密码和外部密钥还可以包含:

% & # < > = \ + /


使用最少数据字段的示例

请注意,这些示例是馈送要求的最少数据,每个馈送的其他对象可能从 SIS 框架快照平面文件高级配置自定义标题 UI 中产生。此外,您还可以从字段映射 UI 中获得字段的必需属性。请参阅本文档末尾,了解含有描述的完整列表、每个对象的默认和可接受值示例。用于安装的完整 URL 可在 SIS 框架管理员 UI 的“HTTP 配置”下方查找。要了解详情,请参阅快照平面文件

以下示例使用竖线字符 (|) 作为分隔符。您可以选择在配置实施时使用哪种分隔符。

有关更复杂的数据使用示例,请参阅快照平面文件示例


用户

任务:创建/更新用户(人员)

URL:人员存储或刷新

示例:

external_person_key|user_id|passwd|firstname|lastname|system_role
testPerson1|aanderson_test|changeme|Alpha|Anderson|none
testPerson2|bbrown_test|changeme|Beta|Brown|none
testPerson3|ccharlie_test|changeme|Chi|Charlie|none
testPerson4|ddavis_test|changeme|Delta|Davis|none
testPerson5|eedwards_test|changeme|Epsilon|Edwards|none

虽然电子邮件不是创建用户所需的字段,但是不这么做会限制系统功能,如发送课程通知电子邮件,等等。

任务:删除/禁用用户(人员)

URL:人员删除

示例:

external_person_key
testPerson1

任务:人员次要机构角色馈送

URL:角色存储/刷新/删除

示例:

external_person_key|role_id
testPerson1|ALUMNI
testPerson1|PROSPECTIVE_STUDENT
testPerson2|ALUMNI

任务:人员与旁听者之间的关联馈送

URL:关联存储/刷新/删除

示例:

external_observer_key|external_user_key
testPerson6|testPerson1


课程

任务:创建/更新新课程

URL:课程存储或刷新

示例:

external_course_key|course_id|course_name
testCourse1|TEST_COURSE_1|Test Course 1
testCourse2|TEST_COURSE_2|Test Course 2
testCourse3|TEST_COURSE_3|Test Course 3

任务:确定课程视图

URL:课程存储或刷新

示例:

external_course_key|course_id|course_name|course_experience
testCourse1|TEST_COURSE_1|Test Course 1|Original
testCourse2|TEST_COURSE_2|Test Course 2|Ultra
testCourse3|TEST_COURSE_3|Test Course 3|Instructor choice

支持的值包括:原始、Ultra 或教师选项。这些值仅为插入值,无法通过 SIS 框架更新。

任务:删除/禁用新课程

URL:课程删除

示例:

external_course_key
testCourse1

如果您希望通过主课程内容填充新课程,请向课程馈送文件添加 template_course_key字段。例如,所有的新数学课程最初都应包含主数学课程中的资料。


组织

任务:创建/更新新组织

URL:组织存储或刷新

示例:

external_organization_key|organization_id|organization_name
testOrg1|TEST_ORG_1|Test Org 1
testOrg2|TEST_ORG_2|Test Org 2
testOrg3|TEST_ORG_3|Test Org 3

任务:禁用新组织

URL:组织删除

示例:

external_organization_key
testOrg1


成员

任务:创建/更新课程成员

URL:课程成员存储或刷新

示例:

external_person_key|external_course_key|role
testPerson1|testCourse1|instructor
testPerson1|testCourse2|student
testPerson2|testCourse1|student
testPerson3|testCourse1|student
testPerson4|testCourse2|instructor
testPerson5|testCourse3|student

任务:禁用课程成员

URL:课程成员删除

示例:

external_person_key|external_course_key
testPerson1|testCourse1

任务:创建/更新组织成员

URL:组织成员存储或刷新

示例:

external_person_key|external_organization_key|role
testPerson1|testOrg1|instructor
testPerson1|testOrg2|student
testPerson2|testOrg1|student
testPerson3|testOrg1|student
testPerson4|testOrg2|instructor
testPerson5|testOrg3|student

任务:禁用组织成员

URL:组织成员存储或刷新

示例:

external_person_key|external_organization_key|role
testPerson1|testOrg1|instructor


学期

任务:创建/更新学期

URL:学期存储或刷新

示例:

external_term_key|name
testTerm1|Test Term 1

任务:禁用学期

URL:学期删除 URL

示例:

external_term_key
testTerm1


节点

任务:创建/更新节点

URL:节点存储或刷新

示例:

external_node_key|name
testNode1|Test Node 1
testNode2|Test Node 2

任务:禁用学期

URL:节点删除

示例:

external_node_key
testNode1


节点关联

任务:创建/更新/禁用课程与节点之间的关联

URL:课程关联存储/刷新/删除

示例:

external_association_key|external_course_key|external_node_key
testCourseAssociation1|testCourse1|testNode1
testCourseAssociation2|testCourse2|testNode2

任务:创建/更新/禁用用户与节点之间的关联

URL:用户关联存储/刷新/删除

示例:

external_association_key|external_user_key|external_node_key
testUserAssociation1|testPerson1|testNode1
testUserAssociation2|testPerson2|testNode1
testUserAssociation3|testPerson1|testNode2

任务:创建/更新/禁用组织与节点之间的关联馈送

URL:组织关联存储/刷新/删除

示例:

external_association_key|external_organization_key|external_node_key
testOrgAssociation1|testOrg1|testNode1
testOrgAssociation2|testOrg2|testNode2


类别支持

任务:创建/更新/禁用课程类别馈送

URL:课程类别存储/刷新/删除

示例:

external_category_key|title
testCourseCategory1|Course Category 1
testCourseCategory2|Course Category 2

任务:创建/更新/禁用组织类别馈送

URL:组织类别存储/刷新/删除

示例:

external_category_key|title
testOrgCategory1|Org Category 1
testOrgCategory2|Org Category 2

任务:创建/更新/禁用课程类别成员馈送

URL:课程类别成员存储/刷新/删除

示例:

external_course_key|external_category_key|available_ind
testCourse1|testCourseCategory1|Y
testCourse2|testCourseCategory2|Y
testCourse3|testCourseCategory1|Y

任务:创建/更新/禁用组织类别成员馈送

URL:组织类别成员存储/刷新/删除

示例:

external_organization_key|external_category_key|available_ind
testOrg1|testOrgCategory1|Y
testOrg2|testOrgCategory2|Y
testOrg3|testOrgCategory1|Y


父子支持

需要建立 parent:child 关系时,向课程馈送中添加“master_course_key”字段。

您必须在分配子关系之前,创建父课程。

任务:创建课程之间的父子关系

URL:课程存储/刷新

示例:

external_course_key|course_id|course_name|master_course_key
testCourse1|TEST_COURSE_1|Test Course 1|
testCourse2|TEST_COURSE_2|Test Course 2|testCourse1
testCourse3|TEST_COURSE_3|Test Course 3|testCourse1
testCourse4|TEST_COURSE_4|Test Course 4|
testCourse5|TEST_COURSE_5|Test Course 5|testCourse4

在本示例中,TEST_COURSE_2 和 TEST_COURSE_3 是父课程 TEST_COURSE_1 的子课程,而 TEST_COURSE_4 不是。您还可以从课程馈送(其中所有课程都包含一个相应 master_course_key 条目)中单独运行子课程馈送,将“课程存储”用于此操作以保留之前存储的课程。


课程复制/模板

如果您希望通过“主”课程内容填充新课程,请向填充的课程馈送添加“template_course_key”字段。例如:所有的新数学课程最初都应包含主数学课程中的资料。

示例:

external_course_key|course_id|course_name|master_course_key|template_course_key
testCourse1|TEST_COURSE_1|Test Course 1||test_course_template1
testCourse2|TEST_COURSE_2|Test Course 2|testCourse1|
testCourse3|TEST_COURSE_3|Test Course 3|testCourse1|
testCourse4|TEST_COURSE_4|Test Course 4||test_course_template1

要了解课程复制和课程模板,请参阅通过复制现有课程创建课程


了解详细信息

快照平面文件标题描述