La interfaz ITranslateMembership se utiliza para traducir un registro de membresía del LIS en una inscripción de Brightspace.
La implementación de la interfaz es D2L.IM.IPSIS.LIS.MMS.ITranslateMembership.
La siguiente lista de configuración ofrece un punto de partida para la implementación del LIS:
Plantilla, IPSIS
- MembershipRequestBaseTranslator (Orden de clasificación = 10)
- MembershipRequestCollectionRequiredTranslator (Orden de clasificación = 20)
- MembershipRequestUserPersonRequiredTranslator (Orden de clasificación = 30)
- MembershipRequestRoleTypeAndStatusRequiredTranslator (Orden de clasificación = 40)
MembershipRequestBaseTranslator
El traductor MembershipRequestBaseTranslator asigna el Identificador de inscripciones.
Implementación
D2L.IM.IPSIS.LIS.RequestAdapters.MMS.Default.MembershipRequestBaseTranslator
Comportamiento esperado
El traductor realiza las siguientes tareas:
- Establece el IMEnrollmentId al valor provisto en sourcedGUID.sourcedid.
- El proceso continúa con el traductor siguiente.
|
Propiedad
|
Objeto de resultados de traducción
|
Esquema de solicitud del LIS
|
|
ID de mensaje de inscripción
|
result.LISMembershipId
|
membershipRecord.sourcedGUID.sourcedId
|
Comportamiento de error
Si existe un problema durante el procesamiento, se arroja una excepción IncompleteRequestException. Esto produce lo siguiente:
- La suspensión de todos los procesamientos adicionales.
- Un encabezado de respuesta del LIS que contiene:
- CodeMajor = failure.
- Severity = status.
- CodeMinor = invaliddata.
Nota de configuración
Este traductor (o un traductor Base alternativo) debe configurarse, en primer lugar, en la lista de traductores.
MembershipRequestCollectionRequiredTranslator
El traductor MembershipRequestCollectionRequiredTranslator requiere y asigna la colección de inscripciones (generalmente, sección del LIS).
Implementación
D2L.IM.IPSIS.LIS.RequestAdapters.MMS.Default.MembershipRequestCollectionRequiredTranslator
Comportamiento esperado
El traductor realiza las siguientes tareas:
- El collectionSourcedId se agrega al objeto de resultado.
- El proceso continúa con el traductor siguiente.
|
Propiedad
|
Objeto de resultados de traducción
|
Esquema de solicitud del LIS
|
|
Código de sección
|
result.Entity.IMOrgUnitIdentifier
|
membershipRecord.membership.collectionSourcedId
|
Comportamiento de error
Si existe un problema durante el procesamiento, se arroja una excepción IncompleteRequestException. Esto produce lo siguiente:
- La suspensión de todos los procesamientos adicionales.
- Un encabezado de respuesta del LIS que contiene:
- CodeMajor = failure.
- Severity = status.
- CodeMinor = invaliddata.
Nota de configuración
Este traductor puede ubicarse en cualquier orden después del traductor Base.
MembershipRequestUserPersonRequiredTranslator
El traductor MembershipRequestUserPersonRequiredTranslator requiere y asigna un usuario.
Comportamiento esperado
El traductor realiza las siguientes tareas:
- Agrega el identificador de la persona al objeto del resultado.
- El proceso continúa con el traductor siguiente.
|
Propiedad
|
Objeto de resultados de traducción
|
Esquema de solicitud del LIS
|
|
UserId
|
result.Entity.IMUserIdentifier
|
membershipRecord.membership.member.personSourcedId
|
Comportamiento de error
Si existe un problema durante el procesamiento, se arroja una excepción IncompleteRequestException. Esto produce lo siguiente:
- La suspensión de todos los procesamientos adicionales.
- Un encabezado de respuesta del LIS que contiene:
- CodeMajor = failure.
- Severity = status.
- CodeMinor = invaliddata.
Nota de configuración
Este traductor puede ubicarse en cualquier orden después del traductor Base.
MembershipRequestRoleTypeAndStatusRequiredTranslator
El traductor MembershipRequestRoleTypeAndStatusRequiredTranslator requiere y asigna un roleType y un estado.
Implementación
D2L.IM.IPSIS.LIS.RequestAdapters.MMS.Default.MembershipRequestRoleTypeStatusRequiredTranslator
Comportamiento esperado
El traductor realiza las siguientes tareas:
- Agrega el rol y el estado al objeto del resultado.
- Es posible proporcionar varios objetos de rol; estos se pasan a los controladores como un IEnumerable.
- Si un rol está presente, pero falta un tipo o un estado, se arroja una excepción IncompleteRequestException.
- El proceso continúa con el traductor siguiente.
|
Propiedad
|
Objeto de resultados de traducción
|
Esquema de solicitud del LIS
|
|
Rol
|
result.Entity.Roles{*}.role
|
membershipRecord.membership.member.role{*}.roleType
|
|
Estado de inscripción
|
results.Entity.Roles{*}.status
|
membershipRecord.membership.member.role{*}.status
|
Comportamiento de error
Si existe un problema durante el procesamiento, se arroja una excepción IncompleteRequestException. Esto produce lo siguiente:
- La suspensión de todos los procesamientos adicionales.
- Un encabezado de respuesta del LIS que contiene:
- CodeMajor = failure.
- Severity = status.
- CodeMinor = invaliddata.
Notas de configuración
- Este traductor puede ubicarse en cualquier orden después del traductor Base.
- Este traductor normalmente no está configurado con MembershipRequestSubRoleAndStatusRequiredTranslator.
- Este traductor normalmente no está configurado con MembershipRequestRoleTypeRequiredTranslator.
MembershipRequestSubRoleAndStatusRequiredTranslator
El traductor MembershipRequestSubRoleAndStatusRequiredTranslator requiere y asigna un rol secundario y un estado.
Implementación
D2L.IM.IPSIS.LIS.RequestAdapters.MMS.Default.MembershipRequestSubRoleStatusRequiredTranslator
Comportamiento esperado
El traductor realiza las siguientes tareas:
- Agrega el rol secundario y el estado al objeto del resultado.
- Es posible proporcionar varios objetos de rol secundario; estos se pasan a los controladores como un IEnumerable.
- Si un rol secundario está presente, pero falta un tipo o un estado, se arroja una excepción IncompleteRequestException.
- El proceso continúa con el traductor siguiente.
|
Propiedad
|
Objeto de resultados de traducción
|
Esquema de solicitud del LIS
|
|
Rol
|
result.Entity.Roles{*}.role
|
membershipRecord.membership.member.role{*}.subRole
|
|
Estado de inscripción
|
results.Entity.Roles{*}.status
|
membershipRecord.membership.member.role{*}.status
|
Comportamiento de error
Si existe un problema durante el procesamiento, se arroja una excepción IncompleteRequestException. Esto produce lo siguiente:
- La suspensión de todos los procesamientos adicionales.
- Un encabezado de respuesta del LIS que contiene:
- CodeMajor = failure.
- Severity = status.
- CodeMinor = invaliddata.
Notas de configuración.
- Este traductor puede ubicarse en cualquier orden después del traductor Base.
- Este traductor normalmente no está configurado con MembershipRequestRoleTypeAndStatusRequiredTranslator.
- Este traductor normalmente no está configurado con MembershipRequestRoleTypeRequiredTranslator.
MembershipRequestRoleTypeRequiredTranslator
El traductor MembershipRequestRoleTypeRequiredTranslator requiere y asigna un RoleType y asigna un estado, si se encuentra disponible. Solo debe utilizarse si existe una posibilidad de que el estado no pueda configurarse.
Implementación
D2L.IM.IPSIS.LIS.RequestAdapters.MMS.Default.MembershipRequestRoleTypeRequiredTranslator
Comportamiento esperado
El traductor realiza las siguientes tareas:
- Para cada rol, el traductor agrega el tipo de rol al objeto del resultado y agrega el estado si está disponible (en caso contrario, será nulo).
- Es posible proporcionar varios objetos de rol; estos se pasan a los controladores como un IEnumerable.
- Si un rol está presente, pero falta un tipo, se arroja una excepción IncompleteRequestException.
- El proceso continúa con el traductor siguiente.
|
Propiedad
|
Objeto de resultados de traducción
|
Esquema de solicitud del LIS
|
|
Rol
|
result.Entity.Roles{*}.role
|
membershipRecord.membership.member.role{*}.subRole
|
|
Estado de inscripción
|
results.Entity.Roles{*}.status
|
membershipRecord.membership.member.role{*}.status
|
Comportamiento de error
Si existe un problema durante el procesamiento, se arroja una excepción IncompleteRequestException. Esto produce lo siguiente:
- La suspensión de todos los procesamientos adicionales.
- Un encabezado de respuesta del LIS que contiene:
- CodeMajor = failure.
- Severity = status.
- CodeMinor = invaliddata.
Notas de configuración
- Este traductor puede ubicarse en cualquier orden después del traductor Base.
- Este traductor normalmente no está configurado con MembershipRequestRoleTypeAndStatusRequiredTranslator.
- Este traductor normalmente no está configurado con MembershipRequestSubRoleAndStatusRequiredTranslator.