Descriptions de l'en-tête du fichier plat d'instantané
Le fichier plat d'instantané offre une possibilité d'intégration à l'aide des derniers objets de données LEARN. Vous trouverez ci-après la liste exhaustive des objets pris en charge, les conventions de dénomination des en-têtes de flux de données pour les champs d'interface utilisateur de ces objets, la description de l'utilisation des objets et les exigences relatives aux données.
Le flux de données étant un fichier texte, toutes les données sont représentées sous la forme d'une chaîne. Dans certains cas, les exigences de format et de longueur spécifiques sont indiquées. Le cas échéant, les valeurs possibles d'un champ sont spécifiées. Les champs obligatoires sont mis en évidence et indiqués.
Objet d'apprentissage pour l'utilisateur
Objet SIE : Personne
Comportement d'insertion/mise à jour par défaut : Insertions ou mises à jour intelligentes
Comportement de suppression par défaut : désactiver
Domaines d'apprentissage
Batch Uid (Required)
Required: Yes
Required: Yes
En-tête : external_person_key
Description : Un identifiant unique pour un utilisateur de l’établissement. Cet identifiant est fourni par l'établissement et n'est pas visible par les utilisateurs.
Il est vivement recommandé de faire en sorte que les données de clé correspondent à un identifiant fixe permanent pour chaque utilisateur. Un exemple de clé correct est un code étudiant permanent attribué lorsque la personne s'inscrit auprès de l'établissement. Notez que la base de données ne peut pas fusionner les données de comptes distincts.
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)
Obligatoire : Oui
Unique : Non
En-tête : firstname
Description : Prénom de l'utilisateur.
Longueur maximale : 100 caractères. Caractères multi-octet acceptés.
Nom (obligatoire)
Obligatoire : Oui
Unique : Non
En-tête : lastname
Description : Nom de famille de l’utilisateur.
Longueur maximale : 100 caractères. Caractères multi-octet acceptés.
Nom d'utilisateur (obligatoire)
Obligatoire : Oui
Unique : Oui
En-tête : user_id
Description : Le nom d’utilisateur utilisé pour se connecter à Blackboard. Le nom d'utilisateur doit être unique.
Longueur maximale : 50 caractères. Caractères multi-octet acceptés.
Prononciation du nom
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.
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.
Longueur maximale : 32 caractères. Caractères multi-octet acceptés.
Nom de domaine
Obligatoire : Non
Unique : Non
En-tête : domain_name
Description : Le nom d’hôte de marque à utiliser dans les courriels de notification avant que l’utilisateur ne se connecte. La valeur doit être l’un des noms d’hôte configurés pour le système. Les valeurs non valides sont ignorées sans avertissement et l’utilisateur est créé avec le nom d’hôte par défaut. Défini uniquement lors de l'insertion, les mises à jour sont ignorées. (format par exemple : blackboard.college.edu college.blackboard.com)
Max length 100. Multi byte characters accepted.
Country
Required: No
Unique: No
Header: country
Description: The country name corresponding to the user's address.
Max length 50. Multi byte characters accepted.
Department
Required: No
Unique: No
Header: department
Description: The name of the department or sub-section where the user works.
Max length 100. Multi byte characters accepted.
Education Level
Required: No
Unique: No
Header: educ_level
Description: The highest level of education achieved by the user.
Supported values: "K-8", "high school", "freshman", "sophomore", "junior", "senior", "graduate school", "post- graduate school"
Required: No
Unique: No
Header: email
Description: The email address of the user. Blackboard recommends that user_email is not null. Users without an email address cannot send email.
Max length 100
Institution Email
Required: No
Unique: Yes
Header: inst_email
Description: The institution email address of the user. inst_email can be set to Null. No email communications are sent to the inst_email.
Max length 254
Pronoms
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
Genre
Obligatoire : Non
Unique : Non
En-tête : gender
Description : Le sexe de l’utilisateur.
Valeurs prises en charge : « Non divulgué », « Masculin », « Féminin ».
Téléphone domicile
Obligatoire : Non
Unique : Non
En-tête : h_phone_1
Description : Numéro de téléphone du domicile de l’utilisateur.
Longueur maximale : 50 caractères. Caractères multi-octet acceptés.
Téléphone domicile (secondaire)
Obligatoire : Non
Unique : Non
En-tête : h_phone_2
Description : Un numéro de téléphone supplémentaire associé à l’utilisateur.
Longueur maximale : 50 caractères. Caractères multi-octet acceptés.
Intitulé du poste
Obligatoire : Non
Unique : Non
En-tête : job_title
Description : Le titre du poste associé à l'utilisateur.
Longueur maximale : 100 caractères. Caractères multi-octet acceptés.
Deuxième prénom
Obligatoire : Non
Unique : Non
En-tête : middlename
Description : Deuxième prénom de l'utilisateur.
Longueur maximale : 100 caractères. Caractères multi-octet acceptés.
Téléphone mobile
Obligatoire : Non
Unique : Non
En-tête : m_phone
Description : numéro de téléphone portable ou de téléavertisseur de l'utilisateur.
Longueur maximale : 50 caractères. Caractères multi-octet acceptés.
Autre nom
Obligatoire : Non
Unique : Non
En-tête : othername
Description : Il s'agit de l'autre nom préféré de l'utilisateur.
Max length: 100.
Type de chiffrement du mot de passe
Obligatoire : Non
Unique : Non
En-tête : pwencryptiontype
Description : Ce champ définit le type de chiffrement du mot de passe utilisé pour chiffrer le mot de passe dans la base de données.
Les valeurs prises en charge sont les suivantes : MD5, SSHA.
Rôle premier dans l'établissement
Obligatoire : Non
Unique : Non
En-tête : institution_role
Description : Le rôle principal au sein de l’établissement de l’utilisateur, qui détermine la vue de l’utilisateur sur les modules du portail et d’autres éléments.
Pour obtenir la liste des rôles dans l'établissement valides dans le système, consultez « Gérer les rôles dans l'établissement » dans le panneau de configuration de l'administrateur.
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
En-tête : 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.
Code étudiant
Obligatoire : Non
Unique : Non
En-tête : student_id
Description : Champ d’identifiant générique. Il s'agit d'un champ en lecture seule.
Longueur maximale : 100 caractères. Caractères multi-octet acceptés.
Suffixe
Obligatoire : Non
Unique : Non
En-tête : suffix
Description : Suffixe du nom d’utilisateur.
Longueur maximale : 100 caractères. Caractères multi-octet acceptés.
Rôle dans le système
Obligatoire : Non
Unique : Non
En-tête : system_role
Description : Rôle administratif de l'utilisateur, décrivant le niveau de privilège d'administration du système de l'utilisateur. Le rôle « none » n'accorde aucun privilège d'administration système ou de création de cours. Il s'agit du rôle le plus couramment attribué.
Les chaînes acceptables sont les suivantes :
Administrateur de l'utilisateur : « account_admin », « accountadmin » ou « user_admin » Support système : « system_support » ou « syssupport »
Créateur de cours : « course_creator » ou « creator »
Assistance : « course_support » ou « support »
Visiteur : "visitor"
Aucun : « aucun »
Observateur : « observateur »
Administrateur du portail : « portal_admin » ou « portal »
Administrateur système : « sys_admin », « sysadmin » ou « system_admin ».
Administrateur de commerce électronique : "ecommerce_admin"
Administrateur du bureau des cartes d’étudiant : "card_office_admin"
Administrateur de magasin : "store_admin"
Pour créer des rôles système définis par l'utilisateur, il faut faire correspondre l'« ID de rôle » qui se trouve dans Panneau de l'administrateur > Rôles système. S’il n’y en a pas, le système prend par défaut la valeur « aucune ».
Titre
Obligatoire : Non
Unique : Non
En-tête : title
Description : Le titre que l'utilisateur préfère utiliser.
Longueur maximale : 100 caractères. Caractères multi-octet acceptés.
Site Web
Obligatoire : Non
Unique : Non
En-tête : page Web
Description : L'URL de la page Web personnelle de l’utilisateur, s’il en a une.
Longueur maximale : 100 caractères.
Téléphone professionnel
Obligatoire : Non
Unique : Non
En-tête : b_Phone _1
Description : Le numéro de téléphone professionnel associé à l’utilisateur.
Longueur maximale : 50 caractères. Caractères multi-octet acceptés.
Téléphone bureau (secondaire)
Obligatoire : Non
Unique : Non
En-tête : b_phone_2
Description : Un numéro de téléphone professionnel supplémentaire associé à l’utilisateur.
Longueur maximale : 50 caractères. Caractères multi-octet acceptés.
Code postal
Obligatoire : Non
Unique : Non
En-tête : zip_code
Description : Code postal de l’utilisateur.
Longueur maximale : 50 caractères. Caractères multi-octet acceptés.
Objets LEARN : Cours/Association
Objet SIE : cours ou association
Comportement d'insertion/mise à jour par défaut : Insertions ou mises à jour intelligentes
Comportement de suppression par défaut : désactiver
Identifiant unique de lot (obligatoire)
Obligatoire : Oui
Unique : Oui
En-tête : external_course_key.external_organization_key
Description : Nom court utilisé par l'établissement pour identifier de manière unique la section Cours ou Organisation. Ce nom n'est pas visible par les utilisateurs. Il peut uniquement comporter des lettres, des chiffres, des tirets et des points. Les espaces et signes de ponctuation ne sont pas autorisés. Cette valeur doit être propre à chaque cours et communauté et correspond généralement à la valeur COURSE_ID ou ORGANIZATION_ID.
Longueur maximale : 64 caractères.
Code cours ou Code communauté (obligatoire)
Obligatoire : Oui
Unique : Oui
En-tête : course_id or organization_id
Description : Nom court utilisé par l'établissement pour identifier de manière unique le cours ou l'association (par exemple, math101_F99 ou ChessClub). Les caractères suivants ne peuvent pas être utilisés : espace ( ) & / ' +
Longueur maximale : 100 caractères. Obligatoirement unique et non modifiable.
Nom du cours ou Nom de la communauté (obligatoire)
Obligatoire : Oui
Unique : Non
En-tête : course_name/organization_name
Description : Titre complet du cours ou de l’association. Destiné à être affiché.
Longueur maximale : 255 caractères. Caractères multi-octet acceptés.
Clé de source de données (obligatoire) Fournie par l'intégration ou le fichier de données.
Obligatoire : Oui
Unique : Non
En-tête : data_source_key
Description : Clé utilisée pour établir le regroupement des éléments de l’utilisateur. Notez que cette clé peut être fournie par la configuration de l'intégration et n'est alors pas requise dans le fichier.
Longueur maximale : 256. Caractères multi-octet acceptés.
Affichage du cours
Obligatoire : Non
Unique : Non
En-tête : course_experience
Description : Détermine l’affichage des cours qui apparaîtra pour les nouveaux cours. Ce champ est uniquement inséré et ne peut pas être mis à jour dans le cadre du SIS.
Valeurs prises en charge : Original, Ultra ou Choix de l’enseignant.
Vue de communauté
Obligatoire : Non
Obligatoire : Non
En-tête : organization_experience
Description : Permet aux clients de sélectionner l’expérience dans laquelle ils souhaitent créer leur organisation. Ce champ est uniquement inséré et ne peut pas être mis à jour dans le cadre du SIS.
Valeurs prises en charge : Original, Ultra ou Choix de l’enseignant.
classificationId
Obligatoire : Non
Unique : Non
En-tête : classification_key
Description : Elle détermine le classement (domaine et discipline) du cours. Il s'agit d'un identifiant représentant la clé primaire de la classification.
Longueur maximale : 450 caractères.
hasDescriptionPage
Obligatoire : Non
Unique : Non
En-tête : desc_page_ind
Description : Ce champ n’est pas pris en charge actuellement. Les intégrations ne doivent pas l'utiliser.
numDaysOfUse
Obligatoire : Non
Unique : Non
En-tête : days_of_use
Description : Nombre de jours pendant lesquels les étudiants peuvent accéder au cours après leur inscription. Ce champ est utile pour l'apprentissage à son propre rythme. Cette valeur n'est utilisée que si la durée est définie comme fixe (« FIXED ») et indique le nombre de jours pendant lesquels le cours est utilisable après sa création.
Valeur numérique. Par exemple : 120
serviceLevelType
Obligatoire : Non
Unique : Non
En-tête : service_level
Description : N’est généralement pas utilisé dans les flux de données. Ignorez-le.
Spécifie le type du cours.
C (Community) = communauté
F (Full) = cours
R (Registered) = non utilisé
T (Test_Drive) = non utilisé
S (System) = cours avec fonctions limitées pour protéger les données qui le constituent.
Valeurs prises en charge : « F », « C », « R », « T », « S ».
Cours autorisé aux visiteurs
Obligatoire : Non
Unique : Non
En-tête : allow_guest_ind
Description : Permet aux visiteurs d’accéder au cours.
Valeurs prises en charge : « Y », « N »
Cours autorisé aux observateurs
Obligatoire : Non
Unique : Non
En-tête : allow_observer_ind
Description : Permet à l’observateur d’accéder au cours.
Valeurs prises en charge : « Y », « N »
Disponible
Obligatoire : Non
Unique : Non
En-tête : available_ind
Description : Disponibilité du compte utilisateur dans l’interface utilisateur. Si ce champ est défini sur Non, le compte d'utilisateur est grisé pour l'administrateur et pour les professeurs. L'utilisateur ne pourra pas se connecter au système. Les valeurs possibles sont « Y » pour oui ou « N » pour non.
Valeurs prises en charge : « Y », « N ».
Liste croisée des cours Uid Batch
Obligatoire : Non
Unique : Non
En-tête : master_course_key
Description : Cours parent EXTERNAL_COURSE_KEY dont ce cours est l’enfant.
Longueur maximale : 64
Description
Obligatoire : Non
Unique : Non
En-tête : description
Description : Description complète du cours.
Longueur maximale : 4000 caractères. Les caractères multioctets sont acceptés.
Durée
Obligatoire : Non
Unique : Non
En-tête : Durée
Description : Ce champ permet d'indiquer si la durée de disponibilité du cours est continue, s'il s'agit d'une plage de dates, de x jours à compter de l'inscription ou d'une durée déterminée.
Les options sont les suivantes :
Continu : « C » = Le cours est toujours accessible.
Plage : « R » = Le cours est accessible dans les jours compris entre la DATE DE DÉBUT et la DATE DE FIN. La date de début ou la date de fin peuvent être laissées ouvertes de façon à rendre un cours accessible à partir d'une certaine date ou jusqu'à une certaine date.
Durée : « D » = N jours à compter de l'inscription
Terme : « T » = dicté par la période (la durée de la période associée contrôle la durée de ce cours)
Valeurs prises en charge : "C", "R", "D", "T"
Rythme de la formation
Obligatoire : Non
Unique : Non
En-tête : cadence
Description : Indique si le cours est dispensé par un instructeur ou s'il est autodirigé selon l'étudiant.
Valeurs prises en charge : « Self », « Instructor »
Date de fin
Obligatoire : Non
Unique : Non
En-tête : end_date
Description : Date à laquelle l'accès au cours se termine.
Format : yyyymmdd
Appliquer pack langue
Obligatoire : Non
Unique : Non
En-tête : locale_enforced
Description : Indicateur qui détermine si le pack linguistique est appliqué lorsqu'un utilisateur accède au cours. Si le pack langue n'est pas appliqué, l'utilisateur peut visualiser le cours en utilisant son pack langue favori.
Valeurs prises en charge : « O », « N ».
Code d'accès d'inscription
Obligatoire : Non
Unique : Non
En-tête : enroll_access_code
Description : Il s'agit du code d'accès que les étudiants doivent utiliser lorsqu'ils s'inscrivent au cours.
Longueur maximale : 50 caractères.
Date de fin d'inscription
Obligatoire : Non
Unique : Non
En-tête : enroll_end
Description : Date à laquelle l’inscription n’est plus disponible pour les étudiants.
Format : yyyymmdd
Date de début d'inscription
Obligatoire : Non
Unique : Non
En-tête : enroll_start
Description : Date à laquelle l’inscription peut commencer.
Format : yyyymmdd
Type d'inscription
Obligatoire : Non
Unique : Non
En-tête : enroll_option
Description : Détermine la méthode d’inscription.
Valeurs prises en charge : « professeur », « self » ou « e-mail ».
Frais
Obligatoire : Non
Unique : Non
En-tête : fee
Description : Frais associés à ce cours ou à cette association.
Numérique. 11 caractères, 2 décimales. Exemple : 1 500,00
Nom de l'établissement
Obligatoire : Non
Unique : Non
En-tête : institution_name
Description : Le nom de l’établissement.
Longueur maximale : 255 caractères. Caractères multi-octet acceptés.
Module linguistique
Obligatoire : Non
Unique : Non
En-tête : locale
Description : Identifiant du pack de langue préféré. Cette valeur est exprimée sous la forme xx_XX ; par exemple, le pack langue français est représenté par l'identifiant fr_FR.
Longueur maximale : 20 caractères.
Verrouillé
Obligatoire : Non
Unique : Non
En-tête : lockout_ind
Description : Indique si l’accès au cours ou à l’association a été restreint. Si ce champ est défini sur « Y », l'accès au cours ou à la communauté est limité par les valeurs END_DATE et START_DATE.
Valeurs prises en charge : « Y », « N »
Utilisation du disque maximum (limite logicielle)
Obligatoire : Non
Unique : Non
En-tête : soft_limit
Description : Limite souple du quota de cours. Ce paramètre déclenche l'envoi de courriels d'avertissement lorsque le stockage des dossiers de cours atteint la soft_limit spécifiée et que des quotas de cours sont en vigueur.
Numérique. Ex. : 10MB serait 10485760 octets.
Identifiant batch d'association principale
Obligatoire : Non
Unique : Oui
En-tête : external_association_key
Description : Clé externe du nœud auquel le cours doit être principalement associé. Le cours utilise les paramètres par défaut de cet outil de nœud pour créer ses propres paramètres. Ce champ est identique au champ « external_association_key » du flux Association de cours, à ceci près qu'il s'agit ici de l'association principale. Autrement dit, il copiera les valeurs par défaut de ses paramètres d'outils lors de la création du cours.
Les en-têtes minimaux requis pour la création de cours destinés à être associés à un nœud hiérarchique de l'établissement sont les suivants :
external_course_key
course_id
course_name
external_association_key
primary_external_node_key
primary_external_node_key
Identifiant batch de nœud principal
Obligatoire : Non
Unique : Non
En-tête : primary_external_node_key
Description : Il s'agit du même champ que « external_node_key » du flux Association de cours, sauf qu'il s'agit de l'association principale.
Les en-têtes minimaux requis pour la création de cours destinés à être associés à un nœud hiérarchique de l'établissement sont les suivants :
external_course_key
course_id
course_name
external_association_key
primary_external_node_key
Longueur maximale : 256
Remplacement de l’UID du lot
Obligatoire : Non
Unique : Oui
En-tête : new_external_course_key
Description : Ce champ est utilisé uniquement dans les rares cas où la clé externe d'un cours ou d'un organisme change.
Longueur maximale : 64 caractères. Caractères multi-octet acceptés.
Identifiant unique de lot de la source de données de remplacement
Obligatoire : Non
Unique : Non
En-tête : new_data_source_key
Description : Nouvelle clé utilisée pour établir le regroupement des éléments de l’utilisateur. Remplace la source de données existante associant les données au groupe désigné par la clé de source de données de remplacement. Remarque : Le champ de mappage de l'interface utilisateur pour l'identifiant unique de lot de la source de données de remplacement de l'utilisateur est « script.flatfile.UserReplacementDataSourceBatchUid ».
État de ligne
Obligatoire : Non
Unique : Non
En-tête : row_status
Description : Définit la valeur de l'enregistrement à l'une des valeurs suivantes : Activé : Accès normal à l'enregistrement. Désactivé : l'enregistrement est visible dans certaines zones de l'interface utilisateur, mais il est impossible de le modifier ou d'y accéder. Supprimé : la suppression de l'enregistrement est prévue.
Valeurs prises en charge : « activé », « désactivé », « supprimé »
Afficher dans le catalogue
Obligatoire : Non
Unique : Non
En-tête : catalog_ind
Description : Indique si le cours ou l’organisation apparaît dans le catalogue.
Valeurs prises en charge : « Y », « N »
Clé de copie de cours source/Clé de copie de communauté source
Obligatoire : Non
Unique : Non
En-tête : template_course_key.template_organization_key
Description : Clé externe de la source de contenu pour les opérations de copie.
Longueur maximale : 64 caractères. Les caractères multioctets sont acceptés.
Date de début
Obligatoire : Non
Unique : Non
En-tête : start_date
Description : Date à laquelle l’accès à la section du cours commence.
Format : yyyymmdd
Période de cours
Obligatoire : Non
Unique : Non
En-tête : term_key
Description : Clé associée à EXTERNAL_TERM_KEY
Longueur maximale : 256 caractères.
Utiliser la disponibilité des plages de dates
Obligatoire : Non
Unique : Non
En-tête : use_term_availability_ind
Description : Indicateur pour suivre le TERME associé à la disponibilité du cours. Si Y, les termes pour available_ind, startDate et endDate sont utilisés ; si N, les paramètres du cours sont utilisés.
Valeurs prises en charge : « Y », « N »
Objet LEARN : Adhésion à un cours et à une association
Note
Les cours et les communautés requièrent les mêmes champs. L'en-tête varie selon que vous créez un cours ou une communauté. Notez les différences lorsque vous construisez les flux de données.
Objet SIE : Adhésions à un cours ou à une association (inscriptions et travaux du personnel)
Comportement d'insertion/mise à jour par défaut : Insertions ou mises à jour intelligentes
Comportement de suppression par défaut : désactiver
UID du lot de cours ou Identifiant unique de lot de l'association (obligatoire)
Obligatoire : Oui
Unique : Non
En-tête : external_course_key ou external_organization_key
Description : Il s'agit de la même clé que celle utilisée pour identifier le cours ou l'association.
Longueur maximale : 64 caractères. Caractères multi-octet acceptés.
Clé de source de données (obligatoire) Fournie par l'intégration ou le fichier de données.
Obligatoire : Oui
Unique : Non
En-tête : data_source_key
Description : Clé utilisée pour établir le regroupement des éléments utilisateur. Notez que cette clé peut être fournie par la configuration de l'intégration et n'est alors pas requise dans le fichier.
Longueur maximale : 256 caractères. Caractères multi-octet acceptés.
Identifiant du lot utilisateur (obligatoire)
Obligatoire : Oui
Unique : Non
En-tête : external_person_key
Description : il s'agit de la clé external_person_key utilisée pour identifier l'utilisateur.
Longueur maximale : 64. Caractères multi-octet acceptés.
hasCartridgeAccess (dispose d'un accès au cartouche)
Obligatoire : Non
Unique : Non
En-tête : hascartridgeaccess
Description : Ce champ n'est pas pris en charge et devrait être supprimé. Ignorez-le. Les nouvelles intégrations ne doivent pas utiliser ce champ. Si des intégrations existantes l'utilisent, elles doivent cesser de le faire.
Disponible
Obligatoire : Non
Unique : Non
En-tête : available_ind
Description : Définit la disponibilité des inscriptions dans Blackboard Learn.
Valeurs prises en charge : « Y », « N »
URL de l'image
Obligatoire : Non
Unique : Non
En-tête : Image_URL
Description : Ce champ n'est pas pris en charge et devrait être supprimé. Ignorez-le. Les nouvelles intégrations ne doivent pas utiliser ce champ. Si des intégrations existantes l'utilisent, elles doivent cesser de le faire.
Inclure dans la liste
Obligatoire : Non
Unique : Non
En-tête : roster_ind
Description : drapeau indiquant si l'utilisateur est affiché dans l'annuaire des étudiants.
Valeurs prises en charge : « Y », « N »
Introduction
Obligatoire : Non
Unique : Non
En-tête : intro
Description : informations d'introduction à la page d'accueil de l'utilisateur dans le cours.
Longueur maximale : 4000 caractères. Caractères multi-octet acceptés.
Notes
Obligatoire : Non
Unique : Non
En-tête : notes
Description : informations pertinentes pour cet utilisateur qui peuvent avoir une incidence sur la participation au cours ou à la participation de l'association.
Longueur illimitée. Caractères multi-octet acceptés.
Informations personnelles
Obligatoire : Non
Unique : Non
En-tête : pinfo
Description : Informations personnelles pour la page d'accueil de l'utilisateur.
Longueur illimitée. Caractères multi-octet acceptés.
Professeur principal
Obligatoire : Non
Unique : Non
En-tête : primary_instructor
Description : indique que le membre est un professeur principal. Le membre doit posséder un rôle au sein du cours avec l'indicateur « Traiter en tant que professeur ». Si le membre n'est pas professeur ou ne dispose pas de cet indicateur, l'option n'apparaît pas. Si vous attribuez un rôle au sein d'un cours où celui-ci ne dispose pas de l'indicateur « Traiter en tant que professeur », un Y dans l'enregistrement d'adhésion est rejeté.
Valeurs prises en charge : « Y », « N »
Recevoir un e-mail
Obligatoire : Non
Unique : Non
En-tête : receive_email_ind
Description : Indique si le courriel est activé pour cet utilisateur.
Valeurs prises en charge : « Y », « N »
Identifiant unique de lot de la source de données de remplacement
Obligatoire : Non
Unique : Non
En-tête : new_data_source_key
Description : Nouvelle clé utilisée pour établir le regroupement des éléments de données. Remplace la source de données existante associant les données au groupe désigné par la clé de source de données de remplacement. Remarque : Le champ de mappage de l'interface utilisateur pour l'identifiant batch de la source de données de remplacement est « script.flatfile.MemberReplacementDataSourceBatchUid »
Rôle
Obligatoire : Non
Unique : Non
En-tête : role
Description : rôle de l'utilisateur dans le cours.
Valeurs prises en charge : « Instructor », « teaching_assistant », « course_builder », « Grader », « Student », « guest », « none »
État de ligne
Obligatoire : Non
Unique : Non
En-tête : row_status
Description : définit la valeur de l'enregistrement sur l'une des valeurs suivantes : Activé : accès normal à l'enregistrement. Désactivé : l'enregistrement est visible dans certaines zones de l'interface utilisateur, mais il est impossible de le modifier ou d'y accéder. Supprimé : la suppression de l'enregistrement est prévue.
Valeurs prises en charge : « activé », « désactivé », « supprimé »
Description du site Web 1
Obligatoire : Non
Unique : Non
En-tête : link_description_1
Description : Description du site Web de l'utilisateur
Longueur maximale : 255 caractères.
Nom du site Web 1
Obligatoire : Non
Unique : Non
En-tête : link_name_1
Description : nom utilisé dans le lien vers le site Web de l'utilisateur
Longueur maximale : 100 caractères.
URL du site Web 1
Obligatoire : Non
Unique : Non
En-tête : link_url_1
Description : URL utilisée dans le lien vers le site Web de l'utilisateur
Longueur maximale : 100 caractères.
Description du site Web 2
Obligatoire : Non
Unique : Non
En-tête : link_description_2
Description : Description du site Web de l'utilisateur
Longueur maximale : 255 caractères.
Nom du site Web 2
Obligatoire : Non
Unique : Non
En-tête : link_name_2
Description : nom utilisé dans le lien vers le site Web de l'utilisateur
Longueur maximale : 100 caractères.
URL du site Web 2
Obligatoire : Non
Unique : Non
En-tête : link_url_2
Description : URL utilisée dans le lien vers le site Web de l'utilisateur
Longueur maximale : 100 caractères.
Description du site Web 3
Obligatoire : Non
Unique : Non
En-tête : link_description_3
Description : Description du site Web de l'utilisateur
Longueur maximale : 255 caractères.
Nom du site Web 3
Obligatoire : Non
Unique : Non
En-tête : link_name_3
Description : nom utilisé dans le lien vers le site Web de l'utilisateur
Longueur maximale : 100 caractères.
URL du site Web 3
Obligatoire : Non
Unique : Non
En-tête : link_url_3
Description : URL utilisée dans le lien vers le site Web de l'utilisateur
Longueur maximale : 100 caractères.
Objet LEARN : Termes
Objet SIE : Durée
Comportement d'insertion/mise à jour par défaut : Insertions ou mises à jour intelligentes
Comportement de suppression par défaut : désactiver
Identifiant unique de lot (obligatoire)
Obligatoire : Oui
Unique : Oui
En-tête : external_term_key
Description : Nom abrégé utilisé par l'établissement pour identifier la période de manière unique. Ce nom n'est pas visible par les utilisateurs. Il peut uniquement comporter des lettres, des chiffres, des tirets et des points. Les espaces et signes de ponctuation ne sont pas autorisés.
Longueur maximale : 256 caractères. Caractères multi-octet acceptés.
Clé de source de données (obligatoire) Fournie par l'intégration ou le fichier de données.
Obligatoire : Oui
Unique : Non
En-tête : data_source_key
Description : Clé utilisée pour établir le regroupement des éléments de l'onglet. Notez que cette clé peut être fournie par la configuration de l'intégration et n'est alors pas requise dans le fichier.
Longueur maximale : 256 caractères. Caractères multi-octet acceptés.
Nom (obligatoire)
Obligatoire : Oui
Unique : Non
En-tête : name
Description : nom du terme.
Longueur maximale : 333 caractères.
daysOfUse
Obligatoire : Non
Unique : Non
En-tête : days_of_use
Description : Nombre de jours pendant lesquels les étudiants peuvent accéder au cours après leur inscription. Ce champ est utile pour l'enseignement à la carte.
Valeur numérique.
Disponible
Obligatoire : Non
Unique : Non
En-tête : available_ind
Description : Détermine la période de disponibilité. Si ce champ est défini sur « N », les objets associés ne sont pas disponibles.
Valeurs prises en charge : « Y », « N »
Description
Obligatoire : Non
Unique : Non
En-tête : description
Description : Description du terme
Longueur illimitée.
Durée
Obligatoire : Non
Unique : Non
En-tête : duration
Description : fenêtre de disponibilité des horaires.
Les options sont les suivantes :
Continu : Le terme est toujours accessible.
Plage : Le terme est valide dans les jours compris entre une date de début et une date de fin. La date de début ou la date de fin peuvent être laissées ouvertes de façon à rendre un trimestre valide à partir d'une certaine date ou jusqu'à une certaine date.
Corrigé : Le terme est valide pendant un nombre de jours défini (DAYS_OF_USE).
Valeurs prises en charge : continu, plage, fixe
Date de fin
Obligatoire : Non
Unique : Non
En-tête : end_date
Description : Il s'agit de la date à laquelle le terme cesse d'être accessible.
Format : yyyymmdd
Terme parent UID du lot
Obligatoire : Non
Unique : Non
En-tête : external_parent_term_key
Description : La clé EXTERNAL_TERM_KEY représentant le terme parent dont ce terme est un enfant. Utilisé pour établir des relations hiérarchiques entre les termes. Si la valeur est « NONE », toute association parent-terme existante sera supprimée. L’association de termes parents n’est possible que pour les types de termes non annuels. Si le type de terme ne prend pas en charge un parent, l'association est ignorée. Si le type de terme est défini sur Annuel ou UNSPECIFIED, toute association de terme parent existante est supprimée. Si le terme parent référencé n'existe pas ou si l'association n'est pas valide, le terme est quand même créé ou mis à jour, mais la relation parentale n'est pas appliquée.
Longueur maximale : 256 caractères. Caractères multi-octet acceptés.
Type de terme
Obligatoire : Non
Unique : Non
En-tête : term_type
Description : Spécifie le type de terme.
Les options sont les suivantes :
Annuel : « a » = année académique ou trimestre aligné sur le calendrier.
Semestre : « s » = semestre académique standard.
Trimestre : « t » = structure académique de trois trimestres.
Trimestre : "q" = structure académique à quatre trimestres.
Intersession : « i » = période de courte durée entre les sessions principales.
Module : « m » = Sous-terme dans un terme plus large.
Non spécifié : « u » = efface le type de terme.
Valeurs prises en charge : « a », « s », « t », « q », « i », « m », « u »
Identifiant batch de remplacement
Obligatoire : Non
Unique : Oui
En-tête : new_external_term_key
Description : Ce champ n'est utilisé que dans les rares cas où la EXTERNAL KEY d'un terme change.
Longueur maximale : 256 caractères. Caractères multi-octet acceptés.
Identifiant unique de lot de la source de données de remplacement
Obligatoire : Non
Unique : Non
En-tête : new_data_source_key
Description : Nouvelle clé utilisée pour établir le regroupement des éléments de données. Remplace la source de données existante associant les données au groupe désigné par la clé de source de données de remplacement. Remarque : Le champ de mappage de l'interface utilisateur pour l'identifiant batch de la source de données de remplacement est « script.flatfile.TermReplacementDataSourceBatchUid »
État de ligne
Obligatoire : Non
Unique : Non
En-tête : row_status
Description : définit la valeur de l'enregistrement sur l'une des valeurs suivantes :
Activé : accès normal à l'enregistrement.
Désactivé : l'enregistrement est visible dans certaines zones de l'interface utilisateur, mais il est impossible de le modifier ou d'y accéder.
Supprimé : la suppression de l'enregistrement est prévue.
Valeurs prises en charge : « activé », « désactivé », « supprimé »
Date de début
Obligatoire : Non
Unique : Non
En-tête : start_date
Description : Il s'agit de la date à laquelle le terme commence à être accessible.
Format : yyyymmdd
Objet LEARN : Association des rôles des établissements secondaires
Objet SIE : Rôle secondaire de l’établissement utilisateur
Comportement d'insertion/mise à jour par défaut : Insertions ou mises à jour intelligentes
Comportement de suppression par défaut : désactiver
Clé de source de données (obligatoire) Fournie par l'intégration ou le fichier de données.
Obligatoire : Oui
Unique : Non
En-tête : data_source_key
Description : Clé utilisée pour établir le regroupement des éléments utilisateur. Notez que cette clé peut être fournie par la configuration de l'intégration et n'est alors pas requise dans le fichier.
Longueur maximale : 256 caractères. Caractères multi-octet acceptés.
Numéro de rôle de l'établissement secondaire (obligatoire)
Obligatoire : Oui
Unique : Non
En-tête : role_id
Description : identifiant du rôle de l'établissement secondaire pour cette association.
Identifiant du lot utilisateur (obligatoire)
Obligatoire : Oui
Unique : Non
En-tête : external_person_key
Description : L'utilisateur external_person_key (batch_uid) à utiliser pour cette association.
Longueur maximale : 64 caractères.
Identifiant unique de lot de la source de données de remplacement
Obligatoire : Non
Unique : Non
En-tête : new_data_source_key
Description : Nouvelle clé utilisée pour établir le regroupement des éléments de données. Remplace la source de données existante associant les données au groupe désigné par la clé de source de données de remplacement. Remarque : Le champ de mappage de l'interface utilisateur pour l'identifiant batch de la source de données de remplacement est « script.flatfile.SecondaryInstRoleReplacementDataSourceBatchUid »
État de ligne
Obligatoire : Non
Unique : Non
En-tête : row_status
Description : définit la valeur de l'enregistrement sur l'une des valeurs suivantes : Activé : accès normal à l'enregistrement. Désactivé : l'enregistrement est visible dans certaines zones de l'interface utilisateur, mais il est impossible de le modifier ou d'y accéder. Supprimé : l'enregistrement devrait être supprimé manuellement par l'administrateur à l'avenir. La ligne n'est pas supprimée automatiquement par le biais d'une tâche.
Valeurs prises en charge : « activé », « désactivé », « supprimé »
Objet LEARN : Observer Association
Objet SIE : Association d'observateurs
Comportement d'insertion/mise à jour par défaut : Insertions ou mises à jour intelligentes
Comportement de suppression par défaut : désactiver
Clé de source de données (obligatoire) Fournie par l'intégration ou le fichier de données.
Obligatoire : Oui
Unique : Non
En-tête : data_source_key
Description : Clé utilisée pour établir le regroupement des éléments utilisateur. Notez que cette clé peut être fournie par la configuration de l'intégration et n'est alors pas requise dans le fichier.
Longueur maximale : 256. Caractères multi-octet acceptés.
Étudiant observé (obligatoire)
Obligatoire : Oui
Unique : Non
En-tête : external_user_key
Description : L'utilisateur external_person_key (batch_uid) à utiliser pour cette association. Identifiant unique d'un utilisateur dont le rôle dans l'établissement correspond à Étudiant. Cet identifiant est fourni par l'établissement et n'est pas visible par les utilisateurs.
Longueur maximale : 64 caractères. Caractères multi-octet acceptés.
Observateur (obligatoire)
Obligatoire : Oui
Unique : Non
En-tête : external_observer_key
Description : L'observateur external_person_key (batch_uid) à utiliser pour cette association. Identifiant unique d'un utilisateur dont le rôle système dans l'établissement correspond à Observateur.
Longueur maximale : 64 caractères. Caractères multi-octet acceptés.
Identifiant unique de lot de la source de données de remplacement
Obligatoire : Non
Unique : Non
En-tête : new_data_source_key
Description : Nouvelle clé utilisée pour établir le regroupement des éléments de données. Remplace la source de données existante associant les données au groupe désigné par la clé de source de données de remplacement. Remarque : Le champ de mappage de l'interface utilisateur pour l'identifiant batch de la source de données de remplacement est « script.flatfile.AssociateObserverReplacementDataSourceBatchUid »
État de ligne
Obligatoire : Non
Unique : Non
En-tête : row_status
Description : définit la valeur de l'enregistrement sur l'une des valeurs suivantes : Activé : accès normal à l'enregistrement. Désactivé : l'enregistrement est visible dans certaines zones de l'interface utilisateur, mais il est impossible de le modifier ou d'y accéder. Supprimé : la suppression de l'enregistrement est prévue.
Valeurs prises en charge : « activé », « désactivé », « supprimé »
OBJET D'APPRENTISSAGE : Catégorie
Objet SIE : Catégorie de cours
Comportement d'insertion/mise à jour par défaut : Insertions ou mises à jour intelligentes
Comportement de suppression par défaut : désactiver
dataSourceBatchUid (obligatoire)
Obligatoire : Oui
Unique : Non
En-tête : data_source_key
Description : Clé utilisée pour établir le regroupement des éléments de catégorie.
Caractères multi-octet acceptés.
titre (obligatoire)
Obligatoire : Oui
Unique : Non
En-tête : title
Description : nom de la catégorie tel qu'il apparaîtra aux utilisateurs dans l'interface utilisateur.
Longueur maximale : 255 caractères. Caractères multi-octet acceptés.
Identifiant unique de lot (obligatoire)
Obligatoire : Oui
Unique : Oui
En-tête : external_category_key
Description : Doit être unique. Notez que ce champ correspond au champ Mnémonique de catégorie dans l'interface utilisateur.
Longueur maximale : 64 caractères. Caractères multi-octet acceptés.
description
Obligatoire : Non
Unique : Non
En-tête : description
Description : Description de la catégorie.
frontPageInd
Obligatoire : Non
Unique : Non
En-tête : frontpage_ind
Description : Détermine si la catégorie est affichée ou non sur la première page du catalogue.
Valeurs prises en charge : « Y », « N »
isAvailable
Obligatoire : Non
Unique : Non
En-tête : available_ind
Description : Définit la disponibilité des catégories dans Blackboard Learn.
Valeurs prises en charge : « Y », « N »
isRestricted
Obligatoire : Non
Unique : Non
En-tête : restrict_ind
Description : Indique si le cours ou l'association est réservé aux membres.
Valeurs prises en charge : « Y », « N »
parentBatchUid
Obligatoire : Non
Unique : Non
En-tête : parent_category_key
Description : La CLÉ EXTERNAL_CATEGORY_KEY représentant la catégorie parent dont cette catégorie est une enfant.
Longueur maximale : 64 caractères.
rowStatus
Obligatoire : Non
Unique : Non
En-tête : row_status
Description : définit la valeur de l'enregistrement sur l'une des valeurs suivantes : Activé : accès normal à l'enregistrement. Désactivé : l'enregistrement est visible dans certaines zones de l'interface utilisateur, mais il est impossible de le modifier ou d'y accéder. Supprimé : la suppression de l'enregistrement est prévue. Chaîne.
Valeurs prises en charge : « activé », « désactivé », « supprimé »
Identifiant batch de remplacement
Obligatoire : Non
Unique : Oui
En-tête : new_external_category_key
Description : Désigne le remplacement de la clé actuelle.
Longueur maximale : 64 caractères. Caractères multi-octet acceptés.
Identifiant unique de lot de la source de données de remplacement
Obligatoire : Non
Unique : Non
En-tête : new_data_source_key
Description : Nouvelle clé utilisée pour établir le regroupement des éléments de données. Remplace la source de données existante associant les données au groupe désigné par la clé de source de données de remplacement. Remarque : Le champ de mappage de l'interface utilisateur pour l'identifiant batch de la source de données de remplacement est « script.flatfile.CourseCatReplacementDataSourceBatchUid »
APPRENDRE L'OBJET : Subject
Objet du SIE : Sujet
Comportement d'insertion/mise à jour par défaut : Insertions ou mises à jour intelligentes
Comportement de suppression par défaut : désactiver
Découvrir les champs : Sujet
ID du lot (obligatoire)
Obligatoire : Oui
Unique : Oui
En-tête : external_subject_key
Description : Nom court utilisé par l'établissement pour identifier le sujet de manière unique. Ce nom n'est pas visible par les utilisateurs. Ne peut contenir que des lettres, des chiffres, des tirets et des points. Aucun espace ou autre signe de ponctuation n'est autorisé. Doit être unique pour toutes les matières, tous les cours et toutes les associations, et est souvent le même que le SUBJECT_ID.
Longueur maximale : 64 caractères. Doit être unique. Les caractères multioctets sont acceptés.
ID du thème (obligatoire)
Obligatoire : Oui
Unique : Oui
En-tête : subject_id
Description : Nom court utilisé par l'établissement pour identifier le sujet de manière unique. La valeur doit respecter le format {SubjectTitle}__{SubjectIdentifier}, avec deux traits de soulignement consécutifs séparant le titre et l’identifiant du sujet. Le titre du sujet ne peut contenir que des lettres, des chiffres, des traits d'union (-), des points (.) et des traits de soulignement (_), et l'identifiant du sujet ne peut contenir que des lettres et des chiffres. Les caractères suivants ne peuvent pas être utilisés : espace ( ), &, /, ', +. Exemple : CHEM__abc123.
Longueur maximale : 100 caractères. Obligatoirement unique et non modifiable.
Nom du sujet (obligatoire)
Obligatoire : Oui
Unique : Non
En-tête : subject_name
Description : Titre complet du sujet. Il est utilisé pour l’affichage.
Longueur maximale : 255 caractères. Les caractères multioctets sont acceptés.
Clé de source de données (obligatoire) Fournie par l'intégration ou le fichier de données.
Obligatoire : Oui
Unique : Non
En-tête : data_source_key
Description : Clé utilisée pour créer un groupe d’éléments de rubrique. Notez que cette information peut être fournie par la configuration d'intégration et n'est donc pas nécessaire dans le fichier.
Max. longueur : 256. Les caractères multioctets sont acceptés.
Disponible
Obligatoire : Non
Unique : Non
En-tête : available_ind
Description : Établit la disponibilité du cours dans Blackboard.
Valeurs prises en charge : "Y", "N"
Description
Obligatoire : Non
Unique : Non
En-tête : description
Description : Description complète du sujet.
Longueur maximale : 4000 caractères. Les caractères multioctets sont acceptés.
Type de rubrique
Obligatoire : Oui
Unique : Non
En-tête : subject_type
Description : Ce champ est utilisé pour indiquer la classification curriculaire du sujet dans le système de gestion de l'apprentissage. Les options sont les suivantes :
Premier cycle : « U » = Le sujet représente un programme d'études de premier cycle.
Diplômé : « G » = Le sujet représente un programme d'études de niveau supérieur.
Développement : « D » = La matière représente un programme de développement ou de rattrapage.
Diplôme de premier cycle non transférable : "N" = La matière représente un programme de premier cycle qui n'est pas transférable.
Transférable : « T » = Le cours représente un programme d’études de premier cycle qui est transférable.
Professionnel : « P » = Le sujet représente un programme d’études professionnelles ou de formation continue.
Valeurs prises en charge : « U », « G », « D », « N », « T », « P ».
Remplacement de l’UID du lot
Obligatoire : Non
Unique : Oui
En-tête : new_external_subject_key
Description : Ce champ n'est utilisé que dans les rares cas où la clé externe d'un sujet change.
Longueur maximale : 64 caractères. Doit être unique. Les caractères multioctets sont acceptés.
Remplacement de l’identifiant unique du lot de la source de données
Obligatoire : Non
Unique : Non
En-tête : new_data_source_key
Description : Nouvelle clé utilisée pour définir le regroupement des éléments du sujet. Remplace la source de données existante en associant les données au groupe désigné par la clé de source de données de remplacement spécifiée. Remarque : Le champ de mappage de l’interface utilisateur pour l’identifiant unique de lot de la source de données de remplacement est « script.flatfile.SubjectReplacementDataSourceBatchUid ».
État de ligne
Obligatoire : Non
Unique : Non
En-tête : row_status
Description : Définit la valeur de l'enregistrement à l'une des valeurs suivantes : Activé : Accès normal à l'enregistrement. Désactivé : L'enregistrement est visible dans certaines zones de l'interface utilisateur, mais ne peut pas être modifié ou affiché. Supprimé : la suppression de l'enregistrement est prévue.
Valeurs prises en charge : « activé », « désactivé », « supprimé »
LEARN Object: Program
SIS Object: Program
Default Insert/Update behavior: Smart Inserts or Updates
Default Delete Behavior: Disable
Batch Uid (Required)
Required: Yes
Unique: Yes
Header: external_program_key
Description: Short name used by the institution to uniquely identify the Program. This is not displayed to users. Can contain only letters, digits, dashes and periods. No spaces or other punctuation allowed. Must be unique across all Programs, Subjects, Courses and Organizations, and is often the same as the PROGRAM_ID.
Max length 64. Must be unique. Multi byte characters accepted.
Program ID (Required)
Required: Yes
Unique: Yes
Header: program_id
Description: Short name used by the institution to uniquely identify the Program.
Max length 100. Must be unique and cannot be changed.
Program Name (Required)
Required: Yes
Unique: No
Header: program_name
Description: Complete title of the Program. This is used for display.
Max length 255. Multi byte characters accepted.
Data Source Key (Required) Supplied by the integration or the data file.
Required: Yes
Unique: No
Header: data_source_key
Description: Key used to establish a grouping of Program elements. Note this may be provided by the integration configuration and thus would not be required in the file.
Max. length: 256. Multi byte characters accepted.
Available
Required: No
Unique: No
Header: available_ind
Description: Establishes Program availability to Blackboard LMS.
Supported values: "Y", "N"
Description
Required: No
Unique: No
Header: description
Description: Complete description of the Program.
Max length 4000. Multi byte characters accepted.
Program Type
Required: Yes
Unique: No
Header: program_type
Description: This is used to indicate the curricular classification of the Program within the learning management system. Options are:
Undergraduate: 'U' = The Subject represents undergraduate-level curriculum.
Graduate: 'G' = The Subject represents graduate-level curriculum.
Supported values: "U", "G
Replacement Batch Uid
Required: No
Unique: Yes
Header: new_external_program_key
Description: This field is used only on the rare occasions when a Program’s EXTERNAL KEY changes.
Max length 64. Must be unique. Multi byte characters accepted.
Replacement Data Source Batch Uid
Required: No
Unique: No
Header: new_data_source_key
Description: New key used to establish grouping of program elements. Replaces existing data source associating data with the group designated by the specified replacement data source key. Note: The UI mapping field for Replacement Data Source Batch Uid is 'script.flatfile.ProgramReplacementDataSourceBatchUid'
Row Status
Required: No
Unique: No
Header: row_status
Description: Sets the value of the record to one of the following: Enabled: Normal access to the record. Disabled: Record is visible in some areas of the UI but may not be changed or accessed. Deleted: Record is scheduled to be removed.
Supported values: "enabled", "disabled", "deleted
OBJET D'APPRENTISSAGE : Catégorie Adhésion
Objet SIE : Catégorie d'adhésion
Comportement d'insertion/mise à jour par défaut : Insertions ou mises à jour intelligentes
Comportement de suppression par défaut : désactiver
Identifiant unique de lot (obligatoire)
Obligatoire : Oui
Unique : Oui
Description : saisie automatique. N'utilisez pas ce code dans les flux de données.
Identifiant unique de lot de catégorie (obligatoire)
Obligatoire : Oui
Unique : Non
En-tête : external_category_key
Description : CLÉ EXTERNE (batch_uid) de la catégorie à laquelle ajouter le cours/la communauté.
Longueur maximale : 64 caractères.
UID du lot de cours ou Identifiant unique de lot de l'association (obligatoire)
Obligatoire : Oui
Unique : Non
En-tête : external_course_key
Description : clé EXTERNAL KEY (batch_uid) du cours ou de la communauté catégorisés.
Longueur maximale : 64 caractères.
Clé de source de données (obligatoire) Fournie par l'intégration ou le fichier de données.
Obligatoire : Oui
Unique : Non
En-tête : data_source_key
Description : Clé utilisée pour établir le regroupement des éléments utilisateur. Notez que cette clé peut être fournie par la configuration de l'intégration et n'est alors pas requise dans le fichier.
Caractères multi-octet acceptés.
Est disponible
Obligatoire : Non
Unique : Oui
En-tête : available_ind
Description : Définit la disponibilité des catégories dans Blackboard Learn.
Valeurs prises en charge : « Y », « N »
Identifiant unique de lot de la source de données de remplacement
Obligatoire : Non
Unique : Non
En-tête : new_data_source_key
Description : Nouvelle clé utilisée pour établir le regroupement des éléments de données. Remplace la source de données existante associant les données au groupe désigné par la clé de source de données de remplacement. Remarque : Le champ de mappage de l'interface utilisateur pour l'identifiant batch de la source de données de remplacement est « script.flatfile.CourseCatMemReplacementDataSourceBatchUid »
État de ligne
Obligatoire : Non
Unique : Non
En-tête : row_status
Description : définit la valeur de l'enregistrement sur l'une des valeurs suivantes : Activé : accès normal à l'enregistrement. Désactivé : l'enregistrement est visible dans certaines zones de l'interface utilisateur, mais il est impossible de le modifier ou d'y accéder. Supprimé : la suppression de l'enregistrement est prévue.
Valeurs prises en charge : « activé », « désactivé », « supprimé »
Objet LEARN : nœud de hiérarchie
Objet SIE : nœud de hiérarchie
Comportement d'insertion/mise à jour par défaut : Insertions ou mises à jour intelligentes
Comportement de suppression par défaut : purge
Les en-têtes minimaux requis pour la création d'un nœud hiérarchique de l'établissement sont les suivants :
external_node_key
data_source_key
parent_node_key
nom
Identifiant unique de lot (obligatoire)
Obligatoire : Oui
Unique : Oui
En-tête : external_node_key
Description : Identifiant utilisé par l'établissement pour identifier de manière unique le nœud de hiérarchie. Ce nom n'est pas visible par les utilisateurs. Il peut uniquement comporter des lettres, des chiffres, des tirets et des points. Les espaces et signes de ponctuation ne sont pas autorisés.
Longueur maximale : 255 caractères. Caractères multi-octet acceptés.
Clé de source de données (obligatoire) Fournie par l'intégration ou le fichier de données.
Obligatoire : Oui
Unique : Non
En-tête : data_source_key
Description : Clé utilisée pour établir le regroupement des éléments utilisateur. Notez que cette clé peut être fournie par la configuration de l'intégration et n'est alors pas requise dans le fichier.
Longueur maximale : 255 caractères. Caractères multi-octet acceptés.
Identifiant du lot parent (obligatoire)
Obligatoire : Oui
Unique : Non
En-tête : parent_node_key
Description : parent external_node_key (batch uid) pour ce nœud.
Longueur maximale : 64 caractères.
Nom (obligatoire)
Obligatoire : Oui
Unique : Non
En-tête : name
Description : nom du nœud
Longueur maximale : 255
Description
Obligatoire : Non
Unique : Non
En-tête : description
Description : Description du nœud
Longueur maximale : 1000.
Identifiant batch de remplacement
Obligatoire : Non
Unique : Oui
En-tête : new_external_node_key
Description : Ce champ n'est utilisé que dans les rares cas où la EXTERNAL KEY d'un nœud change.
Longueur maximale : 255 caractères. Obligatoirement unique. Caractères multi-octet acceptés.
Identifiant unique de lot de la source de données de remplacement
Obligatoire : Non
Unique : Non
En-tête : new_data_source_key
Description : Nouvelle clé utilisée pour établir le regroupement des éléments de données. Remplace la source de données existante associant les données au groupe désigné par la clé de source de données de remplacement. Remarque : Le champ de mappage de l'interface utilisateur pour l'identifiant batch de la source de données de remplacement est « script.flatfile.NodeReplacementDataSourceBatchUid »
Objet LEARN : Association d'utilisateurs hiérarchiques
Objet SIE : Association d'utilisateurs
Comportement d'insertion/mise à jour par défaut : Insertions ou mises à jour intelligentes
Comportement de suppression par défaut : purge
Les en-têtes minimaux requis pour l'association d'utilisateurs à un nœud hiérarchique de l'établissement sont :
external_user_key
external_node_key
external_association_key
data_source_key
Clé de source de données (obligatoire) Fournie par l'intégration ou le fichier de données.
Obligatoire : Oui
Unique : Non
En-tête : data_source_key
Description : Clé utilisée pour établir le regroupement des éléments utilisateur. Notez que cette clé peut être fournie par la configuration de l'intégration et n'est alors pas requise dans le fichier.
Longueur maximale : 255 caractères. Caractères multi-octet acceptés.
Identifiant unique de lot (obligatoire)
Obligatoire : Oui
Unique : Oui
En-tête : external_association_key
Description : ID d'association, qui est l'identifiant unique de l'association entre l'utilisateur et le nœud. Il s'agit souvent d'une concaténation des valeurs User Identifiant unique de lot et Node Identifiant unique de lot pour garantir l'unicité lorsqu'un utilisateur peut être affecté à plusieurs nœuds.
Longueur maximale : 64 caractères.
ID du lot du nœud (obligatoire)
Obligatoire : Oui
Unique : Non
En-tête : external_node_key
Description : le nœud pour cette association, qui est également l'identifiant du nœud qui se trouve dans la zone « Modifier le nœud » de l'interface graphique
Longueur maximale : 64.
Identifiant du lot utilisateur (obligatoire)
Obligatoire : Oui
Unique : Non
En-tête : external_user_key
Description : L'utilisateur external_person_key (batch_uid) à associer à ce nœud.
Longueur maximale : 64.
Identifiant batch de remplacement
Obligatoire : Non
Unique : Oui
En-tête : new_external_association_key
Description : Ce champ n'est utilisé que dans les rares cas où la EXTERNAL KEY d'une association change.
Longueur maximale : 64 caractères. Caractères multi-octet acceptés.
Identifiant unique de lot de la source de données de remplacement
Obligatoire : Non
Unique : Non
En-tête : new_data_source_key
Description : Nouvelle clé utilisée pour établir le regroupement des éléments de données. Remplace la source de données existante associant les données au groupe désigné par la clé de source de données de remplacement. Remarque : Le champ de mappage de l'interface utilisateur pour l'identifiant batch de la source de données de remplacement est « script.flatfile.UserAssociationReplacementDataSourceBatchUid »
Objet LEARN : Association de cours hiérarchiques
Objet SIE : Association de cours
Comportement d'insertion/mise à jour par défaut : Insertions ou mises à jour intelligentes
Comportement de suppression par défaut : purge
Les en-têtes minimaux requis pour l'association de cours à un nœud hiérarchique de l'établissement sont :
external_course_key
external_node_key
external_association_key
data_source_key
Identifiant unique de lot (obligatoire)
Obligatoire : Oui
Unique : Oui
En-tête : external_association_key
Description : chaque association de cours et de nœud doit avoir une valeur unique qui identifie cette relation. L'Identifiant unique de lot est l'identifiant unique de la relation cours-nœud.
Longueur maximale : 64 caractères.
Identifiant unique de lot de cours (obligatoire)
Obligatoire : Oui
Unique : Non
En-tête : external_course_key
Description : le cours external_course_key (batch_uid) à associer à ce nœud.
Longueur maximale : 64 caractères.
Clé de source de données (obligatoire) Fournie par l'intégration ou le fichier de données.
Obligatoire : Oui
Unique : Non
En-tête : data_source_key
Description : Clé utilisée pour établir le regroupement des éléments. Notez que cette clé peut être fournie par la configuration de l'intégration et n'est alors pas requise dans le fichier.
Longueur maximale : 255 caractères. Caractères multi-octet acceptés.
ID du lot du nœud (obligatoire)
Obligatoire : Oui
Unique : Non
En-tête : external_node_key
Description : nœud pour cette association.
Longueur maximale : 64 caractères. Caractères multi-octet acceptés.
Indicateur d'association principal
Obligatoire : Non
Unique : Non
En-tête : is_primary_association
Description : indicateur désignant cette association comme association principale lorsque d'autres peuvent être spécifiées.
Valeurs prises en charge : « Y », « N ».
Identifiant batch de remplacement
Obligatoire : Non
Unique : Oui
En-tête : new_external_association_key
Description : Ce champ n'est utilisé que dans les rares cas où la EXTERNAL KEY d'une association change.
Longueur maximale : 64 caractères. Caractères multi-octet acceptés.
Identifiant unique de lot de la source de données de remplacement
Obligatoire : Non
Unique : Non
En-tête : new_data_source_key
Description : Nouvelle clé utilisée pour établir le regroupement des éléments de données. Remplace la source de données existante associant les données au groupe désigné par la clé de source de données de remplacement. Remarque : Le champ de mappage de l'interface utilisateur pour l'identifiant batch de la source de données de remplacement est « script.flatfile.CourseAssociationReplacementDataSourceBatchUid »
Objet LEARN : Association d'objectifs
Objet SIE : Association de buts
Comportement d'insertion/mise à jour par défaut : Insertions ou mises à jour intelligentes
Comportement de suppression par défaut : purge
Identifiant unique de lot (obligatoire)
Obligatoire : Oui
Unique : Oui
En-tête : Il n’y a pas d’en-tête; il est rempli automatiquement. Ignorez-le dans les flux d'intégration.
Description : identifiant unique de la relation entre le cours et le but (standard).
Longueur maximale : 64 caractères.
Identifiant unique de lot de cours (obligatoire)
Obligatoire : Oui
Unique : Non
En-tête : course_key
Description : identifiant unique (external_course_key) du cours auquel le but (standard) sera associé
Longueur maximale : 64 caractères.
Clé de source de données (obligatoire) Fournie par l'intégration ou le fichier de données.
Obligatoire : Oui
Unique : Non
En-tête : data_source_key
Description : Clé utilisée pour établir le regroupement des éléments utilisateur. Notez que cette clé peut être fournie par la configuration de l'intégration et n'est alors pas requise dans le fichier.
Longueur maximale : 255 caractères. Caractères multi-octet acceptés.
Ensemble de sous-objectifs (obligatoire)
Obligatoire : Oui
Unique : Non
En-tête : std_sub_doc_key
Description : identifiant unique de l'objectif (standard) à associer à un cours.
Longueur maximale : 64 caractères.
Identifiant unique de lot de la source de données de remplacement
Obligatoire : Non
Unique : Non
En-tête : new_data_source_key
Description : Nouvelle clé utilisée pour établir le regroupement des éléments de données. Remplace la source de données existante associant les données au groupe désigné par la clé de source de données de remplacement. Remarque : Le champ de mapplotage de l'interface utilisateur pour l'identifiant unique de lot de la source de données de remplacement est « Script.FlatFile.GoalAssociationReplacementDataSourceBatchUID »
LEARN Object: Subject to Course Association
SIS Object: Subject to Course Association
Default Insert behavior: Smart Inserts. Updates are not supported.
Default Delete Behavior: Purge
The minimum required headers for associating a Subject to a Course are:
external_subject_key
external_course_key
external_association_key
data_source_key
Batch Uid (Required)
Required: Yes
Unique: Yes
Header: external_association_key
Description: Each subject and course association must have a unique value that identifies this relationship. The Batch Uid is the unique identifier for the subject-course relationship.
Max length 64.
Subject Batch Uid (Required)
Required: Yes
Unique: No
Header: external_subject_key
Description: The subject external_subject_key (batch_uid) to be associated with this association.
Max length 64.
Data Source Key (Required) Supplied by the integration or the data file.
Required: Yes
Unique: No
Header: data_source_key
Description: Key used to establish grouping of elements. Note this may be provided by the integration configuration and thus would not be required in the file.
Max length 255. Multi byte characters accepted.
LEARN Object: Subject to Organization Association
SIS Object: Subject to Organization Association
Default Insert behavior: Smart Inserts. Updates are not supported.
Default Delete Behavior: Purge
The minimum required headers for associating a Subject to an Organization are:
external_subject_key
external_org_key
external_association_key
data_source_key
Batch Uid (Required)
Required: Yes
Unique: Yes
Header: external_association_key
Description: Each subject and organization association must have a unique value that identifies this relationship. The Batch Uid is the unique identifier for the subject organization relationship.
Max length 64.
Subject Batch Uid (Required)
Required: Yes
Unique: No
Header: external_subject_key
Description: The subject external_subject_key (batch_uid) to be associated with this association.
Max length 64.
Data Source Key (Required) Supplied by the integration or the data file.
Required: Yes
Unique: No
Header: data_source_key
Description: Key used to establish grouping of elements. Note this may be provided by the integration configuration and thus would not be required in the file.
Max length 255. Multi byte characters accepted.
Node Batch Uid (Required)
Required: Yes
Unique: No
Header: external_org_key
Description: The organization for this association.
Max length 64. Multi byte characters accepted.
Replacement Data Source Batch Uid
Required: No
Unique: No
Header: new_data_source_key
Description: New key used to establish grouping of data elements. Replaces existing data source associating data with the group designated by the specified replacement data source key. Note: The UI mapping field for Replacement Data Source Batch Uid is 'script.flatfile.SubjectToOrganizationAssociationReplacementDataSourceBatchUid'
LEARN Object: Program to Subject Association
SIS Object: Program to Subject Association
Default Insert behavior: Smart Inserts. Updates are not supported.
Default Delete Behavior: Purge
The minimum required headers for associating a Program to a Subject are:
external_program_key
external_subject_key
external_association_key
data_source_key
Batch Uid (Required)
Required: Yes
Unique: Yes
Header: external_association_key
Description: Each program and subject association must have a unique value that identifies this relationship. The Batch Uid is the unique identifier for the program-subject relationship.
Max length 64.
Program Batch Uid (Required)
Required: Yes
Unique: No
Header: external_program_key
Description: The program external_program_key (batch_uid) to be associated with this association.
Max length 64.
Data Source Key (Required) Supplied by the integration or the data file.
Required: Yes
Unique: No
Header: data_source_key
Description: Key used to establish grouping of elements. Note this may be provided by the integration configuration and thus would not be required in the file.
Max length 255. Multi byte characters accepted.
Node Batch Uid (Required)
Required: Yes
Unique: No
Header: external_subject_key
Description: The subject for this association.
Max length 64. Multi byte characters accepted.
Replacement Data Source Batch Uid
Required: No
Unique: No
Header: new_data_source_key
Description: New key used to establish grouping of data elements. Replaces existing data source associating data with the group designated by the specified replacement data source key. Note: The UI mapping field for Replacement Data Source Batch Uid is 'script.flatfile.ProgramToSubjectAssociationReplacementDataSourceBatchUid'