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.
Property | Description |
AuthScheme | The type of authentication to use when connecting to HubSpot. |
Schema | Specify the HubSpot API version to use. HUBSPOTV3 is the new API. |
OAuthOptionalScopes | A comma-separated set of optional scopes that give you permissions to your HubSpot account. |
OAuthRequiredScopes | A comma-separated set of permissions that your Hubspot app needs access to. |
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. |
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. |
Property | Description |
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
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. |
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 . |
Property | Description |
LogModules | Core modules to be included in the log file. |
Property | Description |
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
Property | Description |
Archived | Specify whether to get archived or unarchived records. |
ColumnSizes | A file with a name=value comma separated list of column sizes. |
CompanyPropertiesFile | A file with a comma separated list of properties to select from HubSpot for the Companies table. |
ContactPropertiesFile | A file with a comma separated list of properties to select from HubSpot for the Contacts table. |
DealPropertiesFile | A file with a comma separated list of properties to select from HubSpot for the Deals table. |
ExpandAssociations | Specify whether to expand or not the object Associations tables. |
GenerateSchemaFiles | Indicates the user preference as to when schemas should be generated and saved. |
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. |
NumberColumnMode | Specifies how to handle detected number columns. |
Other | These hidden properties are used only in specific use cases. |
Pagesize | The maximum number of results to return per page from HubSpot. |
Readonly | You can use this property to enforce read-only access to HubSpot from the provider. |
TicketPropertiesFile | A file with a comma separated list of properties to select from HubSpot for the Tickets table. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
UseDisplayNames | Boolean determining if the display names for the tables and columns should be used instead of the API names. |
UseDropdownLabels | Boolean determining if dropdown labels should be used instead of internal values for enums. |
UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
UseSimpleNames | Boolean determining if simple names should be used for tables and columns. |