De ITranslateMembership-interface wordt gebruikt om een LIS-lidmaatschapsrecord te vertalen naar een inschrijving voor Brightspace®.
De interface-implementatie is D2L.IM.IPSIS.LIS.MMS.ITranslateMembership.
De volgende configuratielijst biedt een startpunt voor elke LIS-implementatie.
Sjabloon, IPSIS
- MembershipRequestBaseTranslator (sorteervolgorde = 10)
- MembershipRequestCollectionRequiredTranslator (sorteervolgorde = 20)
- MembershipRequestUserPersonRequiredTranslator (sorteervolgorde = 30)
- MembershipRequestRoleTypeAndStatusRequiredTranslator (sorteervolgorde = 40)
MembershipRequestBaseTranslator
De MembershipRequestBaseTranslator wijst de inschrijvings-id toe.
Implementatie
D2L.IM.IPSIS.LIS.RequestAdapters.MMS.Default.MembershipRequestBaseTranslator®
Verwacht gedrag
Het omzettingsprogramma voert de volgende taken uit:
- Stel IMEnrollmentId in op de waarde die is opgegeven in de sourcedGUID.sourcedid.
- De verwerking gaat door naar het volgende omzettingsprogramma.
|
Eigenschap
|
Object voor omzettingsresultaat
|
Toewijzing LIS-aanvraag
|
|
Inschrijvingsbericht-id
|
result.LISMembershipId
|
membershipRecord.sourcedGUID.sourcedId
|
Foutgedrag
Als zich een probleem voordoet tijdens de verwerking, wordt er een IncompleteRequestException gegenereerd. Dit resulteert in:
- De opschorting van alle verdere verwerking.
- Een LIS-responskoptekst met:
- CodeMajor = failure.
- Severity = status.
- CodeMinor = invaliddata.
Opmerking over de configuratie
Dit omzettingsprogramma (of een alternatief omzettingsprogramma) moet eerst worden geconfigureerd in de lijst met omzettingsprogramma's.
MembershipRequestCollectionRequiredTranslator
De MembershipRequestCollectionRequiredTranslator vereist en wijst de verzameling inschrijvingen toe (meestal LIS-sectie).
Implementatie
D2L.IM.IPSIS.LIS.RequestAdapters.MMS.Default.MembershipRequestCollectionRequiredTranslator®
Verwacht gedrag
Het omzettingsprogramma voert de volgende taken uit:
- De collectionSourcedId wordt toegevoegd aan het resultaatobject.
- De verwerking gaat door naar het volgende omzettingsprogramma.
|
Eigenschap
|
Object voor omzettingsresultaat
|
Toewijzing LIS-aanvraag
|
|
Sectiecode
|
result.Entity.IMOrgUnitIdentifier
|
membershipRecord.membership.collectionSourcedId
|
Foutgedrag
Als zich een probleem voordoet tijdens de verwerking, wordt er een IncompleteRequestException gegenereerd. Dit resulteert in:
- De opschorting van alle verdere verwerking.
- Een LIS-responskoptekst met:
- CodeMajor = failure.
- Severity = status.
- CodeMinor = invaliddata.
Opmerking over de configuratie
Dit omzettingsprogramma kan overal achter het basisomzettingsprogramma worden geplaatst.
MembershipRequestUserPersonRequiredTranslator
De MembershipRequestUserPersonRequiredTranslator vereist een gebruiker en wijst deze toe.
Verwacht gedrag
Het omzettingsprogramma voert de volgende taken uit:
- Hiermee wordt de persoon-id toegevoegd aan het resultaatobject.
- De verwerking gaat door naar het volgende omzettingsprogramma.
|
Eigenschap
|
Object voor omzettingsresultaat
|
Toewijzing LIS-aanvraag
|
|
Gebruikers-id
|
result.Entity.IMUserIdentifier
|
membershipRecord.membership.member.personSourcedId
|
Foutgedrag
Als zich een probleem voordoet tijdens de verwerking, wordt er een IncompleteRequestException gegenereerd. Dit resulteert in:
- De opschorting van alle verdere verwerking.
- Een LIS-responskoptekst met:
- CodeMajor = failure.
- Severity = status.
- CodeMinor = invaliddata.
Opmerking over de configuratie
Dit omzettingsprogramma kan overal achter het basisomzettingsprogramma worden geplaatst.
MembershipRequestRoleTypeAndStatusRequiredTranslator
De MembershipRequestRoleTypeAndStatusRequiredTranslator vereist een roleType en status en wijst deze toe.
Implementatie
D2L.IM.IPSIS.LIS.RequestAdapters.MMS.Default.MembershipRequestRoleTypeStatusRequiredTranslator®
Verwacht gedrag
Het omzettingsprogramma voert de volgende taken uit:
- Voegt de rol en status toe aan het resultaatobject.
- Er kunnen meerdere rolobjecten worden verstrekt. Deze worden als IEnumerable aan de handlers doorgegeven.
- Als een rol aanwezig is, maar een type of een status mist, wordt een IncompleteRequestException gegenereerd.
- De verwerking gaat door naar het volgende omzettingsprogramma.
|
Eigenschap
|
Object voor omzettingsresultaat
|
Toewijzing LIS-aanvraag
|
|
Rol
|
result.Entity.Roles{*}.role
|
membershipRecord.membership.member.role{*}.roleType
|
|
Inschrijvingsstatus
|
results.Entity.Roles{*}.status
|
membershipRecord.membership.member.role{*}.status
|
Foutgedrag
Als zich een probleem voordoet tijdens de verwerking, wordt er een IncompleteRequestException gegenereerd. Dit resulteert in:
- De opschorting van alle verdere verwerking.
- Een LIS-responskoptekst met:
- CodeMajor = failure.
- Severity = status.
- CodeMinor = invaliddata.
Opmerkingen over de configuratie
- Dit omzettingsprogramma kan overal achter het basisomzettingsprogramma worden geplaatst.
- Dit omzettingsprogramma is doorgaans niet geconfigureerd met MembershipRequestRoleTypeAndStatusRequiredTranslator.
- Dit omzettingsprogramma is doorgaans niet geconfigureerd met MembershipRequestRoleTypeRequiredTranslator.
MembershipRequestSubRoleAndStatusRequiredTranslator
Het omzettingsprogramma MembershipRequestSubRoleAndStatusRequiredTranslator vereist en wijst een subrol en status toe.
Implementatie
D2L.IM.IPSIS.LIS.RequestAdapters.MMS.Default.MembershipRequestSubRoleStatusRequiredTranslator®
Verwacht gedrag
Het omzettingsprogramma voert de volgende taken uit:
- Voegt de subrol en status toe aan het resultaatobject.
- Er kunnen meerdere subrolobjecten worden opgegeven. Deze worden als IEnumerable aan de handlers doorgegeven.
- Als er een subrol aanwezig is, maar een type of status ontbreekt, wordt er een IncompleteRequestException gegenereerd.
- De verwerking gaat door naar het volgende omzettingsprogramma.
|
Eigenschap
|
Object voor omzettingsresultaat
|
Toewijzing LIS-aanvraag
|
|
Rol
|
result.Entity.Roles{*}.role
|
membershipRecord.membership.member.role{*}.subRole
|
|
Inschrijvingsstatus
|
results.Entity.Roles{*}.status
|
membershipRecord.membership.member.role{*}.status
|
Foutgedrag
Als zich een probleem voordoet tijdens de verwerking, wordt er een IncompleteRequestException gegenereerd. Dit resulteert in:
- De opschorting van alle verdere verwerking.
- Een LIS-responskoptekst met:
- CodeMajor = failure.
- Severity = status.
- CodeMinor = invaliddata.
Opmerkingen over de configuratie.
- Dit omzettingsprogramma kan overal achter het basisomzettingsprogramma worden geplaatst.
- Dit omzettingsprogramma is doorgaans niet geconfigureerd met MembershipRequestRoleTypeAndStatusRequiredTranslator.
- Dit omzettingsprogramma is doorgaans niet geconfigureerd met MembershipRequestRoleTypeRequiredTranslator.
MembershipRequestRoleTypeRequiredTranslator
De MembershipRequestRoleTypeRequiredTranslator vereist en wijst een roltype toe en wijst de status toe, indien beschikbaar. Dit mag alleen worden gebruikt als de kans bestaat dat de status niet wordt ingesteld.
Implementatie
D2L.IM.IPSIS.LIS.RequestAdapters.MMS.Default.MembershipRequestRoleTypeRequiredTranslator®
Verwacht gedrag
Het omzettingsprogramma voert de volgende taken uit:
- Voor elke rol voegt het omzettingsprogramma het roltype toe aan het resultaatobject en voegt de status toe indien beschikbaar (null als dit niet het geval is).
- Er kunnen meerdere rolobjecten worden verstrekt. Deze worden als IEnumerable aan de handlers doorgegeven.
- Als er een rol aanwezig is, maar het type ontbreekt, wordt er een IncompleteRequestException gegenereerd.
- De verwerking gaat door naar het volgende omzettingsprogramma.
|
Eigenschap
|
Object voor omzettingsresultaat
|
Toewijzing LIS-aanvraag
|
|
Rol
|
result.Entity.Roles{*}.role
|
membershipRecord.membership.member.role{*}.subRole
|
|
Inschrijvingsstatus
|
results.Entity.Roles{*}.status
|
membershipRecord.membership.member.role{*}.status
|
Foutgedrag
Als zich een probleem voordoet tijdens de verwerking, wordt er een IncompleteRequestException gegenereerd. Dit resulteert in:
- De opschorting van alle verdere verwerking.
- Een LIS-responskoptekst met:
- CodeMajor = failure.
- Severity = status.
- CodeMinor = invaliddata.
Opmerkingen over de configuratie
- Dit omzettingsprogramma kan overal achter het basisomzettingsprogramma worden geplaatst.
- Dit omzettingsprogramma is doorgaans niet geconfigureerd met MembershipRequestRoleTypeAndStatusRequiredTranslator.
- Dit omzettingsprogramma is doorgaans niet geconfigureerd met MembershipRequestRoleTypeAndStatusRequiredTranslator.