L'interface du gestionnaire IReplaceDepartmentHandler est utilisée par les adaptateurs IPSIS pour prendre en charge l'opération de remplacement pour les départements.
La mise en œuvre de l'interface est D2L.IM.IPSIS.OrgUnits.Departments.Handlers.IReplaceDepartmentHandler.
Les listes de configuration IPSIS, Template – Department offrent un point de départ pour toute mise en œuvre IPSIS.
La liste des gestionnaires ci-dessous est utilisée comme point de départ :
- ReplaceDepartmentReadHandler (Sort Order = 10)
- ReplaceDepartmentValidateHandler (Sort Order = 20)
- ReplaceDepartmentCreateLMSHandler (Sort Order = 30)
- ReplaceDepartmentCreateIMHandler (Sort Order = 40)
- ReplaceDepartmentSaveLMSHandler (Sort Order = 50)
- ReplaceDepartmentSaveIMHandler (Sort Order = 60)
ReplaceDepartmentReadHandler
Le gestionnaire ReplaceDepartmentReadHandler lit toutes les informations relatives au département stockées dans les tableaux LMS (SGA) ou IM de la base de données à des fins d'utilisation par les gestionnaires ultérieurs.
Mise en œuvre
D2L.IM.IPSIS.Default.OrgUnits.Departmentss.Handlers.ReplaceDepartmentReadHandler
Comportement prévu
Ce gestionnaire effectue les tâches suivantes :
- Tente de lire les informations relatives au département dans les tableaux IM.
- S'il en trouve, il tente de lire toute correspondance au SGA pour le département.
- S'il en trouve, il tente de lire l'information relative au département dans le SGA.
- Tente de lire les informations relatives à toute unité organisationnelle primaire indiquée dans les tableaux IM.
- Si aucune information n'y figure, le gestionnaire définit la liste des nœuds primaires par défaut de l'organisation comme unique UO primaire.
- 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
Un gestionnaire de lecture devrait s'exécuter avant un gestionnaire de validation.
ReplaceDepartmentValidateHandler
Le gestionnaire ReplaceDepartmentValidateHandler vérifie qu'un nom et qu'un code valides sont affectés au département.
Mise en œuvre
D2L.IM.IPSIS.Default.OrgUnits.Departments.Handlers.ReplaceDepartmentValidateHandler
Comportement prévu
Ce gestionnaire effectue les tâches suivantes :
- Vérifie qu'un code et qu'un nom sont précisés pour la requête. Ces valeurs doivent être des chaînes d'une longueur supérieure à 0. Si les champs de code ou de nom affichent une valeur nulle ou vide, le gestionnaire génère une exception ArgumentNullException et interrompt tout le traitement.
- Le gestionnaire de validation s'assure également que la requête ne tente pas de modifier le type (p. ex., Collège à Département) d'une unité organisationnelle existante.
- Si la requête tente de modifier le type, le gestionnaire génère une exception InvalidOperationException et le traitement est interrompu.
- Si toutes les étapes aboutissent, le traitement est cédé au prochain gestionnaire (renvoi d'une 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
Les gestionnaires de validation devraient être configurés de façon à s'exécuter avant le gestionnaire de création.
ReplaceDepartmentParentsNoUpdateLMSHandler
Le gestionnaire ReplaceDepartmentParentsNoUpdateLMSHandler récupère les nœuds primaires de l'unité organisationnelle manuellement créés dans le SGA et empêche la relation d'être écrasée par cette opération de mise à jour.
Mise en œuvre
D2L.IM.IPSIS.Default.OrgUnits.Departments.Handlers.ReplaceDepartmentParentsNoUpdateLMSHandler
Comportement prévu
Ce gestionnaire effectue les tâches suivantes :
- Récupère tous les nœuds primaires du département et actualise la liste des nœuds primaires.
- Le traitement est cédé au prochain gestionnaire (renvoi de la valeur True [vrai]).
Comportement en cas d'erreur
Aucune erreur n'est générée pour ce traducteur.
Note de configuration
- Ce gestionnaire doit s'exécuter après les gestionnaires de lecture et de validation.
- Ce gestionnaire doit s'exécuter avant les gestionnaires d'enregistrement.
- Ordre de tri recommandé = 3.
ReplaceDepartmentCreateLMSHandler
Le gestionnaire ReplaceDepartmentCreateLMSHandler crée le département dans Brightspace.
Mise en œuvre
D2L.IM.IPSIS.Default.OrgUnits.Departments.Handlers.ReplaceDepartmentCreateLMSHandler
Comportement prévu
Ce gestionnaire ne s’exécute que si aucun département existant de Brightspace n’est associé à la requête. Ce gestionnaire effectue les tâches suivantes :
- Crée le département de Brightspace à l’aide des informations transmises dans la requête (ce qui génère automatiquement une entrée de journal de vérification).
- Si toutes les étapes aboutissent, le gestionnaire attribue l'état EntityCreated au résultat.
- Si une erreur survient, le gestionnaire attribue l'état CreateFailed au résultat.
- 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 affichant les informations les plus détaillées possible.
Notes de configuration
- Ce gestionnaire doit être placé après tout gestionnaire de validation.
- Le gestionnaire CreateLMS devrait précéder le gestionnaire CreateIM.
ReplaceDepartmentCreateIMHandler
Le gestionnaire ReplaceDepartmentCreateIMHandler crée l'objet Entity (entité) dans les tableaux IM, et une correspondance si une entité est définie.
Mise en œuvre
D2L.IM.IPSIS.Default.OrgUnits.Departments.Handlers.ReplaceDepartmentCreateIMHandler
Comportement prévu
Ce gestionnaire ne s'exécute que si les tableaux IM ne comprennent aucun objet Entity correspondant. Ce gestionnaire effectue les tâches suivantes :
- Crée le département dans la plateforme IM.
- Si une UO du SGA est associée à la requête, le gestionnaire crée la correspondance du département de la plateforme IM au département du SGA.
- Si toutes les étapes aboutissent, le gestionnaire attribue l'état EntityCreated au résultat.
- 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 affichant les informations les plus détaillées possible.
Note de configuration
Ce gestionnaire doit être placé après tout gestionnaire CreateLMS.
ReplaceDepartmentSaveLMSHandler
Le gestionnaire ReplaceDepartmentSaveLMSHandler enregistre toute modification apportée au département de Brightspace.
Mise en œuvre
Ce gestionnaire ne s’exécute que si des modifications relatives au département de Brightspace doivent être enregistrées. Ce gestionnaire effectue les tâches suivantes :
- Actualise le département de Brightspace (ce qui génère automatiquement une entrée de journal de vérification).
- Si la requête est une mise à jour et qu'au moins un champ a été modifié, le gestionnaire attribue l'état EntityUpdated au résultat.
- 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 doit être placé après tout gestionnaire de création.
ReplaceDepartmentSaveIMHandler
Le gestionnaire ReplaceDepartmentSaveIMHandler enregistre toute modification apportée à l'entité IM et aux correspondances.
Mise en œuvre
D2L.IM.IPSIS.Default.OrgUnits.Departments.Handlers.ReplaceDepartmentSaveIMHandler
Comportement prévu
Ce gestionnaire ne s'exécute que si des modifications relatives à l'entité ou à la hiérarchie dans les tableaux IM doivent être enregistrées. Ce gestionnaire effectue les tâches suivantes :
- Actualise l'entité IM si des modifications sont en cours.
- Actualise les relations de la hiérarchie de l'entité IM si des nœuds primaires ont été ajoutés ou supprimés.
- 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 doit être placé après tout gestionnaire SaveLMS.
ReplaceDepartmentMapByCodeHandler
Ce gestionnaire associe un département à un département existant de Brightspace en établissant la correspondance au niveau du code d’unité organisationnelle.
Mise en œuvre
D2L.IM.IPSIS.Default.OrgUnits.Departments.Handlers.ReplaceDepartmentMapByCodeHandler
Comportement prévu
Ce gestionnaire ne devrait être utilisé que si le code d'unité organisationnelle devait s'avérer unique au sein d'une organisation. Ce gestionnaire effectue les tâches suivantes :
- S’il n’existe aucune correspondance de département, le gestionnaire tente de trouver dans Brightspace un département correspondant au code d’UO.
- S'il trouve une correspondance, le gestionnaire actualise la requête en fonction de la valeur d'UO.
- S'il ne trouve aucune correspondance, le gestionnaire ne fait rien.
- S'il trouve plusieurs correspondances, le gestionnaire génère une exception MultipleOrgUnitsFoundException qui entraîne le renvoi d'une erreur.
- Ce gestionnaire ne devrait être utilisé que si le code d'unité organisationnelle devait s'avérer unique au sein d'une organisation.
- Le traitement est cédé au prochain gestionnaire.
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 serait généralement placé entre les gestionnaires de lecture et les gestionnaires de création, auquel cas il ne s'exécuterait que si les gestionnaires de lecture ne réussissent pas à trouver de département correspondant.
ReplaceDepartmentNameNoUpdateLMSHandler
Mise en œuvre
D2L.IM.IPSIS.Default.OrgUnits.Departments.Handlers.ReplaceDepartmentCreateHandler
Comportement prévu
Ce gestionnaire effectue les tâches suivantes :
- Actualise la requête pour indiquer que le nom ne doit pas être actualisé.
- 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 doit précéder tout gestionnaire SaveLMS.
ReplaceDepartmentValidateLMSOrgUnitExistsHandler
Le gestionnaire ReplaceDepartmentValidateLMSOrgUnitExistsHandler vérifie si l’unité organisationnelle à laquelle la requête correspond a été supprimée dans Brightspace.
Mise en œuvre
D2L.IM.IPSIS.Default.OrgUnits.Departments.Handlers.ReplaceDepartmentValidateLMSOrgUnitExistsHandler
Comportement prévu
Ce gestionnaire effectue les tâches suivantes :
- Tente de récupérer l'unité organisationnelle actuelle.
- Si l’UO actuelle n’existe pas (la requête est une opération de création ou l’UO a été supprimée dans Brightspace), le gestionnaire tente de récupérer la valeur de l’objet ExternalOrgUnitInfo de la requête.
- Si la valeur de l’objet ExternalOrgUnitInfo est valide, il ne s’agit pas d’une opération de création et l’UO a été supprimée dans le Brightspace. Le gestionnaire génère une exception UpdateOrgUnitFailedException.
- Cette exception pousse les services LIS à générer un code de données non valides. Ce code a été évalué comme représentant la réponse la plus appropriée pour cette situation.
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 est placé après les gestionnaires de lecture, généralement comme l'un des premiers gestionnaires de validation.