Skip to main content

Descrições de cabeçalho do arquivo simples do Snapshot

Note

Ao utilizar um leitor de tela, recomendamos utilizar Chrome e JAWS ou NVDA no Windows e utilizar Safari e VoiceOver em um Mac .

O arquivo simples do Snapshot fornece a capacidade de integração usando os objetos de dados do LEARN mais recentes. Veja abaixo uma lista completa de objetos suportados, suas convenções de nomenclatura de UI para cabeçalho de alimentação, descrição de uso e requisitos de dados.

Como o feed de dados é um arquivo de texto, todos os dados são representados como uma sequência de caracteres. Em alguns casos, é preciso ficar atento à formatação e comprimento específicos. Sempre que exigidos pelo campo, os valores compatíveis são fornecidos. Os campos obrigatórios são destacados e observados.

Objeto de aprendizagem do usuário

Note

Ao utilizar um leitor de tela, recomendamos utilizar Chrome e JAWS ou NVDA no Windows e utilizar Safari e VoiceOver em um Mac .

Objeto LEARN: Usuário

Objeto do Sistema de informações do aluno (SIA): Pessoa

Comportamento padrão de inserção/atualização: inserções inteligentes ou atualizações

Comportamento de exclusão padrão: desabilitar

Campos do Learn

Batch Uid (Required)

Required: Yes

Unique: Yes

Cabeçalho: external_person_key

Descrição: Um identificador exclusivo para um usuário na instituição. Esse código é fornecido pela instituição e não é exibido para os usuários.

É altamente recomendável que os dados-chave sejam um identificador permanente e não mutável para cada usuário. Um exemplo de uma boa chave é um código de aluno permanente atribuído quando a pessoa se inscreve na instituição. Observe que o banco de dados não pode mesclar dados entre contas distintas.

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)

Obrigatório: Sim

Único: Não

Cabeçalho: firstname

Descrição: O nome do usuário.

Limite máximo: 100. Caracteres multibyte aceitos.

Sobrenome (Obrigatório)

Obrigatório: Sim

Único: Não

Cabeçalho: lastname

Descrição: O sobrenome do usuário.

Limite máximo: 100. Caracteres multibyte aceitos.

Nome de usuário (Obrigatório)

Obrigatório: Sim

Único: Sim

Cabeçalho: user_id

Descrição: O nome de usuário usado para fazer login no Blackboard LMS. O nome de usuário deve ser exclusivo.

Limite máximo: 50. Caracteres multibyte aceitos.

Pronúncia do nome

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.

Limite máximo: 32. Caracteres multibyte aceitos.

Nome do domínio

Obrigatório: Não

Único: Não

Cabeçalho: domain_name

Descrição: O nome do host da marca a ser usado em e-mails de notificação antes que o usuário faça logon. O valor deve ser um dos nomes de host configurados para o sistema. Os valores inválidos são ignorados sem aviso e o usuário será criado com o valor de nome do host padrão. Definido somente na inserção, as atualizações são ignoradas. (formato, por exemplo, 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.

Data de término

Obrigatório: Não

Único: Não

Cabeçalho: end_date

Descrição: Data em que o acesso ao curso termina.

Limite máximo: 100. Caracteres multibyte aceitos.

Forçar Pacote de Idioma

Obrigatório: Não

Único: Não

Cabeçalho: locale_enforced

Descrição: Um sinalizador que determina se o pacote de idiomas é aplicado quando um usuário acessa o curso. Se o pacote de idiomas não for aplicado, o usuário poderá visualizar o curso usando o pacote de idiomas que preferir.

Valores suportados: "K-8", "ensino médio", "calouro", "segundo ano", "terceiro ano", "quarto ano", "pós-graduação", "pós-pós-graduação"

Código de acesso à inscrição

Obrigatório: Não

Único: Não

Cabeçalho: enroll_access_code

Descrição: O endereço de e-mail do usuário. Blackboard recomenda que user_email não seja nulo. Usuários sem endereço de e-mail não podem enviar e-mails.

Comprimento máximo: 50.

Nome da instituição

Obrigatório: Não

Único: Sim

Cabeçalho: inst_email

Descrição: O endereço de e-mail institucional do usuário. O campo inst_email pode ser definido como nulo. Nenhuma comunicação por e-mail é enviada para o inst_email.

Comprimento máximo: 254

Pronomes

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

Gênero

Obrigatório: Não

Único: Não

Cabeçalho: gender

Descrição: O gênero do usuário.

Valores suportados: "Not Disclosed" (Não divulgado), "Male" (Masculino), "Female" (Feminino)

Telefone Residencial

Obrigatório: Não

Único: Não

Cabeçalho: h_phone_1

Descrição: O número de telefone residencial do usuário.

Limite máximo: 50. Caracteres multibyte aceitos.

Telefone residencial (secundário)

Obrigatório: Não

Único: Não

Cabeçalho: h_phone_2

Descrição: Um número de telefone residencial adicional associado ao usuário.

Limite máximo: 50. Caracteres multibyte aceitos.

Cargo

Obrigatório: Não

Único: Não

Cabeçalho: job_title

Descrição: O cargo associado ao usuário.

Limite máximo: 100. Caracteres multibyte aceitos.

Nome do meio

Obrigatório: Não

Único: Não

Cabeçalho: middlename

Descrição: O nome da mídia fornecido pelo usuário.

Limite máximo: 100. Caracteres multibyte aceitos.

Celular

Obrigatório: Não

Único: Não

Cabeçalho: m_phone

Descrição: o número do telefone celular do usuário.

Limite máximo: 50. Caracteres multibyte aceitos.

Outro nome

Obrigatório: Não

Único: Não

Cabeçalho: othername

Descrição: Este é o nome alternativo preferido do usuário.

Max length: 100.

Tipo de criptografia de senha

Obrigatório: Não

Único: Não

Cabeçalho: pwencryptiontype

Descrição: Esse campo define o tipo de criptografia de senha usado para criptografar a senha no banco de dados.

Os valores suportados são: MD5, SSHA

Função primária da instituição

Obrigatório: Não

Único: Não

Cabeçalho: institution_role

Descrição: A função primária do usuário da instituição, que determina a visualização do usuário dos módulos do portal e de outros itens.

Consulte “Gerenciar funções na instituição” no painel de Administrador do sistema para obter a lista de Funções na instituição válidas no sistema.

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

Cabeçalho: 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 do aluno

Obrigatório: Não

Único: Não

Cabeçalho: student_id

Descrição: Campo de identificador genérico. Esse é um campo somente de exibição.

Limite máximo: 100. Caracteres multibyte aceitos.

Sufixo

Obrigatório: Não

Único: Não

Cabeçalho: suffix

Descrição: O sufixo do nome de usuário.

Limite máximo: 100. Caracteres multibyte aceitos.

Função de sistema

Obrigatório: Não

Único: Não

Cabeçalho: system_role

Descrição: A função administrativa do usuário, que descreve o nível de privilégio de administração do sistema do usuário. A função de “none” não oferece privilégios de administração de sistema ou criação de cursos e é a função mais comum. atribuída.

As seguintes sequências de caracteres são aceitas:

  • Administrador de conta: "account_admin", "accountadmin" ou "user_admin" Suporte ao sistema: "system_support" ou "syssupport"

  • Criador do curso: "course_creator" ou "creator"

  • Suporte: "course_support" ou "support"

  • Convidado: "guest" (convidado)

  • Nenhum: “nenhum”

  • Observador: "observer" (observador)

  • Administrador do portal: "portal_admin" ou "portal"

  • Administrador do sistema: "sys_admin", "sysadmin" ou "system_admin"

  • Administrador de comércio eletrônico: "ecommerce_admin"

  • Administrador do cartão para transações eletrônicas: "card_office_admin"

  • Administrador da loja: "store_admin"

Para criar funções de sistema definidas pelo usuário, corresponda ao "código da função" encontrado em Painel do administrador > Função do sistema. Se não for fornecida uma, o sistema usa como padrão nenhuma.

Título

Obrigatório: Não

Único: Não

Cabeçalho: title

Descrição: O título que o usuário prefere usar.

Limite máximo: 100. Caracteres multibyte aceitos.

Site

Obrigatório: Não

Único: Não

Cabeçalho: webpage

Descrição: O URL da página da Web pessoal do usuário, caso ele tenha uma.

Comprimento máximo: 100

Telefone comercial

Obrigatório: Não

Único: Não

Cabeçalho: b_Phone_1

Descrição: O número de telefone comercial associado ao usuário.

Limite máximo: 50. Caracteres multibyte aceitos.

Telefone comercial (secundário)

Obrigatório: Não

Único: Não

Cabeçalho: b_phone_2

Descrição: Um número de telefone comercial adicional associado ao usuário.

Limite máximo: 50. Caracteres multibyte aceitos.

CEP

Obrigatório: Não

Único: Não

Cabeçalho: zip_code

Descrição: O CEP ou código postal do usuário.

Limite máximo: 50. Caracteres multibyte aceitos.

LEARN OBJECT: Course and Organization

Note

Ao utilizar um leitor de tela, recomendamos utilizar Chrome e JAWS ou NVDA no Windows e utilizar Safari e VoiceOver em um Mac .

SIS Object: Course or Organization

Default Insert/Update behavior: Smart Inserts or Updates

Default Delete Behavior: Disable

Learn Fields

Batch Uid (Required)

Required: Yes

Unique: Yes

Header: external_course_key.external_organization_key

Description: Short name used by the Institution to uniquely identify the Course or Organization section. This is not displayed to users. Can contain only letters, digits, dashes and periods. No spaces or other punctuation allowed. Must be unique for each Course and Organization, and is often the same as the COURSE_ID or ORGANIZATION_ID.

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

Course ID or Organization ID (Required)

Required: Yes

Unique: Yes

Header: course_id or organization_id

Description: Short name used by the institution to uniquely identify the Course or Organization (for example, math101_F99 or ChessClub) The following characters may not be used: space ( ) & / ' +

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

Course Name or Organization Name (Required)

Required: Yes

Unique: No

Header: course_name/organization_name

Description: Complete title of the Course or Organization. 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 Course or organization 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.

Course View

Required: No

Unique: No

Header: course_experience

Description: Determines which course view will appear for new courses. This field is insert only and can't be updated through the SIS framework.

Supported values: Original, Ultra, or Instructor choice.

Organization View

Required: No

Unique: No

Header: organization_experience

Description: Allows clients to select the experience they want to create their organization in. This field is insert only and can't be updated through the SIS framework.

Supported values: Original, Ultra, or Instructor choice.

classificationId

Required: No

Unique: No

Header: classification_key

Description: This determines the classification (subject area and the discipline) of the course. This is an Id representing the primary key for the classification.

Max length 450

hasDescriptionPage

Required: No

Unique: No

Header: desc_page_ind

Description: This field is currently not supported. Integrations should not use this field.

numDaysOfUse

Required: No

Unique: No

Header: days_of_use

Description: Number of days that Students may access the Course after enrollment. Useful for self-paced learning. This value is only used if the duration is set to 'FIXED' and it describes the number of days the course can be used after creation.

Numeric. For example: 120

serviceLevelType

Required: No

Unique: No

Header: service_level

Description: Not typically used in data feeds. Ignore.

Specifies the type of course.

  • C = Community = Organization

  • F = Full = Course

  • R = Registered = (is not used)

  • T = Test_Drive = (is not used)

  • S = System = A course with limited functions to protect data comprising the course.

Supported values: 'F', 'C', 'R','T', 'S'

Allow Guests

Required: No

Unique: No

Header: allow_guest_ind

Description: Allows guest access to the Course.

Supported values: 'Y', 'N'

Allow Observers

Required: No

Unique: No

Header: allow_observer_ind

Description: Allows observer access to the Course.

Supported values: 'Y", 'N'

Available

Required: No

Unique: No

Header: available_ind

Description: Establishes Course or organization availability to Blackboard. If use_term_avail_ind is 'Y', this flag is ignored and this course's availability is determined by its associated term available_ind.

Supported values: 'Y", 'N'

Cross Listed Course Batch Uid

Required: No

Unique: No

Header: master_course_key

Description: Parent course EXTERNAL_COURSE_KEY of which this course is a child.

Max length: 64

Description

Required: No

Unique: No

Header: description

Description: Complete description of the Course.

Max length 4000. Multi byte characters accepted.

Duration

Required: No

Unique: No

Header: duration

Description: This is to indicate if the duration of the course availability is continuous, date range, x days from enrollment, or term-dictated.

Options are:

  • Continuous: 'C' = The Course is always accessible.

  • Range: 'R' = The Course is accessible in the days between one START_DATE and END_DATE. Either the beginning date or the end date can be left open-ended to make a Course accessible from a certain date or until a certain date.

  • Duration: 'D' = N days from enrollment

  • Term: 'T' = term-dictated (the associated term's duration controls this course's duration)

Supported values: "C","R", "D", "T"

Educational Pace

Required: No

Unique: No

Header: pace

Description: Indicates if the Course is Instructor-led or self- paced according to the Student.

Supported values: "Self", "Instructor"

End Date

Required: No

Unique: No

Header: end_date

Description: Date on which access to the Course ends.

Format: yyyymmdd

Enforce Language Pack

Required: No

Unique: No

Header: locale_enforced

Description: A flag that determines if the language pack is enforced when a user accesses the Course. If the language pack is not enforced, the user may view the Course using their preferred language pack.

Supported values: 'Y','N'

Enrollment Access Code

Required: No

Unique: No

Header: enroll_access_code

Description: This is the access code for students to use when enrolling to the course.

Max length 50.

Enrollment End Date

Required: No

Unique: No

Header: enroll_end

Description: Date that enrollment is no longer available to Students.

Format: yyyymmdd

Enrollment Start Date

Required: No

Unique: No

Header: enroll_start

Description: Date that enrollment may begin.

Format: yyyymmdd

Enrollment Type

Required: No

Unique: No

Header: enroll_option

Description: Determines the enrollment method.

Supported values: "instructor", "self", or "email".

Fee

Required: No

Unique: No

Header: fee

Description: Fee associated with this Course or Organization.

Numeric. 11 characters, 2 decimal places. Eg 1500.00

Institution Name

Required: No

Unique: No

Header: institution_name

Description: The name of the institution.

Max length 255. Multi byte characters accepted.

Language Pack

Required: No

Unique: No

Header: locale

Description: Identifier for the preferred language pack. The value is expressed as xx_XX, for example, the French language pack is represented by fr_FR

Max length 20.

Locked Out

Required: No

Unique: No

Header: lockout_ind

Description: Indicates if access to the Course or Organization has been restricted. If set to "Y" access to the Course or organization will be restricted based on the END_DATE and START_DATE.

Supported values: 'Y', 'N'

Maximum disk usage (soft limit)

Required: No

Unique: No

Header: soft_limit

Description: Soft limit on course quota. This setting triggers warning emails when course folder storage reaches the soft_limit specified and course quotas are in effect.

Numeric. eg: 10MB would be 10485760 bytes.

Primary Association Batch Uid

Required: No

Unique: Yes

Header: external_association_key

Description: The external key of the node with which the course should be primarily associated. The course uses that node's tool setting defaults to create its own settings. This is the same field as "external_association_key" from the Course Association feed; except this association is the "primary" one... meaning it will copy its Tool setting defaults on course creation.

The proper minimum required headers for creating courses that are meant to be associated with an Institutional Hierarchy node are:

  • external_course_key

  • course_id

  • course_name

  • external_association_key

  • primary_external_node_key

Primary Node Batch Uid

Required: No

Unique: No

Header: primary_external_node_key

Description: This is the same field as "external_node_key" from the Course Association feed; except this is the primary association.

The proper minimum required headers for creating courses that are meant to be associated with an Institutional Hierarchy node are:

  • external_course_key

  • course_id

  • course_name

  • external_association_key

  • primary_external_node_key

Max length: 256

Replacement Batch Uid

Required: No

Unique: Yes

Header: new_external_course_key

Description: This field is used only on the rare occasions when a Course's or Organization'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 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.CourseReplacementDataSourceBatchUid'

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"

Show In Catalog

Required: No

Unique: No

Header: catalog_ind

Description: Establishes whether the Course or Organization appears in catalog.

Supported values: 'Y', 'N'

Source Course Copy key.Source Organization Copy Key

Required: No

Unique: No

Header: template_course_key.template_organization_key

Description: External key of content source for copy operations.

Max length 64. Multi byte characters accepted.

Start Date

Required: No

Unique: No

Header: start_date

Description: Date on which access to the Course section begins.

Format: yyyymmdd

Term

Required: No

Unique: No

Header: term_key

Description: Associated EXTERNAL_TERM_KEY

Max length 256.

Use Term Availability

Required: No

Unique: No

Header: use_term_availability_ind

Description: Flag to follow associated TERM for availability of course. If Y then the term for available_ind, startdate, and enddate are used; if N then the course settings are used.

Supported values: 'Y', 'N'

Objeto LEARN: Associação a Cursos e Organizações

Note

Ao utilizar um leitor de tela, recomendamos utilizar Chrome e JAWS ou NVDA no Windows e utilizar Safari e VoiceOver em um Mac .

Nota

Cursos e organizações exigem os mesmos campos. O cabeçalho será específico para a criação de um curso ou organização. Observe as diferenças ao criar feeds de dados.

Objeto do Sistema de informações do aluno (SIA): associações de curso ou organização (matrículas e exercícios de equipe)

Comportamento padrão de inserção/atualização: inserções inteligentes ou atualizações

Comportamento de exclusão padrão: desabilitar

Campos do Learn

Uid do código de identificação do lote do curso ou uid do código de identificação do lote da organização (obrigatório)

Obrigatório: Sim

Único: Não

Cabeçalho: external_course_key ou external_organization_key

Descrição: Esta é a mesma chave usada para identificar o Curso ou Organização.

Comprimento máximo: 64. Caracteres multibyte aceitos.

Chave da fonte de dados (obrigatória) fornecida pela integração ou pelo arquivo de dados.

Obrigatório: Sim

Único: Não

Cabeçalho: data_source_key

Descrição: Chave usada para estabelecer o agrupamento de elementos do usuário. Observe que isso pode ser fornecido pela configuração de integração e, portanto, não seria necessário no arquivo.

Comprimento máximo: 256. Caracteres multibyte aceitos.

Código de identificação do lote do usuário (obrigatório)

Obrigatório: Sim

Único: Não

Cabeçalho: external_person_key

Descrição: Este é o external_person_key usado para identificar o usuário.

Comprimento máximo: 64. Caracteres multibyte aceitos.

hasCartridgeAccess

Obrigatório: Não

Único: Não

Cabeçalho: hascartridgeaccess

Descrição: esse campo não é compatível e direcionado para remoção. Ignorar. Novas integrações não devem usar esse campo. Se as integrações existentes utilizarem esse campo, deverão deixar de fazê-lo.

Disponível

Obrigatório: Não

Único: Não

Cabeçalho: available_ind

Descrição: Informa a disponibilidade de inscrições em Blackboard LMS.

Valores suportados: 'Y', 'N'

URL de imagem

Obrigatório: Não

Único: Não

Cabeçalho: Image_URL

Descrição: esse campo não é compatível e direcionado para remoção. Ignorar. Novas integrações não devem usar esse campo. Se as integrações existentes utilizarem esse campo, deverão deixar de fazê-lo.

Incluir na lista de participantes

Obrigatório: Não

Único: Não

Cabeçalho: roster_ind

Descrição: Sinalizador que indica se o usuário é exibido na lista.

Valores suportados: 'Y', 'N'

Introdução

Obrigatório: Não

Único: Não

Cabeçalho: intro

Descrição: Informações de introdução para a página inicial do usuário no curso.

Comprimento máximo: 4000. Caracteres multibyte aceitos.

Observações

Obrigatório: Não

Único: Não

Cabeçalho: notes

Descrição: Informações pertinentes a este usuário que podem impactar na participação do curso ou da organização.

Sem limitações. Caracteres multibyte aceitos.

Informações pessoais

Obrigatório: Não

Único: Não

Cabeçalho: pinfo

Descrição: Informações pessoais para a página inicial do usuário.

Sem limitações. Caracteres multibyte aceitos.

Instrutor principal

Obrigatório: Não

Único: Não

Cabeçalho: primary_instructor

Descrição: indica que a associação é um instrutor principal. Membro deve ser uma função do curso com o sinalizador "tratar como instrutor". Se membro não for instrutor ou não tiver esse sinalizador, a opção não aparecerá. Se estiver atribuindo uma função do curso em que a função do curso não tenha o sinalizador "tratar como instrutor", um Y no registro de associação será rejeitado.

Valores suportados: 'Y', 'N'

Receber e-mail

Obrigatório: Não

Único: Não

Cabeçalho: receive_email_ind

Descrição: sinalize se o e-mail está habilitado para este usuário.

Valores suportados: 'Y', 'N'

Uid de lote de origem de dados de substituição

Obrigatório: Não

Único: Não

Cabeçalho: new_data_source_key

Descrição: nova chave usada para estabelecer o agrupamento de elementos de dados. Substitui dados de associação de fontes de dados existentes ao grupo designado pela chave da fonte de dados de substituição especificada. Observação: o campo de mapeamento da interface do usuário para código de identificação do lote da fonte de dados de substituição é 'script.flatfile.MemberReplacementDataSourceBatchUid'

Função

Obrigatório: Não

Único: Não

Cabeçalho: role

Descrição: A função do usuário no Curso.

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

Status da linha

Obrigatório: Não

Único: Não

Cabeçalho: row_status

Descrição: Define o valor do registro como um dos seguintes: Habilitado: Acesso normal ao registro. Desabilitado: o registro é visível em algumas áreas da interface do usuário, mas não pode ser alterado ou acessado. Excluído: o registro está programado para ser excluído.

Valores possíveis: "habilitado", "desabilitado", "excluído"

Descrição do site 1

Obrigatório: Não

Único: Não

Cabeçalho: link_description_1

Descrição: Descrição do site do usuário

Comprimento máximo: 255

Nome do site 1

Obrigatório: Não

Único: Não

Cabeçalho: link_name_1

Descrição: Nome usado no link para o site do usuário

Comprimento máximo: 100

URL do site 1

Obrigatório: Não

Único: Não

Cabeçalho: link_url_1

Descrição: URL usado no link para o site do usuário

Comprimento máximo: 100

Descrição do site 2

Obrigatório: Não

Único: Não

Cabeçalho: link_description_2

Descrição: Descrição do site do usuário

Comprimento máximo: 255

Nome do site 2

Obrigatório: Não

Único: Não

Cabeçalho: link_name_2

Descrição: Nome usado no link para o site do usuário

Comprimento máximo: 100

URL do site 2

Obrigatório: Não

Único: Não

Cabeçalho: link_url_2

Descrição: URL usado no link para o site do usuário

Comprimento máximo: 100

Descrição do site 3

Obrigatório: Não

Único: Não

Cabeçalho: link_description_3

Descrição: Descrição do site do usuário

Comprimento máximo: 255

Nome do site 3

Obrigatório: Não

Único: Não

Cabeçalho: link_name_3

Descrição: Nome usado no link para o site do usuário

Comprimento máximo: 100

URL do site 3

Obrigatório: Não

Único: Não

Cabeçalho: link_url_3

Descrição: URL usado no link para o site do usuário

Comprimento máximo: 100

APRENDER Objeto: Termos

Note

Ao utilizar um leitor de tela, recomendamos utilizar Chrome e JAWS ou NVDA no Windows e utilizar Safari e VoiceOver em um Mac .

Objeto Sistema de informações do aluno (SIA):Termo

Comportamento padrão de inserção/atualização: inserções inteligentes ou atualizações

Comportamento de exclusão padrão: desabilitar

Campos do Learn

Código de identificação do lote (obrigatório)

Obrigatório: Sim

Único: Sim

Cabeçalho: external_term_key

Descrição: Nome abreviado usado pela instituição para identificar exclusivamente o termo. Não é exibido aos usuários. Pode conter apenas letras, dígitos, traços e pontos. Nenhum espaço ou outra pontuação permitida.

Comprimento máximo: 256. Caracteres multibyte aceitos.

Chave da fonte de dados (obrigatória) fornecida pela integração ou pelo arquivo de dados.

Obrigatório: Sim

Único: Não

Cabeçalho: data_source_key

Descrição: Chave usada para estabelecer o agrupamento de elementos Term. Observe que isso pode ser fornecido pela configuração de integração e, portanto, não seria necessário no arquivo.

Comprimento máximo: 256. Caracteres multibyte aceitos.

Nome (Obrigatório)

Obrigatório: Sim

Único: Não

Cabeçalho: name

Descrição: Nome do termo.

Comprimento máximo: 333

daysOfUse

Obrigatório: Não

Único: Não

Cabeçalho: days_of_use

Descrição: Número de dias que os Alunos podem acessar o Curso após a matrícula. Útil para aprendizagem individualizada.

Valores suportados: Numérico.

Disponível

Obrigatório: Não

Único: Não

Cabeçalho: available_ind

Descrição: determina a disponibilidade do prazo. Se estiver definida para “N”, os objetos associados não estarão disponíveis.

Valores suportados: 'Y', 'N'

Descrição

Obrigatório: Não

Único: Não

Cabeçalho: description

Descrição: Descrição do termo

Sem limitações.

Duração

Obrigatório: Não

Único: Não

Cabeçalho: duration

Descrição: Janela de disponibilidade de período de agendamento.

As opções são:

  • Contínuo: O Termo está sempre acessível.

  • Intervalo: O Termo é válido nos dias entre uma START_DATE e END_DATE. A data de início ou de término pode ser deixada em aberto para tornar um período acessível a partir de uma determinada data ou até uma determinada data.

  • Fixo: O Período é válido por um determinado número de dias (DAYS_OF_USE).

Valores suportados: Continuous, Range, Fixed

Data de término

Obrigatório: Não

Único: Não

Cabeçalho: end_date

Descrição: Esta é a data em que o termo deixa de estar disponível para acesso.

Formato: aaaammdd

UID do lote do termo pai

Obrigatório: Não

Único: Não

Cabeçalho: external_parent_term_key

Descrição: O EXTERNAL_TERM_KEY que representa o Termo pai do qual esse Termo é um filho. Usado para estabelecer relações hierárquicas de termos. Se o valor for "NONE", qualquer associação de termo pai existente será removida. A associação do termo pai só é compatível com os tipos de termo não anual. Se o tipo de termo não for compatível com um pai, a associação será ignorada. Se o tipo de período for definido como Anual ou UNSPECIFIED, qualquer associação de período pai existente será removida. Se o termo pai referenciado não existir ou se a associação for inválida, o termo ainda será criado ou atualizado, mas o relacionamento pai não será aplicado.

Limite máximo: 256. Caracteres multibyte aceitos.

Tipo de termo

Obrigatório: Não

Único: Não

Cabeçalho: term_type

Descrição: Especifica o tipo de termo.

As opções são:

  • Anual: 'a' = Ano acadêmico ou período alinhado ao calendário.

  • Semestre: "s" = semestre acadêmico padrão.

  • Trimestre: "t" = estrutura acadêmica de três períodos.

  • Trimestre: "q" = estrutura acadêmica de quatro trimestres.

  • Intersessão: "i" = um curto período entre os períodos primários.

  • Módulo: 'm' = Subtermo dentro de um termo maior.

  • Não especificado: 'u' = Limpa o tipo de prazo.

  • Valores suportados: "a", "s", "t", "q", "i", "m", "u"

Código de identificação do lote para substituição

Obrigatório: Não

Único: Sim

Cabeçalho: new_external_term_key

Descrição: Este campo é usado apenas nas raras ocasiões em que um termo EXTERNAL KEY é alterado.

Comprimento máximo: 256. Caracteres multibyte aceitos.

Uid de lote de origem de dados de substituição

Obrigatório: Não

Único: Não

Cabeçalho: new_data_source_key

Descrição: nova chave usada para estabelecer o agrupamento de elementos de dados. Substitui dados de associação de fontes de dados existentes ao grupo designado pela chave da fonte de dados de substituição especificada. Observação: o campo de mapeamento da interface do usuário para o código de identificação do lote da fonte de dados de substituição é 'script.flatfile.TermReplacementDataSourceBatchUid'

Status da linha

Obrigatório: Não

Único: Não

Cabeçalho: row_status

Descrição: Define o valor do registro como um dos seguintes:

  • Habilitado: acesso normal ao registro.

  • Desabilitado: o registro é visível em algumas áreas da interface do usuário, mas não pode ser alterado ou acessado.

  • Excluído: o registro está programado para ser excluído.

Valores possíveis: "habilitado", "desabilitado", "excluído"

Data de início

Obrigatório: Não

Único: Não

Cabeçalho: start_date

Descrição: Esta é a data em que o termo começa a estar disponível para acesso.

Formato: aaaammdd

Objeto LEARN: Associação de Função de Instituição Secundária

Note

Ao utilizar um leitor de tela, recomendamos utilizar Chrome e JAWS ou NVDA no Windows e utilizar Safari e VoiceOver em um Mac .

Objeto Sistema de informações do aluno (SIA):Função de instituição secundária do usuário

Comportamento padrão de inserção/atualização: inserções inteligentes ou atualizações

Comportamento de exclusão padrão: desabilitar

Campos do Learn

Chave da fonte de dados (obrigatória) fornecida pela integração ou pelo arquivo de dados.

Obrigatório: Sim

Único: Não

Cabeçalho: data_source_key

Descrição: Chave usada para estabelecer o agrupamento de elementos do usuário. Observe que isso pode ser fornecido pela configuração de integração e, portanto, não seria necessário no arquivo.

Comprimento máximo: 256. Caracteres multibyte aceitos.

ID da função da instituição secundária (obrigatório)

Obrigatório: Sim

Único: Não

Cabeçalho: role_id

Descrição: o identificador da função de instituição secundária para essa associação.

Código de identificação do lote do usuário (obrigatório)

Obrigatório: Sim

Único: Não

Cabeçalho: external_person_key

Descrição: o usuário external_person_key (lote_uid) a ser usado para essa associação.

Comprimento máximo: 64.

Uid de lote de origem de dados de substituição

Obrigatório: Não

Único: Não

Cabeçalho: new_data_source_key

Descrição: nova chave usada para estabelecer o agrupamento de elementos de dados. Substitui dados de associação de fontes de dados existentes ao grupo designado pela chave da fonte de dados de substituição especificada. Observação: o campo de mapeamento da interface do usuário para o código de identificação do lote da fonte de dados de substituição é 'script.flatfile.SecondaryInstRoleReplacementDataSourceBatchUid'

Status da linha

Obrigatório: Não

Único: Não

Cabeçalho: row_status

Descrição: Define o valor do registro como um dos seguintes: Habilitado: Acesso normal ao registro. Desabilitado: o registro é visível em algumas áreas da interface do usuário, mas não pode ser alterado ou acessado. Excluído: o registro está programado para ser excluído manualmente pelo administrador no futuro. A linha não é excluída automaticamente por meio de uma tarefa.

Valores possíveis: "habilitado", "desabilitado", "excluído"

Objeto LEARN: Associação de Observadores

Note

Ao utilizar um leitor de tela, recomendamos utilizar Chrome e JAWS ou NVDA no Windows e utilizar Safari e VoiceOver em um Mac .

Objeto Sistema de informações do aluno (SIA):Associação de observadores

Comportamento padrão de inserção/atualização: inserções inteligentes ou atualizações

Comportamento de exclusão padrão: desabilitar

Campos do Learn

Chave da fonte de dados (obrigatória) fornecida pela integração ou pelo arquivo de dados.

Obrigatório: Sim

Único: Não

Cabeçalho: data_source_key

Descrição: Chave usada para estabelecer o agrupamento de elementos do usuário. Observe que isso pode ser fornecido pela configuração de integração e, portanto, não seria necessário no arquivo.

Comprimento máximo: 256. Caracteres multibyte aceitos.

Aluno Observado (Obrigatório)

Obrigatório: Sim

Único: Não

Cabeçalho: external_user_key

Descrição: o usuário external_person_key (lote_uid) a ser usado para essa associação. Um identificador exclusivo para um usuário com a Função na instituição de aluno. Esse código é fornecido pela instituição e não é exibido para os usuários.

Comprimento máximo: 64. Caracteres multibyte aceitos.

Observador (Obrigatório)

Obrigatório: Sim

Único: Não

Cabeçalho: external_observer_key

Descrição: a external_person_key do observador (batch_uid) para ser usada para essa associação. Um identificador exclusivo para um usuário com a função do sistema de observador na instituição.

Comprimento máximo: 64. Caracteres multibyte aceitos.

Uid de lote de origem de dados de substituição

Obrigatório: Não

Único: Não

Cabeçalho: new_data_source_key

Descrição: nova chave usada para estabelecer o agrupamento de elementos de dados. Substitui dados de associação de fontes de dados existentes ao grupo designado pela chave da fonte de dados de substituição especificada. Observação: o campo de mapeamento da interface do usuário para o código de identificação do lote da fonte de dados de substituição é 'script.flatfile.AssociateObserverReplacementDataSourceBatchUid'

Status da linha

Obrigatório: Não

Único: Não

Cabeçalho: row_status

Descrição: Define o valor do registro como um dos seguintes: Habilitado: Acesso normal ao registro. Desabilitado: o registro é visível em algumas áreas da interface do usuário, mas não pode ser alterado ou acessado. Excluído: o registro está programado para ser excluído.

Valores possíveis: "habilitado", "desabilitado", "excluído"

APRENDER OBJETO: Categoria

Note

Ao utilizar um leitor de tela, recomendamos utilizar Chrome e JAWS ou NVDA no Windows e utilizar Safari e VoiceOver em um Mac .

Objeto Sistema de informações do aluno (SIA):Categoria do curso

Comportamento padrão de inserção/atualização: inserções inteligentes ou atualizações

Comportamento de exclusão padrão: desabilitar

Campos do Learn

dataSourceBatchUid (obrigatório)

Obrigatório: Sim

Único: Não

Cabeçalho: data_source_key

Descrição: Chave usada para estabelecer o agrupamento de elementos de categoria.

Caracteres multibyte aceitos.

título (Obrigatório)

Obrigatório: Sim

Único: Não

Cabeçalho: title

Descrição: o nome da categoria como ela aparecerá para os usuários na interface do usuário.

Comprimento máximo: 255. Caracteres multibyte aceitos.

Código de identificação do lote (obrigatório)

Obrigatório: Sim

Único: Sim

Cabeçalho: external_category_key

Descrição: Deve ser único. Observe que esse campo corresponde ao campo de Categoria mnemônica na UI.

Comprimento máximo: 64. Caracteres multibyte aceitos.

descrição

Obrigatório: Não

Único: Não

Cabeçalho: description

Descrição: Descrição da categoria.

frontPageInd

Obrigatório: Não

Único: Não

Cabeçalho: frontpage_ind

Descrição: determina se a categoria é exibida ou não na primeira página do catálogo.

Valores suportados: 'Y', 'N'

isAvailable

Obrigatório: Não

Único: Não

Cabeçalho: available_ind

Descrição: Estabelece a disponibilidade da categoria no Blackboard Learn.

Valores suportados: 'Y', 'N'

isRestricted

Obrigatório: Não

Único: Não

Cabeçalho: restrict_ind

Descrição: sinalize se o curso ou a organização é restrito a membros.

Valores suportados: 'Y', 'N'

parentBatchUid

Obrigatório: Não

Único: Não

Cabeçalho: parent_category_key

Descrição: o EXTERNAL_CATEGORY_KEY que representa a categoria Pai da qual essa categoria é filho.

Comprimento máximo: 64.

rowStatus

Obrigatório: Não

Único: Não

Cabeçalho: row_status

Descrição: Define o valor do registro como um dos seguintes: Habilitado: Acesso normal ao registro. Desabilitado: o registro é visível em algumas áreas da interface do usuário, mas não pode ser alterado ou acessado. Excluído: o registro está programado para ser excluído. Sequência de caracteres.

Valores possíveis: "habilitado", "desabilitado", "excluído"

Código de identificação do lote para substituição

Obrigatório: Não

Único: Sim

Cabeçalho: new_external_category_key

Descrição: Designa o desenvolvimento da chave atual.

Comprimento máximo: 64. Caracteres multibyte aceitos.

Uid de lote de origem de dados de substituição

Obrigatório: Não

Único: Não

Cabeçalho: new_data_source_key

Descrição: nova chave usada para estabelecer o agrupamento de elementos de dados. Substitui dados de associação de fontes de dados existentes ao grupo designado pela chave da fonte de dados de substituição especificada. Observação: o campo de mapeamento da interface do usuário para o código de identificação do lote da fonte de dados de substituição é 'script.flatfile.CourseCatReplacementDataSourceBatchUid'

OBJETO DO APRENDIZADO: Assunto

Note

Ao utilizar um leitor de tela, recomendamos utilizar Chrome e JAWS ou NVDA no Windows e utilizar Safari e VoiceOver em um Mac .

Assunto do Objeto do Sistema de informações do aluno (SIA):

Comportamento padrão de inserção/atualização: inserções inteligentes ou atualizações

Comportamento de exclusão padrão: desabilitar

Campos de aprendizado: assunto

UID do lote (obrigatório)

Obrigatório: Sim

Único: Sim

Cabeçalho: external_subject_key

Descrição: Nome curto usado pela instituição para identificar exclusivamente o assunto. Não é exibido aos usuários. Pode conter apenas letras, dígitos, traços e pontos. Não são permitidos espaços ou outros sinais de pontuação. Deve ser exclusivo em todas as disciplinas, cursos e organizações e, em geral, é o mesmo que SUBJECT_ID.

Comprimento máximo: 64. Deve ser exclusivo. Caracteres multibyte são aceitos.

Código do curso (obrigatório)

Obrigatório: Sim

Único: Sim

Cabeçalho: subject_id

Descrição: Nome curto usado pela instituição para identificar exclusivamente o assunto. O valor deve seguir o formato {SubjectTitle}__{SubjectIdentifier}, com dois sublinhados consecutivos separando o título e o identificador da disciplina. O título do assunto pode conter apenas letras, números, hífens (-), pontos (.) e sublinhados (_), e o identificador do assunto pode conter apenas letras e números. Os seguintes caracteres não podem ser usados: espaço ( ), &, /, ', +. Exemplo: CHEM__abc123.

Limite máximo: 100. Deve ser exclusivo e não pode ser alterado.

Nome do assunto (obrigatório)

Obrigatório: Sim

Único: Não

Cabeçalho: subject_name

Descrição: Título completo do tópico. Isso é usado para exibir.

Limite máximo: 255. Caracteres multibyte são aceitos.

Chave da fonte de dados (obrigatória) fornecida pela integração ou pelo arquivo de dados.

Obrigatório: Sim

Único: Não

Cabeçalho: data_source_key

Descrição: Chave usada para estabelecer um agrupamento de elementos do assunto. Observe que isso pode ser fornecido pela configuração de integração e, portanto, não seria necessário no arquivo.

Máximo. comprimento: 256. Caracteres multibyte são aceitos.

Disponível

Obrigatório: Não

Único: Não

Cabeçalho: available_ind

Descrição: Estabelece a disponibilidade do tópico no Blackboard.

Valores suportados: "Y", "N"

Descrição

Obrigatório: Não

Único: Não

Cabeçalho: description

Descrição: Descrição completa do tópico.

Limite máximo: 4000. Caracteres multibyte são aceitos.

Tipo de tópico

Obrigatório: Sim

Único: Não

Cabeçalho: subject_type

Descrição: Ela é usada para indicar a classificação curricular do curso no sistema de gerenciamento de aprendizagem. As opções são:

  • Graduação: 'U' = O curso representa o currículo em nível de graduação.

  • Graduação: 'G' = O curso representa um currículo em nível de pós-graduação.

  • Desenvolvimento: 'D' = O curso representa um currículo de desenvolvimento ou de recuperação.

  • Graduação não transferível: 'N' = A disciplina representa um curso de graduação que não é transferível.

  • Graduação transferível: “T” = O curso representa um currículo de graduação que é transferível.

  • Profissional: "P" = O assunto representa um currículo de formação profissional ou continuada.

Valores suportados: "U", "G", "D", "N", "T", "P"

UID de lote de substituição

Obrigatório: Não

Único: Sim

Cabeçalho: new_external_subject_key

Descrição: Esse campo é usado apenas nas raras ocasiões em que a CHAVE EXTERNA de um assunto é alterada.

Comprimento máximo: 64. Deve ser exclusivo. Caracteres multibyte são aceitos.

Uid do código de identificação do lote da fonte de dados de substituição

Obrigatório: Não

Único: Não

Cabeçalho: new_data_source_key

Descrição: Nova chave usada para estabelecer o agrupamento de itens de assunto. Substitui a fonte de dados existente, associando os dados ao grupo designado pela chave da fonte de dados de substituição especificada. Observação: O campo de mapeamento da interface do usuário para o código de identificação do lote da Fonte de Dados de Substituição é "script.flatfile.SubjectReplacementDataSourceBatchUid"

Status da linha

Obrigatório: Não

Único: Não

Cabeçalho: row_status

Descrição: Define o valor do registro como um dos seguintes: Ativo: Acesso normal ao registro. Desativado: O registro permanece visível em algumas áreas da interface do usuário, mas não pode ser alterado nem acessado. Excluído: o registro está programado para ser excluído.

Valores possíveis: "habilitado", "desabilitado", "excluído"

Objeto LEARN: Course

Note

Ao utilizar um leitor de tela, recomendamos utilizar Chrome e JAWS ou NVDA no Windows e utilizar Safari e VoiceOver em um Mac .

Objeto do SIS: Programa

Comportamento padrão de inserção/atualização: inserções ou atualizações inteligentes

Comportamento padrão ao excluir: Desativar

Campos do Learn

ID do lote (obrigatório)

Obrigatório: Sim

Exclusivo: Sim

Título: external_program_key

Descrição: Nome abreviado usado pela instituição para identificar exclusivamente o programa. Isso não é exibido para os usuários. Pode conter apenas letras, números, hífens e pontos. Não são permitidos espaços nem outros sinais de pontuação. Deve ser exclusivo em todos os programas, disciplinas, cursos e organizações, e geralmente é igual ao PROGRAM_ID.

Comprimento máximo: 64. Deve ser exclusivo. Caracteres multibyte aceitos.

ID do programa (obrigatório)

Obrigatório: Sim

Exclusivo: Sim

Título: program_id

Descrição: Nome abreviado usado pela instituição para identificar o programa exclusivamente.

Comprimento máximo: 100. Deve ser exclusivo e não pode ser alterado.

Nome do programa (obrigatório)

Obrigatório: Sim

Exclusivo: No

Título: program_name

Descrição: Título completo do programa. Isso é usado para exibição.

Comprimento máximo: 255. Caracteres multibyte aceitos.

Chave da fonte de dados (obrigatória). Fornecida pela integração ou pelo arquivo de dados.

Obrigatório: Sim

Exclusivo: Não

Cabeçalho: data_source_key

Descrição: Chave usada para definir um agrupamento de elementos do programa. Observe que isso pode ser definido na configuração da integração e, portanto, não seria necessário incluir isso no arquivo.

Comprimento máximo: 256. Caracteres multibyte aceitos.

Disponível

Obrigatório: Não

Exclusivo: Não

Título: available_ind

Descrição: Configura a disponibilidade do curso no Blackboard LMS.

Valores permitidos: "Y", "N"

Descrição

Obrigatório: Não

Exclusivo: Não

Título: descrição

Descrição: Descrição completa do programa.

Comprimento máximo: 4000. Caracteres multibyte aceitos.

Tipo de programa

Obrigatório: Sim

Exclusivo: Não

Título: type_of_program

Descrição: Este campo é utilizado para indicar a classificação curricular do Programa no sistema de gerenciamento de aprendizagem. As opções são:

  • Graduação: "U" = O curso faz parte do currículo de graduação.

  • Pós-graduação: "G" = A disciplina faz parte do currículo de pós-graduação.

Valores aceitos: "U", "G"

Código de identificação do lote para substituição

Obrigatório: Não

Exclusivo: Sim

Título: new_external_program_key

Descrição: Este campo é usado apenas nas raras ocasiões em que a CHAVE ESTRANGEIRA de um programa é alterada.

Comprimento máximo: 64. Deve ser exclusivo. Caracteres multibyte aceitos.

Uid de lote de origem de dados de substituição

Obrigatório: Não

Exclusivo: Não

Título: new_data_source_key

Descrição: Nova chave usada para definir o agrupamento de elementos do programa. Substitui a fonte de dados existente que associa os dados ao grupo designado pela chave de fonte de dados de substituição especificada. Nota: O campo de mapeamento da interface do usuário para o Uid do lote da Fonte de dados de substituição do programa de arquivo simples é 'script.flatfile.ProgramReplacementDataSourceBatchUid'

Status da linha

Obrigatório: Não

Exclusivo: Não

Cabeçalho: row_status

Descrição: Define o valor do registro como uma das seguintes opções: Ativado: Acesso Normal ao registro. Desativado: o registro fica visível em algumas áreas da interface do usuário, mas não pode ser alterado nem acessado. Excluído: o registro está programado para ser excluído.

Valores permitidos: "enabled", "disabled", "deleted"

APRENDER OBJETO: Associação de categoria

Note

Ao utilizar um leitor de tela, recomendamos utilizar Chrome e JAWS ou NVDA no Windows e utilizar Safari e VoiceOver em um Mac .

Objeto do Sistema de informações do aluno (SIA): Associação de categoria

Comportamento padrão de inserção/atualização: inserções inteligentes ou atualizações

Comportamento de exclusão padrão: desabilitar

Campos do Learn

Código de identificação do lote (obrigatório)

Obrigatório: Sim

Único: Sim

Descrição: preenchido automaticamente. Não use em feeds de dados.

Categoria Código de Identificação da Categoria (Obrigatório)

Obrigatório: Sim

Único: Não

Cabeçalho: external_category_key

Descrição: A EXTERNAL KEY (batch_uid) para a categoria à qual adicionar o curso/organização.

Comprimento máximo: 64.

Uid do código de identificação do lote do curso ou uid do código de identificação do lote da organização (obrigatório)

Obrigatório: Sim

Único: Não

Cabeçalho: external_course_key

Descrição: external_organization_key A EXTERNAL KEY (batch_uid) para o curso ou organização que está sendo categorizada.

Comprimento máximo: 64.

Chave da fonte de dados (obrigatória) fornecida pela integração ou pelo arquivo de dados.

Obrigatório: Sim

Único: Não

Cabeçalho: data_source_key

Descrição: Chave usada para estabelecer o agrupamento de elementos do usuário. Observe que isso pode ser fornecido pela configuração de integração e, portanto, não seria necessário no arquivo.

Caracteres multibyte aceitos.

Está disponível

Obrigatório: Não

Único: Sim

Cabeçalho: available_ind

Descrição: Define a disponibilidade da categoria em Blackboard LMS.

Valores suportados: 'Y', 'N'

Uid de lote de origem de dados de substituição

Obrigatório: Não

Único: Não

Cabeçalho: new_data_source_key

Descrição: nova chave usada para estabelecer o agrupamento de elementos de dados. Substitui dados de associação de fontes de dados existentes ao grupo designado pela chave da fonte de dados de substituição especificada. Observação: o campo de mapeamento da interface do usuário para o código de identificação do lote da fonte de dados de substituição é 'script.flatfile.CourseCatMemReplacementDataSourceBatchUid'

Status da linha

Obrigatório: Não

Único: Não

Cabeçalho: row_status

Descrição: Define o valor do registro como um dos seguintes: Habilitado: Acesso normal ao registro. Desabilitado: o registro é visível em algumas áreas da interface do usuário, mas não pode ser alterado ou acessado. Excluído: o registro está programado para ser excluído.

Valores possíveis: "habilitado", "desabilitado", "excluído"

Objeto LEARN: Nó de hierarquia

Note

Ao utilizar um leitor de tela, recomendamos utilizar Chrome e JAWS ou NVDA no Windows e utilizar Safari e VoiceOver em um Mac .

Objeto Sistema de informações do aluno (SIA): Nó de Hierarquia

Comportamento padrão de inserção/atualização: inserções inteligentes ou atualizações

Comportamento de exclusão padrão: Limpar

Campos do Learn

Estes são os cabeçalhos mínimos necessários para criar um nó de hierarquia institucional:

  • external_node_key

  • data_source_key

  • parent_node_key

  • nome

Código de identificação do lote (obrigatório)

Obrigatório: Sim

Único: Sim

Cabeçalho: external_node_key

Descrição: Identificador usado pela instituição para identificar exclusivamente o nó da hierarquia. Não é exibido aos usuários. Pode conter apenas letras, dígitos, traços e pontos. Nenhum espaço ou outra pontuação permitida.

Comprimento máximo: 255. Caracteres multibyte aceitos.

Chave da fonte de dados (obrigatória) fornecida pela integração ou pelo arquivo de dados.

Obrigatório: Sim

Único: Não

Cabeçalho: data_source_key

Descrição: Chave usada para estabelecer o agrupamento de elementos do usuário. Observe que isso pode ser fornecido pela configuração de integração e, portanto, não seria necessário no arquivo.

Comprimento máximo: 255. Caracteres multibyte aceitos.

Código de identificação do lote pai (Obrigatório)

Obrigatório: Sim

Único: Não

Cabeçalho: parent_node_key

Descrição: external_node_key pai (batch uid) para este nó.

Comprimento máximo: 64.

Nome (Obrigatório)

Obrigatório: Sim

Único: Não

Cabeçalho: name

Descrição: Nome do nó

Comprimento máximo: 255

Descrição

Obrigatório: Não

Único: Não

Cabeçalho: description

Descrição: Descrição do nó

Comprimento máximo: 1000.

Código de identificação do lote para substituição

Obrigatório: Não

Único: Sim

Cabeçalho: new_external_node_key

Descrição: Este campo é usado apenas nas raras ocasiões em que a CHAVE EXTERNA de um nó é alterada.

Comprimento máximo: 255. Deve ser exclusivo. Caracteres multibyte aceitos.

Uid de lote de origem de dados de substituição

Obrigatório: Não

Único: Não

Cabeçalho: new_data_source_key

Descrição: nova chave usada para estabelecer o agrupamento de elementos de dados. Substitui dados de associação de fontes de dados existentes ao grupo designado pela chave da fonte de dados de substituição especificada. Observação: o campo de mapeamento da interface do usuário para código de identificação do lote da fonte de dados de substituição é 'script.flatfile.NodeReplacementDataSourceBatchUid'

Objeto LEARN: Associação de Usuário de Hierarquia

Note

Ao utilizar um leitor de tela, recomendamos utilizar Chrome e JAWS ou NVDA no Windows e utilizar Safari e VoiceOver em um Mac .

Objeto Sistema de informações do aluno (SIA): Associação de Usuário

Comportamento padrão de inserção/atualização: inserções inteligentes ou atualizações

Comportamento de exclusão padrão: Limpar

Campos do Learn

Os cabeçalhos mínimos necessários para associar usuários a um nó de hierarquia institucional são:

  • external_user_key

  • external_node_key

  • external_association_key

  • data_source_key

Chave da fonte de dados (obrigatória) fornecida pela integração ou pelo arquivo de dados.

Obrigatório: Sim

Único: Não

Cabeçalho: data_source_key

Descrição: Chave usada para estabelecer o agrupamento de elementos do usuário. Observe que isso pode ser fornecido pela configuração de integração e, portanto, não seria necessário no arquivo.

Comprimento máximo: 255. Caracteres multibyte aceitos.

Código de identificação do lote (obrigatório)

Obrigatório: Sim

Único: Sim

Cabeçalho: external_association_key

Descrição: a código da associação, que é o identificador exclusivo da associação do usuário ao nó. Geralmente, uma concatenação dos valores código de identificação do lote do Usuário e código de identificação do lote do Nó para garantir a exclusividade quando um usuário pode ser atribuído a mais de um nó.

Comprimento máximo: 64.

Código de identificação do lote do nó (Obrigatório)

Obrigatório: Sim

Único: Não

Cabeçalho: external_node_key

Descrição: O nó para esta associação, que também é o Identificador de Nó que pode ser encontrado na área 'Editar Nó' na GUI

Comprimento máximo: 64.

Código de identificação do lote do usuário (obrigatório)

Obrigatório: Sim

Único: Não

Cabeçalho: external_user_key

Descrição: o usuário external_person_key (lote_uid) a ser associado a esse nó.

Comprimento máximo: 64.

Código de identificação do lote para substituição

Obrigatório: Não

Único: Sim

Cabeçalho: new_external_association_key

Descrição: este campo é usado apenas nas raras ocasiões em que a CHAVE EXTERNA de uma associação é alterada.

Comprimento máximo: 64. Caracteres multibyte aceitos.

Uid de lote de origem de dados de substituição

Obrigatório: Não

Único: Não

Cabeçalho: new_data_source_key

Descrição: nova chave usada para estabelecer o agrupamento de elementos de dados. Substitui dados de associação de fontes de dados existentes ao grupo designado pela chave da fonte de dados de substituição especificada. Observação: o campo de mapeamento da interface do usuário para o código de identificação do lote da fonte de dados de substituição é 'script.flatfile.UserAssociationReplacementDataSourceBatchUid'

Objeto LEARN: Associação de Curso de Hierarquia

Note

Ao utilizar um leitor de tela, recomendamos utilizar Chrome e JAWS ou NVDA no Windows e utilizar Safari e VoiceOver em um Mac .

Objeto do Sistema de informações do aluno (SIA): Associação de Curso

Comportamento padrão de inserção/atualização: inserções inteligentes ou atualizações

Comportamento de exclusão padrão: Limpar

Campos do Learn

Os cabeçalhos mínimos necessários para associar cursos a um nó de hierarquia institucional são:

  • external_course_key

  • external_node_key

  • external_association_key

  • data_source_key

Código de identificação do lote (obrigatório)

Obrigatório: Sim

Único: Sim

Cabeçalho: external_association_key

Descrição: Cada associação de curso e nó deve ter um valor exclusivo que identifique esse relacionamento. O código de identificação do lote é o identificador exclusivo para o relacionamento curso-nó.

Comprimento máximo: 64.

Uid do código de identificação do lote do curso (obrigatório)

Obrigatório: Sim

Único: Não

Cabeçalho: external_course_key

Descrição: O curso external_course_key (batch_uid) a ser associado a este nó.

Comprimento máximo: 64.

Chave da fonte de dados (obrigatória) fornecida pela integração ou pelo arquivo de dados.

Obrigatório: Sim

Único: Não

Cabeçalho: data_source_key

Descrição: Chave usada para estabelecer o agrupamento de elementos. Observe que isso pode ser fornecido pela configuração de integração e, portanto, não seria necessário no arquivo.

Comprimento máximo: 255. Caracteres multibyte aceitos.

Código de identificação do lote do nó (Obrigatório)

Obrigatório: Sim

Único: Não

Cabeçalho: external_node_key

Descrição: o nó dessa associação.

Comprimento máximo: 64. Caracteres multibyte aceitos.

Indicador de Associação Primária

Obrigatório: Não

Único: Não

Cabeçalho: is_primary_association

Descrição: sinalizador que designa esse desenvolvimento como o desenvolvimento primário quando outros podem ser especificados.

Valores suportados: 'Y', 'N'.

Código de identificação do lote para substituição

Obrigatório: Não

Único: Sim

Cabeçalho: new_external_association_key

Descrição: este campo é usado apenas nas raras ocasiões em que a CHAVE EXTERNA de uma associação é alterada.

Comprimento máximo: 64. Caracteres multibyte aceitos.

Uid de lote de origem de dados de substituição

Obrigatório: Não

Único: Não

Cabeçalho: new_data_source_key

Descrição: nova chave usada para estabelecer o agrupamento de elementos de dados. Substitui dados de associação de fontes de dados existentes ao grupo designado pela chave da fonte de dados de substituição especificada. Observação: o campo de mapeamento da interface do usuário para o código de identificação do lote da fonte de dados de substituição é 'script.flatfile.CourseAssociationReplacementDataSourceBatchUid'

Objeto LEARN: Associação de metas

Note

Ao utilizar um leitor de tela, recomendamos utilizar Chrome e JAWS ou NVDA no Windows e utilizar Safari e VoiceOver em um Mac .

Objeto do Sistema de informações do aluno (SIA): Associação de Metas

Comportamento padrão de inserção/atualização: inserções inteligentes ou atualizações

Comportamento de exclusão padrão: Limpar

Campos do Learn

Código de identificação do lote (obrigatório)

Obrigatório: Sim

Único: Sim

Cabeçalho: Não há cabeçalho; ele é preenchido automaticamente. Ignore nos feeds de integração.

Descrição: Um identificador exclusivo para a relação entre o curso e a meta (padrão).

Comprimento máximo: 64.

Uid do código de identificação do lote do curso (obrigatório)

Obrigatório: Sim

Único: Não

Cabeçalho: course_key

Descrição: O identificador único (external_course_key) do curso ao qual o objetivo (padrão) será associado

Comprimento máximo: 64.

Chave da fonte de dados (obrigatória) fornecida pela integração ou pelo arquivo de dados.

Obrigatório: Sim

Único: Não

Cabeçalho: data_source_key

Descrição: Chave usada para estabelecer o agrupamento de elementos do usuário. Observe que isso pode ser fornecido pela configuração de integração e, portanto, não seria necessário no arquivo.

Comprimento máximo: 255. Caracteres multibyte aceitos.

Conjunto de metas secundárias (obrigatório)

Obrigatório: Sim

Único: Não

Cabeçalho: std_sub_doc_key

Descrição: o identificador exclusivo da meta (padrão) a ser associada a um curso.

Comprimento máximo: 64.

Uid de lote de origem de dados de substituição

Obrigatório: Não

Único: Não

Cabeçalho: new_data_source_key

Descrição: nova chave usada para estabelecer o agrupamento de elementos de dados. Substitui dados de associação de fontes de dados existentes ao grupo designado pela chave da fonte de dados de substituição especificada. Observação: o campo de mapeamento da interface do usuário para código de identificação do lote da fonte de dados de substituição é 'script.flatfile.GoalAssociationReplacementDataSourceBatchUid'

Objeto LEARN: Associação do período letivo ao curso

Note

Ao utilizar um leitor de tela, recomendamos utilizar Chrome e JAWS ou NVDA no Windows e utilizar Safari e VoiceOver em um Mac .

Objeto SIS: Associação de disciplina ao curso

Comportamento padrão da inserção: Inserções inteligentes. Não há suporte para atualizações.

Comportamento de exclusão padrão: Limpar

Campos do Learn

Os campos obrigatórios para associar um aluno a um curso são:

  • chave_externa_da_matéria

  • chave_do_curso_externo

  • external_association_key

  • data_source_key

ID do lote (obrigatório)

Obrigatório: Sim

Exclusivo: Sim

Título: external_association_key

Descrição: Cada associação entre disciplina e curso deve ter um valor único que identifique essa relação. O Uid do lote é o identificador exclusivo do relacionamento entre disciplina e curso.

Comprimento máximo: 64.

Assunto, Lote, Uid (obrigatório)

Obrigatório: Sim

Exclusivo: Não

Título: external_subject_key

Descrição: O campo external_subject_key (batch_uid) a ser associado a esta associação.

Comprimento máximo: 64.

Chave da fonte de dados (obrigatório) Fornecida pela integração ou pelo arquivo de dados.

Obrigatório: Sim

Exclusivo: Não

Cabeçalho: data_source_key

Descrição: Chave usada para definir o agrupamento de itens. Observe que isso pode ser definido na configuração da integração e, portanto, não seria necessário incluir no arquivo.

Comprimento máximo: 255. Caracteres multibyte aceitos.

Objeto LEARN: Associação do assunto à organização

Note

Ao utilizar um leitor de tela, recomendamos utilizar Chrome e JAWS ou NVDA no Windows e utilizar Safari e VoiceOver em um Mac .

Objeto SIS: Associado à instituição

Comportamento padrão de inserção: Inserções inteligentes. Não há suporte para atualizações.

Comportamento de exclusão padrão: Limpar

Campos do Learn

Os cabeçalhos mínimos necessários para associar um Assunto a uma Organização são:

  • chave_externa_da_matéria

  • chave_da_organização_externa

  • external_association_key

  • data_source_key

Uid do lote (obrigatório)

Obrigatório: Sim

Exclusivo: Sim

Título: external_association_key

Descrição: Cada associação entre um assunto e uma organização deve ter um valor exclusivo que identifique essa relação. O Uid do lote é o identificador exclusivo da relação com a organização em questão.

Comprimento máximo: 64.

Assunto, Lote, Uid (Obrigatório)

Obrigatório: Sim

Exclusivo: Não

Título: external_subject_key

Descrição: O campo external_subject_key (batch_uid) a ser associado a esta associação.

Comprimento máximo: 64.

Chave da fonte de dados (obrigatório). Fornecida pela integração ou pelo arquivo de dados.

Obrigatório: Sim

Exclusivo: Não

Cabeçalho: data_source_key

Descrição: Chave usada para definir o agrupamento de elementos. Observe que isso pode ser definido na configuração de integração e, portanto, não seria necessário incluir no arquivo.

Comprimento máximo: 255. Caracteres multibyte aceitos.

Código de identificação do lote do nó (Obrigatório)

Obrigatório: Sim

Exclusivo: Não

Título: external_org_key

Descrição: A estrutura organizacional dessa associação.

Comprimento máximo: 64. Caracteres multibyte aceitos.

Uid de lote de origem de dados de substituição

Obrigatório: Não

Exclusivo: Não

Título: new_data_source_key

Descrição: Nova chave usada para definir o agrupamento de elementos de dados. Substitui a fonte de dados existente que associa os dados ao grupo designado pela chave da fonte de dados de substituição especificada. Nota: O campo de mapeamento da interface do usuário para o Uid do lote da fonte de dados de substituição da Associação de assunto para organização do arquivo simples é 'script.flatfile.SubjectToOrganizationAssociationReplacementDataSourceBatchUid'

Objeto LEARN: Associação entre programa e disciplina

Note

Ao utilizar um leitor de tela, recomendamos utilizar Chrome e JAWS ou NVDA no Windows e utilizar Safari e VoiceOver em um Mac .

Objeto SIS: Associação entre o programa e a disciplina

Comportamento padrão de colagem: Colagens inteligentes. Não há suporte para atualizações.

Comportamento de exclusão padrão: Limpar

Campos do Learn

Os cabeçalhos mínimos necessários para associar um Programa a uma Disciplina são:

  • chave_do_programa_externo

  • chave_externa_da_disciplina

  • external_association_key

  • data_source_key

Uid do lote (obrigatório)

Obrigatório: Sim

Exclusivo: Sim

Título: external_association_key

Descrição: Cada associação entre programa e disciplina deve ter um valor único que identifique essa relação. O Uid do lote é o identificador exclusivo do relacionamento entre o programa e o aluno.

Comprimento máximo: 64.

Uid do lote do programa (obrigatório)

Obrigatório: Sim

Exclusivo: Não

Título: external_program_key

Descrição: O programa external_program_key (batch_uid) a ser associado a esta associação.

Comprimento máximo: 64.

Chave da fonte de dados (obrigatório). Fornecida pela integração ou pelo arquivo de dados.

Obrigatório: Sim

Exclusivo: Não

Cabeçalho: data_source_key

Descrição: Chave usada para definir o agrupamento de elementos. Observe que isso pode ser definido na configuração de integração e, portanto, não seria necessário incluir isso no arquivo.

Comprimento máximo: 255. Caracteres multibyte aceitos.

Código de identificação do lote do nó (Obrigatório)

Obrigatório: Sim

Exclusivo: Não

Título: external_subject_key

Descrição: O tópico desta associação.

Comprimento máximo: 64. Caracteres multibyte aceitos.

Uid de lote de origem de dados de substituição

Obrigatório: Não

Exclusivo: Não

Título: new_data_source_key

Descrição: Nova chave usada para definir o agrupamento de elementos de dados. Substitui a fonte de dados existente que associa os dados ao grupo designado pela chave da fonte de dados de substituição especificada. Nota: O campo de mapeamento da interface do usuário para o Uid do lote da Fonte de Dados de Substituição de associação de programa para assunto do arquivo simples é 'script.flatfile.ProgramToSubjectAssociationReplacementDataSourceBatchUid'