19. FinancialForce 
19.1. Connection Options
19.1.1. Authentication
Property | Description |
AuthScheme | The type of authentication to use when connecting to FinancialForce. |
User | The FinancialForce user account used to authenticate. |
Password | The password used to authenticate the user. |
SecurityToken | The security token used to authenticate access to the FinancialForce account. |
UseSandbox | A boolean determining if the connection should be made to a FinancialForce sandbox account. |
19.1.2. Connection
Property | Description |
APIVersion | The version of the FinancialForce API used. |
LoginURL | URL to the FinancialForce server used for logging in. |
19.1.3. SSO
Property | Description |
SSOLoginURL | The identity provider's login URL. |
SSOProperties | Additional properties required to connect to the identity provider in a semicolon-separated list. |
SSOExchangeUrl | The url used for consuming the SAML response and exchanging it with FinancialForce specific credentials. |
19.1.4. BulkAPI
Property | Description |
UseBulkAPI | Whether to use the synchronous SOAP API or the asynchronous Bulk API. |
BulkAPIVersion | The version of the bulk API to use for processing queries. |
BulkAPIConcurrencyMode | The concurrency mode for processing bulk rows with BULK API v1. |
BulkPollingInterval | The time interval in milliseconds between requests that check the availability of the bulk query response. The default value is 500 ms. |
BulkQueryTimeout | The timeout in minutes for which the provider will wait for a bulk query response. The default value is 25 minutes. |
WaitForBulkResults | Whether to wait for bulk results when using the asynchronous API. Only active when UseBulkAPI is true. |
19.1.5. OAuth
Property | Description |
InitiateOAuth | Set this property to initiate the process to obtain or refresh the OAuth access token when you connect. |
OAuthClientId | The client ID assigned when you register your application with an OAuth authorization server. |
OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
OAuthAccessToken | The access token for connecting using OAuth. |
OAuthSettingsLocation | The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, this can be held in memory by specifying a value starting with memory://. |
CallbackURL | The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings. |
OAuthServerURL | The server URL to use if authenticating with OAuth. |
OAuthGrantType | The grant type for the OAuth flow. |
OAuthVerifier | The verifier code returned from the OAuth authorization URL. |
OAuthRefreshToken | The OAuth refresh token for the corresponding OAuth access token. |
OAuthExpiresIn | The lifetime in seconds of the OAuth AccessToken. |
OAuthTokenTimestamp | The Unix epoch timestamp in milliseconds when the current Access Token was created. |
19.1.6. SSL
Property | Description |
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
19.1.7. Firewall
Property | Description |
FirewallType | The protocol used by a proxy-based firewall. |
FirewallServer | The name or IP address of a proxy-based firewall. |
FirewallPort | The TCP port for a proxy-based firewall. |
FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
FirewallPassword | A password used to authenticate to a proxy-based firewall. |
19.1.8. Proxy
Property | Description |
ProxyAutoDetect | 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. |
ProxyServer | The hostname or IP address of a proxy to route HTTP traffic through. |
ProxyPort | The TCP port the ProxyServer proxy is running on. |
ProxyAuthScheme | The authentication type to use to authenticate to the ProxyServer proxy. |
ProxyUser | A user name to be used to authenticate to the ProxyServer proxy. |
ProxyPassword | A password to be used to authenticate to the ProxyServer proxy. |
ProxySSLType | The SSL type to use when connecting to the ProxyServer proxy. |
ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . |
19.1.9. Logging
Property | Description |
Logfile | A filepath which designates the name and location of the log file. |
Verbosity | The verbosity level that determines the amount of detail included in the log file. |
LogModules | Core modules to be included in the log file. |
MaxLogFileSize | A string specifying the maximum size in bytes for a log file (for example, 10 MB). |
MaxLogFileCount | A string specifying the maximum file count of log files. |
19.1.10. Schema
Property | Description |
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |
19.1.11. Caching
Property | Description |
AutoCache | Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider . |
CacheDriver | The database driver to be used to cache data. |
CacheConnection | 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. |
CacheLocation | Specifies the path to the cache when caching to a file. |
CacheTolerance | The tolerance for stale data in the cache specified in seconds when using AutoCache . |
Offline | Use offline mode to get the data from the cache instead of the live source. |
CacheMetadata | This property determines whether or not to cache the table metadata to a file store. |
19.1.12. Miscellaneous
Property | Description |
AllOrNone | A boolean indicating if you would like all inserts, updates, or deletes to fail in a request if even a single record fails. |
ArchiveMode | Boolean indicating whether to include deleted and archived records with a standard SELECT query. |
ConnectionLifeTime | The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed. |
ConnectOnOpen | This property species whether to connect to the FinancialForce when the connection is opened. |
ContinueOnAlterException | Whether you want to continue after a ALTER statement has failed. |
FilterScope | Optional scope to limit the records returned from queries. |
IncludeMetadataDescription | Set this property to a value other than NONE if you want to retrieve the descriptions for columns, tables or both of them from the Metadata API. |
MaxRows | 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. |
Other | These hidden properties are used only in specific use cases. |
PoolIdleTimeout | The allowed idle time for a connection before it is closed. |
PoolMaxSize | The maximum connections in the pool. |
PoolMinSize | The minimum number of connections in the pool. |
PoolWaitTime | The max seconds to wait for an available connection. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
Readonly | You can use this property to enforce read-only access to FinancialForce from the provider. |
RTK | The runtime key used for licensing. |
ServerSideAggregation | A boolean determining if server side aggregation should be used. |
SessionTimeout | The time in minutes for which a FinancialForce login session is reused. |
SkipFormulaFields | Set to true if formula fields should be skipped when listing columns. |
SupportEnhancedSQL | This property enhances SQL functionality beyond what can be supported through the API directly, by enabling in-memory client-side processing. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
UseConnectionPooling | This property enables connection pooling. |
UseDisplayNames | Boolean determining if the display names for the columns should be used instead of the API names. |