Skip to main content

Format de données Snapshot Flat File

Le type d'intégration Fichier plat de la structure SIS n'apporte aucun changement par rapport à l'ancienne intégration (outils de ligne de commande d'instantané) excepté l'ajout d'en-têtes aux nouveaux objets de données pris en charge et l'obligation d'inclure certains champs jusque-là facultatifs.

Les mêmes règles de classement s'appliquent aux fichiers plats d'instantané et aux instantanés existants : les flux échoueront si les dépendances ne sont pas satisfaites. Par exemple, un flux d'information sur l'adhésion ne réussira pas tant que les flux sur l'utilisateur et le cours contenant les objets associés à l'adhésion n'auront pas été traités ou qu'un cours enfant ne sera pas lié à un cours parent avant la création du cours principal (parent). Cette logique s'applique également aux plages de dates et aux nœuds.

Notez également que le comportement du système lors du traitement des données envoyées aux points d'arrêt peut être configuré via la page de modification de l'intégration.

Astuce

Pour obtenir la description complète des URL et de leurs fonctions, reportez-vous à la section Fichier plat d'instantané.

Les clients ANGEL passent à Blackboard

Il existe des différences entre les formats de flux de données Blackboard et ANGEL. Ces différences sont décrites dans le parcours de connaissances sur le mappage des données ANGEL to BLACKBOARD.

Jeu de caractères acceptable pour les données d'intégration

Les caractères de sécurité inclus dans les champs de données de base sont les suivants :

A-Z a-z 0-9 . ' , " : ! ? $ @ [ ] { } - _ *

Le mot de passe et les clés externes peuvent également contenir les caractères suivants :

% & # < > = \ + /

Échantillons utilisant un minimum de champs de données

Notez que ces exemples correspondent aux données minimales requises pour le flux. D'autres objets peuvent être dérivés pour chaque flux de l'interface des en-têtes personnalisés dans la configuration avancée des fichiers plats d'instantané de la structure SIS. Vous pouvez également déduire le caractère obligatoire d'un champ depuis l'interface de mappage des champs. Vous trouverez la liste complète des champs (avec leur description), des exemples de valeurs par défaut et les valeurs acceptables pour chaque objet à la fin de ce document. Les URL complètes utilisées pour votre installation peuvent être trouvées via l'interface administrateur de la structure SIS sous Configuration HTTP. Pour en savoir plus, reportez-vous à la section Fichier plat d'instantané.

Les exemples ci-dessous utilisent la barre verticale (|) comme délimiteur. Vous pouvez sélectionner le délimiteur utilisé lorsque vous configurez votre implémentation.

Pour des exemples d'utilisation de données plus complexes, consultez la section Exemples de fichiers instantanés plats.

Utilisateurs

Tâche : Création/mise à jour d'utilisateurs (personnes)

URL : Person Store ou Actualisation

Échantillon :

external_person_key|user_id|passwd|firstname|lastname|system_role

testPerson1|aanderson_test|changeme|Alpha|Anderson|none

testPerson2|bbrown_test|changeme|Beta|Brown|none

testPerson3|ccharlie_test|changeme|Chi|Charlie|none

testPerson4|ddavis_test|changeme|Delta|Davis|none

testPerson5|eedwards_test|changeme|Epsilon|Edwards|none

Note

Bien qu'il ne soit pas obligatoire de renseigner le champ d'adresse e-mail pour créer un utilisateur, il est tout de même conseillé de fournir cette information pour éviter que des capacités du système, telles que l'envoi de notifications de cours par e-mail, soient limitées.

Tâche : Supprimer/désactiver des utilisateurs (personnes)

URL : Personne supprimée

Échantillon :

external_person_key

testPerson1

Tâche : fil des rôles des personnes et des établissements secondaires

URL : Rôle Store/Actualiser/Supprimer

Échantillon :

external_person_key|role_id

testPerson1|ALUMNI

testPerson1|PROSPECTIVE_STUDENT

testPerson2|ALUMNI

Tâche : fil d'actualité de l'association de personne à observateur

URL : Association Store/Actualiser/Supprimer

Échantillon :

external_observer_key|external_user_key

testPerson6|testPerson1

Cours

Tâche : Créer/mettre à jour de nouveaux cours

URL : Sauvegarder ou actualiser les cours

Échantillon :

external_course_key|course_id|course_name

testCourse1|TEST_COURSE_1|Test Course 1

testCourse2|TEST_COURSE_2|Test Course 2

testCourse3|TEST_COURSE_3|Test Course 3

Tâche : Déterminer la vue du cours

URL : Sauvegarder ou actualiser les cours

Échantillon :

external_course_key|course_id|course_name|course_experience

testCourse1|TEST_COURSE_1|Test Course 1|Original

testCourse2|TEST_COURSE_2|Test Course 2|Ultra

testCourse3|TEST_COURSE_3|Test Course 3|Instructor choice

Les valeurs prises en charge sont les suivantes : Original, Ultra ou Choix de l'instructeur. Ces valeurs correspondent uniquement à des insertions et ne peuvent pas être mises à jour par le biais de la structure SIS.

Tâche : Supprimer/désactiver de nouveaux cours

URL : Supprimer le cours

Échantillon :

external_course_key

Cours d'essai 1

Ajoutez le champ template_course_key au fichier de fil de cours lorsque vous souhaitez qu'un nouveau cours soit rempli avec le contenu d'un cours principal. Par exemple, tous les nouveaux cours de mathématiques doivent comprendre avant tout les supports d'un cours de mathématiques maître.

Communautés

Tâche : Créer/mettre à jour de nouvelles communautés

URL : Les communautés stockent ou actualisent

Échantillon :

external_organization_key|organization_id|organization_name

testOrg1|TEST_ORG_1|Test Org 1

testOrg2|TEST_ORG_2|Test Org 2

testOrg3|TEST_ORG_3|Test Org 3

Tâche : Désactivation de nouvelles communautés

URL : Supprimer les communautés

Échantillon :

external_organization_key

Test RG1

Adhésions

Tâche : Créer/mettre à jour des adhésions à des cours

URL : Enregistrer ou actualiser les abonnements au cours

Échantillon :

external_person_key|external_course_key|role

testPerson1|testCourse1|instructor

testPerson1|testCourse2|student

testPerson2|testCourse1|student

testPerson3|testCourse1|student

testPerson4|testCourse2|instructor

testPerson5|testCourse3|student

Tâche : Désactivation de l'adhésion à un cours

URL : Supprimer l'adhésion au cours

Échantillon :

external_person_key|external_course_key

testPerson1|testCourse1

Tâche : Créer/mettre à jour les adhésions à des communautés

URL : Boutique ou actualisation des abonnements de la communauté

Échantillon :

external_person_key|external_organization_key|role

testPerson1|testOrg1|instructor

testPerson1|testOrg2|student

testPerson2|testOrg1|student

testPerson3|testOrg1|student

testPerson4|testOrg2|instructor

testPerson5|testOrg3|student

Tâche : Désactivation de l'adhésion à une communauté

URL : Boutique ou actualisation des abonnements de la communauté

Échantillon :

external_person_key|external_organization_key|role

testPerson1|testOrg1|instructor

Termes

Tâche : créer/mettre à jour les termes

URL : Term Store ou Refresh

Échantillon :

external_term_key|name

testTerm1|Test Term 1

Tâche : désactiver un terme

URL : URL de suppression du terme

Échantillon :

external_term_key

testTerm1

Nœuds

Tâche : créer/mettre à jour des nœuds

URL : Node Store ou Refresh

Échantillon :

external_node_key|name

testNode1|Test Node 1

testNode2|Test Node 2

Tâche : Désactiver les termes

URL : Node Delete

Échantillon :

external_node_key

testNode1

Association de nœuds

Tâche : créer/mettre à jour/désactiver l'association cours-nœud

URL : Course Association Store/Actualiser/Supprimer

Échantillon :

external_association_key|external_course_key|external_node_key

testCourseAssociation1|testCourse1|testNode1

testCourseAssociation2|testCourse2|testNode2

Tâche : créer/mettre à jour/désactiver l'association utilisateur/nœud

URL : User Association Store/Actualiser/Supprimer

Échantillon :

external_association_key|external_user_key|external_node_key

testUserAssociation1|testPerson1|testNode1

testUserAssociation2|testPerson2|testNode1

testUserAssociation3|testPerson1|testNode2

Tâche : créer/mettre à jour/désactiver le flux d'association entre la communauté et le nœud

URL : Communauté Association Store/Actualiser/Supprimer

Échantillon :

external_association_key|external_organization_key|external_node_key

testOrgAssociation1|testOrg1|testNode1

testOrgAssociation2|testOrg2|testNode2

Prise en charge des catégories

Tâche : créer/mettre à jour/désactiver le fil des catégories de cours

URL : Stocker/Actualiser/Supprimer des catégories de cours

Échantillon :

external_category_key|title

testCourseCategory1|Course Category 1

testCourseCategory2|Course Category 2

Tâche : créer/mettre à jour/désactiver le flux de catégories des communautés

URL : Catégorie Communautés Stocker/Actualiser/Supprimer

Échantillon :

external_category_key|title

TestOrgCategory1|Org Catégorie 1

TestOrgCategory2|Org Catégorie 2

Tâche : créer/mettre à jour/désactiver le fil d'adhésion aux catégories de cours

URL : Gestion des adhésions à la catégorie de cours/Actualiser/Supprimer

Échantillon :

external_course_key|external_category_key|available_ind

Cours de test 1 | Catégorie de cours de test 1 | Y

Cours de test 2 | Catégorie de cours de test 2 | Y

Cours d'essai 3 | Catégorie de cours de test 1 | Y

Tâche : créer/mettre à jour/désactiver le fil d'adhésion à la catégorie de communauté

URL : Catégorie de communauté, boutique d'adhésions/Actualiser/Supprimer

Échantillon :

external_organization_key|external_category_key|available_ind

TestOrg 1 | TestOrg Catégorie 1 | Y

TestOrg 2 | TestOrg Catégorie 2 | Y

TestOrg3 | TestOrg Catégorie 1|Y

Pension alimentaire pour parents et enfants

Ajoutez le champ master_course_key à un flux de cours si vous souhaitez instaurer une relation parent-enfant.

Note

Vous devez créer des cours parent avant d'affecter des relations enfant.

Tâche : créer une relation parent-enfant entre les cours

URL : Référence/Actualisation des cours

Échantillon :

external_course_key|course_id|course_name|master_course_key

testCourse1|TEST_COURSE_1|Test Course 1|

testCourse2|TEST_COURSE_2|Test Course 2|testCourse1

testCourse3|TEST_COURSE_3|Test Course 3|testCourse1

testCourse4|TEST_COURSE_4|Test Course 4|

testCourse5|TEST_COURSE_5|Test Course 5|testCourse4

Dans cet exemple, TEST_COURSE_2 et TEST_COURSE_3 sont les enfants du cours parent TEST_COURSE_1, contrairement à TEST_COURSE_4. Vous pouvez également exécuter un flux de cours enfant à l'écart d'un flux de cours dans lequel tous les cours contiennent une entrée pour la clé master_course_key appropriée. Utilisez le stockage de cours pour cette opération afin de conserver les cours précédemment enregistrés.

Copie/modèle de cours

Ajoutez le champ template_course_key au fichier source du cours lorsque vous souhaitez qu'un nouveau cours soit renseigné avec le contenu d'un cours maître. Par exemple : tous les nouveaux cours de mathématiques doivent initialement contenir le matériel d'un cours de master en mathématiques.

Échantillon :

external_course_key|course_id|course_name|master_course_key|template_course_key

testCourse1|TEST_COURSE_1|Test Course 1||test_course_template1

testCourse2|TEST_COURSE_2|Test Course 2|testCourse1|

testCourse3|TEST_COURSE_3|Test Course 3|testCourse1|

testCourse4|TEST_COURSE_4|Test Course 4||test_course_template1

Astuce

Pour comprendre la copie et les modèles d'un cours, reportez-vous à la section Créer des cours en copiant des cours existants.

En savoir plus