L'interface du gestionnaire IReplaceEnrollmentHandler est utilisée par les adaptateurs IPSIS pour prendre en charge l'opération de remplacement pour les inscriptions.
La mise en œuvre de l'interface est D2L.IM.IPSIS.OrgUnits.Memberships.Handlers.IReplaceEnrollmentHandler.
Les listes de configuration suivantes pour l'interface du gestionnaire ReplaceEnrollmentHandler sont expédiées avec le produit. Ces listes comprennent également le point d'extension pour lequel elles sont conçues.
IPSIS, Template – Enrollments
- ReplaceEnrollmentReadIMHandler (Sort Order = 10)
- ReplaceEnrollmentStatusDefaultActiveHandler (Sort Order = 20)
- ReplaceEnrollmentValidateSectionHandler (Sort Order = 30)
- ReplaceEnrollmentCreateIMEnrollmentHandler (Sort Order = 40)
- ReplaceEnrollmentSaveIMEnrollmentHandler (Sort Order = 50)
- ReplaceEnrollmentEnrollLMSOfferingHandler (Sort Order = 60)
- ReplaceEnrollmentEnrollLMSGroupSectionHandler (Sort Order = 70)
- ReplaceEnrollmentUnenrollLMSGroupSectionHandler (Sort Order = 80)
- ReplaceEnrollmentUnenrollLMSOfferingHandler (Sort Order = 90)
Background, Template – Background
- ReplaceEnrollmentUnenrollLMSGroupSectionHandler (Sort Order = 10)
- ReplaceEnrollmentEnrollLMSGroupSectionHandler (Sort Order = 20)
- ReplaceEnrollmentUnenrollLMSOfferingHandler (Sort Order = 30)
- ReplaceEnrollmentEnrollLMSOfferingHandler (Sort Order = 40)
ReplaceEnrollmentReadIMHandler
Le gestionnaire ReplaceEnrollmentReadIMHandler est conçu pour récupérer toutes les informations pertinentes de la base de données des tableaux IM.
Mise en œuvre
D2L.IM.IPSIS.Default.Enrollments.Handlers.ReplaceEnrollmentReadIMHandler
Comportement prévu
Pour Brightspace, une inscription constitue simplement un lien entre une unité organisationnelle, un utilisateur et un rôle. Le gestionnaire ReadIM s'attend à être transmis dans les identificateurs SIS pour chacune de ces entités, qu'il utilise pour rechercher les objets Rôle, Utilisateur et Unité organisationnelle associés dans les tableaux IM et les tableaux LMS (SGA).
Ce gestionnaire effectue les tâches suivantes :
- Lit l'information de l'interface IExternalOrgUnitInfo pour l'unité organisationnelle SIS donnée. Le traitement échoue et le gestionnaire génère une exception si l'objet ExternalOrgUnitInfo n'est pas trouvé (obligatoire).
- Lit la correspondance de rôle pour le rôle SIS donné et sélectionne le premier si plus d'un rôle est transmis. Le traitement échoue et le gestionnaire génère une exception si la correspondance de rôle n'est pas trouvée (obligatoire).
- Lit la correspondance d'utilisateur pour l'utilisateur SIS donné. Le traitement échoue et le gestionnaire génère une exception si la correspondance d'utilisateur n'est pas trouvée (obligatoire).
- Dans le cas de l'actualisation d'une inscription SIS existante, le gestionnaire lit l'interface IEnrollmentMapping. Si aucune correspondance d'inscription n'est trouvée, la requête en crée une nouvelle.
- Si une correspondance d'inscription est trouvée, le gestionnaire confirme que l'utilisateur dans la requête correspond à l'utilisateur de l'inscription existante.
- Lit les informations de l'interface IOrgUnitMappings si elles existent. Si aucune correspondance d'unité organisationnelle n'est trouvée, le gestionnaire consigne un message et poursuit le traitement. Certains cas particuliers peuvent nécessiter l'actualisation des tableaux IM uniquement.
Comportement en cas d'erreur
Si un problème survient lors du traitement, le gestionnaire génère une exception et un message d’information détaillé.
Note de configuration
Le gestionnaire de lecture est généralement configuré en premier lieu dans la liste.
ReplaceEnrollmentValidateSectionHandler
Mise en œuvre
D2L.IM.IPSIS.Default.Enrollments.Handlers.ReplaceEnrollmentValidateSectionHandler
Comportement prévu
Le comportement prévu de ce gestionnaire consiste à confirmer que la requête d'inscription actuelle vise une section ou un groupe de cours.
Comportement en cas d'erreur
Si l'inscription n'est pas liée à une section ou à un groupe de cours, le gestionnaire génère une exception InvalidOrgUnitTypeException.
Note de configuration
Ce gestionnaire devrait être configuré avant le gestionnaire ReplaceEnrollmentCreateIMEnrollmentHandler.
ReplaceEnrollmentKeepLMSCreatedEnrollmentsOnUnenrollValidateHandler
Mise en œuvre
D2L.IM.IPSIS.Default.Enrollments.Handlers.ReplaceEnrollmentKeepLMSCreatedEnrollmentsOnUnenrollValidateHandler
Comportement prévu
Le comportement prévu de ce gestionnaire consiste à confirmer que la requête d’inscription actuelle correspond à un enregistrement d’inscription provenant d’une requête du SIS (et non d’une inscription manuelle dans Brightspace).
Comportement en cas d'erreur
Si l’enregistrement d’inscription provient de Brightspace (p. ex., l’utilisateur a d’abord été inscrit manuellement dans Brightspace et le SIS a envoyé une opération ReplaceMembership pour le même utilisateur et la même UO), le gestionnaire génère une exception UserManuallyEnrolledInLMSException.
Note de configuration
Ce gestionnaire doit être configuré avant le gestionnaire ReplaceEnrollmentCreateIMEnrollmentHandler, mais après le gestionnaire ReplaceEnrollmentReadIMHandler.
ReplaceEnrollmentCreateIMEnrollmentHandler
Mise en œuvre
D2L.IM.IPSIS.Default.Enrollments.Handlers.ReplaceEnrollmentCreateIMEnrollmentHandler
Comportement prévu
Le comportement prévu de ce gestionnaire consiste à créer des enregistrements d'inscription dans les tableaux de la base de données IM s'ils n'existent pas déjà. Pour chaque objet d'inscription de la liste de création de la requête, le gestionnaire actualise l'objet IM_ENROLLMENTS si aucune correspondance IM n'existe.
Comportement en cas d'erreur
Si un problème survient lors du traitement, le gestionnaire génère une exception et un message d’information détaillé.
Note de configuration
Ce gestionnaire devrait être configuré après les gestionnaires de lecture et de validation.
ReplaceEnrollmentEnrollLMSGroupSectionHandler
Le gestionnaire ReplaceEnrollmentEnrollLMSGroupSectionHandler inscrit les utilisateurs dans les sections ou les groupes mis en correspondance dans Brightspace.
Mise en œuvre
D2L.IM.IPSIS.Default.Enrollments.Handlers.ReplaceEnrollmentEnrollLMSGroupSectionHandler
Comportement prévu
Ce gestionnaire effectue les tâches suivantes :
- Inscrit l'utilisateur dans la section ou le groupe pour chaque objet d'inscription actif dans la liste des inscriptions à actualiser (si l'utilisateur n'est pas encore inscrit dans la section ou le groupe), ce qui génère automatiquement une entrée de journal de vérification.
- Si l'utilisateur est déjà inscrit dans la section ou le groupe avec un rôle différent, le gestionnaire désinscrit cet utilisateur et l'inscrit à nouveau en fonction du nouveau rôle (ce qui génère automatiquement une entrée de journal de vérification).
- Si l'utilisateur est déjà inscrit dans la section ou le groupe avec le même rôle, le gestionnaire ne fait rien.
- Le traitement est cédé au prochain gestionnaire (renvoi de la valeur True [vrai]).
Comportement en cas d'erreur
Si un problème survient lors du traitement, le gestionnaire génère une exception et un message d’information détaillé.
Notes de configuration
- Ce gestionnaire devrait être configuré après le gestionnaire SaveIM.
- Ce gestionnaire doit être configuré avant les gestionnaires EnrollLMSOffering et UnenrollLMSOffering.
- Ce gestionnaire ne devrait pas être configuré en même temps que le gestionnaire ReplaceEnrollmentEnrollLMSGroupSectionRoleNoUpdateHandler.
ReplaceEnrollmentEnrollLMSOfferingHandler
Le gestionnaire ReplaceEnrollmentEnrollLMSOfferingHandler inscrit les utilisateurs dans les offres de cours de Brightspace.
Mise en œuvre
D2L.IM.IPSIS.Default.Enrollments.Handlers.ReplaceEnrollmentEnrollLMSOfferingHandler
Comportement prévu
Ce gestionnaire effectue les tâches suivantes :
- Inscrit l'utilisateur dans l'offre de cours pour chaque objet d'inscription actif dans la liste des inscriptions à actualiser (si l'utilisateur n'est pas encore inscrit dans l'offre), ce qui génère automatiquement une entrée de journal de vérification.
- Si l'utilisateur est déjà inscrit dans l'offre avec un rôle différent, le gestionnaire désinscrit cet utilisateur et l'inscrit à nouveau en fonction du nouveau rôle (ce qui génère automatiquement une entrée de journal de vérification).
- Si l'utilisateur est déjà inscrit dans l'offre avec le même rôle, le gestionnaire ne fait rien.
- Le traitement est cédé au prochain gestionnaire (renvoi de la valeur True [vrai]).
Comportement en cas d'erreur
Si un problème survient lors du traitement, le gestionnaire génère une exception et un message d’information détaillé.
Notes de configuration
- Ce gestionnaire devrait être configuré après le gestionnaire EnrollLMSGroupSection.
- Ce gestionnaire ne devrait pas être configuré en même temps que le gestionnaire ReplaceEnrollmentEnrollLMSOfferingRoleNoUpdateHandler.
ReplaceEnrollmentSaveIMEnrollmentHandler
Le gestionnaire ReplaceEnrollmentSaveIMEnrollmentHandler enregistre toute modification apportée aux inscriptions dans les tableaux IM, y compris l'état et le rôle. Il crée également une liste des inscriptions qui doivent être actualisées.
Mise en œuvre
D2L.IM.IPSIS.Default.Enrollments.Handlers.ReplaceEnrollmentSaveIMEnrollmentHandler
Comportement prévu
Ce gestionnaire effectue les tâches suivantes :
- Actualise le rôle et l'état actif/inactif de l'inscription IM actuelle, et enregistre les modifications dans la base de données si un élément diffère de sa valeur d'origine.
- Crée une liste des inscriptions qui doivent être actualisées. Une même inscription IM unique peut correspondre à plusieurs inscriptions si la valeur de l'objet OrgUnitMappings n'est pas définie à une à une.
- Le traitement est cédé au prochain gestionnaire disponible.
Comportement en cas d'erreur
Si un problème survient lors du traitement, le gestionnaire génère une exception et un message d’information détaillé.
Note de configuration
- Ce gestionnaire devrait s'exécuter après le gestionnaire CreateIMEnrollment.
- Ce gestionnaire devrait s'exécuter avant les gestionnaires EnrollLMS et UnenrollLMS.
ReplaceEnrollmentEnrollLMSGroupSectionRoleNoUpdateHandler
Le gestionnaire ReplaceEnrollmentEnrollLMSGroupSectionRoleNoUpdateHandler crée ou actualise l'inscription dans la section ou le groupe, mais il n'actualise pas le rôle si elle en comprend déjà un. Ce gestionnaire inscrit les utilisateurs dans les sections ou les groupes de Brightspace s’ils n’y figurent pas déjà. Il ne modifie pas les inscriptions existantes.
Mise en œuvre
D2L.IM.IPSIS.Default.Enrollments.Handlers.ReplaceEnrollmentEnrollLMSGroupSectionRoleNoUpdateHandler
Comportement prévu
Ce gestionnaire effectue les tâches suivantes :
- Inscrit l’utilisateur dans la section ou le groupe de Brightspace pour chaque objet d’inscription actif dans la liste des inscriptions à actualiser (ce qui génère automatiquement une entrée de journal de vérification).
- Le traitement est cédé au prochain gestionnaire (renvoi de la valeur True [vrai]).
Comportement en cas d'erreur
Si un problème survient lors du traitement, le gestionnaire génère une exception et un message d’information détaillé.
Notes de configuration
- Ce gestionnaire devrait être configuré après le gestionnaire SaveIMEnrollment.
- Ce gestionnaire devrait être configuré avant le gestionnaire EnrollLMSOffering.
- Ce gestionnaire ne devrait pas être configuré en même temps que le gestionnaire ReplaceEnrollmentEnrollLMSGroupSectionHandler.
ReplaceEnrollmentEnrollLMSOfferingRoleNoUpdateHandler
Le gestionnaire ReplaceEnrollmentEnrollLMSOfferingRoleNoUpdateHandler crée ou actualise l'inscription dans l'offre de cours, mais il n'actualise pas le rôle si elle en comprend déjà un. Il ne modifie pas les inscriptions existantes.
Mise en œuvre
D2L.IM.IPSIS.Default.Enrollments.Handlers.ReplaceEnrollmentEnrollLMSOfferingRoleNoUpdateHandler
Comportement prévu
Ce gestionnaire effectue les tâches suivantes :
- Inscrit l'utilisateur dans l'offre de cours pour chaque objet d'inscription actif dans la liste des inscriptions à actualiser (ce qui génère automatiquement une entrée de journal de vérification).
- Le traitement est cédé au prochain gestionnaire (renvoi de la valeur True [vrai]).
Comportement en cas d'erreur
Si un problème survient lors du traitement, le gestionnaire génère une exception et un message d’information détaillé.
Note de configuration
- Ce gestionnaire devrait être configuré après le gestionnaire EnrollLMSGroupSection.
- Ce gestionnaire ne devrait pas être configuré en même temps que le gestionnaire ReplaceEnrollmentEnrollLMSOfferingHandler.
ReplaceEnrollmentStatusDefaultActiveHandler
Le gestionnaire ReplaceEnrollmentStatusDefaultActiveHandler définit par défaut l'état de l'inscription à actif si la valeur est nulle.
Mise en œuvre
D2L.IM.IPSIS.Default.Enrollments.Handlers.ReplaceEnrollmentStatusDefaultActiveHandler
Comportement prévu
Ce gestionnaire effectue les tâches suivantes :
- Définit l'état à actif s'il affiche présentement une valeur nulle.
- Dans le cas contraire, le gestionnaire est omis et ne modifie pas l'état existant.
Comportement en cas d'erreur
Si un problème survient lors du traitement, le gestionnaire génère une exception et un message d’information détaillé.
Notes de configuration
- Ce gestionnaire devrait être configuré après le gestionnaire de lecture.
- Ce gestionnaire devrait être configuré avant les gestionnaires CreateIM et SaveIM.
ReplaceEnrollmentStatusDefaultInactiveHandler
Le gestionnaire ReplaceEnrollmentStatusDefaultInactiveHandler définit par défaut l'état de l'inscription à inactif si la valeur est nulle.
Mise en œuvre
D2L.IM.IPSIS.Default.Enrollments.Handlers.ReplaceEnrollmentStatusDefaultInactiveHandler
Comportement prévu
Ce gestionnaire effectue les tâches suivantes :
- Définit l'état à inactif s'il affiche présentement une valeur nulle.
- Dans le cas contraire, le gestionnaire est omis et ne modifie pas l'état existant.
Notes de configuration
- Ce gestionnaire devrait être configuré après le gestionnaire de lecture.
- Ce gestionnaire devrait être configuré avant les gestionnaires CreateIM et SaveIM.
ReplaceEnrollmentUnenrollLMSGroupSectionHandler
Le gestionnaire ReplaceEnrollmentUnenrollLMSGroupSectionHandler supprime les inscriptions des groupes et sections de Brightspace.
Mise en œuvre
D2L.IM.IPSIS.Default.Enrollments.Handlers.ReplaceEnrollmentUnenrollLMSGroupSectionHandler
Comportement prévu
Ce gestionnaire désinscrit les utilisateurs des sections s'ils ne sont plus censés être inscrits. Ce gestionnaire effectue les tâches suivantes :
- Désinscrit l'utilisateur de la section ou du groupe pour chaque objet d'inscription inactif dans la liste des inscriptions à actualiser (si l'UO est une section de cours ou un groupe du SGA), génère automatiquement une entrée de journal de vérification et attribue l'état EntityDeleted à l'objet RequestStatus.
- Autrement, le gestionnaire ignore cette inscription et passe à la suivante.
Comportement en cas d'erreur
Si un problème survient lors du traitement, le gestionnaire génère une exception et un message d’information détaillé.
Note de configuration
Le gestionnaire UnenrollLMSGroupSection devrait s'exécuter après le gestionnaire de validation et avant le gestionnaire UnenrollLMSOffering.
ReplaceEnrollmentUnenrollLMSOfferingHandler
Le gestionnaire ReplaceEnrollmentUnenrollLMSOfferingHandler supprime les inscriptions des offres de cours de Brightspace.
Mise en œuvre
D2L.IM.IPSIS.Default.Enrollments.Handlers.ReplaceEnrollmentUnenrollLMSOfferingHandler
Comportement prévu
Ce gestionnaire désinscrit les utilisateurs des offres de cours dans Brightspace s’ils ne sont plus supposés être inscrits. Il ne désinscrit les utilisateurs des offres de cours que s'ils ne sont plus inscrits dans aucune section de l'offre.
Ce gestionnaire effectue les tâches suivantes :
- Désinscrit l'utilisateur de l'offre de cours pour chaque objet d'inscription dans la liste des suppressions (si l'inscription n'est plus active et si l'utilisateur n'est inscrit dans aucune autre section de la même offre), génère automatiquement une entrée de journal de vérification et attribue l'état EntityDeleted à l'objet RequestStatus.
- Autrement, le gestionnaire ignore cette inscription et passe à la suivante.
Comportement en cas d'erreur
Si un problème survient lors du traitement, le gestionnaire génère une exception et un message d’information détaillé.
Note de configuration
Le gestionnaire UnenrollLMSOffering devrait s'exécuter après le gestionnaire UnenrollLMSGroupSection.