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 Establishing a Connection.| All Or None | A boolean indicating if you would like all inserts, updates, or deletes to fail in a request if even a single record fails. |
| API Version | The version of the FinancialForce API used. |
| Auth Scheme | The type of authentication to use when connecting to FinancialForce. |
| Auto Cache | Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider . |
| Bulk Polling Interval | The time interval in milliseconds between requests that check the availability of the bulk query response. The default value is 500 ms. |
| Bulk Query Timeout | The timeout in minutes for which the provider will wait for a bulk query response. The default value is 25 minutes. |
| Cache Connection | The connection string for the cache database. This property is always used in conjunction with CacheProvider . Setting both properties will override the value set for CacheLocation for caching data. |
| Cache Location | Specifies the path to the cache when caching to a file. |
| Cache Metadata | This property determines whether or not to cache the table metadata to a file store. |
| Cache Provider | The name of the provider to be used to cache data. |
| Cache Tolerance | The tolerance for stale data in the cache specified in seconds when using AutoCache . |
| Callback URL | The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings. |
| Continue On Alter Exception | Whether you want to continue after a ALTER statement has failed. |
| Filter Scope | Optional scope to limit the records returned from queries. |
| Firewall Password | A password used to authenticate to a proxy-based firewall. |
| Firewall Port | The TCP port for a proxy-based firewall. |
| Firewall Server | The name or IP address of a proxy-based firewall. |
| Firewall Type | The protocol used by a proxy-based firewall. |
| Firewall User | The user name to use to authenticate with a proxy-based firewall. |
| Initiate OAuth | Set this property to initiate the process to obtain or refresh the OAuth access token when you connect. |
| Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
| Logfile | A filepath which designates the name and location of the log file. |
| Login URL | URL to the FinancialForce server used for logging in. |
| Log Modules | Core modules to be included in the log file. |
| Max Log File Count | A string specifying the maximum file count of log files. When the limit is hit, a new log is created in the same folder with the date and time appended to the end and the oldest log file will be deleted. |
| Max Log File Size | A string specifying the maximum size in bytes for a log file (for example, 10 MB). When the limit is hit, a new log is created in the same folder with the date and time appended to the end. |
| Max Rows | Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time. |
| OAuth Client Id | The client ID assigned when you register your application with an OAuth authorization server. |
| OAuth Client Secret | The client secret assigned when you register your application with an OAuth authorization server. |
| OAuth Server URL | The server URL to use if authenticating with OAuth. |
| Offline | Use offline mode to get the data from the cache instead of the live source. |
| Other | These hidden properties are used only in specific use cases. |
| Password | The password used to authenticate the user. |
| Proxy Auth Scheme | The authentication type to use to authenticate to the ProxyServer proxy. |
| Proxy Auto Detect | This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings. |
| Proxy Exceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . |
| Proxy Password | A password to be used to authenticate to the ProxyServer proxy. |
| Proxy Port | The TCP port the ProxyServer proxy is running on. |
| Proxy Server | The hostname or IP address of a proxy to route HTTP traffic through. |
| Proxy SSL Type | The SSL type to use when connecting to the ProxyServer proxy. |
| Proxy User | A user name to be used to authenticate to the ProxyServer proxy. |
| Readonly | You can use this property to enforce read-only access to FinancialForce from the provider. |
| Security Token | The security token used to authenticate access to the FinancialForce account. |
| Server Side Aggregation | A boolean determining if server side aggregation should be used. |
| Session Timeout | The time in minutes for which a FinancialForce login session is reused. |
| SSL Server Cert | The certificate to be accepted from the server when connecting using TLS/SSL. |
| SSO Login URL | The identity provider's login URL. |
| SSO Properties | Additional properties required to connect to the identity provider in a semicolon-separated list. |
| SSO Token URL | The FinancialForce OAuth 2.0 token endpoint for the identity provider. |
| Support Enhanced SQL | This property enhances SQL functionality beyond what can be supported through the API directly, by enabling in-memory client-side processing. |
| Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
| Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
| Use Bulk API | Whether to use the synchronous SOAP API or the asynchronous Bulk API. |
| User | The FinancialForce user account used to authenticate. |
| Use Sandbox | A boolean determining if the connection should be made to a FinancialForce sandbox account. |
| Verbosity | The verbosity level that determines the amount of detail included in the log file. |
| Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |
| Wait For Bulk Results | Whether to wait for bulk results when using the asynchronous API. Only active when UseBulkAPI is true. |