Skip to main content

快照平面文件标题描述

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

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

用户学习对象

LEARN 对象:用户

学生信息系统 对象:人员

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

默认删除行为:禁用

Learn 字段

Batch Uid (Required)

Required: Yes

Required: Yes

标题:external_person_key

描述:组织用户的唯一标识符。这个 ID 由机构提供并且不向用户显示。

强烈建议对每个用户来说,密钥数据是永久、不更改的标识符。良好密钥的示例是在用户申请机构时所分配的永久学生 ID。请注意,数据库无法合并不同帐户之间的数据。

Max length 64.

Data Source Key (Required) Supplied by the integration or the data file.

Required: Yes

Unique: No

Header: data_source_key

Description: Key used to establish grouping of user elements. Note this may be provided by the integration configuration and thus would not be required in the file.

Max. length: 256. Multi byte characters accepted.

First Name (Required)

必需:是

唯一:否

标题:firstname

描述:用户已被分配名称。

最大长度为 100。接受多字节字符。

姓氏(必填)

必需:是

唯一:否

标题:lastname

描述:用户的姓氏。

最大长度为 100。接受多字节字符。

用户名(必填)

必需:是

唯一:是

标题:user_id

描述:用户名用于登录 Blackboard。用户名必须是唯一的。

最大长度为 50。接受多字节字符。

姓名发音

Required: No

Unique: No

Header: TBC

Description: Phonetic spelling or pronunciation guide for user’s name.

Max length: 1000. Multi-byte characters accepted.

Password

Required: No

Unique: No

Header: passwd

Description: The password used to log into Blackboard LMS. If a password is not provided in the data feed, Blackboard LMS auto-populates this field with a SHA-512 password for security purposes.

最大长度为 32。接受多字节字符。

域名

必填:否

唯一:否

标题:domain_name

描述:用户登录前用于通知电子邮件的品牌主机名。该值必须是系统配置的主机名之一。无效值会在没有警告的情况下被忽略,用户将使用默认主机名值创建。设置为仅插入,更新将被忽略。(格式如 blackboard.college.edu、college.blackboard.com)

Max length: 255

Available

Required: No

Unique: No

Header: available_ind

Description: User account availability within the user interface. If set to no, the user account will appear in gray to the Administrator and Instructors. The user will not be able to log into the system. Values may be "Y" for yes, or "N" for no.

Supported values: 'Y', 'N'.

Birthdate

Required: No

Unique: No

Header: birthdate

Description: The user's birth date.

Format: yyyymmdd.

City

Required: No

Unique: No

Header: city

Description: The city name corresponding to the user's address.

Max length 50. Multi byte characters accepted.

Company

Required: No

Unique: No

Header: company

Description: The name of the company for which the user works.

Max length 100. Multi byte characters accepted.

Country

Required: No

Unique: No

Header: country

Description: The country name corresponding to the user's address.

Max length 50. Multi byte characters accepted.

End Date

必填:否

唯一:否

标题:end_date

说明:课程访问结束日期。

格式:yyyymmdd

强制执行语言包

必填:否

唯一:否

标题:locale_enforced

描述:一个标志,用于确定用户访问课程时是否强制执行语言包。如果不强制执行语言包,则用户可能会使用自己喜爱的语言包查看课程。

支持的值:"Y"、"N"

注册访问代码

必填:否

唯一:否

标题:enroll_access_code

说明:这是学生注册课程时使用的访问码。

最大长度为 50。

机构名称

必填:否

唯一:是

标题:external_association_key

描述:课程应主要关联的节点的外部密钥。课程会使用该节点工具的默认设置创建自己的设置。此字段与“课程关联”馈送中的“external_association_key”相同;除非此关联是“主要”关联...也就是说,它将会在课程创建过程中复制其工具设置默认值。

创建要与机构层次结构节点相关联的课程所需的相应最少标题为:

代词

Required: No

Unique: No

Header: pronouns

Description: This is the user’s pronouns. Multiple pronoun values are accepted using comma as delimiter.

Max length 1000

性别

必填:否

唯一:否

标题:gender

描述:用户的性别。

支持的值:“未披露”、“男性”、“女性”

住宅电话

必填:否

唯一:否

标题:h_phone_1

描述:用户的家庭电话号码。

最大长度为 50。接受多字节字符。

住宅电话 (次要)

必填:否

唯一:否

标题:h_phone_2

描述:与用户关联的额外家庭电话号码。

最大长度为 50。接受多字节字符。

职位

必填:否

唯一:否

标题:job_title

描述:用户的相关职务名称。

最大长度为 100。接受多字节字符。

中间名

必填:否

唯一:否

标题:middlename

描述:用户将提供中间名。

最大长度为 100。接受多字节字符。

手机

必填:否

唯一:否

标题:m_phone

描述:用户的移动电话或呼机号码。

最大长度为 50。接受多字节字符。

曾用名

必填:否

唯一:否

标题:othername

描述:这是用户的备用首选姓名。

Max length: 100.

密码加密类型

必填:否

唯一:否

标头:pwencryptiontype

描述:该字段确定用于对数据库密码进行加密的加密类型。

支持的值为:MD5、SSHA。

主要机构角色

必填:否

唯一:否

标题:institution_role

描述:用户的主要机构角色,决定用户对门户模块及其他项目的视图。

请参阅系统管理员面板中的“管理机构角色”,获取系统中有效机构角色的列表。

Replacement Batch Uid

Required: No

Unique: Yes

Header: new_external_person_key

Description: This field is used only on the rare occasions when a user's EXTERNAL_PERSON_KEY changes.

Max length 64. Multi byte characters accepted.

Replacement Data Source Batch Uid

Required: No

Unique: No

标题:new_data_source_key

Description: New key used to establish grouping of user elements. Replaces existing data source associating data with the group designated by the specified replacement data source key. Note: The UI mapping field for Replacement Data Source Batch Uid is 'script.flatfile.UserReplacementDataSourceBatchUid'

Row Status

Required: No

Unique: No

Header: row_status

Description: Sets the value of the record to one of the following: Enabled: Normal access to the record. Disabled: Record is visible in some areas of the UI, but may not be changed or accessed. Deleted: Record is scheduled to be removed.

Supported values: "enabled", "disabled", "deleted"

Max length 64. Multi byte characters accepted.

State/Province

Required: No

Unique: No

Header: state

Description: The state or province name corresponding to the user's address.

Max length 50. Multi byte characters accepted.

Street 1

Required: No

Unique: No

Header: street_1

Description: The first line of the address of the user.

Max length 100. Multi byte characters accepted.

Street 2

Required: No

Unique: No

Header: street_2

Description: The second line of the address of the user.

Max length 100. Multi byte characters accepted.

学生 ID

必填:否

唯一:否

标题:student_id

描述:通用标识符字段。这是一个仅显示字段。

最大长度为 100。接受多字节字符。

后缀

必填:否

唯一:否

标题:suffix

描述:用户名称后缀。

最大长度为 100。接受多字节字符。

系统角色

必填:否

唯一:否

标题:system_role

描述:用户的管理员角色,描述其系统管理权限的级别。角色“无”不提供任何与自身关联的系统管理或课程创建权限,是最经常分配的角色。

系统接受以下字符串:

  • 用户管理员:“account_admin”、“accountadmin” 或 “user_admin” 系统支持:“system_support”或“syssupport”

  • 课程创建者:“course_creator”或“creator”

  • 支持:“course_support”或“support”

  • 访客:"guest"

  • 无: "none"

  • 观察者:"observer"

  • 门户管理员:“portal_admin”或“portal”

  • 系统管理员:“sys_admin”、“system administrator”或“system_admin”

  • 电子商务管理员:“ecommerce_admin”

  • Card Office 管理员:“card_office_admin”

  • 商店管理员:“store_admin”

要创建用户自定义系统角色,请匹配管理员面板 > 系统角色中的“角色 ID”。如果未提供,则系统默认为无。

称谓

必填:否

唯一:否

标题:title

描述:用户偏好使用的头衔。

最大长度为 100。接受多字节字符。

网站

必填:否

唯一:否

标题:webpage

描述:用户个人网页的 URL(如果有的话)。

最大长度为 100

办公电话

必填:否

唯一:否

标题:b_Phone_1

描述:与用户关联的工作电话号码。

最大长度为 50。接受多字节字符。

工作电话 (次要)

必填:否

唯一:否

标题:b_phone_2

描述:与用户关联的其他工作电话号码。

最大长度为 50。接受多字节字符。

邮政编码

必填:否

唯一:否

标题:zip_code

描述:用户的邮政编码。

最大长度为 50。接受多字节字符。

LEARN 对象:课程/组织

学生信息系统 对象:课程或组织

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

默认删除行为:禁用

Learn 字段

Batch Uid (Required)

Required: Yes

Required: Yes

标题:external_course_key.external_organization_key

描述:机构用来唯一标识课程或组织的简称。它不向用户显示。只能包含字母、数字、破折号和句点。不得使用空格或其他标点符号。必须对每个“课程和组织”是唯一的,通常与 COURSE_ID 或 ORGANIZATION_ID 相同。

Max length 64.

课程 ID 或组织 ID(必填)

必需:是

唯一:是

标题:course_id 或 organization_id

描述:机构用来唯一标识课程或组织的简称(例如,math101_F99 或 ChessClub)不得使用以下字符:空格 ( ) & / ' +

最大长度为 100。必须是唯一的,且不可更改。

课程名称或组织名称(必填)

必需:是

唯一:否

标题:course_name/organization_name

说明:课程或组织的完整名称。此名称用于显示。

最大长度为 255。接受多字节字符。

Data Source Key (Required) Supplied by the integration or the data file.

Required: Yes

Unique: No

Header: data_source_key

Description: Key used to establish grouping of user elements. Note this may be provided by the integration configuration and thus would not be required in the file.

Max. length: 256. Multi byte characters accepted.

First Name (Required)

Required: No

Unique: No

Header: TBC

Description: Phonetic spelling or pronunciation guide for user’s name.

Max length: 1000. Multi-byte characters accepted.

Password

必填:否

必填:否

标题:organization_experience

描述:允许客户选择他们想要创建组织时的体验。该字段仅限插入,无法通过 SIS Framework 更新。

支持的值:原版、极限或教练选择。

classificationId

Required: No

Unique: No

Header: passwd

Description: The password used to log into Blackboard LMS. If a password is not provided in the data feed, Blackboard LMS auto-populates this field with a SHA-512 password for security purposes.

Max length: 255

hasDescriptionPage

必填:否

唯一:否

标题:desc_page_ind

描述:当前不支持该字段。集成不得使用此字段。

numDaysOfUse

必填:否

唯一:否

标题:days_of_use

描述:学生注册后可以访问课程的天数。对于自定进度的学习非常有用。仅在持续时间设置为“固定”且其描述课程在创建后可以使用的天数时,才能使用此值。

数字。例如:120.

serviceLevelType

必填:否

唯一:否

标题:服务水平

描述:通常不用于数据流。请忽略。

指定课程类型。

C = 社区 = 组织

F = 完整 = 课程

R = 已注册 =(不使用)

T = Test_Drive =(不使用)

S = 系统 = 功能受限的课程,用于保护组成课程的数据。

支持的值:“F”、“C”、“R”、“T”、“S”

允许访客

必填:否

唯一:否

标题:allow_guest_ind

描述:允许访客进入法庭。

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

允许旁听者

必填:否

唯一:否

页首:allow_observer_ind

描述:允许观察者进入赛道。

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

Available

Required: No

Unique: No

Header: available_ind

Description: User account availability within the user interface. If set to no, the user account will appear in gray to the Administrator and Instructors. The user will not be able to log into the system. Values may be "Y" for yes, or "N" for no.

Supported values: 'Y', 'N'.

Birthdate

Required: No

Unique: No

Header: birthdate

Description: The user's birth date.

Format: yyyymmdd.

City

Required: No

Unique: No

Header: city

Description: The city name corresponding to the user's address.

Max length 50. Multi byte characters accepted.

Company

Required: No

Unique: No

Header: company

Description: The name of the company for which the user works.

Max length 100. Multi byte characters accepted.

  • 连续式:“C”=课程始终可访问。

  • 范围:“R”=课程可在一START_DATE到END_DATE之间的几天内访问。要使课程从特定日期开始或在特定日期之前可供访问,可以相应地将结束日期或开始日期留为空白。

  • 持续时间:“D”= 注册后 N 天

  • 学期:“T”=学期口述(相关学期的持续时间控制本课程的持续时间)

Country

教学进度

Required: No

Unique: No

Header: country

Description: The country name corresponding to the user's address.

Max length 50. Multi byte characters accepted.

End Date

必填:否

唯一:否

标题:end_date

说明:课程访问结束日期。

格式:yyyymmdd

强制执行语言包

必填:否

唯一:否

标题:locale_enforced

描述:一个标志,用于确定用户访问课程时是否强制执行语言包。如果不强制执行语言包,则用户可能会使用自己喜爱的语言包查看课程。

支持的值:"Y"、"N"

注册访问代码

必填:否

唯一:否

标题:enroll_access_code

说明:这是学生注册课程时使用的访问码。

最大长度为 50。

注册结束日期

必填:否

唯一:否

标题:enroll_end

说明:不再提供学生注册日期。

格式:yyyymmdd

注册起始日期

必填:否

唯一:否

标题:enroll_start

说明:注册开始日期。

格式:yyyymmdd

注册类型

必填:否

唯一:否

标题:enroll_option

说明:确定注册方法。

支持的 value:“instructor”、“self”或“email”。

费用

必填:否

唯一:否

标题:成本

说明:与此课程或组织相关的费用。

数字 ,最多 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) 且课程配额生效时,此设置会触发警告邮件。

数字。例如:10MB相当于10485760字节。

主要关联批处理 Uid

必填:否

唯一:是

标题:external_association_key

描述:课程应主要关联的节点的外部密钥。课程会使用该节点工具的默认设置创建自己的设置。此字段与“课程关联”馈送中的“external_association_key”相同;除非此关联是“主要”关联...也就是说,它将会在课程创建过程中复制其工具设置默认值。

创建要与机构层次结构节点相关联的课程所需的相应最少标题为:

  • external_course_key

  • course_id

  • course_name

  • external_association_key

  • primary_external_node_key

  • primary_external_node_key

  • 主要节点批处理 Uid

Required: No

Unique: No

Header: pronouns

Description: This is the user’s pronouns. Multiple pronoun values are accepted using comma as delimiter.

Max length 1000

  • external_course_key

  • course_id

  • course_name

  • external_association_key

  • primary_external_node_key

Max length: 100.

Replacement Batch Uid

Required: No

Unique: Yes

Header: new_external_person_key

Description: This field is used only on the rare occasions when a user's EXTERNAL_PERSON_KEY changes.

Max length 64. Multi byte characters accepted.

Replacement Data Source Batch Uid

Required: No

Unique: No

标题: new_data_source_key

Description: New key used to establish grouping of user elements. Replaces existing data source associating data with the group designated by the specified replacement data source key. Note: The UI mapping field for Replacement Data Source Batch Uid is 'script.flatfile.UserReplacementDataSourceBatchUid'

Row Status

Required: No

Unique: No

Header: row_status

Description: Sets the value of the record to one of the following: Enabled: Normal access to the record. Disabled: Record is visible in some areas of the UI, but may not be changed or accessed. Deleted: Record is scheduled to be removed.

Supported values: "enabled", "disabled", "deleted"

在目录中显示

必填:否

唯一:否

标题:catalog_ind

说明:确定课程或组织是否出现在课程目录中。

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

源课程复制密钥,源组织复制密钥

必填:否

唯一:否

标头:template_course_key.template_organization_key

描述:用于复制作业的内容源外部键。

Max length 64. Multi byte characters accepted.

State/Province

Required: No

Unique: No

Header: state

Description: The state or province name corresponding to the user's address.

Max length 50. Multi byte characters accepted.

Street 1

Required: No

Unique: No

Header: street_1

Description: The first line of the address of the user.

Max length 100. Multi byte characters accepted.

Street 2

Required: No

Unique: No

Header: street_2

Description: The second line of the address of the user.

Max length 100. Multi byte characters accepted.

LEARN 对象:课程和组织成员资格

注意

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

学生信息系统 对象:课程或组织成员资格(注册和员工作业)

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

默认删除行为:禁用

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

描述:用户主页的个人信息。

不受限制。接受多字节字符。

主要教师

必填:否

唯一:否

标题:primary_instructor

描述:表示成员身份是主要讲师。成员必须是标记为“视为教师”的课程角色。如果成员不是教师或没有此标记,则不会显示此选项。如果在分配课程角色时该课程角色没有“视为教师”标记,则会拒绝成员记录中的 Y。

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

接收电子邮件

必填:否

唯一:否

标题:receive_email_ind

说明:标记是否为此用户启用了电子邮件。

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

替换数据源批处理 Uid

必填:否

唯一:否

标题: new_data_source_key

说明:用于建立数据元素分组的新键。使用指定替换数据源密钥指定的小组替换用于关联数据的现有数据源。注意:替换数据源批处理 UID 的 UI 映射字段为“script.flatfile.MemberReplacementDataSourceBatchUid”

角色

必填:否

唯一:否

标题:role

描述:用户在课程中的角色。

支持的值:"Instructor", "teaching_assistant", "course_builder", "Grader", "Student", "guest", "none"

行状态

必填:否

唯一:否

标题:row_status

说明:将记录的值设置为以下值之一:启用:对记录的正常访问。已禁用:记录在 UI 的某些区域可见,但可能无法更改或访问。已删除:计划删除记录。

支持的值:“enabled”、“disabled”、“deleted”

网站 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 对象:术语

学生信息系统 对象:术语

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

默认删除行为:禁用

Learn 字段

批处理 UID(必填)

必需:是

唯一:是

标题:external_term_key

描述:机构用来唯一标识学期的简称。它不向用户显示。只能包含字母、数字、破折号和句点。不得使用空格或其他标点符号。

最大长度为 256。接受多字节字符。

数据源密钥(必填)由集成或数据文件提供。

必需:是

唯一:否

标题: data_source_key

描述:用于建立术语元素分组的键。请注意,此密钥可通过集成配置提供,因此无需在文件中提供。

最大长度为 256。接受多字节字符。

姓名(必填)

必需:是

唯一:否

标题:name

描述:术语的名称。

最大长度为 333

daysOfUse

必填:否

唯一:否

标题:days_of_use

描述:学生在注册后可以访问课程的天数。对于自定进度的学习非常有用。

数字。

可用

必填:否

唯一:否

标题:available_ind

描述:确定学期可用性。如果设置为“N”,则关联的对象将不可用。

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

描述

必填:否

唯一:否

标题:description

描述:术语描述

不受限制。

持续时间

必填:否

唯一:否

标题:duration

说明:计划学期可用性窗口。

选项包括:

  • 连续:该学期始终可访问。

  • 范围:学期在一个 START_DATE 与 END_DATE 之间的天数内有效。要使学期从特定日期开始(或在特定日期之前)有效,可以将结束日期(或开始日期)留为空白。

  • 固定:学期在一定天数内有效 (DAYS_OF_USE)。

支持的值:连续、范围、固定

End Date

必填:否

唯一:否

标题:end_date

说明:这是该学期停止可供访问的日期。

格式:yyyymmdd

父条款批次 UID

必填:否

唯一:否

标题:external_parent_term_key

描述:代表该条款子项的父条款的 EXTERNAL_TERM_KEY。用于建立术语的层级关系。如果值为“None”,任何现有的父条款关联都将被移除。母期限关联仅支持非年度期限类型。如果术语类型不支持父项,则该关联会被忽略。如果期限类型设置为年度或未指定,任何现有的父条款关联都会被移除。如果引用的父条款不存在或关联无效,则仍会创建或更新条款,但不会应用父条款。

最大长度为 256。接受多字节字符。

术语类型

必填:否

唯一:否

标题:term_type

描述:指定术语的类型。

选项包括:

  • 年度:“a”= 学年或与日历相符的学期。

  • 学期:“S”= 标准学期。

  • 三学期制:“t”=三学期学术结构。

  • 学期:“Q”= 四学期学术结构。

  • 学期间期:“i”=两次选举之间的短期。

  • 模式:“m”= 更大项目中的子项目。

  • 未指定:“u”= 清除术语类型。

  • 支持的值:"a"、"s"、"t"、"q"、"i"、"m"、"u"

替换批处理 Uid

必填:否

唯一:是

标题:new_external_term_key

说明:此字段仅在极少数情况下使用术语 EXTERNAL KEY 更改。

最大长度为 256。接受多字节字符。

替换数据源批处理 Uid

必填:否

唯一:否

标题: new_data_source_key

说明:用于建立数据元素分组的新键。使用指定替换数据源密钥指定的小组替换用于关联数据的现有数据源。注意:替换数据源批处理 UID 的 UI 映射字段为“script.flatfile.TermReplacementDataSourceBatchUid”

行状态

必填:否

唯一:否

标题:row_status

描述:将记录的值设置为以下值之一:

  • 已启用:对记录的正常访问。

  • 已禁用:记录在 UI 的某些区域可见,但可能无法更改或访问。

  • 已删除:计划删除记录。

支持的值:“enabled”、“disabled”、“deleted”

开始日期

必填:否

唯一:否

标题:start_date

说明:这是该学期开始可供访问的日期。

格式:yyyymmdd

LEARN对象:中学机构角色关联

学生信息系统 对象:用户二级机构角色

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

默认删除行为:禁用

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 的某些区域可见,但可能无法更改或访问。已删除:记录计划在未来由管理员手动删除。该行不会通过任务自动删除。

支持的值:“enabled”、“disabled”、“deleted”

学习对象:观察者协会

学生信息系统 对象:观察者协会

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

默认删除行为:禁用

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 的某些区域可见,但可能无法更改或访问。已删除:计划删除记录。

支持的值:“enabled”、“disabled”、“deleted”

学习对象:类别

学生信息系统 对象:课程类别

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

默认删除行为:禁用

Learn 字段

dataSourceBatchUid(必填)

必需:是

唯一:否

标题: data_source_key

描述:用于建立类别元素分组的键。

接受多字节字符。

title (必填)

必需:是

唯一:否

标题:title

说明:类别的名称,因为它将在 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 的某些区域可见,但可能无法更改或访问。已删除:计划删除记录。字符串。

支持的值:“enabled”、“disabled”、“deleted”

替换批处理 Uid

必填:否

唯一:是

标题:new_external_category_key

说明:指定当前密钥的替换。

最大长度为 64。接受多字节字符。

替换数据源批处理 Uid

必填:否

唯一:否

标题: new_data_source_key

说明:用于建立数据元素分组的新键。使用指定替换数据源密钥指定的小组替换用于关联数据的现有数据源。注意:替换数据源批处理 UID 的 UI 映射字段为“script.flatfile.CourseCatReplacementDataSourceBatchUid”

学习对象:主语

学生信息系统对象:实体

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

默认删除行为:禁用

学习领域:主题

批处理 UID(必需)

必需:是

唯一:是

标题:external_subject_key

描述:机构用于唯一标识该主题的简称。它不向用户显示。只能包含字母、数字、连字符和句点。不允许使用空格或其他标点符号。必须在所有学科、课程和机构中唯一,并且通常与 SUBJECT_ID 相同。

最大长度为 64。必须是唯一的。接受多字节字符。

主题 ID(必填)

必需:是

唯一:是

标题:subject_id

描述:机构用于唯一标识该主题的简称。该值必须遵循 {SubjectTitle}__{SubjectIdentifier} 格式,主题标题和标识符之间需连续两个下划线。主题标题仅可包含字母、数字、连字符(-)、句号(.)和下划线(_),主题标识符仅可包含字母和数字。以下字符不可使用:空格( )、&、.、/、'、+。例如:CHEM__abc123。

最大长度为 100。必须是唯一的,且不可更改。

主题名称(必填)

必需:是

唯一:否

标题:subject_name

描述:主题的全名。此名称用于显示。

最大长度为 255。接受多字节字符。

数据源密钥(必填)由集成或数据文件提供。

必需:是

唯一:否

标题: data_source_key

描述:用于确定主题元素分组的键。请注意,这可能由集成配置提供,因此文件中不需要。

最大长度:256。接受多字节字符。

可用

必填:否

唯一:否

标题:available_ind

说明:确定 Blackboard 的主题可用性。

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

描述

必填:否

唯一:否

标题:description

描述:主题的完整描述。

最大长度为 4000。接受多字节字符。

学科分类

必需:是

唯一:否

标题:subject_type

描述:用于表示该课程在学习管理系统中的课程分类。选项包括:

  • 本科:“U” = 表示本科水平的课程。

  • 研究生:“G” = 研究生水平课程。

  • 发展性课程:“D” = 学科指代发展性或补救性课程。

  • 本科不可转学分:“N” = 该学科代表不可转学分的本科课程。

  • 本科可转学分:“T” = 该学科代表可转移的本科课程。

  • 专业课程:“P”=学科表示专业或继续教育课程。

支持的值:“U”、“G”、“D”、“N”、“T”、“P”

替换批处理 Uid

必填:否

唯一:是

标题:new_external_subject_key

描述:该字段仅在极少数情况下使用,即当主体的外部密钥发生变化时。

最大长度为 64。必须是唯一的。接受多字节字符。

替换数据源批处理 UID。

必填:否

唯一:否

标题: new_data_source_key

描述:新键用于确定主体元素的分组。使用指定替换数据源密钥指定的小组替换用于关联数据的现有数据源。注意:用于替换数据源批处理 UID 的 UI 映射字段是“script.flatfile.SubjectReplacementDataSourceBatchUid”。

行状态

必填:否

唯一:否

标题:row_status

说明:将记录的值设置为以下值之一:启用:对记录的正常访问。已禁用:记录在 UI 的某些区域可见,但可能无法更改或访问。已删除:计划删除记录。

支持的值:“enabled”、“disabled”、“deleted”

LEARN Object: Program

SIS Object: Program

Default Insert/Update behavior: Smart Inserts or Updates

Default Delete Behavior: Disable

Learn Fields

Batch Uid (Required)

Required: Yes

Unique: Yes

Header: external_program_key

Description: Short name used by the institution to uniquely identify the Program. This is not displayed to users. Can contain only letters, digits, dashes and periods. No spaces or other punctuation allowed. Must be unique across all Programs, Subjects, Courses and Organizations, and is often the same as the PROGRAM_ID.

Max length 64. Must be unique. Multi byte characters accepted.

Program ID (Required)

Required: Yes

Unique: Yes

Header: program_id

Description: Short name used by the institution to uniquely identify the Program.

Max length 100. Must be unique and cannot be changed.

Program Name (Required)

Required: Yes

Unique: No

Header: program_name

Description: Complete title of the Program. This is used for display.

Max length 255. Multi byte characters accepted.

Data Source Key (Required) Supplied by the integration or the data file.

Required: Yes

Unique: No

Header: data_source_key

Description: Key used to establish a grouping of Program elements. Note this may be provided by the integration configuration and thus would not be required in the file.

Max. length: 256. Multi byte characters accepted.

Available

Required: No

Unique: No

Header: available_ind

Description: Establishes Program availability to Blackboard LMS.

Supported values: "Y", "N"

Description

Required: No

Unique: No

Header: description

Description: Complete description of the Program.

Max length 4000. Multi byte characters accepted.

Program Type

Required: Yes

Unique: No

Header: program_type

Description: This is used to indicate the curricular classification of the Program within the learning management system. Options are:

  • Undergraduate: 'U' = The Subject represents undergraduate-level curriculum.

  • Graduate: 'G' = The Subject represents graduate-level curriculum.

Supported values: "U", "G

Replacement Batch Uid

Required: No

Unique: Yes

Header: new_external_program_key

Description: This field is used only on the rare occasions when a Program’s EXTERNAL KEY changes.

Max length 64. Must be unique. Multi byte characters accepted.

Replacement Data Source Batch Uid

Required: No

Unique: No

Header: new_data_source_key

Description: New key used to establish grouping of program elements. Replaces existing data source associating data with the group designated by the specified replacement data source key. Note: The UI mapping field for Replacement Data Source Batch Uid is 'script.flatfile.ProgramReplacementDataSourceBatchUid'

Row Status

Required: No

Unique: No

Header: row_status

Description: Sets the value of the record to one of the following: Enabled: Normal access to the record. Disabled: Record is visible in some areas of the UI but may not be changed or accessed. Deleted: Record is scheduled to be removed.

Supported values: "enabled", "disabled", "deleted

学习对象:类别成员资格

学生信息系统 对象:类别成员资格

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

默认删除行为:禁用

Learn 字段

批处理 UID(必填)

必需:是

唯一:是

描述:自动填充。不在数据馈送中使用。

类别批处理 UID(必填)

必需:是

唯一:否

标题:external_category_key

描述:用于添加课程/组织的类别的外部密钥 (batch_uid)。

最大长度为 64。

课程批次 UID 或组织批次 UID(必填)

必需:是

唯一:否

标题:external_course_key

描述:external_organization_key 是进行分类的课程或组织的外部密钥 (batch_uid)。

最大长度为 64。

数据源密钥(必填)由集成或数据文件提供。

必需:是

唯一:否

标题: data_source_key

描述:用于建立用户元素分组的键。请注意,此密钥可通过集成配置提供,因此无需在文件中提供。

接受多字节字符。

Is Available

必填:否

唯一:是

标题:available_ind

描述:在 Blackboard Learn 中建立类别可用性。

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

替换数据源批处理 Uid

必填:否

唯一:否

标题: new_data_source_key

说明:用于建立数据元素分组的新键。使用指定替换数据源密钥指定的小组替换用于关联数据的现有数据源。注意:替换数据源批处理 UID 的 UI 映射字段为“script.flatfile.CourseCatMemReplacementDataSourceBatchUid”

行状态

必填:否

唯一:否

标题:row_status

说明:将记录的值设置为以下值之一:启用:对记录的正常访问。已禁用:记录在 UI 的某些区域可见,但可能无法更改或访问。已删除:计划删除记录。

支持的值:“enabled”、“disabled”、“deleted”

LEARN 对象:层次结构节点

学生信息系统 对象:层次结构节点

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

默认删除行为:清除

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。

姓名(必填)

必需:是

唯一:否

标题:name

描述:节点名称

最大长度:255

描述

必填:否

唯一:否

标题:description

描述:节点的描述

最大长度:1000。

替换批处理 Uid

必填:否

唯一:是

标题:new_external_node_key

描述:此字段仅在极少数情况下使用节点的外部键更改。

最大长度为 255。必须是唯一的。接受多字节字符。

替换数据源批处理 Uid

必填:否

唯一:否

标题: new_data_source_key

说明:用于建立数据元素分组的新键。使用指定替换数据源密钥指定的小组替换用于关联数据的现有数据源。注意:替换数据源批处理 UID 的 UI 映射字段为“script.flatfile.NodeReplacementDataSourceBatchUid”

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

学生信息系统 对象:用户关联

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

默认删除行为:清除

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对象:层次课程关联

学生信息系统 对象:课程关联

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

默认删除行为:清除

Learn 字段

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

  • external_course_key

  • external_node_key

  • external_association_key

  • data_source_key

批处理 UID(必填)

必需:是

唯一:是

标题:external_association_key

描述:每个课程和节点关联必须具有标识此关系的唯一值。批处理 UID 是课程-节点关系的唯一标识符。

最大长度为 64。

课程批次 UID(必填)

必需:是

唯一:否

标题:external_course_key

描述:将与此节点关联的课程 external_course_key (batch_uid)。

最大长度为 64。

数据源密钥(必填)由集成或数据文件提供。

必需:是

唯一:否

标题: data_source_key

描述:用于建立元素分组的键。请注意,此密钥可通过集成配置提供,因此无需在文件中提供。

最大长度为 255。接受多字节字符。

节点批处理 UID(必填)

必需:是

唯一:否

标题:external_node_key

说明:此关联的节点。

最大长度为 64。接受多字节字符。

主要关联指标

必填:否

唯一:否

标题:is_primary_association

说明:当可以指定其他关联时,将此关联指定为主关联的标志。

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

替换批处理 Uid

必填:否

唯一:是

标题:new_external_association_key

说明:此字段仅在极少数情况下使用关联的外部键更改。

最大长度为 64。接受多字节字符。

替换数据源批处理 Uid

必填:否

唯一:否

标题: new_data_source_key

说明:用于建立数据元素分组的新键。使用指定替换数据源密钥指定的小组替换用于关联数据的现有数据源。注意:替换数据源批处理 UID 的 UI 映射字段为“script.flatfile.CourseAssociationReplacementDataSourceBatchUid”

LEARN 对象:目标关联

学生信息系统 对象:目标关联

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

默认删除行为:清除

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”

LEARN Object: Subject to Course Association

SIS Object: Subject to Course Association

Default Insert behavior: Smart Inserts. Updates are not supported.

Default Delete Behavior: Purge

Learn Fields

The minimum required headers for associating a Subject to a Course are:

  • external_subject_key

  • external_course_key

  • external_association_key

  • data_source_key

Batch Uid (Required)

Required: Yes

Unique: Yes

Header: external_association_key

Description: Each subject and course association must have a unique value that identifies this relationship. The Batch Uid is the unique identifier for the subject-course relationship.

Max length 64.

Subject Batch Uid (Required)

Required: Yes

Unique: No

Header: external_subject_key

Description: The subject external_subject_key (batch_uid) to be associated with this association.

Max length 64.

Data Source Key (Required) Supplied by the integration or the data file.

Required: Yes

Unique: No

Header: data_source_key

Description: Key used to establish grouping of elements. Note this may be provided by the integration configuration and thus would not be required in the file.

Max length 255. Multi byte characters accepted.

LEARN Object: Subject to Organization Association

SIS Object: Subject to Organization Association

Default Insert behavior: Smart Inserts. Updates are not supported.

Default Delete Behavior: Purge

Learn Fields

The minimum required headers for associating a Subject to an Organization are:

  • external_subject_key

  • external_org_key

  • external_association_key

  • data_source_key

Batch Uid (Required)

Required: Yes

Unique: Yes

Header: external_association_key

Description: Each subject and organization association must have a unique value that identifies this relationship. The Batch Uid is the unique identifier for the subject organization relationship.

Max length 64.

Subject Batch Uid (Required)

Required: Yes

Unique: No

Header: external_subject_key

Description: The subject external_subject_key (batch_uid) to be associated with this association.

Max length 64.

Data Source Key (Required) Supplied by the integration or the data file.

Required: Yes

Unique: No

Header: data_source_key

Description: Key used to establish grouping of elements. Note this may be provided by the integration configuration and thus would not be required in the file.

Max length 255. Multi byte characters accepted.

Node Batch Uid (Required)

Required: Yes

Unique: No

Header: external_org_key

Description: The organization for this association.

Max length 64. Multi byte characters accepted.

Replacement Data Source Batch Uid

Required: No

Unique: No

Header: new_data_source_key

Description: New key used to establish grouping of data elements. Replaces existing data source associating data with the group designated by the specified replacement data source key. Note: The UI mapping field for Replacement Data Source Batch Uid is 'script.flatfile.SubjectToOrganizationAssociationReplacementDataSourceBatchUid'

LEARN Object: Program to Subject Association

SIS Object: Program to Subject Association

Default Insert behavior: Smart Inserts. Updates are not supported.

Default Delete Behavior: Purge

Learn Fields

The minimum required headers for associating a Program to a Subject are:

  • external_program_key

  • external_subject_key

  • external_association_key

  • data_source_key

Batch Uid (Required)

Required: Yes

Unique: Yes

Header: external_association_key

Description: Each program and subject association must have a unique value that identifies this relationship. The Batch Uid is the unique identifier for the program-subject relationship.

Max length 64.

Program Batch Uid (Required)

Required: Yes

Unique: No

Header: external_program_key

Description: The program external_program_key (batch_uid) to be associated with this association.

Max length 64.

Data Source Key (Required) Supplied by the integration or the data file.

Required: Yes

Unique: No

Header: data_source_key

Description: Key used to establish grouping of elements. Note this may be provided by the integration configuration and thus would not be required in the file.

Max length 255. Multi byte characters accepted.

Node Batch Uid (Required)

Required: Yes

Unique: No

Header: external_subject_key

Description: The subject for this association.

Max length 64. Multi byte characters accepted.

Replacement Data Source Batch Uid

Required: No

Unique: No

Header: new_data_source_key

Description: New key used to establish grouping of data elements. Replaces existing data source associating data with the group designated by the specified replacement data source key. Note: The UI mapping field for Replacement Data Source Batch Uid is 'script.flatfile.ProgramToSubjectAssociationReplacementDataSourceBatchUid'