Les exemples suivants illustrent la composition des flux de données TERM et correspondent à un grand nombre de cas d'utilisation. Ces exemples utilisent le flux de données le plus simple qui soit requis pour répondre au cas d'utilisation. Il existe de nombreux autres en-têtes de flux TERM pour la création d'enregistrements d'adhésion : une analyse des exigences de votre établissement en matière de système d'informations et de registres et une planification permettent de déterminer la profondeur des données nécessaires pour alimenter correctement LEARN afin qu'il atteigne vos objectifs de données et de cycle de vie TERM (et des communautés/cours associés).
Les exemples sont basés sur les paramètres par défaut de Learn qui sont visibles dans l'interface utilisateur de configuration de l'intégration. La modification de ces éléments de configuration entraînera la modification des résultats de l'exemple. Les explications de ces paramètres sont disponibles dans la Présentation du cadre SIS. Par ailleurs, il est supposé, sauf indication contraire, que l'intégration est configurée pour utiliser la même source de données pour toutes les données entrantes.
À propos de l'objet TERM
L'objet TERM offre une méthode alternative utile d'organisation et de contrôle de l'accès aux cours et aux communautés. Lors de l'utilisation d'un objet TERM pour contrôler l'accès au cours, les paramètres spécifiés par TERM écrasent ceux qui sont autrement fournis au niveau des données du cours, aussi, si vous spécifiez des dates de début ou de fin et une durée au niveau du cours. Celles-ci sont remplacées par celles spécifiées dans l'objet TERM associé.
Cette rubrique décrit l'utilisation du fichier plat d'instantané pour créer et gérer des objets TERM et présente un exemple unique d'utilisation de l'objet TERM dans un flux de données de cours.
Gestion des données de fichiers plats d'instantané
Le cadre SIS prend en charge les téléchargements de flux de données de fichier plat d'instantané via un téléchargement d'interface utilisateur et via un ensemble d'URL fourni par le système Learn.
Accédez aux informations HTTP et téléchargez le fichier de flux à l'aide du menu d'intégration de l'interface utilisateur d'intégration des systèmes d'informations sur les étudiants de l'intégration de données d'administrateur système.
Dans les deux cas, le comportement de l'opération de données est piloté par la configuration de l'intégration et le type d'opération sélectionné. Le type d'opération de données sélectionné contrôle la façon dont les données du flux sont « interprétées » et chaque URL fournira des résultats différents pour répondre aux objectifs de votre intégration.
Les exemples utilisent la fonctionnalité de chargement du fichier de source de données de l'interface utilisateur du cadre d'instantané. Pour en savoir plus sur l'automatisation ou l'utilisation d'autres opérations de programmation/ligne de commande, reportez-vous à Automatisation de fichier plat d'instantané.
Opérations
Des données peuvent être fournies pour Learn, puis mises à jour, supprimées ou modifiées. Par conséquent, vous pouvez commencer avec un ensemble de données basique et le compléter à mesure que les exigences en matière de données de votre établissement évoluent.
Les opérations suivantes sont disponibles via l'interface utilisateur et HTTP :
| Opération | Description |
|---|---|
| Stocker | Stocke ou met à jour l'enregistrement fourni conformément à la configuration d'intégration. Lors de l'utilisation de ce type d'opération, les données contenues dans le fichier source sont stockées ou mises à jour (selon les paramètres de configuration) dans toutes les sources de données qui sont détenues par l'intégration. Pour en savoir plus sur la propriété des données, reportez-vous à la Présentation du cadre SIS. Pour en savoir plus sur les clés de source de données, reportez-vous à la Présentation des clés de source de données. |
| Actualiser | Stocke, met à jour oudésactive la présence d'un enregistrement fourni dans le flux et Learn. Cette opération permet de stocker ou de mettre à jour les données contenues dans le flux de données, tout en désactivant les données qui ne figurent pas dans le flux de données associé à l'intégration dans toutes les sources de données. |
| Supprimer | Désactive un enregistrement fourni. Cette opération désactive, selon les paramètres d'intégration, les enregistrements contenus dans le flux de données associé à l'intégration dans toutes les sources de données. |
Les objets associés aux opérations TERM sont les suivants :
| TERM | Store, Complete Refresh, Delete, Complete Refresh by Data Source |
Les exemples fournis sont illustrés à l'aide de la fonctionnalité de chargement du fichier de source de données de l'interface utilisateur du cadre d'instantané. Pour en savoir plus sur l'automatisation ou l'utilisation d'autres opérations de programmation/ligne de commande, reportez-vous à Automatisation de fichier plat d'instantané.
Rappel concernant les clés de source de données
Tous les objets de données prennent en charge la fonctionnalité de modification de la clé de source de données pour le regroupement de l'ensemble de données et peuvent être utilisés pour modifier la source de données associée. Remarque : ce champ n'est pas obligatoire dans les sources de données basées sur le cadre et sauf indication contraire dans les exemples fournis, l'intégration est configurée pour utiliser une source de données unique. Consultez la Présentation des clés de source de données.
Remarque sur le mappage de champ
Le mappage de champ offre la possibilité de modifier les données entrantes avant de les stocker dans Learn. Cela vous permet d'avoir un contrôle total sur les données stockées et de respecter les règles de Learn spécifiques lorsque les données SIS que vous fournissez sont insuffisantes, par exemple pour la création de mots de passe utilisateur lorsque le mot de passe n'est pas spécifié dans le flux de données.
Lorsqu'il est appliqué à un champ d'objet TERM, le script associé est exécuté par objet, en modifiant ou en fournissant les données avant qu'elles ne soient stockées dans Learn. Une explication complète du mappage des champs est fournie dans Mappage de champs du fichier plat d'instantané.
Exemples relatifs aux périodes de cours (TERM)
À un niveau avancé, vous pouvez identifier les modèles de flux de données d'intégration SIS qui peuvent être appliqués à toutes les opérations de données TERM et la sélection du modèle dépend des données que vous pouvez fournir.
- À l'aide d'un fichier source unique, vous pouvez stocker et mettre à jour les enregistrements (Store) en utilisant un processus distinct pour désactiver (Delete) les enregistrements
- À l'aide d'un fichier source unique, vous pouvez stocker (Store), mettre à jour (Update) et désactiver (Refresh) des enregistrements
- Vous pouvez utiliser une combinaison de fichiers, l'un pour stocker, l'autre pour désactiver.
Enfin, il ne s'agit pas d'un modèle de flux de données SIS, mais cela doit être mentionné, vous pouvez également désactiver et purger à partir de DSK seul à l'aide de l'outil gestion des sources de données disponible dans l'interface utilisateur. Vous devez être très prudent lorsque vous gérez vos données SIS fournies de cette manière. Cette option est particulièrement utile lors de la purge des données qui n'ont pas été ou ne sont plus fournies via le SIS ou le résultat des opérations de test.
Notions de base : TERM
Tous les objets TERM nécessitent un ensemble d'informations de base. Cet ensemble d'informations est détaillé dans Format de données de fichier plat d'instantané et En-têtes de fichier plat d'instantané.
Données en bref
Les ensembles de données et en-têtes requis au minimum pour créer un compte d'adhésion dans Learn comprennent les éléments suivants :
- EXTERNAL_TERM_KEY : identificateur unique pour l'enregistrement de période de cours.
- DATA_SOURCE_KEY : identificateur unique des données définies pour l'enregistrement. Remarque : cette valeur est fournie dans le flux ou via la configuration d'intégration.
- NAME : nom associé à l'objet TERM. Notez que comme il s'agit de rechercher des enregistrements de périodes de cours, il est utile d'utiliser une convention d'affectation de noms qui facilite la différenciation des objets TERM au fil du temps. Par exemple : Utilisez « Arts et sciences Automne 2013 » plutôt qu'« Automne ».
La structure SIS pour une configuration d'intégration fournit des valeurs par défaut pour les champs non obligatoires ou les ignore. Trois paramètres utiles qui ne sont pas obligatoires pour un flux TERM sont DESCRIPTION, AVAILABLE_IND, ROW_STATUS. Ceux-ci fonctionnent de la même manière que pour les autres objets Learn. En outre, pour utiliser l'objet TERM pour contrôler l'accès au cours, vous utiliserez START_DATE et END_DATE. Ceux-ci seront abordés dans le cas d'utilisation suivant.
Chacun de ces en-têtes est décrit complètement dans Descriptions des en-têtes de fichier plat d'instantané.
Ajout d'objets TERM
Pour utiliser un objet TERM afin de contrôler la disponibilité des cours, vous devez d'abord créer cet objet TERM.
Il existe deux méthodes d'ajout d'informations de périodes de cours. La première consiste à stocker (STORE) les informations d'adhésion de manière additive, ce qui entraîne l'ajout ou la mise à jour d'enregistrements, comme indiqué dans le flux de données. La seconde consiste à actualiser (REFRESH) les informations de période de cours (TERM) déjà présentes dans Learn, ce qui entraîne l'ajout ou la mise à jour d'enregistrements, comme indiqué dans le fichier de données lors de la désactivation des enregistrements Learn existants qui ne sont pas présents dans le fichier de données TERM.
Exemples d'opération de stockage
Exemple 1 : créer des objets TERM
Vous souhaitez ajouter des objets TERM pour votre année 2013-2014 à LEARN sans que cela ait une incidence sur les enregistrements existants. Vous avez besoin de différents objets TERM pour votre école de médecine et celle des arts et sciences.
Votre intégration est configurée pour utiliser la même source de données pour toutes les données entrantes.
Pré-requis
aucun.
Exigences minimales de flux de données
EXTERNAL_TERM_KEY
NAME
Solution
Créez un fichier de données terms.txt contenant les en-têtes requis et les données associées par période de cours que vous souhaitez ajouter au système. Par exemple :
EXTERNAL_TERM_KEY|NAME
AS_FA.2013|Arts and Sciences Fall 2013
AS_WI.2014|Arts and Sciences Winter 2014
AS_SP.2014|Arts and Sciences Spring 2014
AS_SU.2014|Arts and Sciences Summer 2014
MED_T1.2013|School of Medicine Term 1 2013
MED_T2.2014|School of Medicine Term 2 2013
MED_T3.2014|School of Medicine Term 3 2013
Utilisez l'interface utilisateur pour télécharger un fichier contenant ce résultat via le type de données TERM à l'aide de l'opération STORE. Les enregistrements TERM seront créés et vous pourrez les découvrir via les outils de période de cours de l'administrateur système.
Postcondition
Des objets TERM sont créés pour les deux établissements : quatre pour l'école des arts et les sciences et trois pour l'école de médecine.
Exemple 2 : mettre à jour des objets TERM
Vous souhaitez ajouter et mettre à jour des objets TERM pour votre année 2013-2014 à LEARN sans que cela ait d'incidence sur les enregistrements existants. En outre, vous souhaitez contrôler explicitement la disponibilité et l'état activé des enregistrements TERM. L'école des arts et des sciences a des dates de début et de fin différentes par période, vous souhaitez donc définir les dates de début et de fin pour chaque période d'établissement afin de contrôler la visibilité des cours associés.
Votre intégration est configurée pour utiliser la même source de données pour toutes les données entrantes.
Pré-requis
aucun.
Exigences minimales de flux de données
EXTERNAL_TERM_KEY
NAME
AVAILABILITY_IND
DURATION
END_DATE
ROW_STATUS
START_DATE
Solution
Créez un fichier de données terms.txt contenant les en-têtes requis et les données associées par période de cours que vous souhaitez ajouter ou mettre à jour dans le système.
Pour utiliser correctement START_DATE et END_DATE, une durée (DURATION) doit également être spécifiée (RANGE ci-dessous) par exemple :
EXTERNAL_TERM_KEY|NAME|START_DATE|END_DATE|DURATION|AVAILABLE_IND|ROW_STATUS
AS_FA.2013|Arts and Sciences Fall 2013|20130915|20131205|RANGE|Y|ENABLED
AS_WI.2014|Arts and Sciences Winter 2014|20140103|20140418|RANGE|Y|ENABLED
AS_SP.2014|Arts and Sciences Spring 2014|20140420|20140520|RANGE|Y|ENABLED
AS_SU.2014|Arts and Sciences Summer 2014|20140608|20140820|RANGE|Y|ENABLED
MED_T1.2013|School of Medicine Term 1 2013|20130801|20131215|RANGE|Y|ENABLED
MED_T2.2014|School of Medicine Term 2 2014|20140110|20140602|RANGE|Y|ENABLED
MED_T3.2014|School of Medicine Term 3 2014|20140603|20140818|RANGE|Y|ENABLED
Postcondition
Les objets TERM sont créés ou mis à jour, ce qui définit explicitement la disponibilité de l'enregistrement TERM, ainsi que le début et la fin de chaque période. Lorsqu'il est associé à un cours, l'objet TERM permet de contrôler la visibilité du cours.
Exemples d'opération d'actualisation
Exemple : créer ou désactiver des objets TERM
Vous souhaitez ajouter et mettre à jour des objets TERM pour votre année 2013-2014 à LEARN et désactiver les enregistrements qui ne sont plus requis. En outre, vous souhaitez contrôler explicitement la disponibilité et l'état activé des enregistrements TERM. L'école des arts et des sciences a des dates de début et de fin différentes par période, vous souhaitez donc définir les dates de début et de fin pour chaque période d'établissement afin de contrôler la visibilité des cours associés.
Votre intégration est configurée pour utiliser la même source de données pour toutes les données entrantes.
Pré-requis
aucun.
Exigences minimales de flux de données
EXTERNAL_TERM_KEY
NAME
AVAILABILITY_IND
DURATION
END_DATE
ROW_STATUS
START_DATE
Solution
Créez un fichier de données terms.txt contenant les en-têtes requis et les données associées par période de cours que vous souhaitez ajouter ou mettre à jour dans le système.
Pour utiliser correctement START_DATE et END_DATE, une durée (DURATION) doit également être spécifiée (RANGE). Par exemple :
EXTERNAL_TERM_KEY|NAME|START_DATE|END_DATE|DURATION|AVAILABLE_IND|ROW_STATUS
AS_FA.2013|Arts and Sciences Fall 2013|20130915|20131205|RANGE|Y|ENABLED
AS_WI.2014|Arts and Sciences Winter 2014|20140103|20140418|RANGE|Y|ENABLED
AS_SP.2014|Arts and Sciences Spring 2014|20140420|20140520|RANGE|Y|ENABLED
AS_SU.2014|Arts and Sciences Summer 2014|20140608|20140820|RANGE|Y|ENABLED
MED_T1.2013|School of Medicine Term 1 2013|20130801|20131215|RANGE|Y|ENABLED
MED_T2.2014|School of Medicine Term 2 2014|20140110|20140602|RANGE|Y|ENABLED
MED_T3.2014|School of Medicine Term 3 2014|20140603|20140818|RANGE|Y|ENABLED
Postcondition
COMPLETE_REFRESH
Les enregistrements TERM contenus dans le fichier de données sont créés ou mis à jour de manière explicite en définissant la disponibilité de l'enregistrement et en fournissant la plage de disponibilité, spécifiant quand les cours associés à ces périodes de cours seront disponibles (start_date) et quand ils deviendront indisponibles (end_date). Comme pour toutes les opérations COMPLETE_REFRESH, tous les enregistrements qui ne sont pas contenus dans l'ensemble de données envoyé sont désactivés (flux de données : ROW_STATUS=DISABLED, base de données : ROWSTATUS=0).
COMPLETE_REFRESH_BY_DATA_SOURCE
Les enregistrements TERM contenus dans le fichier de données sont créés ou mis à jour de manière explicite en définissant la disponibilité de l'enregistrement et en fournissant la plage de disponibilité, spécifiant quand les cours associés à ces périodes de cours seront disponibles (start_date) et quand ils deviendront indisponibles (end_date). Comme pour toutes les opérations COMPLETE_REFRESH_BY_DATA_SOURCE, tous les enregistrements qui ne sont pas contenus dans les données envoyées ET qui ont une clé de source de données correspondant à la source de données configurée pour l'intégration sont désactivés (flux de données : ROW_STATUS=DISABLED, base de données : ÉTAT = 0). Les enregistrements TERM qui ne sont pas associés à la source de données configurée pour l'intégration ne sont pas affectés.
Utilisation d'objets TERM dans les flux de cours
Les communautés et les cours partagent les mêmes modèles de gestion des objets TERM. Les exemples fournis se concentrent sur l'utilisation des objets TERM de cours.
Bien qu'il soit possible de contrôler la disponibilité des cours à l'aide de la durée, des dates, de la disponibilité et de l'état des lignes, l'utilisation de l'objet TERM permet d'utiliser les mêmes paramètres pour les groupes de cours associés à un objet TERM. L'objet TERM est un élément de données facultatif dans les flux de cours.
Les résultats opérationnels normaux doivent être anticipés en fonction de l'opération choisie pour envoyer les données à Learn.
Exemple : gestion de la disponibilité
Dans l'exemple, vous avez créé des objets TERM pour chacune de vos périodes de cours 2014 pour vos écoles des arts et des sciences. L'école de médecine souhaite désormais gérer la disponibilité de certains des cours de chaque établissement à l'aide de ces objets TERM.
Pré-requis
Vous avez créé les objets TERM auxquels vous souhaitez associer vos cours. Il n'y a pas de conditions préalables. Les cours seront créés et associés à l'objet TERM fourni ou seront mis à jour avec l'association TERM, comme indiqué par le type DURATION de l'objet TERM.
Exigences minimales de flux de données
EXTERNAL_COURSE_KEY
COURSE_ID
COURSE_NAME
DURATION
TERM_KEY
Solution
Créez un fichier de données termmanagedcourses.txt contenant les en-têtes requis et les données associées par cours que vous souhaitez ajouter ou mettre à jour dans le système.
Pour utiliser correctement START_DATE et END_DATE un DURATION doit également être spécifié (RANGE). Par exemple :
EXTERNAL_COURSE_KEY|COURSE_ID|COURSE_NAME|DURATION|TERM_KEY
AHIST.101-01.03.FA2013|AHIST.101-01.03.FA2013|Art History 101|TERM|AS_FA.2013
AHIST.101-01.03.WI2013|AHIST.101-01.03.WI2013|Art History 101|TERM|AS_WI.2014
AHIST.101-01.03.SP2013|AHIST.101-01.03.SP2013|Art History 101|TERM|AS_SP.2014
AHIST.101-01.03.SU2013|AHIST.101-01.03.SU2013|Art History 101|TERM|AS_SU.2014
ANAT.100-01.T1|ANAT.100-01.T1|Basic Anatomy|TERM|MED_T1.2013
ANAT.100-01.T2|ANAT.200-01.T2|Intermediate Anatomy|TERM|MED_T2.2014
ANAT.100-01.T3|ANAT.300-01.T3|Advanced Anatomy|TERM|MED_T3.2014
Postcondition
Les cours du flux de données sont créés ou mis à jour et sont visibles par les utilisateurs en fonction des paramètres de l'objet TERM associé à chaque cours. Les effets sur d'autres données système sont dictés par l'opération utilisée pour charger les données dans Learn :
STORE
Lorsque vous utilisez l'opération de stockage, aucune autre donnée n'est affectée : seules les données contenues dans le fichier source sont ajoutées ou mises à jour.
COMPLETE REFRESH
Lorsque vous utilisez l'opération d'actualisation complète, les données contenues dans le fichier sont ajoutées ou mises à jour. Toutes les autres données gérées par cette source de données sont désactivées en raison de leur absence du fichier de données, quelle que soit la source de données.
COMPLETE REFRESH by DATA SOURCE
Lorsque vous utilisez l'actualisation complète des données par source de données, les données contenues dans le fichier sont ajoutées ou mises à jour. Toutes les autres données gérées par cette source de données et associées à la source de données configurée pour cette intégration sont désactivées. Les données qui ne figurent pas dans le fichier de flux et qui ne sont pas associées à la source de données d'intégration ne sont pas affectées.
En savoir plus
Descriptions de l'en-tête du fichier plat d'instantané
