Salesforce Bulk API 2.0 Lookup
The Salesforce Bulk API 2.0 Lookup processor performs lookups on a Salesforce object using Salesforce Bulk API 2.0. To perform lookups with the SOAP or Bulk API, use the Salesforce Lookup processor. For information about supported versions, see Supported Systems and Versions in the Data Collector documentation.
Use the Salesforce Bulk API 2.0 Lookup processor to enrich records with additional data.
For example, you can configure the processor to use an account_number
field as the field to look up account name values in a Salesforce object, and pass the
values to a new account_name
output field.
When a lookup results in multiple matches, the Salesforce Bulk API 2.0 Lookup processor can return the first matching value or return all matching values in separate records.
When you configure the Salesforce Bulk API 2.0 Lookup processor, you define connection information that the processor uses to connect to Salesforce, including the Salesforce API version and the authentication to use. You can also use a connection to configure the processor.
You specify a SOQL query, the output fields for returned values, and the multiple match behavior. You can optionally define a default value to use for fields with missing values and set the behavior for fields with missing values and no default value.
You can configure the maximum number of columns that the lookup query can return and the maximum number of seconds that the processor waits for a response from the query.
You can configure the processor to retrieve deleted records from the Salesforce recycle bin. You can also configure the processor to locally cache the lookup values to improve performance.
You can optionally use an HTTP proxy to connect to Salesforce. When enabled in Salesforce, you can also configure the processor to use mutual authentication.
The processor generates Salesforce field attributes that provide additional information about each field.
Lookup Cache
To improve pipeline performance, you can configure the Salesforce Bulk API 2.0 Lookup processor to locally cache the values returned from a Salesforce object.
The processor caches values until the cache reaches the maximum size or the expiration time. When the first limit is reached, the processor evicts values from the cache.
- Size-based eviction
- Configure the maximum number of values that the processor caches. When the maximum number is reached, the processor evicts the oldest values from the cache.
- Time-based eviction
- Configure the amount of time that a value can remain in the cache without being written to or accessed. When the expiration time is reached, the processor evicts the value from the cache. The eviction policy determines whether the processor measures the expiration time since the last write of the value or since the last access of the value.
When you stop the pipeline, the processor clears the cache.
Salesforce Attributes
The Salesforce Bulk API 2.0 Lookup processor generates Salesforce field attributes that provide additional information about each field. The processor receives these details from Salesforce.
Salesforce attributes include a user-defined prefix to differentiate the
Salesforce attributes from other attributes. The prefix is salesforce.
by default. You can change the prefix that the processor uses and you can configure the
processor not to create Salesforce attributes.
You can use the
record:fieldAttribute
or
record:fieldAttributeOrDefault
functions to access the information
in the attribute.
Salesforce Field Attribute | Description |
---|---|
<Salesforce prefix>salesforceType | Provides the original Salesforce data type for the field. |
<Salesforce prefix>length | Provides the original length for all string and textarea fields. |
<Salesforce prefix>precision | Provides the original precision for all double fields. |
<Salesforce prefix>scale | Provides the original scale for all double fields. |
<Salesforce prefix>digits | Provides the maximum number of digits for all integer fields. |
For more information about field attributes, see Field Attributes.
Changing the API Version
Data Collector ships with version 57.0.0 of the Salesforce Web Services Connector libraries. You can use a different Salesforce API version if you need to access functionality not present in version 57.0.0.