The plug-in interface for IDeleteUserHandler is used by IPSIS adapters to support the delete operation for users.
The interface implementation is D2L.IM.IPSIS.Users.Handlers.IDeleteUserHandler.
The following configuration lists provide a starting point for any IPSIS implementation:
IPSIS, Template - User
DeleteUserIMHandler
The DeleteUserIMHandler performs a hard delete of the user from the IM Tables.
Implementation
D2L.IM.IPSIS.Default.Users.Handlers.DeleteUserIMHandler
Expected behavior
- Deletes the user from the IM Tables.
- Processing continues to the next handler (Return True).
Error behavior
If there is a problem during processing, an exception is thrown, along with as much detailed information as possible.
Configuration note
This should be the last handler in the configuration list after any LMS deletes (or alternatives).
DeleteUserLMSInactiveHandler
The DeleteUserLMSInactiveHandler inactivates the user in the LMS.
Implementation
D2L.IM.IPSIS.Default.Users.Handlers.DeleteUserLMSInactiveHandler
Expected behavior
The handler performs the following tasks:
- Inactivates the user in the LMS.
- Processing continues to the next handler (Return True).
Error behavior
If there is a problem during processing, an exception is thrown, along with as much detailed information as possible.
Configuration notes
- This handler should be configured before user is deleted from the IM Tables, and after Cascaded Enrollment Deletes (if required).
- This handler should not be run with DeleteUserLMSHandler.
DeleteUserLMSHandler
The DeleteUserLMSHandler performs a delete of the user from the LMS.
Implementation
D2L.IM.IPSIS.Default.Users.Handlers.DeleteUserLMSHandler
Expected behavior
The handler performs the following tasks:
- Deletes the user form the LMS.
- Processing continues to the next handler (Return True).
Error behavior
If there is a problem during processing, an exception is thrown, along with as much detailed information as possible.
Configuration notes
- This should be placed before the user is deleted from the IM Tables, and after Cascaded Enrollment Deletes (If required).
- This handler should not be run with DeleteUserLMSInactiveHandler.
DeleteUserCascadeDeleteEnrollmentHandler
If there are any remaining enrollments that are dependent on this user, the configured IPSIS Platform handlers for the IDeleteEnrollmentHandler are used to apply the desired behavior for deleting enrollments for the organization.
Implementation
D2L.IM.IPSIS.Default.Users.Handlers.DeleteUserCascadeDeleteEnrollmentHandler
Expected behavior
The handler performs the following tasks:
- Obtain the list of remaining enrollments for this user specific to IPSIS. Enrollments performed on the LMS are not deleted.
- The IDeleteEnrollmentHandler interface to delete the remaining enrollments.
- Processing continues to the next configured Handler.
Error behavior
If there is a problem during processing, an exception is thrown, along with as much detailed information as possible.
Configuration note
- This must occur before the IM Table delete (example: DeleteUserIMHandler).
- This must occur before the LMS deletes if you wish to also delete LMS Users (example: DeleteUserLMSHandler).