Batching is a feature that enables users to customize the number of records for synchronizing records per request. It provides an optimized and streamlined method for uploading or downloading large datasets between the client and server, mitigating the risk of request timeouts.
Volt MX Foundry relies on back-end systems to support batching functionality. Note that the back-end must be capable of returning data in batched responses.
Offline Objects supports record-count-based batching at both the Object and Object-Service levels.
- From the client side, Batch size and batch ID can be configured using the ‘syncOptions’ parameter within the Sync API, allowing precise control over synchronization operations.The ‘$batchSize’ parameter defines the number of records to upload or download per batch, while the ‘$batchId’ parameter serves as a pointer to track the specific batch being processed during synchronization.
- While the server or backend should include ‘nextBatchID’ which indicates the next batch to be upload or download and ‘hasMoreRecords’ which indicates if additional batches are available for retrieval in their response.
For more details, please refer to Batching - HCL Volt MX Documentation V9.2