Connection String Parameters for QuickBooks
The connection string 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 string for this provider.
| Name | Description |
| ApplicationName | The name of the developer's application. |
| AutoCache | Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider . |
| 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. |
| CacheMetadata | This property determines whether or not to cache the table metadata to a file store. |
| CacheProvider | The name of the provider to be used to cache data. |
| CacheTolerance | The tolerance for stale data in the cache specified in seconds when using AutoCache . |
| CompanyFile | The name of the CompanyFile to open. |
| ConnectDirectly | A boolean indicating if you wish to connect directly to QuickBooks. |
| ConnectionLifeTime | The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed. |
| CustomFieldMode | How custom fields should display. |
| DelayAfterClose | A delay in milliseconds to be applied each time a connection to QuickBooks is closed. |
| FirewallPassword | A password used to authenticate to a proxy-based firewall. |
| FirewallPort | The TCP port for a proxy-based firewall. |
| FirewallServer | The name or IP address of a proxy-based firewall. |
| FirewallType | The protocol used by a proxy-based firewall. |
| FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
| IncludeLineItems | Whether or not to request Line Item responses from QuickBooks when retrieving a base transaction, such as Invoices. |
| IncludeLinkedTxns | Whether or not to request Linked Transactions from QuickBooks when retrieving a base transaction, such as Invoices. |
| Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
| Logfile | A path to the log file. |
| MaxLogFileCount | 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. |
| MaxLogFileSize | 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. |
| 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. |
| 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. |
| Pagesize | The maximum number of results to return per page from QuickBooks. |
| Password | A password for the Remote Connector connection. |
| 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. |
| ProxyAuthScheme | The authentication type to use to authenticate to the ProxyServer proxy. |
| 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. |
| ProxyPassword | A password to be used to authenticate to the ProxyServer proxy. |
| ProxyPort | The TCP port the ProxyServer proxy is running on. |
| ProxyServer | The hostname or IP address of a proxy to route HTTP traffic through. |
| ProxySSLType | The SSL type to use when connecting to the ProxyServer proxy. |
| ProxyUser | A user name to be used to authenticate to the ProxyServer proxy. |
| PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
| QBXMLVersion | The version of QBXML used in the outgoing message. This is only applicable to Desktop Edition. |
| Readonly | You can use this property to enforce read-only access to QuickBooks from the provider. |
| RTK | The runtime key used for licensing. |
| SSLServerCert | The SSL certificate being used by the Remote Connector. |
| SupportEnhancedSQL | 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 | A timeout, in seconds, for the provider to keep open the connection to the Remote Connector or QuickBooks. The value must be greater than 0. If not set or set to 0, the Timeout will default to 300. |
| URL | The URL for the Remote Connector. For example, http://localhost:8166. |
| UseConnectionPooling | This property enables connection pooling. |
| User | A username for the Remote Connector connection (if required by the Remote Connector). |
| UseRDS | Whether the provider will connect using Remote Data Sharing (RDS). Cannot be used together with the Remote Connector. |
| 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. |