TDV Adapter for HubSpot

Build 24.0.9060

Connection String Options

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. Click the links for further details.

For more information on establishing a connection, see Basic Tab.

Authentication


PropertyDescription
AuthSchemeThe type of authentication to use when connecting to HubSpot.
SchemaSpecify the HubSpot API version to use. HubSpotV4 is the latest API.
OAuthOptionalScopesA comma-separated set of optional scopes that give you permissions to your HubSpot account.
OAuthRequiredScopesA comma-separated set of permissions that your Hubspot app needs access to.

OAuth


PropertyDescription
InitiateOAuthSet this property to initiate the process to obtain or refresh the OAuth access token when you connect.
OAuthClientIdThe client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecretThe client secret assigned when you register your application with an OAuth authorization server.
OAuthAccessTokenThe access token for connecting using OAuth.
OAuthSettingsLocationThe location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH . Alternatively, you can hold this location in memory by specifying a value starting with 'memory://'.
CallbackURLThe OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.
OAuthVerifierThe verifier code returned from the OAuth authorization URL.
OAuthRefreshTokenThe OAuth refresh token for the corresponding OAuth access token.
OAuthExpiresInThe lifetime in seconds of the OAuth AccessToken.
OAuthTokenTimestampThe Unix epoch timestamp in milliseconds when the current Access Token was created.

SSL


PropertyDescription
SSLServerCertThe certificate to be accepted from the server when connecting using TLS/SSL.

Firewall


PropertyDescription
FirewallTypeThe protocol used by a proxy-based firewall.
FirewallServerThe name or IP address of a proxy-based firewall.
FirewallPortThe TCP port for a proxy-based firewall.
FirewallUserThe user name to use to authenticate with a proxy-based firewall.
FirewallPasswordA password used to authenticate to a proxy-based firewall.

Proxy


PropertyDescription
ProxyAutoDetectWhen this connection property is set to True, the provider checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details). Set to False if you want to manually configure the provider to connect to a specific proxy server.
ProxyServerThe hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPortThe TCP port that the proxy server (specified in the ProxyServer connection property) is running on.
ProxyAuthSchemeThe authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUserThe username of a user account registered with the proxy server specified in the ProxyServer connnection property.
ProxyPasswordThe password associated with the user specified in the ProxyUser connection property.
ProxySSLTypeThe SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptionsA semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Logging


PropertyDescription
LogModulesCore modules to be included in the log file.

Schema


PropertyDescription
LocationA path to the directory that contains the schema files defining tables, views, and stored procedures.

Miscellaneous


PropertyDescription
ArchivedSpecify whether to get archived or unarchived records.
CallPropertiesFileA file or value with a comma separated list of properties to select from HubSpot for the Calls table.
ColumnSizesA file with a name=value comma separated list of column sizes.
CompanyPropertiesFileA file with a comma separated list of properties to select from HubSpot for the Companies table.
ContactPropertiesFileA file with a comma separated list of properties to select from HubSpot for the Contacts table.
DealPropertiesFileA file with a comma separated list of properties to select from HubSpot for the Deals table.
EmailPropertiesFileA file or value with a comma separated list of properties to select from HubSpot for the Emails table.
ExpandAssociationsSpecify whether to expand or not the object Associations tables.
FeedbackSubmissionPropertiesFileA file or value with a comma separated list of properties to select from HubSpot for the FeedbackSubmissions table.
GenerateSchemaFilesIndicates the user preference as to when schemas should be generated and saved.
GoalPropertiesFileA file or value with a comma separated list of properties to select from HubSpot for the Goals table.
IncludeCustomTablesSpecify whether to get Custom HubSpot Objects or not.
LeadPropertiesFileA file or a CSV string for the columns to select from HubSpot for the Leads table.
LineItemPropertiesFileA file or value with a comma separated list of properties to select from HubSpot for the LineItems table.
MaxRowsLimits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
MeetingPropertiesFileA file or value with a comma separated list of properties to select from HubSpot for the Meetings table.
NotePropertiesFileA file or value with a comma separated list of properties to select from HubSpot for the Notes table.
NumberColumnModeSpecifies how to handle detected number columns.
OrderPropertiesFileA file or a CSV string for the columns to select from HubSpot for the Orders table.
OtherThese hidden properties are used only in specific use cases.
PagesizeThe maximum number of results to return per page from HubSpot.
ProductPropertiesFileA file or value with a comma separated list of properties to select from HubSpot for the Products table.
QuotePropertiesFileA file or value with a comma separated list of properties to select from HubSpot for the Quotes table.
ReadonlyYou can use this property to enforce read-only access to HubSpot from the provider.
TaskPropertiesFileA file or value with a comma separated list of properties to select from HubSpot for the Tasks table.
TicketPropertiesFileA 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.
UseDisplayNamesBoolean determining if the display names for the tables and columns should be used instead of the API names.
UseDropdownLabelsBoolean determining if dropdown labels should be used instead of internal values for enums.
UserDefinedViewsA filepath pointing to the JSON configuration file containing your custom views.
UseSimpleNamesBoolean determining if simple names should be used for tables and columns.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060