L’interface ITranslateGroup sert à traduire un enregistrement de groupe LIS dans une UO Brightspace.
La mise en œuvre de l'interface est D2L.IM.IPSIS.LIS.GMS.ITranslateGroup.
La liste de configuration suivante offre un point de départ pour toute mise en œuvre de LIS :
Template (Modèle), IPSIS
- GroupRequestBaseTranslator (Sort Order = 10)
- GroupRequestTypeValueIdRequiredTranslator (Sort Order = 20)
- GroupRequestNameShortDescRequiredTranslator (Sort Order = 30)
GroupRequestBaseTranslator
Le traducteur GroupRequestBaseTranslator met en correspondance l'ID de groupe.
Mise en œuvre
D2L.IM.IPSIS.LIS.RequestAdapters.GMS.Default.GroupRequestBaseTranslator
Comportement prévu
Le traducteur effectue les tâches suivantes :
- Définit OrgUnitCode et OrgUnitName à la valeur fournie dans sourcedGUID.sourcedid.
- Le traitement passe au traducteur suivant.
Propriété
|
Objet du résultat de la traduction
|
Mise en correspondance de requête LIS
|
Code
|
result.Entity.Code
|
groupRecord.sourcedGUID.sourcedId
|
Nom
|
result.Entity.Name
|
groupRecord.sourcedGUID.sourcedId
|
Comportement en cas d'erreur
Si un problème survient lors du traitement, IncompleteRequestException génère une exception. Résultat :
- L'interruption de toute étape de traitement éventuelle.
- En-tête de réponse LIS contenant :
- CodeMajor = échec.
- Severity = état.
- CodeMinor = invaliddata.
Note de configuration
Ce traducteur (ou un autre traducteur de base) doit d'abord être configuré dans la liste des traducteurs.
GroupRequestTypeValueIdRequiredTranslator
Le traducteur GroupRequestTypeValueIdRequiredTranslator envoie les requêtes relatives au premier type de groupe et le met en correspondance à l'aide de la première typeValue de la requête.
Mise en œuvre
D2L.IM.IPSIS.LIS.RequestAdapters.GMS.Default.GroupRequestTypeValueIdRequiredTranslator
Comportement prévu
Le traducteur effectue les tâches suivantes :
- Met en correspondance l'OrgUnitType depuis le premier type de groupe typeValue.
- Le traitement passe au traducteur suivant.
Propriété
|
Objet du résultat de la traduction
|
Mise en correspondance de requête LIS
|
Type
|
result.LISGroupType
|
groupRecord.group.groupType.typeValue{0}.id.textString
|
Comportement en cas d'erreur
Si un problème survient lors du traitement, IncompleteRequestException génère une exception. Résultat :
- L'interruption de toute étape de traitement éventuelle.
- En-tête de réponse LIS contenant :
- CodeMajor = échec.
- Severity = état.
- CodeMinor = invaliddata.
Notes de configuration
- Ce traducteur peut être placé n'importe où après le traducteur de base.
- Ce traducteur (ou un traducteur de remplacement personnalisé) devrait toujours être configuré.
GroupRequestNameShortDescRequiredTranslator
Le traducteur GroupRequestNameShortDescRequiredTranslator envoie les requêtes relatives au nom et le met en correspondance d'après la description courte.
Mise en œuvre
D2L.IM.IPSIS.LIS.RequestAdapters.GMS.Default.GroupRequestNameShortDescRequiredTranslator
Comportement prévu
Le traducteur effectue les tâches suivantes :
- Met à jour l'OrgUnitName pour contenir la valeur de la description courte dans la requête.
- Le traitement passe au traducteur suivant.
Propriété
|
Objet du résultat de la traduction
|
Mise en correspondance de requête LIS
|
Nom
|
result.Entity.Name
|
groupRecord.group.description.shortDescription
|
Comportement en cas d'erreur
Si un problème survient lors du traitement, IncompleteRequestException génère une exception. Résultat :
- L'interruption de toute étape de traitement éventuelle.
- En-tête de réponse LIS contenant :
- CodeMajor = échec.
- Severity = état.
- CodeMinor = invaliddata.
Note de configuration
Ce traducteur peut être placé n'importe où après le traducteur de base.
GroupRequestNameLongDescRequiredTranslator
Le traducteur GroupRequestNameLongDescRequiredTranslator envoie les requêtes relatives au nom et le met en correspondance d'après la description longue.
Mise en œuvre
D2L.IM.IPSIS.LIS.RequestAdapters.GMS.Default.GroupRequestNameRequiredLongDescTranslator
Comportement prévu
Le traducteur effectue les tâches suivantes :
- Met à jour l'OrgUnitName pour contenir la valeur de la description longue dans la requête.
- Le traitement passe au traducteur suivant.
Propriété
|
Objet du résultat de la traduction
|
Mise en correspondance de requête LIS
|
Nom
|
result.Entity.Name
|
groupRecord.group.description.longDescription
|
Comportement en cas d'erreur
Si un problème survient lors du traitement, IncompleteRequestException génère une exception. Résultat :
- L'interruption de toute étape de traitement éventuelle.
- En-tête de réponse LIS contenant :
- CodeMajor = échec.
- Severity = état.
- CodeMinor = invaliddata.
Note de configuration
Ce traducteur peut être placé n'importe où après le traducteur de base.
GroupRequestNameLongDescOptionalTranslator
Le traducteur GroupRequestNameLongDescOptionalTranslator définit le nom en fonction de la longue description, si elle existe.
Mise en œuvre
D2L.IM.IPSIS.LIS.RequestAdapters.GMS.Default.GroupRequestNameLongDescOptionalTranslator
Comportement prévu
Le traducteur effectue les tâches suivantes :
- Met à jour l'OrgUnitName pour contenir la valeur de la description longue dans la requête si elle existe.
- Le traitement passe au traducteur suivant.
Propriété
|
Objet du résultat de la traduction
|
Mise en correspondance de requête LIS
|
Nom
|
result.Entity.Name
|
groupRecord.group.description.longDescription
|
Comportement en cas d'erreur
Si un problème survient lors du traitement, IncompleteRequestException génère une exception. Résultat :
- L'interruption de toute étape de traitement éventuelle.
- En-tête de réponse LIS contenant :
- CodeMajor = échec.
- Severity = état.
- CodeMinor = invaliddata.
Note de configuration
Ce traducteur peut être placé n'importe où après le traducteur de base.
GroupRequestNameShortDescOptionalTranslator
Le traducteur GroupRequestNameShortDescOptionalTranslator définit le nom en fonction de la description courte, si elle existe.
Mise en œuvre
D2L.IM.IPSIS.LIS.RequestAdapters.GMS.Default.GroupRequestNameShortDescOptionalTranslator
Comportement prévu
Le traducteur effectue les tâches suivantes :
- Met à jour l'OrgUnitName pour contenir la valeur de la description courte dans la requête si elle existe.
- Le traitement passe au traducteur suivant.
Propriété
|
Objet du résultat de la traduction
|
Mise en correspondance de requête LIS
|
Nom
|
result.Entity.Name
|
groupRecord.group.description.shortDescription
|
Comportement en cas d'erreur
Si un problème survient lors du traitement, IncompleteRequestException génère une exception. Résultat :
- L'interruption de toute étape de traitement éventuelle.
- En-tête de réponse LIS contenant :
- CodeMajor = échec.
- Severity = état.
- CodeMinor = invaliddata.
Note de configuration
Ce traducteur peut être placé n'importe où après le traducteur de base.
GroupRequestCreateRecordFromSourcedIdRequiredTranslator
Le traducteur GroupRequestCreateRecordFromSourcedIdRequiredTranslator crée une requête pour un groupe valide si seul le sourcedId a été transmis.
Mise en œuvre
D2L.IM.IPSIS.LIS.RequestAdapters.GMS.Default.GroupRequestCreateRecordFromSourcedIdRequiredTranslator
Comportement prévu
Le traducteur effectue les tâches suivantes :
- Si aucun enregistrement de groupe valide n'existe dans la requête, le traducteur crée une requête de groupe fictive, à l'aide du sourcedId de la description courte et règle par défaut le type à Département.
- Le traitement passe au traducteur suivant.
Note de configuration
Ce traducteur peut être placé tout de suite après le traducteur de base.
GroupRequestTruncateOrgUnitCodeTranslator
Le traducteur GroupRequestTruncateOrgUnitCodeTranslator tronque le code de l'UO de l'objet du résultat si le code contient plus de 50 caractères. Le code tronqué est fixé à 50 caractères.
Mise en œuvre
D2L.IM.IPSIS.LIS.RequestAdapters.CMS.Default.GroupRequestTruncateOrgUnitCodeTranslator
Comportement prévu
Le traducteur effectue les tâches suivantes :
- Vérifiez que le code result.Entity.Code ne dépasse pas 50 caractères. Le cas échéant, le code tronqué est fixé à 50 caractères.
- Le traitement passe au traducteur suivant.
Note de configuration
Ce traducteur peut être placé n'importe où après le traducteur de base.