Skip to main content

Snapshot Flat File Header Descriptions

The Snapshot Flat File provides the ability to integrate using the latest LEARN data objects. Below is a comprehensive list of the supported objects, their UI to Feed Header naming conventions, usage description, and data requirements.

As the data feed is a text file all data is represented as a string. In some cases specific formatting and length are noted. Where required by the field supported values are provided. Required fields are highlighted and noted.

LEARN-object: gebruiker

Studentinformatiesysteem-object: Persoon

Standaard invoeg-/bijwerkingsgedrag: slimme invoegingen of updates

Standaard verwijdergedrag: Uitschakelen

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"

Email

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

Studentinformatiesysteem-object: Cursus of organisatie

Standaard invoeg-/bijwerkingsgedrag: slimme invoegingen of updates

Standaard verwijdergedrag: Uitschakelen

Learn-velden

Batch Uid (Vereist)

Vereist: Ja

Uniek: Ja

Koptekst: external_course_key.external_organization_key

Beschrijving: korte naam die door de instelling wordt gebruikt om de sectie Cursus of Organisatie uniek te identificeren. Deze wordt niet voor gebruikers weergegeven. Kan alleen letters, cijfers, streepjes en punten bevatten. Spaties of andere leestekens zijn niet toegestaan. Moet uniek zijn voor elke cursus en organisatie en is vaak dezelfde als de COURSE_ID of ORGANIZATION_ID.

Maximale lengte: 64. Moet uniek zijn. Tekens die uit meerdere bytes bestaan worden geaccepteerd.

Cursus-ID of organisatie-ID (vereist)

Vereist: Ja

Uniek: Ja

Koptekst: course_id of organization_id

Beschrijving: Korte naam die door de instelling wordt gebruikt om de cursus of organisatie op unieke wijze te identificeren (bijvoorbeeld math101_F99 of schaakclub) De volgende tekens mogen niet worden gebruikt: spatie ( ) & / ' +

Maximale lengte: 100. Moet uniek zijn en kan niet worden gewijzigd.

Cursusnaam of organisatienaam (verplicht)

Vereist: Ja

Uniek: Nee

Koptekst: course_name/organization_name

Beschrijving: Volledige titel van de cursus of organisatie. Deze wordt weergegeven.

Maximale lengte: 255. Tekens die uit meerdere bytes bestaan worden geaccepteerd.

Gegevensbronsleutel (vereist) Geleverd door de integratie of het gegevensbestand.

Vereist: Ja

Uniek: Nee

Koptekst: data_source_key

Beschrijving: Sleutel die wordt gebruikt om een groepering van cursus- of organisatie-elementen tot stand te brengen. Dit wordt mogelijk uitgegeven door de integratieconfiguratie en is daarom niet vereist in het bestand.

Maximale lengte: 256. Tekens die uit meerdere bytes bestaan worden geaccepteerd.

Cursus weergave

Vereist: Nee

Uniek: Nee

Koptekst: course_experience

Beschrijving: hiermee bepaal je welke cursusweergave wordt weergegeven voor nieuwe cursussen. Dit veld is alleen invoegen en kan niet worden bijgewerkt via het Studentinformatiesysteem-framework.

Ondersteunde waarden: Origineel, Ultra of Keuze van de instructeur.

Organisatieweergave

Vereist: Nee

Uniek: Nee

Koptekst: organization_experience

Beschrijving: Hiermee kunnen klanten de ervaring selecteren waarin ze hun organisatie willen maken. Dit veld is alleen invoegen en kan niet worden bijgewerkt via het Studentinformatiesysteem-framework.

Ondersteunde waarden: Origineel, Ultra of Keuze van de instructeur.

classificationId

Vereist: Nee

Uniek: Nee

Koptekst: classification_key

Beschrijving: Dit bepaalt de indeling (vakgebied en discipline) van de cursus. Dit is een ID die de primaire sleutel voor de classificatie vertegenwoordigt.

Maximale lengte: 450

hasDescriptionPage

Vereist: Nee

Uniek: Nee

Koptekst: desc_page_ind

Beschrijving: Dit veld wordt momenteel niet ondersteund. Integraties moeten dit veld niet gebruiken.

numDaysOfUse

Vereist: Nee

Uniek: Nee

Koptekst: days_of_use

Beschrijving: Aantal dagen dat Studenten toegang hebben tot de cursus na inschrijving. Handig wanneer studenten zelf het tempo bepalen. Deze waarde wordt alleen gebruikt als de duur is ingesteld op 'VAST' en deze het aantal dagen beschrijft dat de cursus kan worden gebruikt nadat deze is gemaakt.

Numeriek. Bijvoorbeeld: 120

serviceLevelType

Vereist: Nee

Uniek: Nee

Koptekst: service_level

Beschrijving: wordt doorgaans niet gebruikt in datafeeds. Negeren.

Geeft het type cursus op.

C = Community = Organisatie

V = Vol = Cursus

G = Geregistreerd = (wordt niet gebruikt)

T = Test_Drive = (wordt niet gebruikt)

S = Systeem = Een cursus met beperkte functies om de gegevens waaruit de cursus is opgebouwd te beschermen.

Ondersteunde waarden: 'F', 'C', 'R', 'T', 'S'

Gasten toestaan

Vereist: Nee

Uniek: Nee

Koptekst: allow_guest_ind

Beschrijving: Geeft gasten toegang tot de cursus.

Ondersteunde waarden: 'Y', 'N'

Waarnemers toestaan

Vereist: Nee

Uniek: Nee

Koptekst: allow_observer_ind

Beschrijving: Hiermee heeft de waarnemer toegang tot de cursus.

Ondersteunde waarden: 'Y', 'N'

Beschikbaar

Vereist: Nee

Uniek: Nee

Koptekst: available_ind

Beschrijving: hiermee stelt u de beschikbaarheid van cursussen of organisaties vast op Blackboard. Als use_term_avail_ind 'J' is, wordt deze vlag genegeerd en wordt de beschikbaarheid van deze cursus bepaald door de gekoppelde term available_ind.

Ondersteunde waarden: 'Y', 'N'

Batch-UID gecombineerde cursussen

Vereist: Nee

Uniek: Nee

Koptekst: master_course_key

Omschrijving: Oudercursus EXTERNAL_COURSE_KEY waarvan deze cursus een kind is.

Maximale lengte: 64

Beschrijving

Vereist: Nee

Uniek: Nee

Koptekst: beschrijving

Beschrijving: Volledige beschrijving van de cursus.

Maximale lengte: 4000. Tekens die uit meerdere bytes bestaan worden geaccepteerd.

Duur

Vereist: Nee

Uniek: Nee

Koptekst: duur

Beschrijving: Dit is om aan te geven of de duur van de cursusbeschikbaarheid aaneengesloten, datumbereik, x dagen vanaf inschrijving of semester-gedicteerd is.

Dit zijn de opties:

  • Doorlopend: 'C' = De Cursus is altijd toegankelijk.

  • Bereik: 'R' = De cursus is toegankelijk in de dagen tussen één START_DATE en END_DATE. De begin- of einddatum kan open worden gelaten om een cursus toegankelijk te maken vanaf of tot een bepaalde datum.

  • Duur: 'D' = N dagen vanaf inschrijving

  • Term: 'T' = door de term gedicteerd (de duur van de bijbehorende semester bepaalt de duur van deze cursus)

Ondersteunde waarden: "C", "R", "D", "T"

Leertempo

Vereist: Nee

Uniek: Nee

Kopbal: tempo

Beschrijving: Geeft aan of de cursus onder leiding van een instructeur of in eigen tempo is, afhankelijk van de Student.

Ondersteunde waarden: "Zelf", "Instructeur"

Einddatum

Vereist: Nee

Uniek: Nee

Koptekst: end_date

Beschrijving: Datum waarop de toegang tot de Cursus eindigt.

Formaat: jjjjmmdd

Taalpakket doorvoeren

Vereist: Nee

Uniek: Nee

Koptekst: locale_enforced

Beschrijving: een markering die bepaalt of het taalpakket wordt afgedwongen wanneer een gebruiker de cursus opent. Als het taalpakket niet wordt afgedwongen, kan de gebruiker de cursus weergeven met het gewenste taalpakket.

Ondersteunde waarden: 'Y','N'

Toegangscode voor inschrijving

Vereist: Nee

Uniek: Nee

Koptekst: enroll_access_code

Beschrijving: Dit is de toegangscode die studenten kunnen gebruiken bij het inschrijven voor de cursus.

Maximale lengte: 50.

Einddatum inschrijving

Vereist: Nee

Uniek: Nee

Koptekst: enroll_end

Beschrijving: datum waarop inschrijving niet meer beschikbaar is voor Studenten.

Formaat: jjjjmmdd

Begindatum inschrijving

Vereist: Nee

Uniek: Nee

Koptekst: enroll_start

Beschrijving: Datum waarop de inschrijving kan beginnen.

Formaat: jjjjmmdd

Inschrijvingstype

Vereist: Nee

Uniek: Nee

Koptekst: enroll_option

Beschrijving: hiermee bepaalt u de inschrijvingsmethode.

Ondersteunde waarden: "instructor", "self", or "email".

Kosten

Vereist: Nee

Uniek: Nee

Koptekst: vergoeding

Beschrijving: Vergoeding in verband met deze cursus of organisatie.

Numeriek. 11 tekens, 2 decimalen. Bijvoorbeeld 1500,00

De naam van de instelling

Vereist: Nee

Uniek: Nee

Koptekst: institution_name

Beschrijving: De naam van de instelling.

Maximale lengte: 255. Tekens die uit meerdere bytes bestaan worden geaccepteerd.

Taal pakket

Vereist: Nee

Uniek: Nee

Koptekst: landinstelling

Beschrijving: Identificatie voor het taalpakket van uw voorkeur. De waarde wordt genoteerd als xx_XX. Het Franse taalpakket wordt bijvoorbeeld weergegeven als fr_FR

Maximale lengte: 20.

Buitengesloten

Vereist: Nee

Uniek: Nee

Koptekst: lockout_ind

Beschrijving: Geeft aan of de toegang tot de Cursus of Organisatie beperkt is. Als deze optie is ingesteld op "J", is de toegang tot de cursus of organisatie beperkt op basis van de END_DATE en START_DATE.

Ondersteunde waarden: 'Y', 'N'

Maximaal schijfgebruik (zachte limiet)

Vereist: Nee

Uniek: Nee

Koptekst: soft_limit

Beschrijving: Zachte limiet op cursusquota. Met deze instelling worden waarschuwings-e-mails geactiveerd wanneer de opslag van cursusmappen de opgegeven soft_limit bereikt en er cursusquota van kracht zijn.

Numeriek. Bijvoorbeeld: 10 MB zou 10485760 bytes zijn.

Batch-UID van primaire koppeling

Vereist: Nee

Uniek: Ja

Koptekst: external_association_key

Beschrijving: De externe sleutel van het knooppunt waarmee de cursus voornamelijk moet worden geassocieerd. De cursus gebruikt de standaardinstellingen van dat knooppunt om eigen instellingen te maken. Dit is hetzelfde veld als "external_association_key" uit de feed Cursuskoppeling, alleen gaat het hier om de primaire koppeling. De standaardinstellingen worden gekopieerd wanneer de cursus wordt gemaakt.

De juiste minimaal vereiste kopteksten voor het maken van cursussen die moeten worden gekoppeld met een hiërarchieknooppunt binnen de instelling zijn:

external_course_key

course_id

course_name

external_association_key

primary_external_node_key

Batch-UID van primair knooppunt

Vereist: Nee

Uniek: Nee

Koptekst: primary_external_node_key

Beschrijving: Dit is hetzelfde veld als "external_node_key" uit de feed van de cursusvereniging; Behalve dat dit de primaire associatie is.

De juiste minimaal vereiste kopteksten voor het maken van cursussen die moeten worden gekoppeld met een hiërarchieknooppunt binnen de instelling zijn:

external_course_key

course_id

course_name

external_association_key

primary_external_node_key

Maximale lengte: 256

Vervangende batch-UID

Vereist: Nee

Uniek: Ja

Koptekst: new_external_course_key

Beschrijving: Dit veld wordt alleen gebruikt in het zeldzame geval dat de EXTERNAL KEY van een cursus of organisatie verandert.

Maximale lengte: 64. Moet uniek zijn. Tekens die uit meerdere bytes bestaan worden geaccepteerd.

Vervangende gegevensbronbatch-Uid

Vereist: Nee

Uniek: Nee

Koptekst: new_data_source_key

Beschrijving: Nieuwe sleutel die wordt gebruikt om de groepering van gebruikerselementen tot stand te brengen. Vervangt bestaande gegevensbron die gegevens koppelt aan de groep die is aangewezen door de opgegeven vervangende gegevensbronsleutel. Opmerking: Het UI-toewijzingsveld voor Replacement Data Source Batch-UID is 'script.flatfile.CourseReplacementDataSourceBatchUid'

Rijstatus

Vereist: Nee

Uniek: Nee

Koptekst: row_status

Beschrijving: Hiermee stelt u de waarde van de record in op een van de volgende opties: Ingeschakeld: Normale toegang tot de record. Uitgeschakeld: Record is zichtbaar in sommige delen van de gebruikersinterface, maar kan niet worden gewijzigd of geopend. Verwijderd: De record is gepland om te worden verwijderd.

Ondersteunde waarden: "enabled", "disabled", "deleted"

Weergeven in catalogus

Vereist: Nee

Uniek: Nee

Koptekst: catalog_ind

Beschrijving: Hiermee wordt bepaald of de cursus of organisatie in de catalogus wordt weergegeven.

Ondersteunde waarden: 'Y', 'N'

Kopieersleutel voor broncursus. Kopieersleutel voor bronorganisatie

Vereist: Nee

Uniek: Nee

Koptekst: template_course_key.template_organization_key

Beschrijving: Externe sleutel van de inhoudsbron voor kopieerbewerkingen.

Maximale lengte: 64. Tekens die uit meerdere bytes bestaan worden geaccepteerd.

Startdatum

Vereist: Nee

Uniek: Nee

Koptekst: start_date

Beschrijving: Datum waarop de toegang tot het cursusgedeelte begint.

Formaat: jjjjmmdd

Periode

Vereist: Nee

Uniek: Nee

Koptekst: term_key

Beschrijving: Geassocieerde EXTERNAL_TERM_KEY

Maximale lengte: 256.

Beschikbaarheid van termen gebruiken

Vereist: Nee

Uniek: Nee

Koptekst: use_term_availability_ind

Beschrijving: Vlag om de bijbehorende semester te volgen voor beschikbaarheid natuurlijk. Als dit is ingesteld op J, dan worden de periode voor available_ind, startdate en enddate gebruikt. Als dit is ingesteld op N, worden de cursusinstellingen gebruikt.

Ondersteunde waarden: 'Y', 'N'

TOP

LEARN Object: Course and Organization Membership

Opmerking

Voor cursussen en organisaties zijn dezelfde velden vereist. De koptekst is afhankelijk van of er een cursus of organisatie wordt gemaakt. Je ziet de verschillen wanneer je gegevensfeeds maakt.

Studentinformatiesysteem-object: lidmaatschappen van cursussen of organisaties (inschrijvingen en opdrachten van medewerkers)

Standaard invoeg-/bijwerkingsgedrag: slimme invoegingen of updates

Standaard verwijdergedrag: Uitschakelen

Learn-velden

Cursus Batch-UID of Organization Batch-UID (Vereist)

Vereist: Ja

Uniek: Nee

Koptekst: external_course_key of external_organization_key

Beschrijving: Dit is dezelfde sleutel die wordt gebruikt om de cursus of organisatie te identificeren.

Maximale lengte: 64. Tekens die uit meerdere bytes bestaan worden geaccepteerd.

Gegevensbronsleutel (vereist) Geleverd door de integratie of het gegevensbestand.

Vereist: Ja

Uniek: Nee

Koptekst: data_source_key

Beschrijving: Sleutel die wordt gebruikt om de groepering van gebruikerselementen tot stand te brengen. Dit wordt mogelijk uitgegeven door de integratieconfiguratie en is daarom niet vereist in het bestand.

Maximale lengte: 256. Tekens die uit meerdere bytes bestaan worden geaccepteerd.

User Batch-UID (Vereist)

Vereist: Ja

Uniek: Nee

Koptekst: external_person_key

Beschrijving: Dit is de external_person_key die wordt gebruikt om de gebruiker te identificeren.

Maximale lengte: 64. Tekens die uit meerdere bytes bestaan worden geaccepteerd.

heeftCartridgeToegang

Vereist: Nee

Uniek: Nee

Koptekst: hascartridgeaccess

Beschrijving: Dit veld wordt niet ondersteund en is niet bedoeld voor verwijdering. Negeren. Nieuwe integraties moeten dit veld niet gebruiken. Als bestaande integraties gebruikmaken van dit veld, moet dat worden stopgezet.

Beschikbaar

Vereist: Nee

Uniek: Nee

Koptekst: available_ind

Beschrijving: hiermee wordt de beschikbaarheid van inschrijving in Blackboard Learn bepaald.

Ondersteunde waarden: 'Y', 'N'

Afbeeldings-URL

Vereist: Nee

Uniek: Nee

Koptekst: Image_URL

Beschrijving: Dit veld wordt niet ondersteund en is niet bedoeld voor verwijdering. Negeren. Nieuwe integraties moeten dit veld niet gebruiken. Als bestaande integraties gebruikmaken van dit veld, moet dat worden stopgezet.

Opnemen in rooster

Vereist: Nee

Uniek: Nee

Koptekst: roster_ind

Beschrijving: Vlag die aangeeft of de gebruiker in de lijst wordt weergegeven.

Ondersteunde waarden: 'Y', 'N'

Inleiding

Vereist: Nee

Uniek: Nee

Koptekst: intro

Beschrijving: Introductie-informatie voor de startpagina van de gebruiker in de cursus.

Maximale lengte: 4000. Tekens die uit meerdere bytes bestaan worden geaccepteerd.

Opmerkingen

Vereist: Nee

Uniek: Nee

Koptekst: noten

Beschrijving: Informatie die relevant is voor deze gebruiker en die van invloed kan zijn op de deelname aan de cursus of organisatie.

Niet beperkt. Tekens die uit meerdere bytes bestaan worden geaccepteerd.

Persoonlijke gegevens

Vereist: Nee

Uniek: Nee

Koptekst: pinfo

Beschrijving: Persoonlijke gegevens voor de startpagina van de gebruiker.

Niet beperkt. Tekens die uit meerdere bytes bestaan worden geaccepteerd.

Primaire cursusleider

Vereist: Nee

Uniek: Nee

Koptekst: primary_instructor

Beschrijving: Geeft aan dat het lidmaatschap een primaire instructeur is. Lid moet een cursusrol hebben met de vlag 'behandelen als cursusleider'. Als het lid geen cursusleider is of deze vlag niet heeft, wordt deze optie niet weergegeven. Als je een cursusrol toewijst zonder de vlag 'behandelen als cursusleider', wordt een J in de lidmaatschapsrecord afgekeurd.

Ondersteunde waarden: 'Y', 'N'

E-mail ontvangen

Vereist: Nee

Uniek: Nee

Koptekst: receive_email_ind

Beschrijving: markeer of e-mail is ingeschakeld voor deze gebruiker.

Ondersteunde waarden: 'Y', 'N'

Vervangende gegevensbronbatch-Uid

Vereist: Nee

Uniek: Nee

Koptekst: new_data_source_key

Beschrijving: Nieuwe sleutel die wordt gebruikt om de groepering van gegevenselementen tot stand te brengen. Vervangt bestaande gegevensbron die gegevens koppelt aan de groep die is aangewezen door de opgegeven vervangende gegevensbronsleutel. Opmerking: Het UI-toewijzingsveld voor Replacement Data Source Batch-UID is 'script.flatfile.MemberReplacementDataSourceBatchUid'

Rol

Vereist: Nee

Uniek: Nee

Koptekst: rol

Beschrijving: de rol van de gebruiker in de cursus.

Ondersteunde waarden: "Instructor", "teaching_assistant", "course_builder", "Grader", "Student", "guest", "none"

Rijstatus

Vereist: Nee

Uniek: Nee

Koptekst: row_status

Beschrijving: Hiermee stelt u de waarde van de record in op een van de volgende opties: Ingeschakeld: Normale toegang tot de record. Uitgeschakeld: Record is zichtbaar in sommige delen van de gebruikersinterface, maar kan niet worden gewijzigd of geopend. Verwijderd: De record is gepland om te worden verwijderd.

Ondersteunde waarden: "enabled", "disabled", "deleted"

Beschrijving website 1

Vereist: Nee

Uniek: Nee

Koptekst: link_description_1

Beschrijving: Beschrijving voor de website van de gebruiker

Maximale lengte: 255

Website 1 Naam

Vereist: Nee

Uniek: Nee

Koptekst: link_name_1

Beschrijving: Naam gebruikt in link naar gebruikerswebsite

Maximale lengte: 100

Website 1 URL

Vereist: Nee

Uniek: Nee

Koptekst: link_url_1

Beschrijving: URL gebruikt in link naar gebruikerswebsite

Maximale lengte: 100

Website 2 Beschrijving

Vereist: Nee

Uniek: Nee

Koptekst: link_description_2

Beschrijving: Beschrijving voor de website van de gebruiker

Maximale lengte: 255

Website 2 Naam

Vereist: Nee

Uniek: Nee

Koptekst: link_name_2

Beschrijving: Naam gebruikt in link naar gebruikerswebsite

Maximale lengte: 100

Website 2 URL

Vereist: Nee

Uniek: Nee

Koptekst: link_url_2

Beschrijving: URL gebruikt in link naar gebruikerswebsite

Maximale lengte: 100

Website 3 Beschrijving

Vereist: Nee

Uniek: Nee

Koptekst: link_description_3

Beschrijving: Beschrijving voor de website van de gebruiker

Maximale lengte: 255

Website 3 Naam

Vereist: Nee

Uniek: Nee

Koptekst: link_name_3

Beschrijving: Naam gebruikt in link naar gebruikerswebsite

Maximale lengte: 100

Website 3 URL

Vereist: Nee

Uniek: Nee

Koptekst: link_url_3

Beschrijving: URL gebruikt in link naar gebruikerswebsite

Maximale lengte: 100

TOP

LEARN Object: Term

Studentinformatiesysteem-object:Term

Standaard invoeg-/bijwerkingsgedrag: slimme invoegingen of updates

Standaard verwijdergedrag: Uitschakelen

Learn-velden

Batch Uid (Vereist)

Vereist: Ja

Uniek: Ja

Koptekst: external_term_key

Beschrijving: Korte naam die door de instelling wordt gebruikt om de semester uniek te identificeren. Deze wordt niet voor gebruikers weergegeven. Kan alleen letters, cijfers, streepjes en punten bevatten. Spaties of andere leestekens zijn niet toegestaan.

Maximale lengte: 256. Tekens die uit meerdere bytes bestaan worden geaccepteerd.

Gegevensbronsleutel (vereist) Geleverd door de integratie of het gegevensbestand.

Vereist: Ja

Uniek: Nee

Koptekst: data_source_key

Beschrijving: Sleutel die wordt gebruikt om de groepering van termelementen tot stand te brengen. Dit wordt mogelijk uitgegeven door de integratieconfiguratie en is daarom niet vereist in het bestand.

Maximale lengte: 256. Tekens die uit meerdere bytes bestaan worden geaccepteerd.

Naam (Vereist)

Vereist: Ja

Uniek: Nee

Header: naam

Beschrijving: Naam van de term.

Maximale lengte: 333

daysOfUse

Vereist: Nee

Uniek: Nee

Koptekst: days_of_use

Beschrijving: Aantal dagen dat Studenten toegang hebben tot de cursus na inschrijving. Handig wanneer studenten zelf het tempo bepalen.

Numeriek.

Beschikbaar

Vereist: Nee

Uniek: Nee

Koptekst: available_ind

Beschrijving: Bepaalt de beschikbaarheid van de semester. Als dit is ingesteld op 'N', zijn de gekoppelde objecten niet beschikbaar.

Ondersteunde waarden: 'Y', 'N'

Beschrijving

Vereist: Nee

Uniek: Nee

Koptekst: beschrijving

Beschrijving: Beschrijving van de term

Niet beperkt.

Duur

Vereist: Nee

Uniek: Nee

Koptekst: duur

Beschrijving: Beschikbaarheidsvenster voor planningstermijnen.

Dit zijn de opties:

  • Doorlopend: De Term is altijd toegankelijk.

  • Bereik: De semester is geldig in de dagen tussen één START_DATE en END_DATE. De begin- of einddatum kan open worden gelaten om een periode geldig te maken vanaf of tot een bepaalde datum.

  • Vast: De Termijn is geldig voor een bepaald aantal dagen (DAYS_OF_USE).

Ondersteunde waarden: Continu, Bereik, Vast

Einddatum

Vereist: Nee

Uniek: Nee

Koptekst: end_date

Beschrijving: Dit is de datum waarop het semester niet meer beschikbaar is voor toegang.

Formaat: jjjjmmdd

Vervangende batch-UID

Vereist: Nee

Uniek: Ja

Koptekst: new_external_term_key

Beschrijving: Dit veld wordt alleen gebruikt in de zeldzame gevallen waarin een term EXTERNAL KEY verandert.

Maximale lengte: 256. Tekens die uit meerdere bytes bestaan worden geaccepteerd.

Vervangende gegevensbronbatch-Uid

Vereist: Nee

Uniek: Nee

Koptekst: new_data_source_key

Beschrijving: Nieuwe sleutel die wordt gebruikt om de groepering van gegevenselementen tot stand te brengen. Vervangt bestaande gegevensbron die gegevens koppelt aan de groep die is aangewezen door de opgegeven vervangende gegevensbronsleutel. Opmerking: Het UI-toewijzingsveld voor Replacement Data Source Batch-UID is 'script.flatfile.TermReplacementDataSourceBatchUid'

Rijstatus

Vereist: Nee

Uniek: Nee

Koptekst: row_status

Beschrijving: Hiermee stelt u de waarde van de record in op een van de volgende opties:

  • Ingeschakeld: Normale toegang tot de record.

  • Uitgeschakeld: Record is zichtbaar in sommige delen van de gebruikersinterface, maar kan niet worden gewijzigd of geopend.

  • Verwijderd: De record is gepland om te worden verwijderd.

Ondersteunde waarden: "enabled", "disabled", "deleted"

Startdatum

Vereist: Nee

Uniek: Nee

Koptekst: start_date

Beschrijving: Dit is de datum waarop het semester beschikbaar begint te zijn voor toegang.

Formaat: jjjjmmdd

TOP

LEARN Object: Secondary Institution Role Association

Studentinformatiesysteem-object:Rol secundaire instelling gebruiker

Standaard invoeg-/bijwerkingsgedrag: slimme invoegingen of updates

Standaard verwijdergedrag: Uitschakelen

Learn-velden

Gegevensbronsleutel (vereist) Geleverd door de integratie of het gegevensbestand.

Vereist: Ja

Uniek: Nee

Koptekst: data_source_key

Beschrijving: Sleutel die wordt gebruikt om de groepering van gebruikerselementen tot stand te brengen. Dit wordt mogelijk uitgegeven door de integratieconfiguratie en is daarom niet vereist in het bestand.

Maximale lengte: 256. Tekens die uit meerdere bytes bestaan worden geaccepteerd.

Rol-ID secundaire instelling (vereist)

Vereist: Ja

Uniek: Nee

Koptekst: role_id

Beschrijving: de identificatiecode voor de rol van de secundaire instelling voor deze vereniging.

User Batch-UID (Vereist)

Vereist: Ja

Uniek: Nee

Koptekst: external_person_key

Omschrijving: De gebruiker external_person_key (batch_uid) te gebruiken voor deze koppeling.

Maximale lengte: 64.

Vervangende gegevensbronbatch-Uid

Vereist: Nee

Uniek: Nee

Koptekst: new_data_source_key

Beschrijving: Nieuwe sleutel die wordt gebruikt om de groepering van gegevenselementen tot stand te brengen. Vervangt bestaande gegevensbron die gegevens koppelt aan de groep die is aangewezen door de opgegeven vervangende gegevensbronsleutel. Opmerking: Het UI-toewijzingsveld voor Replacement Data Source Batch-UID is 'script.flatfile.SecondaryInstRoleReplacementDataSourceBatchUid'

Rijstatus

Vereist: Nee

Uniek: Nee

Koptekst: row_status

Beschrijving: Hiermee stelt u de waarde van de record in op een van de volgende opties: Ingeschakeld: Normale toegang tot de record. Uitgeschakeld: Record is zichtbaar in sommige delen van de gebruikersinterface, maar kan niet worden gewijzigd of geopend. Verwijderd: De record is gepland om in de toekomst handmatig te worden verwijderd door de beheerder. De rij wordt niet automatisch door middel van een taak verwijderd.

Ondersteunde waarden: "enabled", "disabled", "deleted"

TOP

LEARN Object: Observer Association

Studentinformatiesysteem-object: Waarnemersvereniging

Standaard invoeg-/bijwerkingsgedrag: slimme invoegingen of updates

Standaard verwijdergedrag: Uitschakelen

Learn-velden

Gegevensbronsleutel (vereist) Geleverd door de integratie of het gegevensbestand.

Vereist: Ja

Uniek: Nee

Koptekst: data_source_key

Beschrijving: Sleutel die wordt gebruikt om de groepering van gebruikerselementen tot stand te brengen. Dit wordt mogelijk uitgegeven door de integratieconfiguratie en is daarom niet vereist in het bestand.

Maximale lengte: 256. Tekens die uit meerdere bytes bestaan worden geaccepteerd.

Geobserveerde Student (verplicht)

Vereist: Ja

Uniek: Nee

Koptekst: external_user_key

Omschrijving: De gebruiker external_person_key (batch_uid) te gebruiken voor deze koppeling. Een unieke identificatie voor een gebruiker met de instellingsrol Student. Deze ID wordt uitgegeven door de instelling en wordt niet weergegeven aan gebruikers.

Maximale lengte: 64. Tekens die uit meerdere bytes bestaan worden geaccepteerd.

Waarnemer (Vereist)

Vereist: Ja

Uniek: Nee

Koptekst: external_observer_key

Beschrijving: De waarnemer external_person_key (batch_uid) die voor deze vereniging moet worden gebruikt. Een unieke identificatie voor een gebruiker met de systeemrol Waarnemer.

Maximale lengte: 64. Tekens die uit meerdere bytes bestaan worden geaccepteerd.

Vervangende gegevensbronbatch-Uid

Vereist: Nee

Uniek: Nee

Koptekst: new_data_source_key

Beschrijving: Nieuwe sleutel die wordt gebruikt om de groepering van gegevenselementen tot stand te brengen. Vervangt bestaande gegevensbron die gegevens koppelt aan de groep die is aangewezen door de opgegeven vervangende gegevensbronsleutel. Opmerking: Het UI-toewijzingsveld voor Replacement Data Source Batch-UID is 'script.flatfile.AssociateObserverReplacementDataSourceBatchUid'

Rijstatus

Vereist: Nee

Uniek: Nee

Koptekst: row_status

Beschrijving: Hiermee stelt u de waarde van de record in op een van de volgende opties: Ingeschakeld: Normale toegang tot de record. Uitgeschakeld: Record is zichtbaar in sommige delen van de gebruikersinterface, maar kan niet worden gewijzigd of geopend. Verwijderd: De record is gepland om te worden verwijderd.

Ondersteunde waarden: "enabled", "disabled", "deleted"

TOP

LEARN Object: Category

Studentinformatiesysteem-object:Cursus Categorie

Standaard invoeg-/bijwerkingsgedrag: slimme invoegingen of updates

Standaard verwijdergedrag: Uitschakelen

Learn-velden

dataSourceBatchUid (Vereist)

Vereist: Ja

Uniek: Nee

Koptekst: data_source_key

Beschrijving: Sleutel die wordt gebruikt om de groepering van categorie-elementen tot stand te brengen.

Tekens die uit meerdere bytes bestaan worden geaccepteerd.

titel (Vereist)

Vereist: Ja

Uniek: Nee

Koptekst: titel

Beschrijving: de naam van de categorie zoals deze wordt weergegeven voor gebruikers in de gebruikersinterface.

Maximale lengte: 255. Tekens die uit meerdere bytes bestaan worden geaccepteerd.

Batch Uid (Vereist)

Vereist: Ja

Uniek: Ja

Koptekst: external_category_key

Beschrijving: Moet uniek zijn. Dit veld komt overeen met het veld Sneltoetsen voor categorie in de gebruikersinterface.

Maximale lengte: 64. Tekens die uit meerdere bytes bestaan worden geaccepteerd.

beschrijving

Vereist: Nee

Uniek: Nee

Koptekst: beschrijving

Beschrijving: Categorie beschrijving.

frontPageInd

Vereist: Nee

Uniek: Nee

Koptekst: frontpage_ind

Beschrijving: Bepaalt of de categorie al dan niet op de voorpagina van de catalogus wordt weergegeven.

Ondersteunde waarden: 'Y', 'N'

isAvailable

Vereist: Nee

Uniek: Nee

Koptekst: available_ind

Beschrijving: hiermee stelt u de beschikbaarheid van categorieën in Blackboard Learn in.

Ondersteunde waarden: 'Y', 'N'

isRestricted

Vereist: Nee

Uniek: Nee

Koptekst: restrict_ind

Beschrijving: markeer of de cursus of organisatie beperkt is tot leden.

Ondersteunde waarden: 'Y', 'N'

parentBatchUid

Vereist: Nee

Uniek: Nee

Koptekst: parent_category_key

Beschrijving: de EXTERNAL_CATEGORY_KEY die de bovenliggende categorie vertegenwoordigt waarvan deze categorie een kind is.

Maximale lengte: 64.

rowStatus

Vereist: Nee

Uniek: Nee

Koptekst: row_status

Beschrijving: Hiermee stelt u de waarde van de record in op een van de volgende opties: Ingeschakeld: Normale toegang tot de record. Uitgeschakeld: Record is zichtbaar in sommige delen van de gebruikersinterface, maar kan niet worden gewijzigd of geopend. Verwijderd: De record is gepland om te worden verwijderd. Tekenreeks

Ondersteunde waarden: "enabled", "disabled", "deleted"

Vervangende batch-UID

Vereist: Nee

Uniek: Ja

Koptekst: new_external_category_key

Beschrijving: Verwijst naar de vervanging van de huidige sleutel.

Maximale lengte: 64. Tekens die uit meerdere bytes bestaan worden geaccepteerd.

Vervangende gegevensbronbatch-Uid

Vereist: Nee

Uniek: Nee

Koptekst: new_data_source_key

Beschrijving: Nieuwe sleutel die wordt gebruikt om de groepering van gegevenselementen tot stand te brengen. Vervangt bestaande gegevensbron die gegevens koppelt aan de groep die is aangewezen door de opgegeven vervangende gegevensbronsleutel. Opmerking: Het UI-toewijzingsveld voor Replacement Data Source Batch-UID is 'script.flatfile.CourseCatReplacementDataSourceBatchUid'

TOP

LEARN Object: Category Membership

Studentinformatiesysteem-object: Categorie lidmaatschap

Standaard invoeg-/bijwerkingsgedrag: slimme invoegingen of updates

Standaard verwijdergedrag: Uitschakelen

Learn-velden

Batch Uid (Vereist)

Vereist: Ja

Uniek: Ja

Beschrijving: Automatisch gevuld. Niet gebruiken in gegevensfeeds.

Categorie batch-UID (Vereist)

Vereist: Ja

Uniek: Nee

Koptekst: external_category_key

Beschrijving: De EXTERNAL KEY (batch_uid) voor de categorie waaraan de batch moet worden toegevoegd.

Maximale lengte: 64.

Cursus Batch-UID of Organization Batch-UID (Vereist)

Vereist: Ja

Uniek: Nee

Koptekst: external_course_key

Beschrijving: external_organization_key De EXTERNAL KEY (batch_uid) voor de cursus of organisatie die wordt gecategoriseerd.

Maximale lengte: 64.

Gegevensbronsleutel (vereist) Geleverd door de integratie of het gegevensbestand.

Vereist: Ja

Uniek: Nee

Koptekst: data_source_key

Beschrijving: Sleutel die wordt gebruikt om de groepering van gebruikerselementen tot stand te brengen. Dit wordt mogelijk uitgegeven door de integratieconfiguratie en is daarom niet vereist in het bestand.

Tekens die uit meerdere bytes bestaan worden geaccepteerd.

Is beschikbaar

Vereist: Nee

Uniek: Ja

Koptekst: available_ind

Beschrijving: hiermee stelt u de beschikbaarheid van categorieën in Blackboard Learn in.

Ondersteunde waarden: 'Y', 'N'

Vervangende gegevensbronbatch-Uid

Vereist: Nee

Uniek: Nee

Koptekst: new_data_source_key

Beschrijving: Nieuwe sleutel die wordt gebruikt om de groepering van gegevenselementen tot stand te brengen. Vervangt bestaande gegevensbron die gegevens koppelt aan de groep die is aangewezen door de opgegeven vervangende gegevensbronsleutel. Opmerking: Het UI-toewijzingsveld voor Replacement Data Source Batch-UID is 'script.flatfile.CourseCatMemReplacementDataSourceBatchUid'

Rijstatus

Vereist: Nee

Uniek: Nee

Koptekst: row_status

Beschrijving: Hiermee stelt u de waarde van de record in op een van de volgende opties: Ingeschakeld: Normale toegang tot de record. Uitgeschakeld: Record is zichtbaar in sommige delen van de gebruikersinterface, maar kan niet worden gewijzigd of geopend. Verwijderd: De record is gepland om te worden verwijderd.

Ondersteunde waarden: "enabled", "disabled", "deleted"

TOP

LEARN Object: Hierarchy Node

Studentinformatiesysteem-object: Hiërarchieknooppunt

Standaard invoeg-/bijwerkingsgedrag: slimme invoegingen of updates

Standaard verwijdergedrag: Opschonen

Learn-velden

Deze zijn de minimaal vereiste kopteksten voor het maken van een hiërarchieknooppunt binnen de instelling:

  • external_node_key

  • data_source_key

  • parent_node_key

  • naam

Batch Uid (Vereist)

Vereist: Ja

Uniek: Ja

Koptekst: external_node_key

Beschrijving: Identificatie die door de instelling wordt gebruikt om het hiërarchische knooppunt op unieke wijze te identificeren. Deze wordt niet voor gebruikers weergegeven. Kan alleen letters, cijfers, streepjes en punten bevatten. Spaties of andere leestekens zijn niet toegestaan.

Maximale lengte: 255. Tekens die uit meerdere bytes bestaan worden geaccepteerd.

Gegevensbronsleutel (vereist) Geleverd door de integratie of het gegevensbestand.

Vereist: Ja

Uniek: Nee

Koptekst: data_source_key

Beschrijving: Sleutel die wordt gebruikt om de groepering van gebruikerselementen tot stand te brengen. Dit wordt mogelijk uitgegeven door de integratieconfiguratie en is daarom niet vereist in het bestand.

Maximale lengte: 255. Tekens die uit meerdere bytes bestaan worden geaccepteerd.

Parent Batch-UID (vereist)

Vereist: Ja

Uniek: Nee

Koptekst: parent_node_key

Beschrijving: Bovenliggende external_node_key (batch uid) voor dit knooppunt.

Maximale lengte: 64.

Naam (Vereist)

Vereist: Ja

Uniek: Nee

Header: naam

Beschrijving: Naam knooppunt

Maximale lengte: 255

Beschrijving

Vereist: Nee

Uniek: Nee

Koptekst: beschrijving

Beschrijving: Beschrijving van de knoop

Maximale lengte: 1000.

Vervangende batch-UID

Vereist: Nee

Uniek: Ja

Koptekst: new_external_node_key

Beschrijving: Dit veld wordt alleen gebruikt in de zeldzame gevallen waarin de EXTERNAL KEY van een knooppunt verandert.

Maximale lengte: 255. Moet uniek zijn. Tekens die uit meerdere bytes bestaan worden geaccepteerd.

Vervangende gegevensbronbatch-Uid

Vereist: Nee

Uniek: Nee

Koptekst: new_data_source_key

Beschrijving: Nieuwe sleutel die wordt gebruikt om de groepering van gegevenselementen tot stand te brengen. Vervangt bestaande gegevensbron die gegevens koppelt aan de groep die is aangewezen door de opgegeven vervangende gegevensbronsleutel. Opmerking: Het UI-toewijzingsveld voor Replacement Data Source Batch-UID is 'script.flatfile.NodeReplacementDataSourceBatchUid'

TOP

LEARN Object: Hierarchy User Association

Studentinformatiesysteem-object: Gebruikersvereniging

Standaard invoeg-/bijwerkingsgedrag: slimme invoegingen of updates

Standaard verwijdergedrag: Opschonen

Learn-velden

De minimaal vereiste kopteksten voor het koppelen van gebruikers aan een hiërarchieknooppunt binnen de instelling zijn:

  • external_user_key

  • external_node_key

  • external_association_key

  • data_source_key

Gegevensbronsleutel (vereist) Geleverd door de integratie of het gegevensbestand.

Vereist: Ja

Uniek: Nee

Koptekst: data_source_key

Beschrijving: Sleutel die wordt gebruikt om de groepering van gebruikerselementen tot stand te brengen. Dit wordt mogelijk uitgegeven door de integratieconfiguratie en is daarom niet vereist in het bestand.

Maximale lengte: 255. Tekens die uit meerdere bytes bestaan worden geaccepteerd.

Batch Uid (Vereist)

Vereist: Ja

Uniek: Ja

Koptekst: external_association_key

Beschrijving: De associatie-id, de unieke ID van de gebruiker naar de knooppuntkoppeling. Vaak een aaneenschakeling van de User Batch-UID- en Node Batch-UID-waarden om uniciteit te garanderen wanneer een gebruiker aan meer dan één knooppunt kan worden toegewezen.

Maximale lengte: 64.

Node Batch-UID Uid (Vereist)

Vereist: Ja

Uniek: Nee

Koptekst: external_node_key

Beschrijving: De node voor deze koppeling, die ook de Node Identifier is die te vinden is in het gebied 'Edit Node' in de GUI

Maximale lengte: 64.

User Batch-UID (Vereist)

Vereist: Ja

Uniek: Nee

Koptekst: external_user_key

Beschrijving: De gebruiker external_person_key (batch_uid) om aan dit knooppunt te worden gekoppeld.

Maximale lengte: 64.

Vervangende batch-UID

Vereist: Nee

Uniek: Ja

Koptekst: new_external_association_key

Beschrijving: Dit veld wordt alleen gebruikt in de zeldzame gevallen waarin de EXTERNAL KEY van een vereniging verandert.

Maximale lengte: 64. Tekens die uit meerdere bytes bestaan worden geaccepteerd.

Vervangende gegevensbronbatch-Uid

Vereist: Nee

Uniek: Nee

Koptekst: new_data_source_key

Beschrijving: Nieuwe sleutel die wordt gebruikt om de groepering van gegevenselementen tot stand te brengen. Vervangt bestaande gegevensbron die gegevens koppelt aan de groep die is aangewezen door de opgegeven vervangende gegevensbronsleutel. Opmerking: Het UI-toewijzingsveld voor Replacement Data Source Batch-UID is 'script.flatfile.UserAssociationReplacementDataSourceBatchUid'

TOP

LEARN Object: Hierarchy Course Association

SIS-object: Cursuskoppeling

Standaard invoeg-/bijwerkingsgedrag: slimme invoegingen of updates

Standaard verwijdergedrag: Opschonen

Learn-velden

De minimaal vereiste kopteksten voor het koppelen van cursussen aan een hiërarchieknooppunt binnen de instelling zijn:

  • external_course_key

  • external_node_key

  • external_association_key

  • data_source_key

Batch Uid (Vereist)

Vereist: Ja

Uniek: Ja

Koptekst: external_association_key

Beschrijving: Elke cursus en knooppuntassociatie moet een unieke waarde hebben die deze relatie identificeert. De Batch-UID is de unieke id voor de relatie tussen koers en knooppunt.

Maximale lengte: 64.

Cursus Batch-UID (Vereist)

Vereist: Ja

Uniek: Nee

Koptekst: external_course_key

Beschrijving: De cursus external_course_key (batch_uid) die aan dit knooppunt moet worden gekoppeld.

Maximale lengte: 64.

Gegevensbronsleutel (vereist) Geleverd door de integratie of het gegevensbestand.

Vereist: Ja

Uniek: Nee

Koptekst: data_source_key

Beschrijving: Sleutel die wordt gebruikt om de groepering van elementen tot stand te brengen. Dit wordt mogelijk uitgegeven door de integratieconfiguratie en is daarom niet vereist in het bestand.

Maximale lengte: 255. Tekens die uit meerdere bytes bestaan worden geaccepteerd.

Node Batch-UID Uid (Vereist)

Vereist: Ja

Uniek: Nee

Koptekst: external_node_key

Beschrijving: De node voor deze vereniging.

Maximale lengte: 64. Tekens die uit meerdere bytes bestaan worden geaccepteerd.

Primaire associatie-indicator

Vereist: Nee

Uniek: Nee

Koptekst: is_primary_association

Beschrijving: Vlag die deze vereniging aanduidt als de primaire vereniging, terwijl andere verenigingen kunnen worden opgegeven.

Ondersteunde waarden: 'Y', 'N'.

Vervangende batch-UID

Vereist: Nee

Uniek: Ja

Koptekst: new_external_association_key

Beschrijving: Dit veld wordt alleen gebruikt in de zeldzame gevallen waarin de EXTERNAL KEY van een vereniging verandert.

Maximale lengte: 64. Tekens die uit meerdere bytes bestaan worden geaccepteerd.

Vervangende gegevensbronbatch-Uid

Vereist: Nee

Uniek: Nee

Koptekst: new_data_source_key

Beschrijving: Nieuwe sleutel die wordt gebruikt om de groepering van gegevenselementen tot stand te brengen. Vervangt bestaande gegevensbron die gegevens koppelt aan de groep die is aangewezen door de opgegeven vervangende gegevensbronsleutel. Opmerking: Het UI-toewijzingsveld voor Replacement Data Source Batch-UID is 'script.flatfile.CourseAssociationReplacementDataSourceBatch-UID'

TOP

LEARN Object: Goal Association

Studentinformatiesysteem-object: Doelvereniging

Standaard invoeg-/bijwerkingsgedrag: slimme invoegingen of updates

Standaard verwijdergedrag: Opschonen

Learn-velden

Batch Uid (Vereist)

Vereist: Ja

Uniek: Ja

Koptekst: Deze heeft geen koptekst, deze wordt automatisch ingevuld. Negeren in integratievelden.

Beschrijving: Een unieke identificatiecode voor de relatie tussen de cursus en het doel (standaard).

Maximale lengte: 64.

Cursus Batch-UID (Vereist)

Vereist: Ja

Uniek: Nee

Koptekst: course_key

Beschrijving: De unieke identificatiecode (external_course_key) voor de cursus waaraan het doel (standaard) wordt gekoppeld

Maximale lengte: 64.

Gegevensbronsleutel (vereist) Geleverd door de integratie of het gegevensbestand.

Vereist: Ja

Uniek: Nee

Koptekst: data_source_key

Beschrijving: Sleutel die wordt gebruikt om de groepering van gebruikerselementen tot stand te brengen. Dit wordt mogelijk uitgegeven door de integratieconfiguratie en is daarom niet vereist in het bestand.

Maximale lengte: 255. Tekens die uit meerdere bytes bestaan worden geaccepteerd.

Sub Goal Set (Vereist)

Vereist: Ja

Uniek: Nee

Koptekst: std_sub_doc_key

Beschrijving: de unieke identificatie voor het doel (standaard) om aan een cursus te koppelen.

Maximale lengte: 64.

Vervangende gegevensbronbatch-Uid

Vereist: Nee

Uniek: Nee

Koptekst: new_data_source_key

Beschrijving: Nieuwe sleutel die wordt gebruikt om de groepering van gegevenselementen tot stand te brengen. Vervangt bestaande gegevensbron die gegevens koppelt aan de groep die is aangewezen door de opgegeven vervangende gegevensbronsleutel. Opmerking: Het UI-toewijzingsveld voor Replacement Data Source Batch-UID is 'script.flatfile.GoalAssociationReplacementDataSourceBatch-UID'