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

Connection String Options

CData BizTalk Adapter for HubSpot 2019 - Build 19.0.7424

Connection String Options  

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

Adapter

CData.BizTalk.HubSpotAdapter.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., you must then 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 HubSpot

Connect via OAuth

HubSpot's API allows for authentication via OAuth. To authenticate using OAuth, leave these values blank to use the adapter's embedded app. Alternatively, you may create a custom app to obtain the OAuthClientId, OAuthClientSecret to use custom OAuth credentials. In addition to those properties, set CallbackURL. See Using OAuth Authentication for an authentication guide.

Connect via API Key

To connect via Hubspot API Keys, set the APIKey property, and you are ready to connect.

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.

Api KeyYour API key that gives you access to your HubSpot account.
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.
Column SizesA file with a name=value comma separated list of column sizes. For use with custom fields.
Company Properties FileA file with a comma separated list of properties to select from HubSpot for the Companies table.
Contact Properties FileA file with a comma separated list of properties to select from HubSpot for the Contacts table.
Deal Properties FileA file with a comma separated list of properties to select from HubSpot for the Deals table.
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.
Generate Schema FilesIndicates the user preference as to when schemas should be generated and saved.
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.
OAuth Access TokenThe access token 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.
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.
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 destination hostnames 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 HubSpot from the provider.
RTKThe runtime key used for licensing.
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.
Ticket Properties FileA file with a comma separated list of properties to select from HubSpot for the Tickets table.
TimeoutThe value in seconds until the timeout error is thrown, canceling the operation.
Use Display NamesBoolean determining if the display names for the columns should be used instead of the API names.
Use Dropdown LabelsBoolean determining if dropdown labels should be used instead of internal values for enums.
Use Simple NamesBoolean determining if simple names should be used for tables and columns.
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.7424.0