L’interface ITranslateMembership sert à traduire un enregistrement d’abonnement LIS en inscription dans Brightspace.
La mise en œuvre de l'interface est D2L.IM.IPSIS.LIS.MMS.ITranslateMembership.
La liste de configuration suivante offre un point de départ pour toute mise en œuvre de LIS :
Template (Modèle), IPSIS
- MembershipRequestBaseTranslator (Sort Order = 10)
- MembershipRequestCollectionRequiredTranslator (Sort Order = 20)
- MembershipRequestUserPersonRequiredTranslator (Sort Order = 30)
- MembershipRequestRoleTypeAndStatusRequiredTranslator (Sort Order = 40)
MembershipRequestBaseTranslator
Le MembershipRequestBaseTranslator met en correspondance l'identificateur d'inscription.
Mise en œuvre
D2L.IM.IPSIS.LIS.RequestAdapters.MMS.Default.MembershipRequestBaseTranslator
Comportement prévu
Le traducteur effectue les tâches suivantes :
- Définit IMEnrollmentId à 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
|
|
ID du message d'inscription
|
result.LISMembershipId
|
membershipRecord.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.
MembershipRequestCollectionRequiredTranslator
Le traducteur MembershipRequestCollectionRequiredTranslator envoie les requêtes relatives à la collection d'inscriptions (typiquement une section LIS) et la met en correspondance.
Mise en œuvre
D2L.IM.IPSIS.LIS.RequestAdapters.MMS.Default.MembershipRequestCollectionRequiredTranslator
Comportement prévu
Le traducteur effectue les tâches suivantes :
- Le collectionSourcedId est ensuite ajouté à l'objet du résultat.
- Le traitement passe au traducteur suivant.
|
Propriété
|
Objet du résultat de la traduction
|
Mise en correspondance de requête LIS
|
|
Code de section
|
result.Entity.IMOrgUnitIdentifier
|
membershipRecord.membership.collectionSourcedId
|
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.
MembershipRequestUserPersonRequiredTranslator
Le traducteur MembershipRequestUserPersonRequiredTranslator envoie les requêtes relatives à l'utilisateur et le met en correspondance.
Comportement prévu
Le traducteur effectue les tâches suivantes :
- Ajoute le code d'identification de personne à l'objet du résultat.
- Le traitement passe au traducteur suivant.
|
Propriété
|
Objet du résultat de la traduction
|
Mise en correspondance de requête LIS
|
|
UserId
|
result.Entity.IMUserIdentifier
|
membershipRecord.membership.member.personSourcedId
|
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.
MembershipRequestRoleTypeAndStatusRequiredTranslator
Le traducteur MembershipRequestRoleTypeAndStatusRequiredTranslator envoie les requêtes relatives au roleType et le met en correspondance.
Mise en œuvre
D2L.IM.IPSIS.LIS.RequestAdapters.MMS.Default.MembershipRequestRoleTypeStatusRequiredTranslator
Comportement prévu
Le traducteur effectue les tâches suivantes :
- Ajoute le rôle et l'état à l'objet du résultat.
- Plusieurs objets de rôle peuvent être fournis; ils sont transmis au gestionnaire à titre d'IEnumerable.
- Si un rôle est présent, mais qu'il y manque l'un ou l'autre type ou l'état, une exception IncompleteRequestException est générée.
- Le traitement passe au traducteur suivant.
|
Propriété
|
Objet du résultat de la traduction
|
Mise en correspondance de requête LIS
|
|
Rôle
|
result.Entity.Roles{*}.role
|
membershipRecord.membership.member.role{*}.roleType
|
|
État de l’inscription
|
results.Entity.Roles{*}.status
|
membershipRecord.membership.member.role{*}.status
|
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 n'est généralement pas configuré avec MembershipRequestSubRoleAndStatusRequiredTranslator.
- Ce traducteur n'est généralement pas configuré avec MembershipRequestRoleTypeRequiredTranslator.
MembershipRequestSubRoleAndStatusRequiredTranslator
Le traducteur MembershipRequestSubRoleAndStatusRequiredTranslator envoie les requêtes relatives au sous-rôle et à l'état et les met en correspondance.
Mise en œuvre
D2L.IM.IPSIS.LIS.RequestAdapters.MMS.Default.MembershipRequestSubRoleStatusRequiredTranslator
Comportement prévu
Le traducteur effectue les tâches suivantes :
- Ajoute le sous-rôle et l'état à l'objet du résultat.
- Plusieurs objets de sous-rôle peuvent être fournis; ils sont transmis au gestionnaire à titre d'IEnumerable.
- Si un sous-rôle est présent, mais qu'il y manque l'un ou l'autre type ou l'état, une exception IncompleteRequestException est générée.
- Le traitement passe au traducteur suivant.
|
Propriété
|
Objet du résultat de la traduction
|
Mise en correspondance de requête LIS
|
|
Rôle
|
result.Entity.Roles{*}.role
|
membershipRecord.membership.member.role{*}.subRole
|
|
État de l’inscription
|
results.Entity.Roles{*}.status
|
membershipRecord.membership.member.role{*}.status
|
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 n'est généralement pas configuré avec MembershipRequestRoleTypeAndStatusRequiredTranslator.
- Ce traducteur n'est généralement pas configuré avec MembershipRequestRoleTypeRequiredTranslator.
MembershipRequestRoleTypeRequiredTranslator
Le traducteur MembershipRequestRoleTypeRequiredTranslator envoie les requêtes relatives roleType et le met en correspondance avec l'état s'il est disponible. Cette fonction doit être utilisée seulement s'il y a une chance que l'état ne soit pas défini.
Mise en œuvre
D2L.IM.IPSIS.LIS.RequestAdapters.MMS.Default.MembershipRequestRoleTypeRequiredTranslator
Comportement prévu
Le traducteur effectue les tâches suivantes :
- Pour chaque rôle, le traducteur ajoute le type de rôle à l'objet du résultat et l'état s'il est disponible (valeur nulle s'il ne l'est pas).
- Plusieurs objets de rôle peuvent être fournis; ils sont transmis au gestionnaire à titre d'IEnumerable.
- Si un rôle est présent, mais qu'il y manque le type, une exception IncompleteRequestException est générée.
- Le traitement passe au traducteur suivant.
|
Propriété
|
Objet du résultat de la traduction
|
Mise en correspondance de requête LIS
|
|
Rôle
|
result.Entity.Roles{*}.role
|
membershipRecord.membership.member.role{*}.subRole
|
|
État de l’inscription
|
results.Entity.Roles{*}.status
|
membershipRecord.membership.member.role{*}.status
|
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 n'est généralement pas configuré avec MembershipRequestRoleTypeAndStatusRequiredTranslator.
- Ce traducteur n'est généralement pas configuré avec MembershipRequestSubRoleAndStatusRequiredTranslator.