CData BizTalk Adapter for QuickBooks Online 2019 - Online Help
Questions / Feedback?

Connection String Options

CData BizTalk Adapter for QuickBooks Online 2019 - Build 19.0.7354

Connection String Options  

The connection string properties describe the various options that can be used to establish a connection.

Adapter

CData.BizTalk.QuickBooksOnlineAdapter.dll

Remarks

The connection string can be set to a series of option=value strings separated by semicolons. If a connection string property value has special characters such as semicolons, single quotes, spaces, etc., then you must quote the value using either single or double quotes.

Connection options are case insensitive.

To specify a location to the database where the tables, views, and stored procedures are located, set the Location property. Caching Data can be enabled by using the appropriate options.

Authenticating to QuickBooks Online

QuickBooks Online uses the OAuth authentication standard. You can use the Embedded Credentials to connect without setting any connection properties. When you connect, the adapter opens the OAuth endpoint in your default browser. Simply log in and grant permissions to the application. The adapter then completes the OAuth process.

Connection String Options


The following is the full list of the options you can configure in the connection string for this provider. Click on the links for further details.

Auto CacheAutomatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider .
Cache ConnectionThe 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 LocationSpecifies the path to the cache when caching to a file.
Cache MetadataThis property determines whether or not to cache the table metadata to a file store.
Cache ProviderThe name of the provider to be used to cache data.
Cache ToleranceThe tolerance for stale data in the cache specified in seconds when using AutoCache .
Callback URLThe OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.
Company IdThe unique identifier of a given company in QuickBooks Online.
Country CodeThe country code for the edition of QuickBooks Online being used.
Firewall PasswordA password used to authenticate to a proxy-based firewall.
Firewall PortThe TCP port for a proxy-based firewall.
Firewall ServerThe name or IP address of a proxy-based firewall.
Firewall TypeThe protocol used by a proxy-based firewall.
Firewall UserThe user name to use to authenticate with a proxy-based firewall.
Hide Line TotalsWhether or not to hide line totals on line item tables.
Initiate OAuthSet this property to initiate the process to obtain or refresh the OAuth access token when you connect.
LocationA path to the directory that contains the schema files defining tables, views, and stored procedures.
LogfileA path to the log file.
Max Log File CountA 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 SizeA 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 RowsLimits 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.
Minor VersionSet the minor version to be used when sending requests to the QuickBooks Online API.
OAuth Access TokenThe access token for connecting using OAuth.
OAuth Access Token SecretThe OAuth access token secret for connecting using OAuth.
OAuth Client IdThe client ID assigned when you register your application with an OAuth authorization server.
OAuth Client SecretThe client secret assigned when you register your application with an OAuth authorization server.
OAuth Refresh TokenThe OAuth refresh token for the corresponding OAuth access token.
OAuth Settings LocationThe 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://.
OAuth VerifierThe verifier code returned from the OAuth authorization URL.
OAuth VersionSet OAuth version of your application.
OfflineUse offline mode to get the data from the cache instead of the live source.
OtherThese hidden properties are used only in specific use cases.
PagesizeThe maximum number of results to return per page from QuickBooks Online.
Proxy Auth SchemeThe authentication type to use to authenticate to the ProxyServer proxy.
Proxy Auto DetectThis 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 ExceptionsA semicolon separated list of hosts or IPs that are exempt from connecting through the ProxyServer .
Proxy PasswordA password to be used to authenticate to the ProxyServer proxy.
Proxy PortThe TCP port the ProxyServer proxy is running on.
Proxy ServerThe hostname or IP address of a proxy to route HTTP traffic through.
Proxy SSL TypeThe SSL type to use when connecting to the ProxyServer proxy.
Proxy UserA user name to be used to authenticate to the ProxyServer proxy.
Pseudo ColumnsThis property indicates whether or not to include pseudo columns as columns to the table.
ReadonlyYou can use this property to enforce read-only access to QuickBooks Online from the provider.
RTKThe runtime key used for licensing.
ScopeIdentifies the QuickBooks API access that your application is requesting. Scopes are space-delimited.
SSL Server CertThe certificate to be accepted from the server when connecting using TLS/SSL.
Support Enhanced SQLThis property enhances SQL functionality beyond what can be supported through the API directly, by enabling in-memory client-side processing.
TablesThis property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
TimeoutA timeout, in seconds, for the provider to keep open the connection to QuickBooks Online. The value must be greater than 0. If not set or set to 0, the Timeout will default to 60.
Use SandboxA boolean indicating if you are using a Sandbox account.
V1O Auth Client IdThe 1.0 access token for connecting using OAuth. Used for automatic migrations to 2.0.
V1O Auth Client SecretThe 1.0 OAuth access token secret for connecting using OAuth. Used for automatic migrations to 2.0.
ViewsRestricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

 
 
Copyright (c) 2020 CData Software, Inc. - All rights reserved.
Build 19.0.7354.0