Property | Description |
|---|---|
Connection | Name of the source connection. |
Source Type | Type of the source connection. Select Single, Multiple, or Query. |
Source Object | Name of the source object. You can define a custom query to use as the source object. |
Query Options | You can choose from the following options:
|
Related Objects | Includes related objects in the task. You can join objects with existing relationships for Salesforce connection type. |
Property | Description |
|---|---|
SOQL Filter Condition | Enter a filter condition to filter Salesforce source records. 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 Query Options as well as the SOQL Filter Condition, the SOQL Filter Condition overrides the filter under Query Options. |
CDC Time Limit | Time period, in seconds, that the agent reads changed Salesforce data. When you set the CDC Time Limit to a non-zero value, the agent performs a full initial read of the source data and then captures changes to the Salesforce data for the time period you specify. Set the value to -1 to capture changed data for an infinite period of time. Default is 0. |
Flush Interval | Interval, in seconds, at which the agent captures changed Salesforce data. Default is 300. If you set the CDC Time Limit to a non-zero value, the agent captures changed data from the source every 300 seconds. Otherwise, the agent ignores this value. |
CDC Start Timestamp | Start date and time for the time period. The agent extracts data added or modified after this time. Must be in the format YYYY-MM-DDTHH:MI:SS.SSSZ. You can also use the $Paramstart mapping variable in a parameter file to specify the CDC start time. |
CDC End Timestamp | End date and time for the time period. The agent extracts data added or modified before this time. Must be in the format YYYY-MM-DDTHH:MI:SS.SSSZ. You can also use the $Paramend mapping variable in a parameter file to specify the CDC end time. |
Row Limit | The maximum number of rows the agent processes. Default is 0. The default value indicates that there is no row limit, and the agent processes all records. |
Use queryAll | Runs a query that returns all rows, including active, archived, and deleted rows that are available in the recycle bin. Otherwise, the agent returns active rows. The Use queryAll property for Bulk API is available for Salesforce API version 39.0 and later. The Secure Agent ignores this property when you configure the session to perform change data capture. |
Use SystemModstamp for CDC | Uses the SystemModstamp as the time stamp for changed records in Salesforce. Otherwise, the agent uses the LastModifiedDate time stamp to identify changed records in Salesforce. Default is to use the LastModifiedDate time stamp. |
Enable Bulk Query | Uses the Salesforce Bulk API to read Salesforce source data. By default, the Secure Agent uses the standard Salesforce API. |
Enable Bulk 2.0 Query | Uses the Salesforce Bulk API 2.0 to read large amount of data from Salesforce. |
Property | Description |
|---|---|
Connection | Name of the target connection. |
Target Object | Type of the target object. |
Filter | Filter condition filters data in Salesforce. |
Display technical names instead of labels | Displays technical names instead of business names. |
Display target fields in alphabetical order | Displays target fields in alphabetical order instead of the order returned by the target system. |
Advanced Property | Description |
|---|---|
Treat Insert as Upsert | Upserts any records flagged as insert. By default, the agent treats all records as insert. |
Treat Update as Upsert | Upserts any records flagged as update. Select this property when you use the Update Strategy transformation in the mapping. Select the Treat Source Rows As session property to flag records as update. |
Max Batch Size | Maximum number of records the agent writes to a Salesforce target in one batch. Default is 200 records. This property is not applicable in Bulk API target sessions. |
Set Fields to Null | Replaces values in the target with null values from the source. By default, the agent does not replace values in a record with null values during an update or upsert operation. |
Use SFDC Error File | Generates the error log files. By default, the agent does not generate the error log files. To generate an error log file for a Bulk API target session, select the Monitor Bulk Job Until All Batches Processed session property as well. Similarly, to generate an error log file for a Bulk API 2.0 target session, select the Monitor Bulk API 2.0 Jobs property. |
Use SFDC Success File | Generates the success log files. By default, the agent does not generate the success log files. To generate a success log file for a Bulk API target session, select the Monitor Bulk Job Until All Batches Processed session property as well. Similarly, to generate a success log file for a Bulk API 2.0 target session, select the Monitor Bulk API 2.0 Jobs property. |
SFDC Success File Directory | 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. |
Use Idlookup Field for Upserts | Uses the Salesforce idLookup field to identify target records that need to be upserted. If you do not select this property, use the external ID for the upsert operation. If you do not select this property and do not provide the external ID, the session fails. |
Use this ExternalId/IdLookup field for Upserts | The exact name of the external ID or idLookup field to use for upserts. By default, the agent uses the first external ID or idLookup field in the target. Use this property when you want to use a different field for upserts. |
Use SFDC Bulk API | Uses the Salesforce Bulk API to load batch files containing large amounts of data to Salesforce targets. By default, the agent uses the standard Salesforce API. |
Use SFDC Bulk API 2.0 | Uses the Salesforce Bulk API 2.0 to load batch files containing large amounts of data to Salesforce targets. |
Monitor Bulk Job Until All Batches Processed | Monitors a Bulk API target session. When you select this property, the agent logs the status of each batch in the session log. If you do not select this property, the agent does not generate complete session statistics for the session log. Select this property along with the Use SFDC Success File or Use SFDC Error File session properties to generate the success or error logs for the session. |
Monitor Bulk API 2.0 Jobs | Monitors a Salesforce Bulk API 2.0 target. |
Override Parallel Concurrency | Instructs the Salesforce Bulk API to write batches to targets serially. By default, the Bulk operation writes batches in parallel. |
Disable Bulk Success and Error File Creation | Disables the creation of success and error log files for a Bulk API and Bulk API 2.0 target session. Overrides the Use SFDC Error File and Use SFDC Success File session properties. |
Enable Field Truncation Attribute | Allows Salesforce to truncate target data that is larger than the target field. When you select this property, Salesforce truncates overflow data and writes the row to the Salesforce target. By default, the agent writes overflow data to the session error file. |
Lookup Object Properties | Description |
|---|---|
Connection | Name of the lookup connection. |
Lookup Object | Name of the lookup object for the mapping. |
Display technical names instead of labels | Displays technical names instead of business names. |
Display lookup fields in alphabetical order | Displays lookup fields in alphabetical order instead of the order returned by the source system. |