The ITranslateReadGroupResponse interface is used to translate a Brightspace org unit into a LIS group record on the response message of a read operation.
Note: Values such as Name and Code are stored both in the IM tables and in the LMS tables. Depending on IPSIS handler configuration, both sets of data might be available to the translators. In this case, information from the IM tables will be preferred, with LMS data only used if the IM data is missing or incomplete.
The interface implementation is D2L.IM.IPSIS.LIS.GMS.ITranslateReadGroupResponse.
The following configuration list provides a starting point for any LIS implementation:
Template, IPSIS
- ReadGroupResponseSourcedGuidRequiredTranslator (Sort Order = 10)
- ReadGroupResponseTypeValueIdRequiredTranslator (Sort Order = 20)
- ReadGroupResponseNameShortDescTranslator (Sort Order = 30)
ReadGroupResponseSourcedGuidRequiredTranslator
Implementation
D2L.IM.IPSIS.LIS.ResultAdapters.GMS.Default.ReadGroupResponseSourcedGuidRequiredTranslator
Expected behavior
This translator initializes the results object and sets the minimum required fields in the response.
|
ExternalInfo
|
OrgUnit
|
LIS Mapping
|
|
request.ExternalInfo.IMOrgUnitIdentifier
|
request.Entity.Code
|
gresult.Entity.sourcedGUID.sourcedId
|
The result.Entity.group.groupType object is populated with the required default structure taking the language from the LIS context, but all values are blank.
groupType has two properties that are initialized: scheme {language, textString} and typevalue {id {language, textString}, level {language, textString}, type {language, textString} }.
result.Status is set to VocabParseStatus.PartialDataStorage.
ReadGroupResponseTypeValueIdRequiredTranslator
Implementation
D2L.IM.IPSIS.LIS.ResultAdapters.GMS.Default.ReadGroupResponseTypeValueIdRequiredTranslator
Expected behavior
ReadGroupResponseTypeValueIdRequiredTranslator requires the Base translator to run first, and adds the OrgUnitType Mapping Id to the typeValue.id in the result.
|
ExternalOrgUnitInfo
|
Desire2Learn LP
|
|
request.ExternalInfo.OrgUnitTypeMapping.IMOrgUnitTypeId
|
result.Entity.group.groupType.typeValue(0).id
|
ReadGroupResponseNameShortDescTranslator
Implementation
D2L.IM.IPSIS.LIS.ResultAdapters.GMS.Default.ReadGroupResponseNameShortDescTranslator
Expected behavior
|
ExternalOrgUnitInfo
|
OrgUnit
|
LIS Mapping
|
|
request.ExternalInfo.IMOrgUnitName
|
request.Entity.Name
|
result.Entity.group.description.shortDescription
|
ReadGroupResponseNameLongDescTranslator
Implementation
D2L.IM.IPSIS.LIS.ResultAdapters.GMS.Default.ReadGroupResponseNameLongDescTranslator
Expected behavior
ReadGroupResponseNameLongDescTranslator requires the Base translator to run first, and simply adds the OrgUnitName to the long description in the response.
|
ExternalOrgUnitInfo
|
OrgUnit
|
LIS Mapping
|
|
request.ExternalInfo.IMOrgUnitName
|
request.Entity.Name
|
result.Entity.group.description.longDescription
|