When you create a mapping, you can configure a Source or Target transformation to represent a Salesforce object.
Salesforce sources in mappings
In a mapping, you can configure a Source transformation to represent a single Salesforce source or multiple Salesforce sources.
Specify the name and description of the Salesforce source. Configure the source and advanced properties for the source object.
You can parameterize the Salesforce source objects at run time with values specified in a parameter file in a mapping.
The following table describes the Salesforce source properties that you can configure in a Source transformation:
Property
Description
Connection
Name of the source connection.
Object Type
Type of the source object. Select one of the following object types:
- Single Object
- Multiple Objects
- Query
- Parameter
Default is Single Object.
Object
Name of the source object for the mapping.
You can specify a custom query for a source object.
Parameter
This property appears only if you select parameter as the object type.
A placeholder to dynamically assign values at run time for the source object without the requirement to edit the task.
Select an existing parameter for the source object or click New Parameter to define a new parameter for the source object.
To overwrite the parameter at run time, select the Allow parameter to be overridden at run time option.
Filter
Adds conditions to filter records. Configure a simple or an advanced filter.
You cannot use the LIMIT clause in an advanced filter. To limit the number of rows, specify the row limit in the advanced source properties.
Sort
Not applicable for a Salesforce connection.
Include archived and deleted rows in the source
Includes archived and deleted source rows. By default, the agent returns active rows.
The following table describes the Salesforce advanced source properties that you can configure in a Source transformation:
Advanced Property
Description
Row Limit
The maximum number of rows the agent processes. Select All Rows to process all records, or Specify number of rows to process specific number of rows.
Salesforce API
Salesforce API to read source data. Select one of the following options:
- Standard API
- Bulk API
- Bulk API 2.0
You must use an OAuth connection if you select the Bulk API 2.0 option to read data.
Enable PK Chunking
Select to enable the primary key chunking. When you enable primary key chunking, the Bulk API splits the data set into multiple chunks based on the record ID and creates extract queries for each chunk.
Doesn't apply to Salesforce Bulk API 2.0.
PK Chunking Size
The size of data in a chunk or batch size. For example, if you want to upload a 10 MB file, you can upload the file in fragments, that is, 1MB at a time. When you mention 1MB as the chunk size,1 MB of data is transferred at a time until the complete transfer takes place.
PK Chunking startRow ID
The row ID from where the chunking starts.
SOQL Filter Condition
SOQL condition to filter source data. You cannot use the LIMIT clause in the filter condition. To limit the number of rows, specify the row limit in the advanced source properties.
If you configure the filter under Salesforce source properties as well as the SOQL Filter Condition, then the SOQL Filter Condition overrides the filter under Salesforce source properties.
Maximum Rows Per Request
The maximum number of records to retrieve per set of results for the query. The request is still subject to the size limits. Default is 0.
Applies to Salesforce Bulk API 2.0 only.
Tracing Level
Amount of detail that appears in the log for this transformation. You can choose terse, normal, verbose initialization, or verbose data. Default is normal.
Adding multiple source objects
When you configure a Source transformation to read from multiple Salesforce objects, you can select related objects based on existing relationships in Salesforce.
1On the Source page in the mapping, select the Salesforce connection.
2Select Multiple Objects as the Source Type.
3In the Objects and Relationships section, click Add Source Objects from the menu.
4In the Select Source Object window, select the source object that you want to add, and then click OK.
5To add related objects, select the source object, right-click menu, and then click Add Related Objects.
6In the Select Related Object window, select the related object that you want to add, and then click OK.
For example, the following image shows the list of related objects that have existing relationships with the Account parent object:
The following image shows the selected parent-child objects in the Source transformation:
Salesforce targets in mappings
In a mapping, you can configure a Salesforce object as the Target transformation to insert data to Salesforce.
Specify the name and description of the Salesforce target. Configure the target and advanced properties for the target object.
You can parameterize the Salesforce target objects at run time with values specified in a parameter file in a mapping.
The following table describes the Salesforce target properties that you can configure in a Target transformation:
Property
Description
Connection
Name of the target connection.
Object Type
Type of the target object. Select one of the following object types:
- Single Object
- Parameter
Default is Single Object.
Object
Name of the target object. Target object for a single target or primary target object for multiple targets.
Parameter
This property appears only if you select parameter as the object type.
A placeholder to dynamically assign values at run time for the target object without the requirement to edit the task.
Select an existing parameter for the target object or click New Parameter to define a new parameter for the target object.
To overwrite the parameter at run time, select the Allow parameter to be overridden at run time option.
Operation
Target operation. Select Insert, Update, Upsert, Delete, or Data Driven.
The following table describes the Salesforce target advanced properties that you can configure in a Target transformation:
Advanced Property
Description
Max Rows per Batch
The maximum number of records to include in each query that writes to the Salesforce target. You can use the following Salesforce API when you load data to the Salesforce target:
- Standard API. Enter a number between 1 and 200. To process multiple upserts on a particular row in the same query, set the batch size to 1. Default is 200.
- Bulk API. Enter a number between 201 and 10,000. Default is 10,000.
Note: To use Max Rows Per Batch property for Bulk API, add SalesforceBulkBatchSizeOverride=true custom property in the Advanced Session Properties on the Runtime Options tab of the mapping task.
Set to Null
Indicates if null values are allowed to replace existing values in the target. Select True to allow null values to replace existing values in the target.
Default is False.
Use SFDC Error File
Creates an error file with the Salesforce error logs when the task runs.
By default, the Secure Agent does not generate the error log files.
Select this property so that the Secure Agent generates the error logs in the following directory: <Secure Agent installation directory>/apps/Data_Integration_Server/data/error.
Use SFDC Success File
Creates a success file with the Salesforce success logs when the task runs.
By default, the Secure Agent does not generate the success log files.
Select this property so that the Secure Agent generates the success logs in the following directory: <Secure Agent installation directory>/apps/Data_Integration_Server/data/success.
Success File Location
Overrides the default success file directory with the path you specify.
Applicable when you select the Use SFDC Success File property.
To override, specify the location in the Secure Agent machine where you want the agent to generate the success log file.
Salesforce API
Salesforce API to write target data. Select any one of the options:
- Standard API
- Bulk API
- Bulk API 2.0
Monitor Bulk
Monitors a Salesforce Bulk API target.
Monitor Bulk 2.0
Monitors a Salesforce Bulk API 2.0 target.
Enable Serial Mode
Loads Salesforce Bulk API batches to the target serially.
By default, Salesforce loads Bulk API batches in parallel.
Applies to Salesforce Bulk API only.
Hard Delete
For loading to Salesforce targets using the Bulk Delete operation.
Permanently deletes target rows. Deleted rows cannot be recovered.
Hard Delete option is not applicable for standard API. It applies to Bulk API and Bulk API 2.0 only.
Forward Rejected Rows
Forwards rejected rows to the next session.
Salesforce lookup objects in mappings
You can retrieve data from a Salesforce lookup object based on the specified lookup condition.
When you configure a lookup in Salesforce, you select the lookup connection and lookup object. You also define the behavior when a lookup condition returns more than one match.
Note: Salesforce lookup works only with the Salesforce Standard API.
For an uncached lookup, you cannot configure logical operators, such as <, >, <=, and >= in the lookup condition.
You can parameterize the Salesforce lookup objects at run time with values specified in a parameter file in a mapping.
The following table describes the Salesforce lookup object properties that you can configure in a Lookup transformation:
Property
Description
Connection
Name of the lookup connection.
Object Type
Type of the lookup object. Select one of the following object types:
- Single Object
- Query
- Parameter
Default is Single Object.
Lookup Object
Name of the lookup object for the mapping.
Parameter
This property appears only if you select parameter as the object type.
A placeholder to dynamically assign values at run time for the lookup object without the requirement to edit the task.
Select an existing parameter for the lookup object or click New Parameter to define a new parameter for the lookup object.
To overwrite the parameter at run time, select the Allow parameter to be overridden at run time option.
Multiple Matches
Behavior when the lookup condition returns multiple matches. You can return first row, last row, any row, all rows, or report an error.
If you choose all rows and there are multiple matches, the Lookup transformation is an active transformation. If you choose any row, the first row, or the last row and there are multiple matches, the Lookup transformation is a passive transformation.
The Data Integration service uses case sensitive approach when performing lookups. For Salesforce lookups, the case sensitive comparison depends on the Salesforce support.
