De plug-in-interface voor IReplaceEnrollmentHandler wordt door IPSIS-adapters gebruikt om het vervangen van inschrijvingen te ondersteunen.
De interface-implementatie is D2L.IM.IPSIS.OrgUnits.Memberships.Handlers.IReplaceEnrollmentHandler.
De volgende configuratielijsten voor de ReplaceEnrollmentHandler-interface worden bij het product geleverd. Ze worden vermeld samen met het uitbreidingspunt waarvoor ze bedoeld zijn.
IPSIS, Sjabloon - Inschrijvingen
- ReplaceEnrollmentReadIMHandler (sorteervolgorde = 10)
- ReplaceEnrollmentStatusDefaultActiveHandler (sorteervolgorde = 20)
- ReplaceEnrollmentValidateSectionHandler (sorteervolgorde = 30)
- ReplaceEnrollmentCreateIMEnrollmentHandler (sorteervolgorde = 40)
- ReplaceEnrollmentSaveIMEnrollmentHandler (sorteervolgorde = 50)
- ReplaceEnrollmentEnrollLMSOfferingHandler (sorteervolgorde = 60)
- ReplaceEnrollmentEnrollLMSGroupSectionHandler (sorteervolgorde = 70)
- ReplaceEnrollmentUnenrollLMSGroupSectionHandler (sorteervolgorde = 80)
- ReplaceEnrollmentUnenrollLMSOfferingHandler (sorteervolgorde = 90)
Achtergrond, Sjabloon - Achtergrond
- ReplaceEnrollmentUnenrollLMSGroupSectionHandler (sorteervolgorde = 10)
- ReplaceEnrollmentEnrollLMSGroupSectionHandler (sorteervolgorde = 20)
- ReplaceEnrollmentUnenrollLMSOfferingHandler (sorteervolgorde = 30)
- ReplaceEnrollmentEnrollLMSOfferingHandler (sorteervolgorde = 40)
ReplaceEnrollmentReadIMHandler
De ReplaceEnrollmentReadIMHandler zal naar verwachting alle relevante informatie in de database uit de IM-tabellen ophalen.
Implementatie
D2L.IM.IPSIS.Default.Enrollments.Handlers.ReplaceEnrollmentReadIMHandler®
Verwacht gedrag
Voor Brightspace® is een inschrijving simpelweg een koppeling tussen een OrgUnit, een gebruiker en een rol. De ReadIM-handler verwacht in SIS-id's te worden doorgegeven voor elk van deze entiteiten, die worden gebruikt om de bijbehorende rol-, gebruiker- en OrgUnit-objecten op te zoeken in zowel de IM- als de LMS-tabellen.
De handler voert de volgende taken uit:
- Leest de IExternalOrgUnitInfo voor de gegeven SIS OrgUnit. Mislukt met een uitzondering als de ExternalOrgUnitInfo niet wordt gevonden (verplicht).
- Leest de roltoewijzing voor de gegeven SIS-rol, waarbij de eerste wordt geselecteerd als er meerdere worden doorgegeven. Mislukt met een uitzondering als de roltoewijzing niet wordt gevonden (verplicht).
- Leest de gebruikerstoewijzing voor de opgegeven SIS-gebruiker. Mislukt met een uitzondering als de gebruikerstoewijzing niet wordt gevonden (verplicht)
- Als dit een update van een bestaande SIS-inschrijving is, leest de handler de IEnrollmentMapping. Als er geen inschrijvingstoewijzing wordt gevonden, wordt er een nieuwe gemaakt door de aanvraag.
- Als er een inschrijvingstoewijzing wordt gevonden, valideert de handler dat de gebruiker in de aanvraag overeenkomt met de gebruiker in de bestaande inschrijving.
- Leest de IOrgUnitMappings als deze bestaan. Als er geen OrgUnit-toewijzing wordt gevonden, registreert de handler een bericht en gaat vervolgens verder. Er kunnen geldige gebruiksscenario's zijn waarbij we alleen de IM-tabellen bijwerken.
Foutgedrag
Als zich een probleem voordoet tijdens de verwerking, wordt er een uitzondering gegenereerd, samen met zoveel mogelijk gedetailleerde informatie.
Opmerking over de configuratie
De Read-handler wordt doorgaans als eerste in de lijst geconfigureerd.
ReplaceEnrollmentValidateSectionHandler
Implementatie
D2L.IM.IPSIS.Default.Enrollments.Handlers.ReplaceEnrollmentValidateSectionHandler®
Verwacht gedrag
Het verwachte gedrag voor deze handler is om te bevestigen dat de huidige inschrijvingsaanvraag geldt voor een cursussectie of voor een groep.
Foutgedrag
Als de inschrijving niet voor een cursus of groep is, wordt een InvalidOrgUnitTypeException gegenereerd.
Opmerking over de configuratie
Deze handler moet worden geconfigureerd vóór de handler ReplaceEnrollmentCreateIMEnrollmentHandler.
ReplaceEnrollmentKeepLMSCreatedEnrollmentsOnUnenrollValidateHandler
Implementatie
D2L.IM.IPSIS.Default.Enrollments.Handlers.ReplaceEnrollmentKeepLMSCreatedEnrollmentsOnUnenrollValidateHandler®
Verwacht gedrag
Het verwachte gedrag voor deze handler is om te bevestigen dat de huidige inschrijvingsaanvraag overeenkomt met een inschrijvingsrecord die afkomstig is van een SIS-aanvraag (geen handmatige inschrijving voor Brightspace®).
Foutgedrag
Als de inschrijvingsrecord afkomstig is uit Brightspace® (bijvoorbeeld als de gebruiker voor het eerst handmatig is ingeschreven in Brightspace® en vervolgens een vervangend lidmaatschap voor dezelfde gebruiker en organisatie-eenheid heeft verzonden), genereert de handler een UserManuallyEnrolledInLMSException.
Opmerking over de configuratie
Deze handler moet worden geconfigureerd vóór de ReplaceEnrollmentCreateIMEnrollmentHandler, maar na de ReplaceEnrollmentReadIMHandler.
ReplaceEnrollmentCreateIMEnrollmentHandler
Implementatie
D2L.IM.IPSIS.Default.Enrollments.Handlers.ReplaceEnrollmentCreateIMEnrollmentHandler®
Verwacht gedrag
Het verwachte gedrag voor deze handler is het maken van Inschrijvingsrecords in de IM-databasetabellen als deze nog niet bestaan. Voor elk inschrijvingsobject in de aanmaaklijst in de aanvraag wordt IM_ENROLLMENTS bijgewerkt als er geen IM-toewijzing bestaat.
Foutgedrag
Als zich een probleem voordoet tijdens de verwerking, wordt er een uitzondering gegenereerd, samen met zoveel mogelijk gedetailleerde informatie.
Opmerking over de configuratie
Deze handler moet worden geconfigureerd na de Read- en Validate-handlers.
ReplaceEnrollmentEnrollLMSGroupSectionHandler
De ReplaceEnrollmentEnrollLMSGroupSectionHandler schrijft gebruikers in secties of groepen in die zijn toegewezen in Brightspace®.
Implementatie
D2L.IM.IPSIS.Default.Enrollments.Handlers.ReplaceEnrollmentEnrollLMSGroupSectionHandler®
Verwacht gedrag
De handler voert de volgende taken uit:
- Voor elk actief inschrijvingsobject in de lijst met inschrijvingen die moeten worden bijgewerkt, schrijft de handler de gebruiker in als de gebruiker nog niet is ingeschreven in de sectie/groep (automatisch resulterend in een controlevermelding).
- Als de gebruiker al is ingeschreven in de sectie/groep met een andere rol, schrijft de handler de gebruiker uit en schrijft deze opnieuw in met de nieuwe rol (automatisch resulterend in een controlevermelding).
- Als de gebruiker al is ingeschreven in de sectie/groep met dezelfde rol, doet de handler niets.
- De verwerking gaat door naar de volgende handler (retourneert True).
Foutgedrag
Als zich een probleem voordoet tijdens de verwerking, wordt er een uitzondering gegenereerd, samen met zoveel mogelijk gedetailleerde informatie.
Opmerkingen over de configuratie
- Deze handler moet worden geconfigureerd na de SaveIM-handler.
- Deze handler moet worden geconfigureerd vóór de LMSOffering-handlers Enroll en Unenroll.
- Deze handler moet niet tegelijkertijd worden geconfigureerd met ReplaceEnrollmentEnrollLMSGroupSectionRoleNoUpdateHandler.
ReplaceEnrollmentEnrollLMSOfferingHandler
De ReplaceEnrollmentEnrollLMSOfferingHandler schrijft gebruikers in voor edities in Brightspace®.
Implementatie
D2L.IM.IPSIS.Default.Enrollments.Handlers.ReplaceEnrollmentEnrollLMSOfferingHandler®
Verwacht gedrag
De handler voert de volgende opties uit:
- Voor elk actief inschrijvingsobject in de lijst met inschrijvingen die moeten worden bijgewerkt, schrijft de handler de gebruiker in voor de cursuseditie als de gebruiker nog niet is ingeschreven (automatisch resulterend in een controlevermelding).
- Als de gebruiker al is ingeschreven voor de editie met een andere rol, schrijft de handler de gebruiker uit en schrijft deze opnieuw in met de nieuwe rol (automatisch resulterend in een controlevermelding).
- Als de gebruiker al is ingeschreven voor de editie met dezelfde rol, doet de handler niets.
- De verwerking gaat door naar de volgende handler (retourneert True).
Foutgedrag
Als zich een probleem voordoet tijdens de verwerking, wordt er een uitzondering gegenereerd, samen met zoveel mogelijk gedetailleerde informatie.
Opmerkingen over de configuratie
- Deze handler moet worden geconfigureerd na de EnrollLMSGroupSection-handler.
- Deze handler moet niet tegelijkertijd worden geconfigureerd met ReplaceEnrollmentEnrollLMSOfferingRoleNoUpdateHandler.
ReplaceEnrollmentSaveIMEnrollmentHandler
De ReplaceEnrollmentSaveIMEnrollmentHandler slaat alle wijzigingen in de inschrijving in de IM-tabellen op, inclusief de status en rol. Er wordt ook een lijst met inschrijvingen gemaakt die moeten worden bijgewerkt.
Implementatie
D2L.IM.IPSIS.Default.Enrollments.Handlers.ReplaceEnrollmentSaveIMEnrollmentHandler®
Verwacht gedrag
De handler voert de volgende taken uit:
- Hiermee worden de rol en de status actief/inactief van de huidige IM-inschrijving bijgewerkt en worden wijzigingen in de database opgeslagen als er iets anders is dan de oorspronkelijke waarde.
- Hiermee maakt u een lijst met inschrijvingen die moeten worden bijgewerkt. Een enkele IM-inschrijving kan aan meerdere inschrijvingen worden gekoppeld als de OrgUnitMappings niet een-op-een zijn.
- De verwerking gaat door naar de volgende beschikbare handler.
Foutgedrag
Als zich een probleem voordoet tijdens de verwerking, wordt er een uitzondering gegenereerd, samen met zoveel mogelijk gedetailleerde informatie.
Opmerking over de configuratie
- Deze handler moet plaatsvinden na de CreateIMEnrollment-handler.
- Deze handler moet plaatsvinden voor de Enroll en Unenroll LMS-handlers.
ReplaceEnrollmentEnrollLMSGroupSectionRoleNoUpdateHandler
De ReplaceEnrollmentEnrollLMSGroupSectionRoleNoUpdateHandler maakt of werkt de inschrijving in de sectie/groep bij, maar werkt de rol niet bij als deze al een rol heeft. Deze handler schrijft gebruikers in secties of groepen in Brightspace® in als dit nog niet is gebeurd. Het verandert de bestaande inschrijvingen niet.
Implementatie
D2L.IM.IPSIS.Default.Enrollments.Handlers.ReplaceEnrollmentEnrollLMSGroupSectionRoleNoUpdateHandler®
Verwacht gedrag
De handler voert de volgende taken uit:
- Voor elk actief inschrijvingsobject in de lijst met inschrijvingen die moeten worden bijgewerkt, schrijft de handler de gebruiker in de sectie of groep van Brightspace® in (automatisch resulterend in een controlevermelding).
- De verwerking gaat door naar de volgende handler (retourneert True).
Foutgedrag
Als zich een probleem voordoet tijdens de verwerking, wordt er een uitzondering gegenereerd, samen met zoveel mogelijk gedetailleerde informatie.
Opmerkingen over de configuratie
- Deze handler moet worden geconfigureerd na de SaveIMEnrollment-handler.
- Deze handler moet worden geconfigureerd vóór de EnrollLMSOffering-handler.
- Deze handler moet niet tegelijkertijd worden geconfigureerd met ReplaceEnrollmentEnrollLMSGroupSectionHandler.
ReplaceEnrollmentInrollLMSOfferingRoleNoUpdateHandler
De ReplaceEnrollmentEnrollLMSOfferingRoleNoUpdateHandler maakt de inschrijving of werkt deze bij in de cursuseditie, maar werkt een al bestaande rol niet bij. De handler wijzigt geen bestaande inschrijvingen.
Implementatie
D2L.IM.IPSIS.Default.Enrollments.Handlers.ReplaceEnrollmentEnrollLMSOfferingRoleNoUpdateHandler®
Verwacht gedrag
De handler voert de volgende taken uit:
- Voor elk actief inschrijvingsobject in de lijst met inschrijvingen die moet worden bijgewerkt, schrijft de handler de gebruiker in voor de cursuseditie (er wordt automatisch een controlevermelding gemaakt).
- De verwerking gaat door naar de volgende handler (retourneert True).
Foutgedrag
Als zich een probleem voordoet tijdens de verwerking, wordt er een uitzondering gegenereerd, samen met zoveel mogelijk gedetailleerde informatie.
Opmerking over de configuratie
- Deze handler moet worden geconfigureerd na de EnrollLMSGroupSection-handler.
- Deze handler moet niet tegelijkertijd met ReplaceEnrollmentEnrollLMSOfferingHandler worden geconfigureerd.
ReplaceEnrollmentStatusDefaultActiveHandler
De ReplaceEnrollmentStatusDefaultActiveHandler stelt de inschrijvingsstatus standaard in op Actief als deze null is.
Implementatie
D2L.IM.IPSIS.Default.Enrollments.Handlers.ReplaceEnrollmentStatusDefaultActiveHandler®
Verwacht gedrag
De handler voert de volgende taken uit:
- Als de status momenteel null is, stelt de handler de status in op Actief.
- Anders wordt deze handler overgeslagen en verandert de bestaande status niet.
Foutscenario's
Als zich een probleem voordoet tijdens de verwerking, wordt er een uitzondering gegenereerd, samen met zoveel mogelijk gedetailleerde informatie.
Opmerkingen over de configuratie
- Deze handler moet na de Read-handler worden geconfigureerd.
- Deze handler moet worden geconfigureerd vóór de CreateIM- en SaveIM-handlers.
ReplaceEnrollmentStatusDefaultInactiveHandler
Deze handler stelt de inschrijvingsstatus standaard in op inactief als deze null is.
Implementatie
D2L.IM.IPSIS.Default.Enrollments.Handlers.ReplaceEnrollmentStatusDefaultInactiveHandler®
Verwacht gedrag
De handler voert de volgende taken uit:
- Als de status momenteel null is, stelt de handler de status in op inactief.
- Anders wordt deze handler overgeslagen en verandert de bestaande status niet.
Opmerkingen over de configuratie
- Deze handler moet na de Read-handler worden geconfigureerd.
- Deze handler moet worden geconfigureerd vóór de CreateIM- en SaveIM-handlers.
ReplaceEnrollmentUnenrollLMSGroupSectionHandler
De ReplaceEnrollmentUnenrollLMSGroupSectionHandler verwijdert inschrijvingen uit Groepen en Secties in Brightspace®.
Implementatie
D2L.IM.IPSIS.Default.Enrollments.Handlers.ReplaceEnrollmentUnenrollLMSGroupSectionHandler®
Verwacht gedrag
Deze handler schrijft gebruikers uit bij secties als ze niet langer worden geacht ingeschreven te zijn. De handler voert de volgende taken uit:
- Voor elk inactief inschrijvingsobject in de lijst met inschrijvingen die moeten worden bijgewerkt, maakt de handler, als de organisatie-eenheid een LMS-cursussectie of een LMS-groep is, schrijft de handler de gebruiker uit bij de sectie of groep (automatisch resulterend in een controlevermelding) en wordt RequestStatus = EntityDeleted ingesteld.
- Anders slaat de handler deze over en gaat de handler door naar de volgende inschrijving.
Foutgedrag
Als zich een probleem voordoet tijdens de verwerking, wordt er een uitzondering gegenereerd, samen met zoveel mogelijk gedetailleerde informatie.
Opmerking over de configuratie
UnenrollLMSGroupSection moet plaatsvinden na Validate en vóór UnenrollLMSOffering.
ReplaceEnrollmentUnenrollLMSOfferingHandler
De ReplaceEnrollmentUnenrollLMSOfferingHandler verwijdert inschrijvingen uit de editie van Brightspace®.
Implementatie
D2L.IM.IPSIS.Default.Enrollments.Handlers.ReplaceEnrollmentUnenrollLMSOfferingHandler®
Verwacht gedrag
Deze handler maakt de inschrijving van gebruikers van edities in Brightspace® ongedaan als de inschrijving als beëindigd moet worden beschouwd. Gebruikers worden alleen voor edities uitgeschreven als ze niet langer zijn ingeschreven in een sectie van de editie.
De handler voert de volgende taken uit:
- Voor elk inschrijvingsobject in de verwijderingslijst geldt dat, als het niet langer een actieve inschrijving is en de gebruiker niet is ingeschreven in andere secties van dezelfde editie, de handler de inschrijving van de gebruiker voor de cursuseditie ongedaan maakt (automatisch resulterend in een controlevermelding) en RequestStatus = EntityDeleted instelt.
- Anders slaat de handler deze over en gaat de handler door naar de volgende inschrijving.
Foutgedrag
Als zich een probleem voordoet tijdens de verwerking, wordt er een uitzondering gegenereerd, samen met zoveel mogelijk gedetailleerde informatie.
Opmerking over de configuratie
UnenrollLMSOffering moet plaatsvinden na de UnenrollLMSGroupSection-handler.