Info over de ITranslatePerson-interface
De ITranslatePerson-interface wordt gebruikt om aanvragen van LIS-personen om te zetten naar een IPSIS-gebruikersobject voor Brightspace®.
De interface-implementatie is D2L.IM.IPSIS.LIS.PMS.ITranslatePerson.
De volgende configuratielijst biedt een startpunt voor elke implementatie:
Sjabloon, IPSIS
- PersonRequestBaseTranslator (sorteervolgorde = 10)
- PersonRequestFirstAndLastNameRequiredTranslator (sorteervolgorde = 20)
- PersonRequestInstitutionRoleOptionalTranslator (sorteervolgorde = 30)
- PersonRequestEmailPrimaryOptionalTranslator (sorteervolgorde = 40)
- PersonRequestFirstUserIdAndPasswordOptionalTranslator (sorteervolgorde = 50)
PersonRequestBaseTranslator
De PersonRequestBaseTranslator vereist en wijst de persoon-id toe.
Implementatie
D2L.IM.IPSIS.LIS.RequestAdapters.PMS.Default.PersonRequestBaseTranslator®
Verwacht gedrag
Het omzettingsprogramma voert de volgende taken uit:
- Hiermee stelt u de OrgDefinedId in op de waarde die is opgegeven in het sourcedGUID.sourcedid.
- De verwerking gaat door naar het volgende omzettingsprogramma.
|
Eigenschap
|
Object voor omzettingsresultaat
|
Toewijzing LIS-aanvraag
|
|
OrgDefinedId
|
result.Entity.OrgDefinedId
|
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.
PersonRequestIsActiveTranslator
De PersonRequestIsActiveTranslator stelt de status van de gebruiker in op basis van de veldwaarde.
Implementatie
D2L.IM.IPSIS.LIS.RequestAdapters.PMS.Default.PersonRequestIsActiveTranslator®
Verwacht gedrag
Het omzettingsprogramma voert de volgende taken uit:
- Leest het LIS-bericht voor uitbreidingsvelden waarbij fieldName = "IsActive".
- De veldwaarde moet 0 of 1 zijn, of True of False.
- De verwerking gaat door naar het volgende omzettingsprogramma (Return True).
|
Eigenschap
|
Object voor omzettingsresultaat
|
Toewijzing LIS-aanvraag
|
|
Status
|
result.Entity.Status
|
extension.extensionField.fieldValue[IsActive]
|
Foutgedrag
Er worden geen fouten gegenereerd voor dit omzettingsprogramma.
Opmerking over de configuratie
Dit omzettingsprogramma moet worden geconfigureerd op een willekeurige plaats na de PersonRequestBaseTranslator.
PersonRequestFirstAndLastNameRequiredTranslator
De PersonRequestFirstAndLastNameRequiredTranslator vereist voor- en achternamen en wijst deze toe.
Implementatie
D2L.IM.IPSIS.LIS.RequestAdapters.PMS.Default.PersonRequestFirstAndLastNameRequiredTranslator®
Verwacht gedrag
Het omzettingsprogramma voert de volgende taken uit:
- Probeert om de voornaam in te vullen op basis van de volgende vocabulaire-overeenkomsten:
- Indien name.nameType.instanceName.textString = (Contact of Full)
- en name.partName.instanceName.textString = (First of Given)
- Probeert om de achternaam in te vullen op basis van de volgende vocabulaire-overeenkomsten:
- Indien name.nameType.instanceName.textString = (Contact of Full)
- en name.partName.instanceName.textString = (Last, Family of Surname)
- De verwerking gaat door naar het volgende omzettingsprogramma.
|
Eigenschap
|
Object voor omzettingsresultaat
|
Toewijzing LIS-aanvraag
|
|
Voornaam
|
result.Entity.FirstName
|
person.name.partName.instanceValue.textString
wanneer person.name.partName.instanceName.textString = (First of Given)
|
|
Achternaam
|
result.Entity.LastName
|
person.name.partName.instanceValue.textString
wanneer person.name.partName.instanceName.textString = (Last, Family of Surname)
|
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.
PersonRequestInstitutionRoleOptionalTranslator
De PersonRequestInstitutionRoleOptionalTranslator probeert een rol en een eigenschap voor de primaire rol toe te wijzen.
Implementatie
D2L.IM.IPSIS.LIS.RequestAdapters.PMS.Default.PersonRequestInstitutionRoleOptionalTranslator®
Verwacht gedrag
Het omzettingsprogramma voert de volgende taken uit:
- Voegt de rollen uit de institutionRole-elementen toe aan de resultatenlijst.
- Als een institutionRole-waarde wordt aangegeven als een primaryroletype, wordt de rol gebruikt als de primaire rol.
- Als er geen rol wordt opgegeven, gaat de verwerking naar het volgende omzettingsprogramma.
- De verwerking gaat door naar het volgende omzettingsprogramma.
|
Eigenschap
|
Object voor omzettingsresultaat
|
Toewijzing LIS-aanvraag
|
|
Rollen
|
result.SISRoles(*).Name
|
person.roles.institutionRole(*).institutionroletype.instanceValue.textString
|
|
Primaire rol
|
result.SISRoles(*).Primary
|
person.roles.institutionRole(*).institutionroletype.instanceValue.textString
wanneer person.roles.institutionRole(*).primaryroletype = true
|
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.
PersonRequestEmailPrimaryOptionalTranslator
De PersonRequestEmailPrimaryOptionalTranslator probeert een e-mailadres toe te wijzen.
Implementatie
D2L.IM.IPSIS.LIS.RequestAdapters.PMS.Default.PersonRequestEmailPrimaryOptionalTranslator®
Verwacht gedrag
Het omzettingsprogramma voert de volgende taken uit:
- Als er nog geen e-mailadres is ingesteld, gebruikt het omzettingsprogramma een vocabulaire en haalt de eerste gevonden EmailPrimary-waarde op.
- De verwerking gaat door naar het volgende omzettingsprogramma.
|
Eigenschap
|
Object voor omzettingsresultaat
|
Toewijzing LIS-aanvraag
|
|
Rollen
|
result.Entity.ExternalEmail
|
person.contactinfo.contactInfoValue.textString
Wanneer person.contactinfo.contactInfoType.instanceValue.textString = E-mailPrimary
|
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.
PersonRequestFirstUserIdAndPasswordOptionalTranslator
De PersonRequestFirstUserIdAndPasswordOptionalTranslator probeert de userid en het wachtwoord toe te wijzen.
Implementatie
D2L.IM.IPSIS.LIS.RequestAdapters.PMS.Default.PersonRequestFirstUserIdAndPasswordOptionalTranslator®
Verwacht gedrag
Het omzettingsprogramma voert de volgende taken uit:
- De gebruikersnaam wordt ingevuld op basis van de userId als deze is opgegeven.
- Als er een gebruikersnaam wordt opgegeven, wordt het wachtwoord ingevuld.
- Als er een coderingstype voor wachtwoorden is opgegeven, wordt de wachtwoordversleuteling ingevuld.
- De verwerking gaat door naar het volgende omzettingsprogramma.
|
Eigenschap
|
Object voor omzettingsresultaat
|
Toewijzing LIS-aanvraag
|
|
Gebruikersnaam
|
result.Entity.Username.value
|
person.userId.userIdValue.textString
|
|
UserIdType
|
result.Entity.UserIdType
|
person.userId.userIdType.textString
|
|
Wachtwoord
|
result.Entity.Username.Password.Value
|
person.userId.password.textString
|
|
EncryptionMethod
|
result.Entity.EncryptionMethod
|
person.userId.pwEncryptionType.textString
|
|
AuthenticationType
|
result.Username.AuthenticationType
|
person.userId.authenticationType.textString
|
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.
PersonRequestSystemRoleOptionalTranslator
De PersonRequestSystemRoleOptionalTranslator probeert de systeemrol toe te wijzen.
Implementatie
D2L.IM.IPSIS.LIS.RequestAdapters.PMS.Default.PersonRequestSystemRoleOptionalTranslator®
Verwacht gedrag
- Voegt de rol vanuit de systeemelementen toe aan de lijst met resultaatrollen.
- De verwerking gaat door naar het volgende omzettingsprogramma.
|
Eigenschap
|
Object voor omzettingsresultaat
|
Toewijzing LIS-aanvraag
|
|
Rollen
|
result.SISRoles(*).Name
|
person.roles.systemRole.instanceValue.textString
|
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.
PersonRequestEmailSecondaryOptionalTranslator
De PersonRequestEmailSecondaryOptionalTranslator probeert een e-mailadres toe te wijzen op basis van de secundaire e-mails in het bericht als er nog geen e-mail is ingesteld.
Implementatie
D2L.IM.IPSIS.LIS.RequestAdapters.PMS.Default.PersonRequestEmailSecondaryOptionalTranslator®
Verwacht gedrag
- Als er nog geen e-mailadres is ingesteld, gebruikt u het vocabulaire en wordt de eerste EmailSecondary-waarde opgehaald die wordt gevonden.
- De verwerking gaat door naar het volgende omzettingsprogramma.
|
Eigenschap
|
Object voor omzettingsresultaat
|
Toewijzing LIS-aanvraag
|
|
Rollen
|
result.Entity.ExternalEmail
|
person.contactinfo.contactInfoValue.textString
wanneer person.contactinfo.contactInfoType.instanceValue.textString = EmailSecondary
|
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.
PersonRequestCreateRecordFromSourcedIdRequiredTranslator
De PersonRequestCreateRecordFromSourcedIdRequiredTranslator maakt een geldige persoonsaanvraag als het enige dat is doorgegeven de sourceId is.
Implementatie
D2L.IM.IPSIS.LIS.RequestAdapters.PMS.Default.PersonRequestCreateRecordFromSourcedIdRequiredTranslator®
Verwacht gedrag
Het omzettingsprogramma voert de volgende taken uit:
- Als er geen geldige persoonsrecord op de aanvraag bestaat, bouwt het omzettingsprogramma een aanvraag voor een dummy-persoon op, waarbij de sourceID wordt gebruikt voor de voornaam, achternaam en gebruikers-id.
- De verwerking gaat door naar het volgende omzettingsprogramma.
Opmerkingen over de configuratie
- Dit omzettingsprogramma moet direct na het Base-omzettingsprogramma worden geplaatst.
- Dit omzettingsprogramma wordt alleen gebruikt als verwacht wordt dat er onvoldoende informatie van het SIS wordt ontvangen om een persoon uit te bouwen in Brightspace®.