Snapshot Flat File Header Descriptions
The Snapshot Flat File provides the ability to integrate using the latest LEARN data objects. Below is a comprehensive list of the supported objects, their UI to Feed Header naming conventions, usage description, and data requirements.
As the data feed is a text file all data is represented as a string. In some cases specific formatting and length are noted. Where required by the field supported values are provided. Required fields are highlighted and noted.
LEARN 对象：用户
学生信息系统 对象：人员
默认插入/更新行为：智能插入或更新
默认删除行为：禁用
Learn Fields
Batch Uid (Required)
Required: Yes
Unique: Yes
Header: external_person_key
Description: A unique identifier for a user at the institution. This ID is provided by the institution and is not displayed to users.
It is strongly recommended that the key data be a permanent, non-changing identifier for each user. An example of a good key is a permanent Student ID assigned when the person applies to the institution. Please note that the database cannot merge data between distinct accounts.
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)
Required: Yes
Unique: No
Header: firstname
Description: The user's given first name.
Max length 100. Multi byte characters accepted.
Last Name (Required)
Required: Yes
Unique: No
Header: lastname
Description: The user's family/last name.
Max length 100. Multi byte characters accepted.
Username (Required)
Required: Yes
Unique: Yes
Header: user_id
Description: The username used to log into Blackboard Learn. The username must be unique.
Max length 50. Multi byte characters accepted.
Name Pronunciation
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 Learn. If a password is not provided in the data feed Learn auto-populates this field with a SHA-512 password for security purposes.
Max length 32. Multi byte characters accepted.
Domain Name
Required: No
Unique: No
Header: domain_name
Description: The hostname of the brand to be used in notification emails before the user logs in. The value must be one of the configured hostnames for the system. Invalid values are ignored without warning and user will be created with default hostname value. Set at insert only, updates are ignored. (format e.g. 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.
Department
Required: No
Unique: No
Header: department
Description: The name of the department or sub-section where the user works.
Max length 100. Multi byte characters accepted.
Education Level
Required: No
Unique: No
Header: educ_level
Description: The highest level of education achieved by the user.
Supported values: "K-8", "high school", "freshman", "sophomore", "junior", "senior", "graduate school", "post- graduate school"
Required: No
Unique: No
Header: email
Description: The email address of the user. Blackboard recommends that user_email is not null. Users without an email address cannot send email.
Max length 100
Institution Email
Required: No
Unique: Yes
Header: inst_email
Description: The institution email address of the user. inst_email can be set to Null. No email communications are sent to the inst_email.
Max length 254
Pronouns
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
Required: No
Unique: No
Header: gender
Description: The gender of the user.
Supported values: "Not Disclosed", "Male", "Female"
Home Phone
Required: No
Unique: No
Header: h_phone_1
Description: The user's home phone number.
Max length 50. Multi byte characters accepted.
Home Phone (Secondary)
Required: No
Unique: No h_phone_2
Description: An additional home phone number associated with the user.
Max length 50. Multi byte characters accepted.
Job Title
Required: No
Unique: No
Header: job_title
Description: The associated job title for the user.
Max length 100. Multi byte characters accepted.
Middle Name
Required: No
Unique: No middlename
Description: The user's given middle name.
Max length 100. Multi byte characters accepted.
Mobile Phone
Required: No
Unique: No
Header: m_phone
Description: The user's mobile phone or pager number.
Max length 50. Multi byte characters accepted.
Other Name
Required: No
Unique: No
Header: othername
Description: This is the user's alternate preferred name.
Max length: 100.
Password Encryption Type
Required: No
Unique: No
Header: pwencryptiontype
Description: This field sets the password encryption type used to encrypt the password in the database.
Supported values are: MD5, SSHA
Primary Institution Role
Required: No
Unique: No
Header: institution_role
Description: The user's Primary Institution Role, which determines the user's view of the Portal Modules and other items.
See "Manage Institution Roles" in the System Admin panel for the list of valid Institution Roles on the system.
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
Header: 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.
Student ID
Required: No
Unique: No
Header: student_id
Description: Generic identifier field. This is a display only field.
Max length 100. Multi byte characters accepted.
Suffix
Required: No
Unique: No
Header: suffix The user's name suffix.
Max length 100. Multi byte characters accepted.
System Role
Required: No
Unique: No
Header: system_role
Description: The user's administrative role, describing the user's level of system administration privilege. The role of "none" has no system administration or Course creation privileges associated with it, and is the most commonly assigned role.
The following strings are acceptable:
User Administrator: "account_admin", "accountadmin" or "user_admin"
Course Creator: "course_creator" or "creator"
Support: "course_support" or "support"
Guest: "guest"
None: "none"
Observer: "observer"
Portal Administrator: "portal_admin" or "portal"
System Administrator: "sys_admin", "sysadmin" or "system_admin"
eCommerce Administrator: "ecommerce_admin"
eCommerce Administrator: "ecommerce_admin"
Card Office Administrator: "card_office_admin"
Store Administrator: "store_admin"
To create user-defined system roles, match the "Role ID" found in Administrator Panel > System Role. If a role ID is not given, the system defaults to none.
Title
Required: No
Unique: No
Header: title
Description: The title that the user prefers to use.
Max length 100. Multi byte characters accepted.
Website
Required: No
Unique: No
Header: webpage
Description: The URL of the user's personal Web page, if they have one.
Max length 100
Work Phone
Required: No
Unique: No
Header: b_Phone _1
Description: The work phone number associated with the user.
Max length 50. Multi byte characters accepted.
Work Phone (Secondary)
Required: No
Unique: No
Header: b_phone_2
Description: An additional work phone number associated with the user.
Max length 50. Multi byte characters accepted.
Zip/Postal Code
Required: No
Unique: No
Header: zip_code
Description: The user's ZIP or Postal Code.
Max length 50. Multi byte characters accepted.
TOP
LEARN Object: Course and Organization
学生信息系统 对象：课程或组织
默认插入/更新行为：智能插入或更新
默认删除行为：禁用
Learn 字段
批处理 UID（必填）
必需：是
唯一：是
标头：external_course_key.external_organization_key
描述：机构用于唯一标识课程或组织部分的简称。它不向用户显示。只能包含字母、数字、破折号和句点。不得使用空格或其他标点符号。必须对每个“课程和组织”是唯一的，通常与 COURSE_ID 或 ORGANIZATION_ID 相同。
最大长度为 64。必须是唯一的。接受多字节字符。
课程 ID 或组织 ID（必填）
必需：是
唯一：是
标题：course_id 或 organization_id
描述：机构用来唯一标识课程或组织的简称（例如，math101_F99 或 ChessClub）不得使用以下字符：空格 （ ） & / ' +
最大长度为 100。必须是唯一的，不能发生更改。
课程名称或组织名称（必填）
必需：是
唯一：否
标题：course_name/organization_name
描述：课程或组织的完整标题。此名称用于显示。
最大长度为 255。接受多字节字符。
数据源密钥（必填）由集成或数据文件提供。
必需：是
唯一：否
标题：data_source_key
描述：用于建立课程或组织元素分组的键。请注意，此密钥可通过集成配置提供，因此，无需在文件中提供。
最大长度：256。接受多字节字符。
课程视图
必填：否
唯一：否
标题：course_experience
描述：确定新课程将显示的课程视图。此字段仅插入，无法通过 学生信息系统 框架进行更新。
支持的值：Original、Ultra 或 Instructor 选择。
组织视图
必填：否
唯一：否
标题：organization_experience
说明：允许客户端选择要在其中创建组织的体验。此字段仅插入，无法通过 学生信息系统 框架进行更新。
支持的值：Original、Ultra 或 Instructor 选择。
classificationId
必填：否
唯一：否
标题：classification_key
描述：这决定了课程的分类（学科领域和学科）。这是一个 ID，用于表示分类的主密钥。
最大长度为 450
has描述页面
必填：否
唯一：否
标题：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
描述
必填：否
唯一：否
标题：description
描述：课程的完整描述。
最大长度为 4000。接受多字节字符。
持续时间
必填：否
唯一：否
标题：duration
描述：这是为了指示课程可用性的持续时间是连续的、日期范围、注册后的 x 天还是学期规定的。
选项包括：
连续式：“C”=课程始终可访问。
范围：“R”=课程可在一START_DATE到END_DATE之间的几天内访问。要使课程从特定日期开始或在特定日期之前可供访问，可以相应地将结束日期或开始日期留为空白。
持续时间：“D”= 注册后 N 天
学期：“T”=学期口述（相关学期的持续时间控制本课程的持续时间）
支持的值：“C”、“R”、“D”、“T”
教学进度
必填：否
唯一：否
标题：pace
描述：指示课程是讲师指导还是根据学生自定进度。
支持的值：“Self”、“Instructor”
End Date
必填：否
唯一：否
标题：end_date
描述：对课程的访问结束日期。
格式：yyyymmdd
强制执行语言包
必填：否
唯一：否
标题：locale_enforced
描述：确定在用户访问课程时是否强制执行语言包的标志。如果不强制执行语言包，则用户可能会使用自己喜爱的语言包查看课程。
支持的值：“Y”、“N”
注册访问代码
必填：否
唯一：否
标题：enroll_access_code
说明：这是学生在注册课程时使用的访问代码。
最大长度为 50。
注册结束日期
必填：否
唯一：否
标题：enroll_end
描述：注册不再对学生开放的日期。
格式：yyyymmdd
注册起始日期
必填：否
唯一：否
标题：enroll_start
描述：注册可能开始的日期。
格式：yyyymmdd
注册类型
必填：否
唯一：否
标题：enroll_option
描述：确定注册方法。
支持的值：“instructor”、“self”或“email”。
费用
必填：否
唯一：否
标题：fee
描述：与本课程或组织相关的费用。
数字 ，最多 11 个字符，包含 2 位小数。例如，1500.00
机构名称
必填：否
唯一：否
标题：institution_name
描述：机构的名称。
最大长度为 255。接受多字节字符。
语言包
必填：否
唯一：否
标头：locale
说明：首选语言包的标识符。该值可表示为 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
主要节点批处理 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
必填：否
唯一：否
Header: new_data_source_key
描述：用于建立用户元素分组的新键。使用指定替换数据源密钥指定的小组替换用于关联数据的现有数据源。注意：替换数据源批处理 UID 的 UI 映射字段为“script.flatfile.CourseReplacementDataSourceBatchUid”
行状态
必填：否
唯一：否
标题：row_status
说明：将记录的值设置为以下值之一：启用：对记录的正常访问。已禁用：记录在 UI 的某些区域可见，但可能无法更改或访问。已删除：计划删除记录。
支持的值：“enabled”、“disabled”、“deleted”
在目录中显示
必填：否
唯一：否
标题：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”
TOP
LEARN Object: Course and Organization Membership
注意
课程和组织需要相同的字段。标题将特定于正在创建的是课程还是组织，注意构建数据馈送时的区别。
学生信息系统 对象：课程或组织成员资格（注册和员工作业）
默认插入/更新行为：智能插入或更新
默认删除行为：禁用
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”
引言
必填：否
唯一：否
标题：intro
描述：课程中用户主页的介绍信息。
最大长度为 4000。接受多字节字符。
备注
必填：否
唯一：否
标题：notes
描述：与此用户相关的信息，可能会影响课程或组织参与。
不受限制。接受多字节字符。
个人信息
必填：否
唯一：否
标题：pinfo
描述：用户主页的个人信息。
不受限制。接受多字节字符。
主要教师
必填：否
唯一：否
标题：primary_instructor
描述：表示成员身份是主要讲师。成员必须是标记为“视为教师”的课程角色。如果成员不是教师或没有此标记，则不会显示此选项。如果在分配课程角色时该课程角色没有“视为教师”标记，则会拒绝成员记录中的 Y。
支持的值：“Y”、“N”
接收电子邮件
必填：否
唯一：否
标题：receive_email_ind
说明：标记是否为此用户启用了电子邮件。
支持的值：“Y”、“N”
替换数据源批处理 Uid
必填：否
唯一：否
Header: 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
TOP
LEARN Object: Term
学生信息系统 对象：术语
默认插入/更新行为：智能插入或更新
默认删除行为：禁用
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
必填：否
唯一：是
标题：new_external_term_key
说明：此字段仅在极少数情况下使用术语 EXTERNAL KEY 更改。
最大长度为 256。接受多字节字符。
替换数据源批处理 Uid
必填：否
唯一：否
Header: new_data_source_key
说明：用于建立数据元素分组的新键。使用指定替换数据源密钥指定的小组替换用于关联数据的现有数据源。注意：替换数据源批处理 UID 的 UI 映射字段为“script.flatfile.TermReplacementDataSourceBatchUid”
行状态
必填：否
唯一：否
标题：row_status
描述：将记录的值设置为以下值之一：
已启用：对记录的正常访问。
已禁用：记录在 UI 的某些区域可见，但可能无法更改或访问。
已删除：计划删除记录。
支持的值：“enabled”、“disabled”、“deleted”
开始日期
必填：否
唯一：否
标题：start_date
说明：这是该学期开始可供访问的日期。
格式：yyyymmdd
TOP
LEARN Object: Secondary Institution Role Association
学生信息系统 对象：用户二级机构角色
默认插入/更新行为：智能插入或更新
默认删除行为：禁用
Learn 字段
数据源密钥（必填）由集成或数据文件提供。
必需：是
唯一：否
标题：data_source_key
描述：用于建立用户元素分组的键。请注意，此密钥可通过集成配置提供，因此，无需在文件中提供。
最大长度为 256。接受多字节字符。
辅助机构角色 ID（必填）
必需：是
唯一：否
标题：role_id
描述：此关联的辅助机构角色的标识符。
用户批处理 UID（必需）
必需：是
唯一：否
标题：external_person_key
描述：用于此关联的用户 external_person_key (batch_uid)。
最大长度 64。
替换数据源批处理 Uid
必填：否
唯一：否
Header: new_data_source_key
说明：用于建立数据元素分组的新键。使用指定替换数据源密钥指定的小组替换用于关联数据的现有数据源。注意：替换数据源批 UID 的 UI 映射字段为“script.flatfile.SecondaryInstRoleReplacementDataSourceBatchUid”
行状态
必填：否
唯一：否
标题：row_status
说明：将记录的值设置为以下值之一：启用：对记录的正常访问。已禁用：记录在 UI 的某些区域可见，但可能无法更改或访问。已删除：记录计划在未来由管理员手动删除。该行不会通过任务自动删除。
支持的值：“enabled”、“disabled”、“deleted”
TOP
LEARN Object: Observer Association
学生信息系统 对象：观察者协会
默认插入/更新行为：智能插入或更新
默认删除行为：禁用
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
必填：否
唯一：否
Header: new_data_source_key
说明：用于建立数据元素分组的新键。使用指定替换数据源密钥指定的小组替换用于关联数据的现有数据源。注意：替换数据源批处理 UID 的 UI 映射字段为“script.flatfile.AssociateObserverReplacementDataSourceBatchUid”。
行状态
必填：否
唯一：否
标题：row_status
说明：将记录的值设置为以下值之一：启用：对记录的正常访问。已禁用：记录在 UI 的某些区域可见，但可能无法更改或访问。已删除：计划删除记录。
支持的值：“enabled”、“disabled”、“deleted”
TOP
LEARN Object: Category
学生信息系统 对象：课程类别
默认插入/更新行为：智能插入或更新
默认删除行为：禁用
Learn 字段
dataSourceBatchUid（必填）
必需：是
唯一：否
标题：data_source_key
描述：用于建立类别元素分组的键。
接受多字节字符。
title （必填）
必需：是
唯一：否
标题：title
说明：类别的名称，因为它将在 UI 中向用户显示。
最大长度为 255。接受多字节字符。
批处理 UID（必填）
必需：是
唯一：是
标题：external_category_key
描述：必须是唯一的。请注意，此字段与 UI 中的“类别助记”字段相对应。
最大长度为 64。接受多字节字符。
描述
必填：否
唯一：否
标题：description
描述：类别描述。
frontPageInd
必填：否
唯一：否
标题：frontpage_ind
描述：确定类别是否显示在目录的首页上。
支持的值：“Y”、“N”
Header: new_data_source_keyisAvailable
必填：否
唯一：否
标题：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
必填：否
唯一：否
Header: new_data_source_key
说明：用于建立数据元素分组的新键。使用指定替换数据源密钥指定的小组替换用于关联数据的现有数据源。注意：替换数据源批处理 UID 的 UI 映射字段为“script.flatfile.CourseCatReplacementDataSourceBatchUid”
TOP
LEARN Object: Category Membership
学生信息系统 对象：类别成员资格
默认插入/更新行为：智能插入或更新
默认删除行为：禁用
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
必填：否
唯一：否
Header: new_data_source_key
说明：用于建立数据元素分组的新键。使用指定替换数据源密钥指定的小组替换用于关联数据的现有数据源。注意：替换数据源批处理 UID 的 UI 映射字段为“script.flatfile.CourseCatMemReplacementDataSourceBatchUid”
行状态
必填：否
唯一：否
标题：row_status
说明：将记录的值设置为以下值之一：启用：对记录的正常访问。已禁用：记录在 UI 的某些区域可见，但可能无法更改或访问。已删除：计划删除记录。
支持的值：“enabled”、“disabled”、“deleted”
TOP
LEARN Object: Hierarchy Node
学生信息系统 对象：层次结构节点
默认插入/更新行为：智能插入或更新
默认删除行为：清除
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
必填：否
唯一：否
Header: new_data_source_key
说明：用于建立数据元素分组的新键。使用指定替换数据源密钥指定的小组替换用于关联数据的现有数据源。注意：替换数据源批处理 UID 的 UI 映射字段为“script.flatfile.NodeReplacementDataSourceBatchUid”
TOP
LEARN Object: Hierarchy User Association
学生信息系统 对象：用户关联
默认插入/更新行为：智能插入或更新
默认删除行为：清除
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
必填：否
唯一：否
Header: new_data_source_key
说明：用于建立数据元素分组的新键。使用指定替换数据源密钥指定的小组替换用于关联数据的现有数据源。注意：替换数据源批处理 UID 的 UI 映射字段为“script.flatfile.UserAssociationReplacementDataSourceBatchUid”
TOP
LEARN Object: Hierarchy Course Association
学生信息系统 对象：课程关联
默认插入/更新行为：智能插入或更新
默认删除行为：清除
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
必填：否
唯一：否
Header: new_data_source_key
说明：用于建立数据元素分组的新键。使用指定替换数据源密钥指定的小组替换用于关联数据的现有数据源。注意：替换数据源批处理 UID 的 UI 映射字段为“script.flatfile.CourseAssociationReplacementDataSourceBatchUid”
TOP
LEARN Object: Goal Association
学生信息系统 对象：目标关联
默认插入/更新行为：智能插入或更新
默认删除行为：清除
Learn 字段
批处理 UID（必填）
必需：是
唯一：是
标题：此字段没有标题，是自动填充字段。请在集成馈送中忽略。
描述：课程与目标（标准）之间关系的唯一标识符。
最大长度 64。
课程批次 UID（必填）
必需：是
唯一：否
标题：course_key
描述：将关联目的的课程的唯一标识符 (external_course_key)。
最大长度 64。
数据源密钥（必填）由集成或数据文件提供。
必需：是
唯一：否
标题：data_source_key
描述：用于建立用户元素分组的键。请注意，此密钥可通过集成配置提供，因此，无需在文件中提供。
最大长度为 255。接受多字节字符。
子目标集（必填）
必需：是
唯一：否
标题：std_sub_doc_key
描述：要关联到课程的目标（标准）的唯一标识符。
最大长度为 64。
替换数据源批处理 Uid
必填：否
唯一：否
Header: new_data_source_key
说明：用于建立数据元素分组的新键。使用指定替换数据源密钥指定的小组替换用于关联数据的现有数据源。注意：替换数据源批处理 UID 的 UI 映射字段为“script.flatfile.GoalAssociationReplacementDataSourceBatchUid”