A interface ITranslateMembership é usada para traduzir um registro de associação do LIS em uma inscrição do Brightspace.
A implementação da interface é D2L.IM.IPSIS.LIS.MMS.ITranslateMembership.
A seguinte lista de configuração fornece um ponto de partida para qualquer implementação do LIS.
Modelo, IPSIS
- MembershipRequestBaseTranslator (Ordem de classificação = 10)
- MembershipRequestCollectionRequiredTranslator (Ordem de classificação = 20)
- MembershipRequestUserPersonRequiredTranslator (Ordem de classificação = 30)
- MembershipRequestRoleTypeAndStatusRequiredTranslator (Ordem de classificação = 40)
MembershipRequestBaseTranslator
O MembershipRequestBaseTranslator mapeia o Identificador da inscrição.
Implementação
D2L.IM.IPSIS.LIS.RequestAdapters.MMS.Default.MembershipRequestBaseTranslator
Comportamento esperado
O tradutor realiza as seguintes tarefas:
- Configura o IMEnrollmentId para o valor fornecido no sourcedGUID.sourcedid.
- Continua o processamento para o próximo tradutor.
Propriedade
|
Objeto de resultado da tradução
|
Mapeamento da solicitação do LIS
|
ID da mensagem da inscrição
|
result.LISMembershipId
|
membershipRecord.sourcedGUID.sourcedId
|
Comportamento de erro
Se houver um problema durante o processamento, um IncompleteRequestException será lançado. Isso resulta em:
- Suspensão de todo processamento adicional.
- Um cabeçalho de resposta do LIS contendo:
- CodeMajor = failure.
- Severity = status.
- CodeMinor = invaliddata.
Nota sobre a configuração
Esse tradutor (ou um tradutor base alternativo) deve ser configurado em primeiro lugar na lista de tradutores.
MembershipRequestCollectionRequiredTranslator
O MembershipRequestCollectionRequiredTranslator requer e mapeia a coleção de inscrições (normalmente, a seção do LIS).
Implementação
D2L.IM.IPSIS.LIS.RequestAdapters.MMS.Default.MembershipRequestCollectionRequiredTranslator
Comportamento esperado
O tradutor realiza as seguintes tarefas:
- O collectionSourcedId é adicionado ao objeto de resultado.
- Continua o processamento para o próximo tradutor.
Propriedade
|
Objeto de resultado da tradução
|
Mapeamento da solicitação do LIS
|
Código da Seção
|
result.Entity.IMOrgUnitIdentifier
|
membershipRecord.membership.collectionSourcedId
|
Comportamento de erro
Se houver um problema durante o processamento, um IncompleteRequestException será lançado. Isso resulta em:
- Suspensão de todo processamento adicional.
- Um cabeçalho de resposta do LIS contendo:
- CodeMajor = failure.
- Severity = status.
- CodeMinor = invaliddata.
Nota sobre a configuração
Esse tradutor pode ser posicionado em qualquer lugar depois do tradutor base.
MembershipRequestUserPersonRequiredTranslator
O MembershipRequestUserPersonRequiredTranslator requer e mapeia um usuário.
Comportamento esperado
O tradutor realiza as seguintes tarefas:
- Adiciona o Id da pessoa ao objeto de resultado.
- Continua o processamento para o próximo tradutor.
Propriedade
|
Objeto de resultado da tradução
|
Mapeamento da solicitação do LIS
|
ID do usuário
|
result.Entity.IMUserIdentifier
|
membershipRecord.membership.member.personSourcedId
|
Comportamento de erro
Se houver um problema durante o processamento, um IncompleteRequestException será lançado. Isso resulta em:
- Suspensão de todo processamento adicional.
- Um cabeçalho de resposta do LIS contendo:
- CodeMajor = failure.
- Severity = status.
- CodeMinor = invaliddata.
Nota sobre a configuração
Esse tradutor pode ser posicionado em qualquer lugar depois do tradutor base.
MembershipRequestRoleTypeAndStatusRequiredTranslator
O MembershipRequestRoleTypeAndStatusRequiredTranslator requer e mapeia um roleType e status.
Implementação
D2L.IM.IPSIS.LIS.RequestAdapters.MMS.Default.MembershipRequestRoleTypeStatusRequiredTranslator
Comportamento esperado
O tradutor realiza as seguintes tarefas:
- Adiciona a função e o status ao objeto de resultado.
- Múltiplos objetos de função podem ser fornecidos; eles são transmitidos para os manipuladores como um IEnumerable.
- Se uma função estiver presente, mas houver um tipo ou status ausente, um IncompleteRequestException será lançado.
- Continua o processamento para o próximo tradutor.
Propriedade
|
Objeto de resultado da tradução
|
Mapeamento da solicitação do LIS
|
Função
|
result.Entity.Roles{*}.role
|
membershipRecord.membership.member.role{*}.roleType
|
Status da inscrição
|
results.Entity.Roles{*}.status
|
membershipRecord.membership.member.role{*}.status
|
Comportamento de erro
Se houver um problema durante o processamento, um IncompleteRequestException será lançado. Isso resulta em:
- Suspensão de todo processamento adicional.
- Um cabeçalho de resposta do LIS contendo:
- CodeMajor = failure.
- Severity = status.
- CodeMinor = invaliddata.
Notas sobre a configuração
- Esse tradutor pode ser posicionado em qualquer lugar depois do tradutor base.
- Esse tradutor normalmente não é configurado com MembershipRequestSubRoleAndStatusRequiredTranslator.
- Esse tradutor normalmente não é configurado com MembershipRequestRoleTypeRequiredTranslator.
MembershipRequestSubRoleAndStatusRequiredTranslator
O tradutor MembershipRequestSubRoleAndStatusRequiredTranslator requer e mapeia uma Subfunção e status.
Implementação
D2L.IM.IPSIS.LIS.RequestAdapters.MMS.Default.MembershipRequestSubRoleStatusRequiredTranslator
Comportamento esperado
O tradutor realiza as seguintes tarefas:
- Adiciona a subfunção e o status ao objeto de resultado.
- Múltiplos objetos de subfunção podem ser fornecidos; eles são transmitidos para os manipuladores como um IEnumerable.
- Se uma subfunção estiver presente, mas houver um tipo ou status ausente, um IncompleteRequestException será lançado.
- Continua o processamento para o próximo tradutor.
Propriedade
|
Objeto de resultado da tradução
|
Mapeamento da solicitação do LIS
|
Função
|
result.Entity.Roles{*}.role
|
membershipRecord.membership.member.role{*}.subRole
|
Status da inscrição
|
results.Entity.Roles{*}.status
|
membershipRecord.membership.member.role{*}.status
|
Comportamento de erro
Se houver um problema durante o processamento, um IncompleteRequestException será lançado. Isso resulta em:
- Suspensão de todo processamento adicional.
- Um cabeçalho de resposta do LIS contendo:
- CodeMajor = failure.
- Severity = status.
- CodeMinor = invaliddata.
Notas sobre a configuração.
- Esse tradutor pode ser posicionado em qualquer lugar depois do tradutor base.
- Esse tradutor normalmente não é configurado com MembershipRequestRoleTypeAndStatusRequiredTranslator.
- Esse tradutor normalmente não é configurado com MembershipRequestRoleTypeRequiredTranslator.
MembershipRequestRoleTypeRequiredTranslator
O MembershipRequestRoleTypeRequiredTranslator requer e mapeia um RoleType e mapeia o status, se disponível. Deve ser usado apenas se houver uma chance de que o status possa não estar configurado.
Implementação
D2L.IM.IPSIS.LIS.RequestAdapters.MMS.Default.MembershipRequestRoleTypeRequiredTranslator
Comportamento esperado
O tradutor realiza as seguintes tarefas:
- Para cada função, o tradutor adiciona o tipo de função ao objeto de resultado e adiciona o status se disponível (nulo se não).
- Múltiplos objetos de função podem ser fornecidos; eles são transmitidos para os manipuladores como um IEnumerable.
- Se uma função estiver presente, mas o tipo estiver ausente, um IncompleteRequestException será lançado.
- Continua o processamento para o próximo tradutor.
Propriedade
|
Objeto de resultado da tradução
|
Mapeamento da solicitação do LIS
|
Função
|
result.Entity.Roles{*}.role
|
membershipRecord.membership.member.role{*}.subRole
|
Status da inscrição
|
results.Entity.Roles{*}.status
|
membershipRecord.membership.member.role{*}.status
|
Comportamento de erro
Se houver um problema durante o processamento, um IncompleteRequestException será lançado. Isso resulta em:
- Suspensão de todo processamento adicional.
- Um cabeçalho de resposta do LIS contendo:
- CodeMajor = failure.
- Severity = status.
- CodeMinor = invaliddata.
Notas sobre a configuração
- Esse tradutor pode ser posicionado em qualquer lugar depois do tradutor base.
- Esse tradutor normalmente não é configurado com MembershipRequestRoleTypeAndStatusRequiredTranslator.
- Esse tradutor normalmente não é configurado com MembershipRequestSubRoleAndStatusRequiredTranslator.