通过快照平面文件,可以采用最新 LEARN 数据对象进行集成。下方完整列出了支持的对象、其 UI、馈送标题命名约定及、使用描述及数据要求。

因为数据馈送是一个文本文件,因此,所有数据都采用字符串表示。在某些情况下,需要注意特定格式设置和长度。如果字段要求,需提供支持的值。我们会 突出显示并注明必填字段。

LEARN 对象:

用户

课程/组织

课程/组织成员

学期

次要机构角色关联

旁听者关联

类别

类别成员

层次结构节点

层次结构用户关联

层次结构课程关联

目的关联

LEARN 对象:用户

SIS 对象:人员

默认插入/更新行为:智能插入或更新

默认删除行为:禁用

Learn 字段

批处理 Uid(必填)
必填:是    
唯一:是    
标题:external_person_key    
描述:
对于机构用户的一个独特标识符。这个 ID 由机构提供并且不向用户显示。
 
强烈建议对每个用户来说,密钥数据是永久、不更改的标识符。良好密钥的示例是在用户申请机构时所分配的永久学生 ID。请注意,数据库无法合并不同帐户之间的数据。
 
最大长度 64。
 
数据源密钥(必填) 通过集成或数据文件提供。
必填:是    
唯一:否    
标题:data_source_key    
描述:
用于确定用户元素分组的密钥。请注意,此密钥可通过集成配置提供,因此,无需在文件中提供。
 
最大长度:256。 接受多字节字符。
 
名字(必填)
必填:是    
唯一:否    
标题:名字    
描述:
用户的给定名字。


 
最大长度 100。接受多字节字符。
 
姓氏(必填)
必填:是    
唯一:否    
标题:姓氏    
描述:
用户的姓氏。
 
最大长度 100。接受多字节字符。
 
用户名(必填)
必填:是    
唯一:是  
标题:   user_id
描述:
用于登录 Blackboard Learn 的用户名。用户名必须是唯一的。
 
最大长度 50。接受多字节字符。
 
姓名发音
必填:否    
唯一:否    
头:TBC
描述:
用户名的发音拼写或发音指南。
 
最大长度:1000。接受多字节字符。
 
密码
必填:否   
唯一:否    
标题:密码    
描述:
用于登录 Blackboard Learn 的密码。如果数据馈送中未提供密码,则为了安全起见,Learn 会使用 SHA-512 密码自动填充此字段。
 
最大长度 32。接受多字节字符。
可用
必填:否    
唯一:否    
标题:available_ind    
描述:
用户界面内的用户帐户可用性。如果设置为否,则用户帐户将对管理员和教师显示为灰色。用户将无法登录系统。值可以是“Y”(表示是),也可以是“N”(表示否)。
 
支持的值:“Y”、“N”。
 
出生日期
必填:否    
唯一:否    
标题:出生日    
描述:
用户的出生日期。
 
格式:yyyymmdd。
 
城市
必填:否    
唯一:否    
标题:城市    
描述:
与用户地址相对应的城市名称。
 
最大长度 50。接受多字节字符。
 
公司
必填:否   
唯一:否    
标题:公司    
描述:
用户工作的公司名称。
 
最大长度 100。接受多字节字符。
 
国家/地区
必填:否    
唯一:否    
标题:国家/地区    
描述:
与用户地址相对应的国家/地区名称。
 
最大长度 50。接受多字节字符。
 
部门
必填:否    
唯一:否    
标题:部门    
描述:
用户工作的院系或部门名称。
 
最大长度 100。接受多字节字符。
 
教育程度
必填:否    
唯一:否    
标题:educ_level    
描述:
用户的最高教育程度。
 
支持的值:“K-8”、“中学”、“大一”、“大二”、“大三”、“大四”、“研究生”、“研究生毕业”
 
电子邮件
必填:否    
唯一:否    
标题:电子邮件
描述:用户的电子邮件地址。Blackboard 建议不要将 user_email 留空。无电子邮件地址的用户无法发送电子邮件。
 
最大长度 100
 
机构电子邮件
必填:否    
唯一:是    
标题: inst_email
描述: 用户的机构电子邮件地址。inst_email 可以设置为空 。不会向 inst_email 发送电子邮件通信。
 
最大长度 254
 
代词
必填:    否
唯一:    否
标题:   代词
描述:这是用户的代词。使用逗号作为分隔符,接受多个代词值。
 
最大长度 1000
 
性别
必填:否    
唯一:否    
标题:性别    
描述:
用户的性别。
 
支持的值:“保密”、“男性”、“女性”
 
住宅电话
必填:否    
唯一:否    
标题:h_phone_1    
描述:
用户的住宅电话号码。
 
最大长度 50。接受多字节字符。
 
住宅电话 (次要)
必填:否    
唯一:没有 h_phone_2    
描述:
与用户关联的其他住宅电话号码。
 
最大长度 50。接受多字节字符。
 
职位
必填:否    
唯一:否    
标题:job_title    
描述:
用户的关联职位。
 
最大长度 100。接受多字节字符。
 
中间名
必填:否   
唯一:无中间名    
描述:
用户的给定中间名。
 
最大长度 100。接受多字节字符。
 
手机
必填:否    
唯一:否    
标题:m_phone    
描述:
用户的移动电话或呼机号码。
 
最大长度 50。接受多字节字符。
 
曾用名
必填:否    
唯一:否    
标题:其他名字    
描述:
这是用户的备用首选名字。
 
最大长度:100。
 
密码加密类型
必填:否    
唯一:否    
标题:pwencryptiontype    
描述:
该字段设置用于加密数据库中密码的密码加密类型。
 
支持的值包括:MD5、SSHA
 
主要机构角色
必填:否    
唯一:否    
标题:institution_role    
描述:
用户的主要机构角色,其用于确定门户模块和其他项目的用户视图。
 
请参阅系统管理员面板中的“管理机构角色”,了解有效系统机构角色列表。
 
要求
代词:    无
唯一:    无
标题:   代词
描述:
这是用户的代词。
 
最大长度 1000。
 
替换批处理 Uid
必填:否    
唯一:是    
标题:new_external_person_key    
描述:
此字段仅在用户 EXTERNAL_PERSON_KEY 发生更改的极少数情况下使用。
 
最大长度 64。接受多字节字符。
 
替换数据源批处理 Uid
必填:否    
唯一:否    
标题:new_data_source_key    
描述:
用于确定用户元素分组的新密钥。使用指定替换数据源密钥指定的小组替换用于关联数据的现有数据源。注意:“替换数据源批处理 Uid”的 UI 映射字段为“script.flatfile.UserReplacementDataSourceBatchUid”
 
行状态
必填:否    
唯一:否    
标题:row_status    
描述:
将该记录的值设置为以下值之一:已启用:可以正常访问记录。已禁用:记录在 UI 的某些区域中可见,但不能进行更改或访问。已删除:记录已被计划删除。
 
支持的值:“已启用”、“已禁用”、“已删除”
 
最大长度 64。接受多字节字符。
 
省份
必填:否    
唯一:否    
标题:状态    
描述:
与用户地址相对应的州/省/自治区/直辖市名称。
 
最大长度 50。接受多字节字符。
 
街道 1
必填:否    
唯一:否    
标题:street_1    
描述:
用户地址的第一行。
 
最大长度 100。接受多字节字符。
 
街道 2
必填:否    
唯一:否    
标题:street_2    
描述:
用户地址的第二行。
 
最大长度 100。接受多字节字符。
 
学生 ID
必填:否    
唯一:否    
标题:student_id    
描述:
通用标识符字段。这是一个仅显示字段。
 
最大长度 100。接受多字节字符。
 
后缀
必填:否    
唯一:否    
标题:后缀 用户名后缀。    
 
最大长度 100。接受多字节字符。
 
系统角色
必填:否    
唯一:否    
标题:system_role    
描述:
用户的管理角色,用于描述用户的系统管理权限级别。角色“无”不提供任何与自身关联的系统管理或课程创建权限,是最经常分配的角色。系统接受以下字符串:用户管理员:“account_admin”、“accountadmin”或“user_admin”系统支持:“system_support”或“syssupport”课程创建者:“course_creator”或“creator”支持:“course_support”或“support”访客:"guest"
None: “none”旁听者:"observer"
Portal Administrator: “portal_admin”或“portal”系统管理员:“sys_admin”、“sysadmin”或“system_admin”电子商务管理员:“ecommerce_admin”卡部管理员:“card_office_admin”商店管理员:“store_admin”可以使用用户定义的系统角色。仅匹配在“管理员面板”>“系统角色”中找到的“角色 ID” 如果未提供一个角色 ID,则系统会默认将其设置为无。标题 无 无标题 用户倾向使用的标题。
 
最大长度 100。接受多字节字符。
 
网站
必填:否    
唯一:否    
标题:网页    
描述:
用户个人网页(如有)的 URL。
 
最大长度 100
 
办公电话
必填:否    
唯一:否    
标题:b_Phone _1    
描述:
与用户关联的办公电话号码。
 
最大长度 50。接受多字节字符。
 
工作电话 (次要)
必填:否    
唯一:否    
标题:b_phone_2    
描述:
与用户关联的其他办公电话号码。
 
最大长度 50。接受多字节字符。
 
邮政编码
必填:否    
唯一:否    
标题:zip_code    
描述:
用户的邮政编码。
 
最大长度 50。接受多字节字符。
 

顶端

LEARN 对象:课程和组织

SIS 对象:课程或组织

默认插入/更新行为:智能插入或更新

默认删除行为:禁用

Learn 字段

批处理 Uid(必填)
必填:是    
唯一:是    
标题:external_course_key.external_organization_key    
描述:
机构用来唯一标识“课程或组织”区域的简短名称。它不向用户显示。只能包含字母、数字、破折号和句点。不得使用空格或其他标点符号。必须对每个“课程和组织”是唯一的,通常与 COURSE_ID 或 ORGANIZATION_ID 相同。
 
最大长度 64。必须是唯一的。接受多字节字符。
 
课程 ID 或组织 ID(必填)
必填:是    
唯一:是    
标题:course_id or organization_id    
描述:
机构用来唯一标识“课程或组织”的简短名称(例如,math101_F99 或 ChessClub) 不得使用以下字符:空格 ( ) & / ' +
 
最大长度 100。必须是唯一的,不能发生更改。
 
课程名称或组织名称(必填)
必填:是    
唯一:否    
标题:course_name/organization_name    
描述:
课程或组织的完整标题。此名称用于显示目的。
 
最大长度 255。接受多字节字符。
 
数据源密钥(必填) 通过集成或数据文件提供。
必填:是    
唯一:否    
标题:data_source_key    
描述:
用于确定课程或组织元素分组的密钥。请注意,此密钥可通过集成配置提供,因此,无需在文件中提供。
 
最大长度:256。接受多字节字符。
 
课程视图
必填:否    
唯一:否    
标题:course_experience  
描述:
确定将为新课程显示哪个课程视图。此字段仅为插入,无法通过 SIS框架更新。 
 
支持的值:原始、Ultra 或教师选项。
 
classificationId
必填:否    
唯一:否    
标题:classification_key    
描述:
此字段用于确定课程的分类(主题区和学科)。这是一个 ID,用于表示分类的主密钥。
 
最大长度 450
 
hasDescriptionPage
必填:否    
唯一:否    
标题:desc_page_ind    
描述:
此字段当前不受支持。集成不得使用此字段。
 
numDaysOfUse
必填:否    
唯一:否    
标题:days_of_use    
描述:
学生在注册后可以访问课程的天数。用于自定进度的学习。仅在持续时间设置为“固定”且其描述课程在创建后可以使用的天数时,才能使用此值。
 
数字。例如:120
 
serviceLevelType
必填:否    
唯一:否    
标题:service_level    
描述:
在数据馈送中不常用。忽略。
指定课程类型。
C = 社区 = 组织
F = 完整 = 课程
R = 已注册 =(不使用)
T = Test_Drive =(不使用)
S = 系统 = 功能受限的课程,用于保护组成课程的数据。
 
支持的值:“F”、“C”、“R”、“T”、“S”
 
允许访客
必填:否    
唯一:否    
标题:allow_guest_ind    
描述:
允许访客访问课程。
 
支持的值:“Y”、“N”
 
允许旁听者
必填:否    
唯一:否    
标题:allow_observer_ind    
描述:
允许旁听者访问课程。
 
支持的值:“Y”、“N”
 
可用
必填:否    
唯一:否    
标题:available_ind    
描述:
确定课程或组织对 Blackboard 的可用性。如果 use_term_avail_ind 是“Y”,则此标记可以忽略,此课程的可用性由其关联的学期 available_ind 确定。
 
支持的值:“Y”、“N”
 
交叉列出的课程批处理 Uid
必填:否    
唯一:否    
标题:master_course_key    
描述:
这个子课程所属的父课程 EXTERNAL_COURSE_KEY。
 
最大长度:64
 
说明
必填:否    
唯一:否    
标题:描述    
描述:
课程的完整描述。
 
最大长度 4000。接受多字节字符。
 
持续时间
必填:否    
唯一:否    
标题:持续时间    
描述:
这用于表示课程可用性的持续时间是连续、日期范围、注册之日起的 x 天还是学期规定的时间。
 
选项包括:
连续:“C”= 课程始终可供访问。
范围:“R”= 课程在一个 START_DATE 与 END_DATE 之间的天数内可访问。要使课程从特定日期开始(或在特定日期之前)可供访问,可以将结束日期(或开始日期)留为空白。
持续时间:“D”= 从注册日起的 N 天
学期:“T”= 学期规定的时间(关联学期的持续时间用于控制此课程的持续时间)
 
支持的值:  “C”、“R”、“D”、“T”
 
教学进度
必填:否    
唯一:否    
标题:进度    
描述:
指定课程是由教师指导还是由学生自定进度。
 
支持的值:  “自定”、“教师”
 
结束日期
必填:否    
唯一:否    
标题:end_date    
描述:
课程访问的结束日期。
 
格式:yyyymmdd
 
强制执行语言包
必填:否    
唯一:否    
标题:locale_enforced    
描述:
一种标记,用于确定是否在用户访问课程时强制执行语言包。如果不强制执行语言包,则用户可能会使用自己喜爱的语言包查看课程。
 
支持的值:“Y”、“N”
 
注册访问代码
必填:否    
唯一:否    
标题:enroll_access_code    
描述:
这是学生在注册课程时使用的访问代码。
 
最大长度 50。
 
注册结束日期
必填:否    
唯一:否    
标题:enroll_end    
描述:
注册不再对学生可用的日期。
 
格式:yyyymmdd
 
注册起始日期
必填:否    
唯一:否    
标题:enroll_start    
描述:
注册可以开始的日期。
 
格式:yyyymmdd
 
注册类型
必填:否    
唯一:否    
标题:enroll_option    
描述:
确定注册方法。
 
支持的值:“教师”、“自行”或“电子邮件”。
 
费用
必填:否    
唯一:否    
标题:费用    
描述:
与此课程或组织关联的费用。
 
数字 。11 个字符,2 个小数位。例如,1500.00
 
机构名称
必填:否    
唯一:否    
标题:institution_name    
描述:
机构的名称。
 
最大长度 255。接受多字节字符。
 
语言包
必填:否    
唯一:否    
标题:语言环境    
描述:
偏好语言包的标识符。该值可表示为 xx_XX,例如,法语语言包可用 fr_FR 表示
 
最大长度 20。
 
已锁定
必填:否    
唯一:否    
标题:lockout_ind    
描述:
指定对课程或组织的访问是否受到限制。如果设置为“Y”,将根据 END_DATE 和 START_DATE 限制对课程或组织的访问。
 
支持的值:“Y”、“N”
 
最大磁盘使用量 (软性限制)
必填:否    
唯一:否    
标题:soft_limit    
描述:
课程限额的软性限制。当课程文件夹存储达到指定的 soft_limit 且课程限额有效时,此设置会触发警告电子邮件。
 
数字。例如:10 MB 是 10485760 字节。
 
主要关联批处理 Uid
必填:否    
唯一:是    
标题:external_association_key  
描述:
应主要关联课程的节点的外部密钥。课程使用该节点的工具设置默认值来创建自己的设置。此字段与“课程关联”馈送中的“external_association_key”相同;除非此关联是“主要”关联...也就是说,它将会在课程创建过程中复制其工具设置默认值。
创建要与机构层次结构节点相关联的课程所需的相应最小标题为:
external_course_key
course_id
course_name
external_association_key
primary_external_node_key
 
主要节点批处理 Uid
必填:否    
唯一:否    
标题:primary_external_node_key    
描述:
此字段与“课程关联”馈送中的“external_node_key”相同;除非这是主要关联。
创建要与机构层次结构节点相关联的课程所需的相应最小标题为:
external_course_key
course_id
course_name
external_association_key
primary_external_node_key
 
最大长度:256
 
替换批处理 Uid
必填:否    
唯一:是    
标题:new_external_course_key    
描述:
此字段仅在课程或组织外部密钥发生更改的极少数情况下使用。
 
最大长度 64。必须是唯一的。接受多字节字符。
 
替换数据源批处理 Uid
必填:否    
唯一:否    
标题:new_data_source_key    
描述:
用于确定用户元素分组的新密钥。使用指定替换数据源密钥指定的小组替换用于关联数据的现有数据源。注意:“替换数据源批处理 Uid”的 UI 映射字段为“script.flatfile.CourseReplacementDataSourceBatchUid”
 
行状态
必填:否    
唯一:否    
标题:row_status    
描述:
将该记录的值设置为以下值之一:已启用:可以正常访问记录。已禁用:记录在 UI 的某些区域中可见,但不能进行更改或访问。已删除:记录已被计划删除。
 
支持的值:“已启用”、“已禁用”、“已删除”
 
在目录中显示
必填:否    
唯一:否    
标题:catalog_ind    
描述:
确定课程或组织是否显示在目录中。
 
支持的值:“Y”、“N”
 
源课程复制密钥 源组织复制密钥
必填:否    
唯一:否    
标题:template_course_key.template_organization_key    
描述:
用于复制操作的内容源外部密钥。
 
最大长度 64。接受多字节字符。
 
起始日期
必填:否    
唯一:否    
标题:start_date    
描述:
课程部分访问的开始日期。
 
格式:yyyymmdd
 
学期
必填:否    
唯一:否    
标题:term_key    
描述:
关联的 EXTERNAL_TERM_KEY
 
最大长度 256。
 
使用学期可用性
必填:否    
唯一:否    
标题:use_term_availability_ind    
描述:
标记可用于衡量关联学期是否为课程的可用性。如果设为 Y,则使用 available_ind、startdate 和 enddate 对应的学期;如果设为 N,则使用课程设置。
 
支持的值:“Y”、“N”
 

顶端

LEARN 对象:课程和组织成员

注意:课程和组织需要相同的字段。标题将特定于是否在创建课程或组织,注意构建数据馈送时的区别。

SIS 对象:课程或组织成员(注册和职员指定)

默认插入/更新行为:智能插入或更新 

默认删除行为:禁用 

Learn 字段

课程批处理 Uid 或组织批处理 Uid(必填)
必填:是    
唯一:否    
标题:external_course_key 或 external_organization_key    
描述:
这是用于标识课程或组织的相同密钥。
 
最大长度 64。接受多字节字符。
 
数据源密钥(必填) 通过集成或数据文件提供。
必填:是    
唯一:否    
标题:data_source_key    
描述:
用于确定用户元素分组的密钥。请注意,此密钥可通过集成配置提供,因此,无需在文件中提供。
 
最大长度 256。接受多字节字符。
 
用户批处理 Uid(必填)
必填:是    
唯一:否    
标题:external_person_key    
描述:
这是用于标识用户的 external_person_key。
 
最大长度:64。接受多字节字符。
 
hasCartridgeAccess
必填:否    
唯一:否    
标题:hascartridgeaccess    
描述:
此字段不受支持,将被删除。忽略。新集成不得使用此字段,如果现有集成采用此字段,则应立即停止采用。
 
可用
必填:否    
唯一:否    
标题:available_ind    
描述:
确定 Blackboard Learn 内的注册可用性。
 
支持的值:“Y”、“N”
 
图像 URL
必填:否    
唯一:否    
标题:Image_URL    
描述:
此字段不受支持,将被删除。忽略。新集成不得使用此字段,如果现有集成采用此字段,则应立即停止采用。
 
包括在名单中
必填:否    
唯一:否    
标题:roster_ind    
描述:
一种标记,用于表示是否将用户显示在花名册中。
 

支持的值:“Y”、“N”

引言
必填:否    
唯一:否    
标题:简介    
描述:
课程内用户主页的简介信息。
 
最大长度 4000。接受多字节字符。
 
注释
必填:否    
唯一:否    
标题:注释    
描述:
与此用户相关的信息,其可能会影响课程或组织参与。
 
不限制。接受多字节字符。
 
个人信息
必填:否    
唯一:否    
标题:pinfo    
描述:
用户主页的个人信息。
 
不限制。接受多字节字符。
 
接收电子邮件
必填:否   
唯一:否    
标题:receive_email_ind    
描述:
标记是否为此用户启用电子邮件。
 
支持的值:“Y”、“N”
 
替换数据源批处理 Uid
必填:否    
唯一:否    
标题:new_data_source_key    
描述:
用于确定数据元素分组的新密钥。使用指定替换数据源密钥指定的小组替换用于关联数据的现有数据源。注意:“替换数据源批处理 Uid”的 UI 映射字段为“script.flatfile.MemberReplacementDataSourceBatchUid”
 
角色
必填:否    
唯一:否    
标题:角色    
描述:
用户在课程中的角色。
 
支持的值:“教师”、“teaching_assistant”、“course_builder”、“评分者”、“学生”、“访客”、“无”
 
行状态
必填:否    
唯一:否    
标题:row_status    
描述:
将该记录的值设置为以下值之一:已启用:可以正常访问记录。已禁用:记录在 UI 的某些区域中可见,但不能进行更改或访问。已删除:记录已被计划删除。
 
支持的值:“已启用”、“已禁用”、“已删除”
 
对网站 1 的描述
必填:否    
唯一:否    
标题:link_description_1    
描述:
用户网站的描述
 
最大长度 255
 
网站 1 名称
必填:否    
唯一:否    
标题: link_name_1    
描述:
在指向用户网站的链接中使用的名称
 
最大长度 100
 
网站 1 URL
必填:否    
唯一:否    
标题:link_url_1    
描述:
在指向用户网站的链接中使用的 URL
 
最大长度 100
 
对网站 2 的描述
必填:否    
唯一:否    
标题:link_description_2    
描述:
用户网站的描述
 
最大长度 255
 
网站 2 名称
必填:否    
唯一:否    
标题:link_name_2    
描述:
在指向用户网站的链接中使用的名称
 
最大长度 100
 
网站 2 URL
必填:否    
唯一:否    
标题:link_url_2    
描述:
在指向用户网站的链接中使用的 URL
 
最大长度 100
 
对网站 3 的描述
必填:否    
唯一:否    
标题:link_description_3    
描述:
用户网站的描述
 
最大长度 255
 
网站 3 名称
必填:否    
唯一:否    
标题:link_name_3    
描述:
在指向用户网站的链接中使用的名称
 
最大长度 100
 
网站 3 URL
必填:否    
唯一:否    
标题:link_url_3    
描述:
在指向用户网站的链接中使用的 URL
 
最大长度 100
 

 

 


顶端

LEARN 对象:学期

SIS 对象:学期

默认插入/更新行为:智能插入或更新

默认删除行为:禁用

Learn 字段

批处理 Uid(必填)
必填:是    
唯一:是    
标题:external_term_key    
描述:
机构用来唯一标识学期的简短名称。它不向用户显示。只能包含字母、数字、破折号和句点。不得使用空格或其他标点符号。
 
最大长度 256。接受多字节字符。
 
数据源密钥(必填) 通过集成或数据文件提供。
必填:是    
唯一:否    
标题:data_source_key    
描述:
用于确定学期元素分组的密钥。请注意,此密钥可通过集成配置提供,因此,无需在文件中提供。
 
最大长度 256。接受多字节字符。
 
名称(必填)
必填:是    
唯一:否    
标题:名字    
描述:
学期名称。
 
最大长度 333
 
daysOfUse
必填:否    
唯一:否    
标题:days_of_use    
描述:
学生在注册后可以访问课程的天数。用于自定进度的学习。
 
数字。
 
可用
必填:否    
唯一:否    
标题:available_ind    
描述:
表示学期可用性。如果设置为“N”,则关联的对象将不可用。
 
支持的值:“Y”、“N”
 
说明
必填:否    
唯一:否    
标题:描述    
描述:
学期的描述
 
不限制。
 
持续时间
必填:否    
唯一:否    
标题:持续时间    
描述:
安排学期可用性窗口。
 
选项包括:
连续:学期始终可供访问。
范围:学期在一个 START_DATE 与 END_DATE 之间的天数内有效。要使学期从特定日期开始(或在特定日期之前)有效,可以将结束日期(或开始日期)留为空白。
固定:学期在一定天数内有效 (DAYS_OF_USE)。 
 
支持的值:连续、范围、固定
 
结束日期
必填:否    
唯一:否    
标题:end_date    
描述:
这是学期停止供用户访问的日期。
 
格式:yyyymmdd
 
替换批处理 Uid
必填:否    
唯一:是    
标题:new_external_term_key    
描述:
此字段仅在学期 EXTERNAL KEY 发生更改的极少数情况下使用。
 
最大长度 256。接受多字节字符。
 
替换数据源批处理 Uid
必填:否    
唯一:否    
标题:new_data_source_key    
描述:
用于确定数据元素分组的新密钥。使用指定替换数据源密钥指定的小组替换用于关联数据的现有数据源。注意:“替换数据源批处理 Uid”的 UI 映射字段为“script.flatfile.TermReplacementDataSourceBatchUid”
 
行状态
必填:否    
唯一:否    
标题:row_status    
描述:
将该记录的值设置为以下值之一:
已启用:可以正常访问记录。
已禁用:记录在 UI 的某些区域中可见,但不能进行更改或访问。
已删除:记录已被计划删除。
 
支持的值:“已启用”、“已禁用”、“已删除”
 
起始日期
必填:否    
唯一:否    
标题:start_date    
描述:
这是学期开始供用户访问的日期。
 
格式:yyyymmdd
 

顶端

LEARN 对象:次要机构角色关联

SIS 对象:用户次要机构角色

默认插入/更新行为:智能插入或更新

默认删除行为:禁用

Learn 字段

数据源密钥(必填) 通过集成或数据文件提供。
必填:是    
唯一:否    
标题:data_source_key    
描述:
用于确定用户元素分组的密钥。请注意,此密钥可通过集成配置提供,因此,无需在文件中提供。
 
最大长度 256。接受多字节字符。
 
次要机构角色 ID(必填)
必填:是    
唯一:否    
标题: role_id    
描述:
此关联的次要机构角色标识符。
 
用户批处理 Uid(必填)
必填:是    
唯一:否    
标题:external_person_key    
描述:
用于此关联的用户 external_person_key (batch_uid)。
 
最大长度 64。
 
替换数据源批处理 Uid
必填:否    
唯一:否    
标题:new_data_source_key    
描述:
用于确定数据元素分组的新密钥。使用指定替换数据源密钥指定的小组替换用于关联数据的现有数据源。注意:“替换数据源批处理 Uid”的 UI 映射字段为“script.flatfile.SecondaryInstRoleReplacementDataSourceBatchUid”
 
行状态
必填:否    
唯一:否    
标题:row_status    
描述:
将该记录的值设置为以下值之一:已启用:可以正常访问记录。已禁用:记录在 UI 的某些区域中可见,但不能进行更改或访问。已删除:记录计划在未来由管理员手动删除。该行不会通过任务自动删除。
 
支持的值:“已启用”、“已禁用”、“已删除”
 

顶端

LEARN 对象:旁听者关联

SIS 对象:旁听者关联

默认插入/更新行为:智能插入或更新

默认删除行为:禁用

Learn 字段

数据源密钥(必填) 通过集成或数据文件提供。
必填:是    
唯一:否    
标题:data_source_key    
描述:
用于确定用户元素分组的密钥。请注意,此密钥可通过集成配置提供,因此,无需在文件中提供。
 
最大长度:256。接受多字节字符。
 
所旁听的学生(必填)
必填:是    
唯一:否    
标题:external_user_key    
描述:
用于此关联的用户 external_person_key (batch_uid)。在机构中具有“学生”这个机构角色的用户唯一标识符。这个 ID 由机构提供并且不向用户显示。
 
最大长度 64。接受多字节字符。
 
旁听者(必填)
必填:是    
唯一:否    
标题:external_observer_key    
描述:
用于此关联的旁听者 external_person_key (batch_uid)。在机构中具有“旁听者”这个系统角色的用户唯一标识符。
 
最大长度 64。接受多字节字符。
 
替换数据源批处理 Uid
必填:否    
唯一:否    
标题:new_data_source_key    
描述:
用于确定数据元素分组的新密钥。使用指定替换数据源密钥指定的小组替换用于关联数据的现有数据源。注意:“替换数据源批处理 Uid”的 UI 映射字段为“script.flatfile.AssociateObserverReplacementDataSourceBatchUid”
 
行状态
必填:否    
唯一:否    
标题:row_status    
描述:
将该记录的值设置为以下值之一:已启用:可以正常访问记录。已禁用:记录在 UI 的某些区域中可见,但不能进行更改或访问。已删除:记录已被计划删除。
 
支持的值:“已启用”、“已禁用”、“已删除”
 

顶端

LEARN 对象:类别

SIS 对象:课程类别

默认插入/更新行为:智能插入或更新

默认删除行为:禁用

Learn 字段

dataSourceBatchUid(必填)
必填:是    
唯一:否    
标题:data_source_key    
描述:
用于确定类别元素分组的密钥。
 
接受多字节字符。
 
标题(必填)
必填:是    
唯一:否    
标题:职务    
描述:
类别名称,将在 UI 内显示给用户。
最大长度 255。接受多字节字符。
 
批处理 Uid(必填)
必填:是    
唯一:是    
标题:external_category_key    
描述:
必须是唯一的。请注意,此字段与 UI 中的“类别助记”字段相对应。
最大长度 64。接受多字节字符。
 
description
必填:否    
唯一:否    
标题:描述    
描述:
类别描述。
 
frontPageInd
必填:否    
唯一:否    
标题:frontpage_ind    
描述:
确定类别是否显示在目录的首页上。
 
支持的值:“Y”、“N”
 
isAvailable
必填:否    
唯一:否    
标题:available_ind    
描述:
确定 Blackboard Learn 内的类别可用性。
 
支持的值:“Y”、“N”
 
isRestricted
必填:否    
唯一:否    
标题:restrict_ind    
描述:
标记课程或组织是否仅限于成员。
 
支持的值:“Y”、“N”
 
parentBatchUid
必填:否    
唯一:否    
标题:parent_category_key    
描述:
EXTERNAL_CATEGORY_KEY 表示这个子类别所属的父类别。
 
最大长度 64。
 
rowStatus
必填:否    
唯一:否    
标题:row_status    
描述:
将该记录的值设置为以下值之一:已启用:可以正常访问记录。已禁用:记录在 UI 的某些区域中可见,但不能进行更改或访问。已删除:记录已被计划删除。字符串。
 
支持的值:“已启用”、“已禁用”、“已删除”
 
替换批处理 Uid
必填:否    
唯一:是    
标题:new_external_category_key    
描述:
指定当前密钥的替换。
 
最大长度 64。接受多字节字符。
 
替换数据源批处理 Uid
必填:否    
唯一:否    
标题:new_data_source_key    
描述:
用于确定数据元素分组的新密钥。使用指定替换数据源密钥指定的小组替换用于关联数据的现有数据源。注意:“替换数据源批处理 Uid”的 UI 映射字段为“script.flatfile.CourseCatReplacementDataSourceBatchUid”
 
 

顶端

LEARN 对象:类别成员

SIS 对象: 类别成员

默认插入/更新行为:智能插入或更新

默认删除行为:禁用

Learn 字段

批处理 Uid(必填)
必填:是    
唯一:是    
描述:
自动填充。不在数据馈送中使用。
 
类别批处理 Uid(必填)
必填:是    
唯一:否    
标题:external_category_key    
描述:
用于添加课程/组织的类别的外部密钥 (batch_uid)。
 
最大长度 64。
 
课程批处理 Uid 或组织批处理 Uid(必填)
必填:是    
唯一:否    
标题:external_course_key    
描述:
external_organization_key 进行分类的课程或组织的外部密钥 (batch_uid)。
 
最大长度 64。
 
数据源密钥(必填) 通过集成或数据文件提供。
必填:是    
唯一:否    
标题:data_source_key    
描述:
用于确定用户元素分组的密钥。请注意,此密钥可通过集成配置提供,因此,无需在文件中提供。
 
接受多字节字符。
 
可用
必填:否    
唯一:是    
标题:available_ind    
描述:
确定 Blackboard Learn 内的类别可用性。
 
支持的值:“Y”、“N”
 
替换数据源批处理 Uid
必填:否    
唯一:否    
标题:new_data_source_key    
描述:
用于确定数据元素分组的新密钥。使用指定替换数据源密钥指定的小组替换用于关联数据的现有数据源。注意:“替换数据源批处理 Uid”的 UI 映射字段为“script.flatfile.CourseCatMemReplacementDataSourceBatchUid”
 
行状态
必填:否    
唯一:否    
标题:row_status    
描述:
将该记录的值设置为以下值之一:已启用:可以正常访问记录。已禁用:记录在 UI 的某些区域中可见,但不能进行更改或访问。已删除:记录已被计划删除。
 
支持的值:“已启用”、“已禁用”、“已删除”
 

顶端

LEARN 对象:层次结构节点

SIS 对象:等级节点

默认插入/更新行为:智能插入或更新

默认删除行为: 清除

Learn 字段

创建机构层次结构节点所需的相应最小标题如下:

external_node_key

data_source_key

parent_node_key

名称

批处理 Uid(必填)
必填:是    
唯一:是    
标题:external_node_key    
描述:
机构用来唯一标识层次结构节点的标识符。它不向用户显示。只能包含字母、数字、破折号和句点。不得使用空格或其他标点符号。
 
最大长度 255。接受多字节字符。
 
数据源密钥(必填) 通过集成或数据文件提供。
必填:是    
唯一:否    
标题:data_source_key    
描述:
用于确定用户元素分组的密钥。请注意,此密钥可通过集成配置提供,因此,无需在文件中提供。
 
最大长度 255。接受多字节字符。
 
父批处理 Uid(必填)
必填:是    
唯一:否    
标题:parent_node_key    
描述:
此节点的父 external_node_key (batch uid)。
 
最大长度 64。
 
 
名称(必填)
必填:是    
唯一:否    
标题:名字    
描述:
节点名称
 
最大长度:255
 
说明
必填:否    
唯一:否    
标题:描述    
描述:
节点的描述
 
最大长度:1000。
 
替换批处理 Uid
必填:否    
唯一:是    
标题:new_external_node_key    
描述:
此字段仅在节点外部密钥发生更改的极少数情况下使用。
 
最大长度 255。必须是唯一的。接受多字节字符。
 
替换数据源批处理 Uid
必填:否    
唯一:否    
标题:new_data_source_key    
描述:
用于确定数据元素分组的新密钥。使用指定替换数据源密钥指定的小组替换用于关联数据的现有数据源。注意:“替换数据源批处理 Uid”的 UI 映射字段为“script.flatfile.NodeReplacementDataSourceBatchUid”
 
 

顶端

LEARN 对象:层次结构用户关联

SIS 对象: 用户关联

默认插入/更新行为:智能插入或更新

默认删除行为:清除

Learn 字段

将用户关联到机构层次结构节点所需的相应最小标题如下:

external_user_key

external_node_key

external_association_key

data_source_key

数据源密钥(必填) 通过集成或数据文件提供。
必填:是    
唯一:否    
标题:data_source_key    
描述:
用于确定用户元素分组的密钥。请注意,此密钥可通过集成配置提供,因此,无需在文件中提供。
 
最大长度 255。接受多字节字符。
 
批处理 Uid(必填)
必填:是    
唯一:是    
标题:external_association_key    
描述:
关联 ID,是用户与节点之间关联的唯一标识。当某个用户可以分配给多个节点时,通常是用户批处理 UID 和节点批处理 UID 值的结合使用,以确保唯一性。
 
最大长度 64。
 
节点批处理 Uid(必填)
必填:是    
唯一:否    
标题:external_node_key    
描述:
此关联的节点,它也是可在 GUI 中“编辑节点”区域找到的节点标识符。
 
最大长度:64。
 
用户批处理 Uid(必填)
必填:是    
唯一:否    
标题:external_user_key    
描述:
用于与此节点关联的用户 external_person_key (batch_uid)。
 
最大长度:64。
 
替换批处理 Uid
必填:否    
唯一:是    
标题:new_external_association_key    
描述:
此字段仅在关联外部密钥发生更改的极少数情况下使用。
 
最大长度 64。接受多字节字符。
 
替换数据源批处理 Uid
必填:否    
唯一:否    
标题:new_data_source_key    
描述:
用于确定数据元素分组的新密钥。使用指定替换数据源密钥指定的小组替换用于关联数据的现有数据源。注意:“替换数据源批处理 Uid”的 UI 映射字段为“script.flatfile.UserAssociationReplacementDataSourceBatchUid”
 
 

顶端

LEARN 对象:层次结构课程关联

SIS 对象: 课程关联

默认插入/更新行为:智能插入或更新

默认删除行为:清除

Learn 字段

将课程关联到机构层次结构节点所需的相应最小标题如下:

external_course_key

external_node_key

external_association_key

data_source_key

批处理 Uid(必填)

必填:是    
唯一:是    
标题:external_association_key    
描述:
关联 ID。
 
最大长度 64。
 
课程批处理 Uid(必填)
必填:是    
唯一:否    
标题:external_course_key    
描述:
用于与此节点关联的课程 external_course_key (batch_uid)。
 
最大长度 64。
 
数据源密钥(必填) 通过集成或数据文件提供。
必填:是    
唯一:否    
标题:data_source_key    
描述:
用于确定元素分组的密钥。请注意,此密钥可通过集成配置提供,因此,无需在文件中提供。
 
最大长度 255。接受多字节字符。
 
节点批处理 Uid(必填)
必填:是    
唯一:否    
标题:external_node_key    
描述:
此关联的节点。
 
最大长度 64。接受多字节字符。
 
主要关联指示器
必填:否    
唯一:否    
标题:s_primary_association    i
描述:
一种标记,用于在可以指定他人时将此关联指定为主要关联。
 
支持的值:“Y”、“N”。
 
替换批处理 Uid
必填:否    
唯一:是    
标题:new_external_association_key    
描述:
此字段仅在关联外部密钥发生更改的极少数情况下使用。
 
最大长度 64。接受多字节字符。
 
替换数据源批处理 Uid
必填:否    
唯一:否    
标题:new_data_source_key    
描述:
用于确定数据元素分组的新密钥。使用指定替换数据源密钥指定的小组替换用于关联数据的现有数据源。注意:“替换数据源批处理 Uid”的 UI 映射字段为“script.flatfile.CourseAssociationReplacementDataSourceBatchUid”
 

顶端

LEARN 对象:目的关联

SIS 对象:目的关联

默认插入/更新行为:智能插入或更新

默认删除行为:清除

Learn 字段

批处理 Uid(必填)
必填:是    
唯一:是    
标题:此字段没有标题,是自动填充字段。    在集成馈送中忽略。
描述:
课程与目的之间的关系的唯一标识符(标准)。
 
最大长度 64。
 
课程批处理 Uid(必填)
必填:是    
唯一:否    
标题:course_key    
描述:

将关联目的的课程的唯一标识符 (external_course_key)。

最大长度 64。

 
数据源密钥(必填) 通过集成或数据文件提供。
必填:是    
唯一:否    
标题:data_source_key    
描述:
用于确定用户元素分组的密钥。请注意,此密钥可通过集成配置提供,因此,无需在文件中提供。
 
最大长度 255。接受多字节字符。
 
子目的集(必填)
必填:是    
唯一:否    
标题:std_sub_doc_key    
描述:
用于关联到课程的目的的唯一标识符(标准)。
 
最大长度 64。
 
替换数据源批处理 Uid
必填:否    
唯一:否    
标题:new_data_source_key    
描述:
用于确定数据元素分组的新密钥。使用指定替换数据源密钥指定的小组替换用于关联数据的现有数据源。注意:“替换数据源批处理 Uid”的 UI 映射字段为“script.flatfile.GoalAssociationReplacementDataSourceBatchUid”

了解详细信息