The ITranslateAnnounceBulkDataExchange interface is used to translate an announce request for bulk into a result object containing a single BulkJobParams object, a list of BulkFileUrlParams objects, and a list of BulkEntityTypeFilterParams objects.
The interface implementation is D2L.IM.IPSIS.LIS.BDEMS.ITranslateAnnounceBulkDataExchange.
The IPSIS, Template configuration list provides a starting point for any LIS implementation. The AnnounceBulkDataExchangeTranslator (Sort Order = 10) handler list is used as a starting point.
AnnounceBulkDataExchangeTranslator (Sort Order = 10)
The translator requires and maps the bulk job, files, and file type/filter information from the bulk announce request.
Implementation
D2L.IM.IPSIS.LIS.RequestAdapters.BDEMS.Default.AnnounceBulkDataExchangeTranslator
Expected behavior
The translator performs the following tasks:
- Maps the Bulk Job and Bulk Job properties.
- Maps the files and file properties.
- Proceeds to the next available translator.
Property |
Translation Result Object |
Announce Request Mapping |
JobId |
result.BulkJobParams.IMJobId |
request.transactionId |
ExpiryDateTime |
result.BulkJobParams.ExpiryDateTime |
request.bulkBlockManifest.expiryDate |
Status |
result.BulkJobParams.Status |
BulkJobStatus.BulkRequested |
BulkFileUrlParams
Property |
Translation Result Object |
Announce Request Mapping |
Remote File Url |
result.BulkFileUrlParams[*].RemoteFileUrl |
request.bulkBlockManifest.bulkBlockDataFile[*].url |
File Size |
result.BulkFileUrlParams[*].FileSize |
request.bulkBlockManifest.bulkBlockDataFile[*].totalSize |
CheckSum |
result.BulkFileUrlParams[*].CheckSum |
request.bulkBlockManifest.bulkBlockDataFile[*].checkSum |
BulkEntityTypeFilterParams
Property |
Translation Result Object |
Announce Request Mapping |
Entity Type |
result.BulkEntityTypeFilterParams[*].EntityType |
request.bulkBlockManifest.bulkBlockDataFile[*].serviceSet. serviceRecord[*].interfaceName |
Start Save Point |
result.BulkEntityTypeFilterParams[*].EndSavePointDateTime |
request.bulkBlockManifest.bulkBlockDataFile[*].savePoint |
End Save Point |
result.BulkEntityTypeFilterParams[*].EndSavePointDateTime |
request.bulkBlockManifest.bulkBlockDataFile[*].savePoint |