Specifies whether to use the asynchronous Bulk API or the synchronous SOAP API for reading and writing data in Certinia.

Data Type

bool

Default Value

false

Remarks

When UseBulkAPI is set to true, the component uses Salesforce’s Bulk API for both reads and writes. For reads, the component creates bulk query jobs and begins returning results as they become available. Queries that contain JOINs or aggregations are not supported by the Bulk API, so the component automatically falls back to the SOAP API.

For writes, up to 10,000 records per batch can be sent. These requests are asynchronous, meaning the component does not wait for Certinia to fully process the operation. You can monitor the status of these jobs using the temporary system table. For example: SELECT * FROM Info#TEMP

This query returns job and batch IDs. These IDs can be used with GetJob, GetBatch, and GetBatchResults to track the job’s progress.

When UseBulkAPI is set to false, the component uses the SOAP API for reads and writes. In this mode, batch processing is still supported for writes, but the results are returned synchronously.

The Bulk API is optimized for processing large data sets asynchronously, making it well-suited for high-volume imports and exports. However, it does not support complex queries that involve joins or aggregations, requiring fallback to the SOAP API. For writes, the Bulk API allows efficient handling of large record volumes, but its asynchronous nature means job monitoring is required. The SOAP API provides immediate feedback on operations and is more suitable for smaller transactions.

This property is useful for large-scale data operations where asynchronous processing is acceptable or preferred.