Advanced Options
The following table lists and describes the advanced options that you can configure for an adapter datastore. The options are listed in the top-down order in which they appear in the Advanced Options pane of the Create New Datastore dialog box or Edit Datastore dialog box.
| Option | Description |
|---|---|
|
CDC Enable |
When this option is set to true, Changed Data Capture (CDC) is enabled and the adapter datastore tracks changes that have occurred in the data source since the data was last imported in Data Services. Tables that you import using this datastore cannot be used as target objects. When this option is set to false, CDC is disabled. |
| Enable Bulk API Temporary File |
When this option is set to yes, the adapter creates a temporary file when using the Bulk API to write result set data. This option avoids connection rests. Note: This setting is deprecated and will be removed in a future release. |
| Disable REST Fallback | When this option is set to yes, the adapter does not fall back to the REST API when a bulk query fails. |
|
Enable WSC Trace Logging |
When this option is set to yes, the Salesforce web server connector generates trace-level connection logs. These logs contain information on the request and response payloads sent to Salesforce. Important:
Important: Enabling this property captures the authentication credentials in plain text. Use this feature at your own risk. When this option is set to no, WSC trace logging is disabled. |
|
Username |
Your user name for accessing Salesforce |
|
Password |
Your password for accessing Salesforce |
|
Token |
Your security token for accessing Salesforce Note: Some connections require a security token, while others do not. Only provide a security token if your connection fails without it. |
| OAuth Access Token | The access token to use for OAuth connections. |
| OAuth Refresh Token | The Refresh Token used to obtain a fresh Access Token after it expires, when using OAuth authentication. |
| OAuth Client ID | The Client ID used for OAuth connections. On Salesforce, this is the Consumer Key property of a Connected App. |
| OAuth Client Secret | The Client Secret used for OAuth connections. On Salesforce, this is the Consumer Secret property of a Connected App. |
| OAuth Token Request End Point |
The end point to use when requesting tokens to use for OAuth. |
| Web Service End Point | The authentication m_endpoint URL. If you do not specify an endpoint, the default value https://www.salesforce.com/services/Soap/u/48.0 is used. |
| Batch Size | The maximum number of rows that a query returns at a time. The maximum value is 2000 rows. |
| Bulk API Batch Size | The maximum number of rows that can be sent to Salesforce.com in one bulk API call. The maximum value is 10000 rows. |
|
Metadata Resilience |
When set to yes, the adapter is resilient to metadata errors and does not return error messages if it detects missing columns or tables while running a job or operation. For more information, see Metadata Resilience. When set to no, the adapter returns error messages if it detects missing columns or tables while running a job or operation. |
|
Default Base64Binary Field Length |
The maximum length of Base64Binary field data passed in from Salesforce The maximum value is 5120000. Any data beyond this length is truncated. |
|
ID Column Required |
When this option is set to true, the adapter requires every result set to include an ID column, and returns an error if there is no ID column. When this option is set to false, ID columns are not required in result sets. |
|
Retry Number |
The maximum number of times that the adapter retries a failed API call. |
|
Proxy Host |
The IP address or host name of the proxy server. |
|
Proxy Port |
The number of the port that the proxy server uses to listen for client connections. |
|
Proxy Password |
Your password for accessing the proxy server. |
|
Proxy User Name |
Your user name for accessing the proxy server. |
|
CDC Deleted Records |
When this option is set to disable, the adapter does not retrieve any deleted records. When this option is set to enable, the adapter retrieves limited data from deleted records, including the ID and deleted date. When this option is set to full data, the adapter retrieves the full contents of any deleted records. |
|
Disable CDC Upserted Records |
When this option is set to yes, the adapter does not retrieve inserted and updated records during CDC operations. When this option is set to no, the adapter retrieves inserted or updated records during CDC operations. |
|
Bulk API Stop On First Failure |
When this option is set to yes, the adapter stops loading data after it fails to load a record. When this option is set to no, the adapter continues to load data even if it fails to load some of the records. |
|
Enable Failure Logging |
When this option is set to yes, the adapter logs information about the records that failed to load, including information such as the Salesforce job ID, batch ID, key column value, and the reason for the failure. The log file is saved in the location specified by the Failure Logging Path option. When this option is set to no, the adapter does not log information about records that failed to load. |
|
Failure Logging Path |
The location where the adapter saves the log file about records that failed to load, when Enable Failure Logging is set to yes. By default, the location is |
| Auto Logout |
When this option is set to true, the adapter instance automatically logs out from Salesforce after the connection is closed. When this option is set to false, the adapter instance does not automatically log out from Salesforce after the connection is closed. Note: If you encounter "invalid session" errors when using the adapter, set this option to false. |
| Reduce API Calls |
When this option is set to YES, the adapter instance uses a single API call to retrieve multiple batches of data. When this option is set to NO, the adapter instance uses multiple API calls to retrieve multiple batches of data. Note: Enabling this option increases the amount of memory that the adapter instance consumes. |
| Disable BULK Query |
When this option is set to YES, the adapter instance does not use the Bulk API to retrieve data. When this option is set to NO, the adapter instance uses the Bulk API to retrieve data. Note: When using the Bulk API, the adapter instance retrieves data more quickly but also consumes more memory. |
| Enable Parallel Bulk Job Execution |
When this option is set to yes, the adapter processes up to 10 batches of data in parallel for insert, delete, and update jobs. This improves performance, but can increase memory usage. Enable this option when there is no inter-dependency between the batches. When this option is set to no, the adapter does not process insert, delete, and update jobs in parallel. |
| Bulk API Threshold | The number of query results at which the driver starts to use the Bulk API. The default value is 30000. |
| PKChunkSize | The number of results to include in each chunk, when query results are retrieved using primary key chunking. This is only relevant if the PKChunkThreshold is met. The default value is 100000. |
| PKChunkThreshold | The minimum number of records needed to enable the primary key chunking during Bulk query data retrieval. The default value is 100000. |
| Data Exchange Timeout | The amount of time, in seconds, after which the adapter closes a data fetch job, if an error occurs in SAP Data Services during that job. The default value is 60 seconds. |
|
Date Time In UTC |
When this option is set to yes, the adapter returns date/time data values in UTC (Coordinated Universal Time). When this option is set to no, the adapter converts date/time data values from UTC to your local time zone before returning the data. |
Metadata Resilience
You can prevent the adapter from returning error messages in some cases where it detects missing columns or tables by setting the Metadata Resilience option to yes.
When metadata resilience is enabled, the adapter does not return error messages if it encounters the following scenarios while sending data to Salesforce
- A table no longer exists, so the adapter does not make any changes in Salesforce
- A column no longer exists, so the adapter does not send a value for that column to Salesforce
Note:
The following metadata resilience functionality is expected to be available in a later version of the driver.
When metadata resilience is enabled, the adapter does not return error messages if it encounters the following scenarios while reading data from a source:
- A table no longer exists, so the adapter returns no records from the query.
- A field that is currently used in a data flow no longer exists, so the adapter returns a NULL value for every row of that field to Data Services.
- A field that is currently used in a WHERE clause no longer exists, so the adapter interprets the part of the WHERE clause containing that field as FALSE.
For example, if the WHERE clause is WHERE ColumnA = A or ColumnB = B and ColumnB no longer exists, then the adapter interprets the clause as WHERE Column A = A.