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.

Objeto LEARN: Usuario

Objeto SIS or Sistema de información del estudiante: Persona

Comportamiento predeterminado de inserción/actualización: inserciones inteligentes o actualizaciones

Comportamiento de eliminación predeterminado: Deshabilitar

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

Objeto SIS or Sistema de información del estudiante: Curso u organización

Comportamiento predeterminado de inserción/actualización: inserciones inteligentes o actualizaciones

Comportamiento de eliminación predeterminado: Deshabilitar

Campos de aprendizaje

UID de lote (obligatorio)

Requerido: Sí

Único: Sí

Encabezado: external_course_key.external_organization_key

Descripción: Nombre corto utilizado por la institución para identificar de forma única la sección Curso u Organización. Este elemento no se muestra a los usuarios. Solo puede contener letras, dígitos, guiones y puntos. No se permiten espacios u otros signos de puntuación. Debe ser único para cada curso u organización y, con frecuencia, es igual que COURSE_ID u ORGANIZATION_ID.

Longitud máxima 64. Debe ser único. Se aceptan caracteres de varios bytes.

ID del curso o ID de la organización (obligatorio)

Requerido: Sí

Único: Sí

Encabezado: course_id o organization_id

Descripción: Nombre breve usado por la institución para identificar de forma única al curso o a la organización (por ejemplo, math101_F99 o ChessClub). No se pueden usar los siguientes caracteres: space ( ) & / ' +

Longitud máxima: 100. Debe ser única y no puede modificarse.

Nombre del curso o nombre de la organización (obligatorio)

Requerido: Sí

Único: No

Encabezado: course_name/organization_name

Descripción: Título completo del Curso u Organización. Este valor se muestra.

Longitud máxima: 255. Se aceptan caracteres de varios bytes.

Clave de la fuente de datos (obligatorio) Suministrada por la integración o el archivo de datos.

Requerido: Sí

Único: No

Encabezado: data_source_key

Descripción: Clave utilizada para establecer una agrupación de elementos del curso o de la organización. Tenga en cuenta que la configuración de integración puede proporcionar este elemento y, por lo tanto, no ser necesario en el archivo.

Longitud máxima: 256. Se aceptan caracteres de varios bytes.

Vista de curso

Requerido: No

Único: No

Encabezado: course_experience

Descripción: Determina qué vista de curso aparecerá para los nuevos cursos. Este campo es solo insertar y no se puede actualizar a través del marco SIS o Sistema de información del estudiante.

Valores admitidos: Original, Ultra o Elección del profesor.

Vista de la organización:

Requerido: No

Único: No

Encabezado: organization_experience

Descripción: Permite a los clientes seleccionar la experiencia en la que desean crear su organización. Este campo es solo insertar y no se puede actualizar a través del marco SIS o Sistema de información del estudiante.

Valores admitidos: Original, Ultra o Elección del profesor.

classificationId

Requerido: No

Único: No

Encabezado: classification_key

Descripción: Esto determina la clasificación (área temática y disciplina) del curso. Se trata de un identificador que representa la clave principal de la clasificación.

Longitud máxima: 450.

hasDescriptionPage

Requerido: No

Único: No

Encabezado: desc_page_ind

Descripción: Este campo no se admite actualmente. Las integraciones no deben usar este campo.

numDaysOfUse

Requerido: No

Único: No

Encabezado: days_of_use

Descripción: Número de días que los estudiantes pueden acceder al curso después de la inscripción. Útil para el aprendizaje autodidacta. Este valor solo se usa si la duración se establece en "FIXED" y describe la cantidad de días que puede usarse el curso tras su creación.

Numérico. Por ejemplo: 120

serviceLevelType

Requerido: No

Único: No

Encabezado: servicio_level

Descripción: no se suele utilizar en fuentes de datos. Ignorar.

Especifica el tipo de curso.

C = Community = Organización

F = Full = Curso

R = Registered = (no se usa)

T = Test_Drive = (no se usa)

S = System = Un curso con funciones limitadas para proteger los datos que lo conforman.

Valores admitidos: 'F', 'C', 'R', 'T', 'S'

Permitir invitados

Requerido: No

Único: No

Encabezado: allow_guest_ind

Descripción: Permite el acceso de invitados al curso.

Valores admitidos: 'Y', 'N'

Permitir observadores

Requerido: No

Único: No

Encabezado: allow_observer_ind

Descripción: Permite el acceso de observadores al Curso.

Valores admitidos: 'Y', 'N'

Disponible

Requerido: No

Único: No

Encabezado: available_ind

Descripción: Establece la disponibilidad del curso o de la organización para Blackboard. Si use_term_avail_ind es "Y", este indicador se ignora y la disponibilidad del curso se determina por su período asociado available_ind.

Valores admitidos: 'Y', 'N'

UID de lote de curso en todas las listas

Requerido: No

Único: No

Encabezado: master_course_key

Descripción: Curso principal EXTERNAL_COURSE_KEY de los cuales este curso es un hijo.

Longitud máxima: 64

Descripción

Requerido: No

Único: No

Encabezado: descripción

Descripción: Descripción completa del Curso.

Longitud máxima: 4000. Se aceptan caracteres de varios bytes.

Duración

Requerido: No

Único: No

Encabezado: duración

Descripción: Esto es para indicar si la duración de la disponibilidad del curso es continua, rango de fechas, x días desde la inscripción o dictado por el período.

Las opciones son las siguientes:

Continuo: 'C' = El curso es siempre accesible.
Rango: 'R' = El curso es accesible en los días entre la una START_DATE y las END_DATE. Es posible dejar la fecha de inicio o la de finalización abiertas para que se pueda acceder al curso a partir de una fecha determinada o hasta una fecha determinada.
Duración: 'D' = N días desde la inscripción
Término: 'T' = dictado por el término (la duración del término asociado controla la duración de este curso)

Valores admitidos: "C", "R", "D", "T"

Ritmo educativo

Requerido: No

Único: No

Encabezado: ritmo

Descripción: Indica si el curso es dirigido por un profesor o a su propio ritmo según el estudiante.

Valores admitidos: "Self", "Instructor"

Fecha de finalización

Requerido: No

Único: No

Encabezado: end_date

Descripción: Fecha en la que finaliza el acceso al Curso.

Formato: aaaammdd

Forzar paquete de idiomas

Requerido: No

Único: No

Encabezado: locale_enforced

Descripción: Marca que determina si el paquete de idioma se aplica cuando un usuario accede al curso. Si el paquete de idioma no se aplica, el usuario puede ver el curso usando el paquete de idioma que prefiera.

Valores admitidos: 'Y','N'

Código de acceso a la inscripción

Requerido: No

Único: No

Encabezado: enroll_access_code

Descripción: Este es el código de acceso que los estudiantes deben usar al inscribirse en el curso.

Longitud máxima: 50.

Fecha de finalización de la inscripción

Requerido: No

Único: No

Encabezado: enroll_end

Descripción: Fecha en que la inscripción ya no está disponible para los estudiantes.

Formato: aaaammdd

Fecha de inicio de la inscripción

Requerido: No

Único: No

Encabezado: enroll_start

Descripción: Fecha en que puede comenzar la inscripción.

Formato: aaaammdd

Tipo de inscripción

Requerido: No

Único: No

Encabezado: enroll_option

Descripción: Determina el método de inscripción.

Valores admitidos: "instructor", "self" o "email".

Importe

Requerido: No

Único: No

Encabezado: fee

Descripción: Tarifa asociada con este Curso u Organización.

Numérico. 11 caracteres, 2 lugares decimales. P. ej. 1500.00

Nombre de la institución

Requerido: No

Único: No

Encabezado: institution_name

Descripción: El nombre de la institución.

Longitud máxima: 255. Se aceptan caracteres de varios bytes.

Paquete de idioma

Requerido: No

Único: No

Encabezado: locale

Descripción: identificador del paquete de idioma preferido. Este valor se expresa como xx_XX; por ejemplo, el paquete de idioma francés se representa como fr_FR

Longitud máxima: 20.

Bloqueado

Requerido: No

Único: No

Encabezado: lockout_ind

Descripción: Indica si se ha restringido el acceso al curso o a la organización. Si se establece en "Y", el acceso al curso o a la organización quedará restringido en función de la END_DATE y la START_DATE.

Valores admitidos: 'Y', 'N'

Uso máximo de disco (espacio relativo)

Requerido: No

Único: No

Encabezado: soft_limit

Descripción: Límite suave en la cuota del curso. Esta opción envía correos electrónicos de advertencia cuando la carpeta de almacenamiento del curso alcanza el valor de soft_limit especificado y hay límites vigentes de espacio para el curso.

Numérico. Por ejemplo: 10 MB serían 10485760 bytes.

UID de lote de asociación primaria

Requerido: No

Único: Sí

Encabezado: external_association_key

Descripción: Clave externa del nodo con el que debe asociarse el curso de manera principal. El curso usa los valores predeterminados de herramienta del nodo para crear sus propios ajustes. Este es el mismo campo que "external_association_key" de la fuente de asociación del curso, excepto que esta es la asociación "primaria", lo que significa que se copiarán sus valores predeterminados de configuración de la herramienta cuando se cree el curso.

Los encabezados mínimos necesarios para crear cursos que deben asociarse con un nodo de la jerarquía institucional son los siguientes:

external_course_key

course_id

course_name

external_association_key

primary_external_node_key

UID de lote de nodo primario

Requerido: No

Único: No

Encabezado: primary_external_node_key

Descripción: Este es el mismo campo que "external_node_key" de la introducción de asociación del curso, excepto porque esta es la asociación primaria.

Los encabezados mínimos necesarios para crear cursos que deben asociarse con un nodo de la jerarquía institucional son los siguientes:

external_course_key

course_id

course_name

external_association_key

primary_external_node_key

Longitud máxima: 256

UID de lote de sustitución

Requerido: No

Único: Sí

Encabezado: new_external_course_key

Descripción: Este campo solo se usa en las contadas ocasiones en las que cambia el valor de EXTERNAL KEY del curso o de la organización.

Longitud máxima 64. Debe ser único. Se aceptan caracteres de varios bytes.

UID de lote de la fuente de datos de sustitución

Requerido: No

Único: No

Encabezado: new_data_source_key

Descripción: Nueva clave utilizada para establecer la agrupación de elementos de usuario. Sustituye el orden de datos existente y asocia los datos con el grupo designado por la clave de origen de datos de sustitución especificada. Nota: El campo de asignación de la interfaz de usuario para el UID de lote de origen de datos de reemplazo es 'script.flatfile.CourseReplacementDataSourceBatchUid'

Estado de fila

Requerido: No

Único: No

Encabezado: row_status

Descripción: Establece el valor del registro en uno de los siguientes: Habilitado: Acceso normal al registro. Deshabilitado: el registro está visible en algunas áreas de la interfaz de usuario, pero no se puede cambiar ni acceder a él. Eliminado: el registro está programado para ser eliminado.

Valores admitidos: "enabled", "disabled", "deleted"

Mostrar en catálogo

Requerido: No

Único: No

Encabezado: catalog_ind

Descripción: Establece si el curso o la organización aparecen en el catálogo.

Valores admitidos: 'Y', 'N'

Clave de copia de curso de origen/Clave de copia de la organización de origen

Requerido: No

Único: No

Encabezado: template_course_key.template_organization_key

Descripción: Clave externa de la fuente del contenido para operaciones de copia.

Longitud máxima 64. Se aceptan caracteres de varios bytes.

Fecha de inicio

Requerido: No

Único: No

Encabezado: start_date

Descripción: Fecha en la que se inicia el acceso a la sección del Curso.

Formato: aaaammdd

Período

Requerido: No

Único: No

Encabezado: term_key

Descripción: Valor EXTERNAL_TERM_KEY asociado

Longitud máxima: 256.

Usar disponibilidad de términos

Requerido: No

Único: No

Encabezado: use_term_availability_ind

Descripción: Bandera para seguir el PERÍODO asociado para la disponibilidad del curso. Si tiene el valor Y, entonces se usa el período de available_ind, startdate y enddate; en caso de ser N, se usan los ajustes del curso.

Valores admitidos: 'Y', 'N'

TOP

LEARN Object: Course and Organization Membership

Nota

Los cursos y organizaciones necesitan los mismos campos. Los encabezados son específicos según se esté creando un curso o una organización; tenga en cuenta las diferencias al crear entradas de datos.

Objeto SIS or Sistema de información del estudiante: Membresías de cursos u organizaciones (inscripciones y actividades de personal)

Comportamiento predeterminado de inserción/actualización: inserciones inteligentes o actualizaciones

Comportamiento de eliminación predeterminado: Deshabilitar

Campos de aprendizaje

Uid por lotes del curso o UID de lote de la organización (obligatorio)

Requerido: Sí

Único: No

Encabezado: external_course_key o external_organization_key

Descripción: Esta es la misma clave utilizada para identificar el curso u organización.

Longitud máxima 64. Se aceptan caracteres de varios bytes.

Clave de la fuente de datos (obligatorio) Suministrada por la integración o el archivo de datos.

Requerido: Sí

Único: No

Encabezado: data_source_key

Descripción: Clave utilizada para establecer la agrupación de elementos de usuario. Tenga en cuenta que la configuración de integración puede proporcionar este elemento y, por lo tanto, no ser necesario en el archivo.

Longitud máxima: 256. Se aceptan caracteres de varios bytes.

UID de lote de usuario (obligatorio)

Requerido: Sí

Único: No

Encabezado: external_person_key

Descripción: Este es el valor external_person_key que se usa para identificar al usuario.

Longitud máxima: 64. Se aceptan caracteres de varios bytes.

hasCartridgeAccess

Requerido: No

Único: No

Encabezado: hascartridgeaccess

Descripción: Este campo no es compatible y está destinado a su eliminación. Ignorar. Las nuevas integraciones no deben usar este campo. Las integraciones existentes que lo utilicen deben dejar de hacerlo.

Disponible

Requerido: No

Único: No

Encabezado: available_ind

Descripción: Establece la disponibilidad de inscripción en Blackboard Learn.

Valores admitidos: 'Y', 'N'

URL de imagen

Requerido: No

Único: No

Encabezado: Image_URL

Incluir en la lista

Requerido: No

Único: No

Encabezado: roster_ind

Descripción: Marca que indica si el usuario se muestra en la lista.

Valores admitidos: 'Y', 'N'

Introducción

Requerido: No

Único: No

Encabezado: intro

Descripción: Información de introducción para la página de inicio del usuario dentro del curso.

Longitud máxima: 4000. Se aceptan caracteres de varios bytes.

Anotaciones

Requerido: No

Único: No

Encabezado: notes

Descripción: Información pertinente para este usuario que puede afectar la participación del curso o de la organización.

Sin limitación. Se aceptan caracteres de varios bytes.

Información personal

Requerido: No

Único: No

Encabezado: pinfo

Descripción: Información personal para la página de inicio del usuario.

Sin limitación. Se aceptan caracteres de varios bytes.

Profesor principal

Requerido: No

Único: No

Encabezado: primary_instructor

Descripción: Indica que la membresía es un profesor principal. El miembro debe tener un rol del curso con el indicador "tratar como profesor". Si el miembro no es profesor o no tiene este indicador, la opción no aparece. Si se asigna un rol de curso que no tiene el indicador "tratar como profesor", se rechaza la Y en el registro de afiliación.

Valores admitidos: 'Y', 'N'

Recibir mensaje de correo electrónico

Requerido: No

Único: No

Encabezado: receive_email_ind

Descripción: marca si el correo electrónico está habilitado para este usuario.

Valores admitidos: 'Y', 'N'

UID de lote de la fuente de datos de sustitución

Requerido: No

Único: No

Encabezado: new_data_source_key

Descripción: Nueva clave utilizada para establecer la agrupación de elementos de datos. Sustituye el orden de datos existente y asocia los datos con el grupo designado por la clave de origen de datos de sustitución especificada. Nota: El campo de asignación de la interfaz de usuario para el UID de lote de origen de datos de reemplazo es 'script.flatfile.MemberReplacementDataSourceBatchUid'

Rol

Requerido: No

Único: No

Encabezado: role

Descripción: el rol del usuario en el curso.

Valores admitidos: "Instructor", "teaching_assistant", "course_builder", "Grader", "Student", "guest", "none"

Estado de fila

Requerido: No

Único: No

Encabezado: row_status

Valores admitidos: "enabled", "disabled", "deleted"

Descripción de sitio web 1

Requerido: No

Único: No

Encabezado: link_description_1

Descripción: Descripción para el sitio web del usuario

Longitud máxima: 255

Sitio web 1 Nombre

Requerido: No

Único: No

Encabezado: link_name_1

Descripción: Nombre utilizado en el enlace al sitio web del usuario

Longitud máxima: 100.

URL del sitio web 1

Requerido: No

Único: No

Encabezado: link_url_1

Descripción: URL utilizada en el enlace al sitio web del usuario

Longitud máxima: 100.

Sitio web 2 Descripción

Requerido: No

Único: No

Encabezado: link_description_2

Descripción: Descripción para el sitio web del usuario

Longitud máxima: 255

Sitio web 2 Nombre

Requerido: No

Único: No

Encabezado: link_name_2

Descripción: Nombre utilizado en el enlace al sitio web del usuario

Longitud máxima: 100.

URL del sitio web 2

Requerido: No

Único: No

Encabezado: link_url_2

Descripción: URL utilizada en el enlace al sitio web del usuario

Longitud máxima: 100.

Sitio web 3 Descripción

Requerido: No

Único: No

Encabezado: link_description_3

Descripción: Descripción para el sitio web del usuario

Longitud máxima: 255

Sitio web 3 Nombre

Requerido: No

Único: No

Encabezado: link_name_3

Descripción: Nombre utilizado en el enlace al sitio web del usuario

Longitud máxima: 100.

URL del sitio web 3

Requerido: No

Único: No

Encabezado: link_url_3

Descripción: URL utilizada en el enlace al sitio web del usuario

Longitud máxima: 100.

TOP

LEARN Object: Term

SIS o Sistema de información del estudiante Objeto:Término

Comportamiento predeterminado de inserción/actualización: inserciones inteligentes o actualizaciones

Comportamiento de eliminación predeterminado: Deshabilitar

Campos de aprendizaje

UID de lote (obligatorio)

Requerido: Sí

Único: Sí

Encabezado: external_term_key

Descripción: Nombre corto utilizado por la institución para identificar de manera única el término. Este elemento no se muestra a los usuarios. Solo puede contener letras, dígitos, guiones y puntos. No se permiten espacios u otros signos de puntuación.

Longitud máxima: 256. Se aceptan caracteres de varios bytes.

Clave de la fuente de datos (obligatorio) Suministrada por la integración o el archivo de datos.

Requerido: Sí

Único: No

Encabezado: data_source_key

Descripción: Clave utilizada para establecer la agrupación de elementos término. Tenga en cuenta que la configuración de integración puede proporcionar este elemento y, por lo tanto, no ser necesario en el archivo.

Longitud máxima: 256. Se aceptan caracteres de varios bytes.

Nombre (obligatorio)

Requerido: Sí

Único: No

Encabezado: name

Descripción: Nombre del término.

Longitud máxima: 333.

daysOfUse

Requerido: No

Único: No

Encabezado: days_of_use

Descripción: Número de días que los estudiantes pueden acceder al curso después de la inscripción. Útil para el aprendizaje autodidacta.

Numérico.

Disponible

Requerido: No

Único: No

Encabezado: available_ind

Descripción: Determina la disponibilidad del período. Si se establece en "N", los objetos asociados no estarán disponibles.

Valores admitidos: 'Y', 'N'

Descripción

Requerido: No

Único: No

Encabezado: descripción

Descripción: Descripción del término

Sin limitación.

Duración

Requerido: No

Único: No

Encabezado: duración

Descripción: Ventana de disponibilidad de períodos de programas.

Las opciones son las siguientes:

Continuo: El Término siempre está accesible.
Intervalo: el período es válido en los días entre START_DATE y END_DATE. La fecha de inicio o la fecha de finalización se puede dejar abierta para que el período sea válido a partir de una fecha determinada o hasta una fecha determinada.
Fijo: el período es válido durante una cantidad determinada de días (DAYS_OF_USE).

Valores admitidos: Continuo, Rango, Fijo

Fecha de finalización

Requerido: No

Único: No

Encabezado: end_date

Descripción: Esta es la fecha en que el período deja de estar disponible para acceder.

Formato: aaaammdd

UID de lote de sustitución

Requerido: No

Único: Sí

Encabezado: new_external_term_key

Descripción: Este campo solo se usa en las contadas ocasiones en las que cambia el valor de EXTERNAL KEY de un período.

Longitud máxima: 256. Se aceptan caracteres de varios bytes.

UID de lote de la fuente de datos de sustitución

Requerido: No

Único: No

Encabezado: new_data_source_key

Descripción: Nueva clave utilizada para establecer la agrupación de elementos de datos. Sustituye el orden de datos existente y asocia los datos con el grupo designado por la clave de origen de datos de sustitución especificada. Nota: El campo de asignación de la interfaz de usuario para el UID de lote de la fuente de datos de reemplazo es 'script.flatfile.TermReplacementDataSourceBatchUid'

Estado de fila

Requerido: No

Único: No

Encabezado: row_status

Descripción: establece el valor del registro en uno de los siguientes:

Habilitado: acceso normal al registro.
Deshabilitado: el registro está visible en algunas áreas de la interfaz de usuario, pero no se puede cambiar ni acceder a él.
Eliminado: el registro está programado para ser eliminado.

Valores admitidos: "enabled", "disabled", "deleted"

Fecha de inicio

Requerido: No

Único: No

Encabezado: start_date

Descripción: Esta es la fecha en que el término comienza a estar disponible para acceder.

Formato: aaaammdd

TOP

LEARN Object: Secondary Institution Role Association

Objeto SIS or Sistema de información del estudiante:Rol de la institución secundaria del usuario

Comportamiento predeterminado de inserción/actualización: inserciones inteligentes o actualizaciones

Comportamiento de eliminación predeterminado: Deshabilitar

Campos de aprendizaje

Clave de la fuente de datos (obligatorio) Suministrada por la integración o el archivo de datos.

Requerido: Sí

Único: No

Encabezado: data_source_key

Longitud máxima: 256. Se aceptan caracteres de varios bytes.

ID de rol de institución secundaria (obligatorio)

Requerido: Sí

Único: No

Encabezado: role_id

Descripción: identificador de la función de institución secundaria para esta asociación.

UID de lote de usuario (obligatorio)

Requerido: Sí

Único: No

Encabezado: external_person_key

Descripción: El valor external_person_key (batch_uid) del usuario que se utilizará para esta asociación.

Longitud máxima 64.

UID de lote de la fuente de datos de sustitución

Requerido: No

Único: No

Encabezado: new_data_source_key

Estado de fila

Requerido: No

Único: No

Encabezado: row_status

Valores admitidos: "enabled", "disabled", "deleted"

TOP

LEARN Object: Observer Association

SIS or Sistema de información del estudiante Objeto:Asociación de observadores

Comportamiento predeterminado de inserción/actualización: inserciones inteligentes o actualizaciones

Comportamiento de eliminación predeterminado: Deshabilitar

Campos de aprendizaje

Clave de la fuente de datos (obligatorio) Suministrada por la integración o el archivo de datos.

Requerido: Sí

Único: No

Encabezado: data_source_key

Longitud máxima: 256. Se aceptan caracteres de varios bytes.

Estudiante observado (Obligatorio)

Requerido: Sí

Único: No

Encabezado: external_user_key

Descripción: El valor external_person_key (batch_uid) del usuario que se utilizará para esta asociación. Un identificador único para un usuario con el rol institucional de estudiante en la institución. La institución proporciona este ID, que no se muestra a los usuarios.

Longitud máxima 64. Se aceptan caracteres de varios bytes.

Observador (Obligatorio)

Requerido: Sí

Único: No

Encabezado: external_observer_key

Descripción: El valor external_person_key (batch_uid) del observador que se utilizará para esta asociación. Un identificador único para un usuario con el rol del sistema de observador en la institución.

Longitud máxima 64. Se aceptan caracteres de varios bytes.

UID de lote de la fuente de datos de sustitución

Requerido: No

Único: No

Encabezado: new_data_source_key

Estado de fila

Requerido: No

Único: No

Encabezado: row_status

Valores admitidos: "enabled", "disabled", "deleted"

TOP

LEARN Object: Category

Objeto SIS or Sistema de información del estudiante:Categoría del curso

Comportamiento predeterminado de inserción/actualización: inserciones inteligentes o actualizaciones

Comportamiento de eliminación predeterminado: Deshabilitar

Campos de aprendizaje

dataSourceBatchUid (obligatorio)

Requerido: Sí

Único: No

Encabezado: data_source_key

Descripción: Clave utilizada para establecer la agrupación de elementos de categoría.

Se aceptan caracteres de varios bytes.

título (Obligatorio)

Requerido: Sí

Único: No

Encabezado: title

Descripción: el nombre de la categoría tal como aparecerá para los usuarios dentro de la interfaz de usuario.

Longitud máxima: 255. Se aceptan caracteres de varios bytes.

UID de lote (obligatorio)

Requerido: Sí

Único: Sí

Encabezado: external_category_key

Descripción: Debe ser único. Tenga en cuenta que este campo se corresponde con el campo de nombre nemotécnico de la categoría en la interfaz de usuario.

Longitud máxima 64. Se aceptan caracteres de varios bytes.

descripción

Requerido: No

Único: No

Encabezado: descripción

Descripción: Descripción de la categoría.

frontPageInd

Requerido: No

Único: No

Encabezado: frontpage_ind

Descripción: Determina si la categoría se muestra o no en la página principal del catálogo.

Valores admitidos: 'Y', 'N'

isAvailable

Requerido: No

Único: No

Encabezado: available_ind

Descripción: Establece la disponibilidad de la categoría dentro de Blackboard Learn.

Valores admitidos: 'Y', 'N'

isRestricted

Requerido: No

Único: No

Encabezado: restrict_ind

Descripción: Marca si el curso o la organización están restringidos a los miembros.

Valores admitidos: 'Y', 'N'

parentBatchUid

Requerido: No

Único: No

Encabezado: parent_category_key

Descripción: El valor EXTERNAL_CATEGORY_KEY que corresponde a la categoría principal de esta categoría secundaria.

Longitud máxima 64.

rowStatus

Requerido: No

Único: No

Encabezado: row_status

Valores admitidos: "enabled", "disabled", "deleted"

UID de lote de sustitución

Requerido: No

Único: Sí

Encabezado: new_external_category_key

Descripción: designa el reemplazo de la clave actual.

Longitud máxima 64. Se aceptan caracteres de varios bytes.

UID de lote de la fuente de datos de sustitución

Requerido: No

Único: No

Encabezado: new_data_source_key

TOP

LEARN Object: Category Membership

Objeto SIS or Sistema de información del estudiante: Pertenencia a categorías

Comportamiento predeterminado de inserción/actualización: inserciones inteligentes o actualizaciones

Comportamiento de eliminación predeterminado: Deshabilitar

Campos de aprendizaje

UID de lote (obligatorio)

Requerido: Sí

Único: Sí

Descripción: Se rellena automáticamente. No usar en introducciones de datos.

Categoría UID de lote (obligatorio)

Requerido: Sí

Único: No

Encabezado: external_category_key

Descripción: El valor EXTERNAL KEY (batch_uid) de la categoría a la que se agregará el curso o la organización.

Longitud máxima 64.

Uid por lotes del curso o UID de lote de la organización (obligatorio)

Requerido: Sí

Único: No

Encabezado: external_course_key

Descripción: external_organization_key El valor EXTERNAL KEY (batch_uid) del curso u organización que se está clasificando.

Longitud máxima 64.

Clave de la fuente de datos (obligatorio) Suministrada por la integración o el archivo de datos.

Requerido: Sí

Único: No

Encabezado: data_source_key

Se aceptan caracteres de varios bytes.

Está disponible

Requerido: No

Único: Sí

Encabezado: available_ind

Descripción: Establece la disponibilidad de la categoría dentro de Blackboard Learn.

Valores admitidos: 'Y', 'N'

UID de lote de la fuente de datos de sustitución

Requerido: No

Único: No

Encabezado: new_data_source_key

Estado de fila

Requerido: No

Único: No

Encabezado: row_status

Valores admitidos: "enabled", "disabled", "deleted"

TOP

LEARN Object: Hierarchy Node

Objeto SIS or Sistema de información del estudiante: Nodo de jerarquía

Comportamiento predeterminado de inserción/actualización: inserciones inteligentes o actualizaciones

Comportamiento de eliminación predeterminado: purgar

Campos de aprendizaje

Los encabezados mínimos necesarios para crear un nodo de la jerarquía institucional son los siguientes:

external_node_key
data_source_key
parent_node_key
nombre

UID de lote (obligatorio)

Requerido: Sí

Único: Sí

Encabezado: external_node_key

Descripción: Identificador utilizado por la institución para identificar de forma única el nodo jerárquico. Este elemento no se muestra a los usuarios. Solo puede contener letras, dígitos, guiones y puntos. No se permiten espacios u otros signos de puntuación.

Longitud máxima: 255. Se aceptan caracteres de varios bytes.

Clave de la fuente de datos (obligatorio) Suministrada por la integración o el archivo de datos.

Requerido: Sí

Único: No

Encabezado: data_source_key

Longitud máxima: 255. Se aceptan caracteres de varios bytes.

UID de lote principal (obligatorio)

Requerido: Sí

Único: No

Encabezado: parent_node_key

Descripción: Valor external_node_key (batch_uid) principal de este nodo.

Longitud máxima 64.

Nombre (obligatorio)

Requerido: Sí

Único: No

Encabezado: name

Descripción: Nombre del nodo

Longitud máxima: 255

Descripción

Requerido: No

Único: No

Encabezado: descripción

Descripción: Descripción del nodo

Longitud máxima: 1000.

UID de lote de sustitución

Requerido: No

Único: Sí

Encabezado: new_external_node_key

Descripción: Este campo solo se usa en las contadas ocasiones en las que cambia el valor EXTERNAL KEY de un nodo.

Longitud máxima: 255. Debe ser único. Se aceptan caracteres de varios bytes.

UID de lote de la fuente de datos de sustitución

Requerido: No

Único: No

Encabezado: new_data_source_key

TOP

LEARN Object: Hierarchy User Association

Objeto SIS or Sistema de información del estudiante: Asociación de usuarios

Comportamiento predeterminado de inserción/actualización: inserciones inteligentes o actualizaciones

Comportamiento de eliminación predeterminado: purgar

Campos de aprendizaje

Los encabezados mínimos necesarios para asociar usuarios a un nodo de jerarquía institucional son los siguientes:

external_user_key
external_node_key
external_association_key
data_source_key

Clave de la fuente de datos (obligatorio) Suministrada por la integración o el archivo de datos.

Requerido: Sí

Único: No

Encabezado: data_source_key

Longitud máxima: 255. Se aceptan caracteres de varios bytes.

UID de lote (obligatorio)

Requerido: Sí

Único: Sí

Encabezado: external_association_key

Descripción: el identificador de asociación, que es el identificador único de la asociación de usuario a nodo. A menudo, una concatenación de los valores de UID de lote de usuario y UID de lote de nodo para garantizar la unicidad cuando un usuario se puede asignar a más de un nodo.

Longitud máxima 64.

UID de lote de nodo (obligatorio)

Requerido: Sí

Único: No

Encabezado: external_node_key

Descripción: El nodo de esta asociación, que también es el identificador de nodo que se puede encontrar en el área 'Editar nodo' en la GUI

Longitud máxima: 64.

UID de lote de usuario (obligatorio)

Requerido: Sí

Único: No

Encabezado: external_user_key

Descripción: El valor external_person_key (batch_uid) del usuario que se asociará con este nodo.

Longitud máxima: 64.

UID de lote de sustitución

Requerido: No

Único: Sí

Encabezado: new_external_association_key

Descripción: Este campo solo se usa en las contadas ocasiones en las que cambia el valor EXTERNAL KEY de una asociación.

Longitud máxima 64. Se aceptan caracteres de varios bytes.

UID de lote de la fuente de datos de sustitución

Requerido: No

Único: No

Encabezado: new_data_source_key

TOP

LEARN Object: Hierarchy Course Association

Objeto SIS or Sistema de información del estudiante: Asociación de cursos

Comportamiento predeterminado de inserción/actualización: inserciones inteligentes o actualizaciones

Comportamiento de eliminación predeterminado: purgar

Campos de aprendizaje

Los encabezados mínimos necesarios para asociar cursos a un nodo de jerarquía institucional son los siguientes:

external_course_key
external_node_key
external_association_key
data_source_key

UID de lote (obligatorio)

Requerido: Sí

Único: Sí

Encabezado: external_association_key

Descripción: Cada asociación de curso y nodo debe tener un valor único que identifique esta relación. El UID de lote es el identificador único de la relación curso-nodo.

Longitud máxima 64.

Curso UID de lote (Obligatorio)

Requerido: Sí

Único: No

Encabezado: external_course_key

Descripción: El valor external_course_key (batch_uid) del curso que se asociará con este nodo.

Longitud máxima 64.

Clave de la fuente de datos (obligatorio) Suministrada por la integración o el archivo de datos.

Requerido: Sí

Único: No

Encabezado: data_source_key

Descripción: Clave utilizada para establecer la agrupación de elementos. Tenga en cuenta que la configuración de integración puede proporcionar este elemento y, por lo tanto, no ser necesario en el archivo.

Longitud máxima: 255. Se aceptan caracteres de varios bytes.

UID de lote de nodo (obligatorio)

Requerido: Sí

Único: No

Encabezado: external_node_key

Descripción: el nodo de esta asociación.

Longitud máxima 64. Se aceptan caracteres de varios bytes.

Indicador de asociación primario

Requerido: No

Único: No

Encabezado: is_primary_association

Descripción: Marca que designa esta asociación como la asociación principal cuando se pueden especificar otras.

Valores admitidos: 'Y', 'N'.

UID de lote de sustitución

Requerido: No

Único: Sí

Encabezado: new_external_association_key

Descripción: Este campo solo se usa en las contadas ocasiones en las que cambia el valor EXTERNAL KEY de una asociación.

Longitud máxima 64. Se aceptan caracteres de varios bytes.

UID de lote de la fuente de datos de sustitución

Requerido: No

Único: No

Encabezado: new_data_source_key

TOP

LEARN Object: Goal Association

SIS or Sistema de información del estudiante Objeto: Asociación de meta

Comportamiento predeterminado de inserción/actualización: inserciones inteligentes o actualizaciones

Comportamiento de eliminación predeterminado: purgar

Campos de aprendizaje

UID de lote (obligatorio)

Requerido: Sí

Único: Sí

Encabezado: este elemento no tiene encabezado, se completa automáticamente. Ignorar en las fuentes de integraciones.

Descripción: Un identificador único para la relación entre el curso y la meta (estándar).

Longitud máxima 64.

Curso UID de lote (Obligatorio)

Requerido: Sí

Único: No

Encabezado: course_key

Descripción: El identificador único (external_course_key) para el curso al que se asociará la meta (estándar).

Longitud máxima 64.

Clave de la fuente de datos (obligatorio) Suministrada por la integración o el archivo de datos.

Requerido: Sí

Único: No

Encabezado: data_source_key

Longitud máxima: 255. Se aceptan caracteres de varios bytes.

Conjunto de submeta (obligatorio)

Requerido: Sí

Único: No

Encabezado: std_sub_doc_key

Descripción: El identificador único para la meta (estándar) que se asociará a un curso.

Longitud máxima 64.

UID de lote de la fuente de datos de sustitución

Requerido: No

Único: No

Encabezado: new_data_source_key

Snapshot Flat File Header Descriptions

Objeto LEARN: Usuario

Learn Fields

LEARN Object: Course and Organization

Campos de aprendizaje

LEARN Object: Course and Organization Membership

Nota

Campos de aprendizaje

LEARN Object: Term

Campos de aprendizaje

LEARN Object: Secondary Institution Role Association

Campos de aprendizaje

LEARN Object: Observer Association

Campos de aprendizaje

LEARN Object: Category

Campos de aprendizaje

LEARN Object: Category Membership

Campos de aprendizaje

LEARN Object: Hierarchy Node

Campos de aprendizaje

LEARN Object: Hierarchy User Association

Campos de aprendizaje

LEARN Object: Hierarchy Course Association

Campos de aprendizaje

LEARN Object: Goal Association

Campos de aprendizaje

Resultados de la búsqueda