Connection Properties
The connection properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection settings for this provider. Click the links for further details.
For more information on establishing a connection, see Getting Started.
| Property | Description |
| AuthScheme | Specifies the authentication method to use when connecting to Salesforce. |
| User | Specifies the authenticating user's user ID. |
| Password | Specifies the authenticating user's password. |
| SecurityToken | Specifies the security token used to authenticate access to the Salesforce account. |
| UseSandbox | Specifies whether the connection should be made to a Salesforce sandbox environment rather than a production instance. |
| CredentialsLocation | Specifies the file path where the OKTA MFA token is stored for authentication. |
| Property | Description |
| APIVersion | Specifies the Salesforce API version to use for the connection. |
| LoginURL | Specifies the Salesforce server URL used for authentication and login. |
| Property | Description |
| SSOLoginURL | The identity provider's login URL. |
| SSOProperties | Additional properties required to connect to the identity provider, formatted as a semicolon-separated list. |
| SSOExchangeURL | The URL used for consuming the SAML response and exchanging it for service specific credentials. |
| Property | Description |
| UseBulkAPI | Specifies whether to use the asynchronous Bulk API or the synchronous SOAP API for reading and writing data in Salesforce. |
| BulkAPIConcurrencyMode | Specifies the concurrency mode used when processing bulk rows with Salesforce Bulk API v1. |
| BulkUploadLimit | Specifies the maximum file size (in MB) that can be uploaded using Salesforce Bulk API v2. |
| BulkPollingInterval | Specifies the time interval (in milliseconds) between requests that check the availability of a bulk process response. |
| BulkQueryTimeout | Specifies the maximum time (in minutes) the provider waits for a bulk query response before timing out. |
| WaitForBulkResults | Specifies whether the provider should wait for bulk operation results to complete when using the asynchronous Bulk API. Only applies when UseBulkAPI is set to true. |
| BulkAPIVersion | Specifies the Salesforce Bulk API version to use for processing bulk queries and data operations. |
| PushEmptyValuesAsNull | Indicates whether empty values should be interpreted as empty strings or as NULL. |
| Property | Description |
| InitiateOAuth | Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working. |
| OAuthClientId | Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. |
| OAuthClientSecret | Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.). |
| OAuthAccessToken | Specifies the OAuth access token used to authenticate requests to the data source. This token is issued by the authorization server after a successful OAuth exchange. |
| OAuthSettingsLocation | Specifies the location of the settings file where OAuth values are saved. |
| CallbackURL | Identifies the URL users return to after authenticating to Salesforce via OAuth (Custom OAuth applications only). |
| Scope | Specifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created. |
| OAuthServerURL | Specifies the OAuth server URL used during the authentication process. |
| OAuthAuthorizationURL | The authorization URL for the OAuth service. |
| OAuthAccessTokenURL | The URL from which the OAuth access token is retrieved. |
| OAuthVerifier | Specifies a verifier code returned from the OAuthAuthorizationURL . Used when authenticating to OAuth on a headless server, where a browser can't be launched. Requires both OAuthSettingsLocation and OAuthVerifier to be set. |
| PKCEVerifier | The PKCE code verifier generated from executing the GetOAuthAuthorizationUrl stored procedure for PKCE authentication schemes. |
| OAuthRefreshToken | Specifies the OAuth refresh token used to request a new access token after the original has expired. |
| OAuthExpiresIn | Specifies the duration in seconds, of an OAuth Access Token's lifetime. The token can be reissued to keep access alive as long as the user keeps working. |
| OAuthTokenTimestamp | Displays a Unix epoch timestamp in milliseconds that shows how long ago the current access token was created. |
| Property | Description |
| OAuthJWTCert | Supplies the name of the client certificate's JWT Certificate store. |
| OAuthJWTCertType | Identifies the type of key store containing the JWT Certificate. |
| OAuthJWTCertPassword | Provides the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank. |
| OAuthJWTCertSubject | Identifies the subject of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '*' to select the first certificate. |
| OAuthJWTIssuer | The issuer of the Java Web Token. |
| OAuthJWTSubject | The user subject for which the application is requesting delegated access. |
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic. |
| ProxyPort | Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | Specifies the password of the user specified in the ProxyUser connection property. |
| ProxySSLType | Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
| Property | Description |
| Logfile | Specifes the file path to the log file where the provider records its activities, such as authentication, query execution, and connection details. |
| Verbosity | Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5. |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
| MaxLogFileSize | Specifies the maximum size of a single log file in bytes. For example, '10 MB'. When the file reaches the limit, the provider creates a new log file with the date and time appended to the name. |
| MaxLogFileCount | Specifies the maximum number of log files the provider retains. When the limit is reached, the oldest log file is deleted to make space for a new one. |
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
| Property | Description |
| AutoCache | Specifies whether the content of tables targeted by SELECT queries is automatically cached to the specified cache database. |
| CacheProvider | The namespace of an ADO.NET provider. The specified provider is used as the target database for all caching operations. |
| CacheConnection | Specifies the connection string for the specified cache database. |
| CacheLocation | Specifies the path to the cache when caching to a file. |
| CacheTolerance | Notes the tolerance, in seconds, for stale data in the specified cache database. Requires AutoCache to be set to True. |
| Offline | Gets the data from the specified cache database instead of live Salesforce data. |
| CacheMetadata | Determines whether the provider caches table metadata to a file-based cache database. |
| Property | Description |
| AllOrNone | Specifies whether all insert, update, or delete operations in a request should fail if any individual record fails. |
| ArchiveMode | Specifies whether to include deleted and archived records in standard SELECT queries. |
| ContinueOnAlterException | Specifies whether the provider should continue executing subsequent ALTER statements after one fails. |
| DirectQueryLimit | Specifies the maximum number of rows returned by queries in both Import and DirectQuery modes. |
| EnableForeignKeyDetection | Whether to detect the foreign keys in ODBC. |
| ExposeConceptualEntities | Specifies whether Salesforce Record Types should be exposed as separate tables. |
| FilterScope | Specifies an optional scope to limit the records returned in queries using Salesforce's USING SCOPE keyword. |
| IncludeItemURL | Boolean determining if the ItemURL column should be exposed for every table. |
| IncludeMetadataDescription | Specifies whether to retrieve descriptions for columns, tables, or both from the Salesforce Metadata API. |
| IncludeReports | Specifies whether Salesforce Reports should be exposed as views in the schema. |
| MaximumColumnSize | The maximum column size. |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| NullBooleanBehavior | This property determines how the NULL values should be treated for the Boolean columns. |
| Other | Specifies additional hidden properties for specific use cases., to be used only when our Support team advises it, to address specific issues. See Remarks for details. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| QueryPassthrough | Specifies whether to allow SOQL queries to be passed directly to Salesforce instead of translating SQL queries into SOQL. |
| Readonly | Toggles read-only access to Salesforce from the provider. |
| RemoveBOMCharacter | Specifies whether the provider should remove the Byte Order Mark (BOM) character (0xFEFF) from content. |
| RemovePrivateChar | Specifies whether to replace private use characters with a '?' character in the retrieved content. |
| ReplaceInvalidUTF8Chars | Specifies whether to replace invalid UTF-8 characters in the content with a '?' character. |
| ReportExactPicklistLength | Specifies whether to report the exact length of picklist fields as defined in Salesforce, or to report them with a default length of 255. |
| RTK | Specifies the runtime key for licensing the provider. If unset or invalid, the provider defaults to the standard licensing method. This property is only required in environments where the standard licensing method is unsupported or requires a runtime key. |
| ServerSideAggregation | Specifies whether aggregation operations such as SUM, COUNT, and GROUP BY should be performed on the Salesforce server or handled by the client. |
| SessionTimeout | Specifies the duration, in minutes, for which a Salesforce login session is reused before expiring. |
| SkipFormulaFields | Specifies whether formula fields should be excluded when listing columns for Salesforce objects. |
| SkipPickListTranslation | Specifies a comma-separated list of columns for which picklist translation should be skipped when retrieving data. |
| SortColumns | Specifies whether table columns should be sorted alphabetically by name or reported in the order provided by Salesforce. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
| TranslatePickListFields | Specifies whether picklist field values should be translated into the language of the currently authenticated Salesforce user. |
| UseDisplayNames | Specifies whether to use display names for columns instead of their API names when listing metadata and querying data. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file. |
| UseToolingAPI | Specifies whether to use the Salesforce Tooling API for retrieving and modifying metadata and development-related objects. |