skip to main content
Parameters for all supported Data Store types : HubSpot connection parameters (Beta)
 

Try DataDirect Cloud Now

HubSpot connection parameters (Beta)

The following tables describes parameters available on the tabs of a HubSpot® Data Source dialog.
*General tab
*OData tab
Note: DataDirect Cloud provides read-only access to the HubSpot cloud data store account.

General tab

Click the thumbnail to view the screen. Required fields are marked with an asterisk.
General tab of the HubSpot data source setup dialogGeneral tab of the HubSpot data source setup dialog
Table 36. General Tab connection parameters for HubSpot
Field
Description
Data Source Name
A unique name for this Data Source definition. Names can contain alphanumeric characters and underscores only, they cannot contain any special characters.
Description
A description of this set of connection parameters.
Table 37. HubSpot Custom Properties
Custom Property
Required
Default Value
Valid Value
Description
Hapikey
Yes
The HubSpot API key for your HubSpot cloud data store account.
Note: The HubSpot data store requires either a HubSpot API key (hapikey) or an access token (access_token) for authentication.Progress recommends that you use the HubSpot API key for authentication because the access token is only valid for a brief period of time.
Access Token
Yes
The HubSpot access token for your HubSpot cloud data store account.
Note: The HubSpot data store requires either a HubSpot API key (hapikey) or an access token (access_token) for authentication. Progress recommends that you use the HubSpot API key for authentication because the access token is only valid for a brief period of time.
Keyword Conflict Suffix
No
A string of up to five characters that the connectivity service appends to an object or a field name that conflicts with an SQL keyword
Web Service Timeout
No
180
0 to 100000
Timeout for HubSpot web service calls. If set to 0, the connectivity service does not time out a Web Service call.
Web Service Retry Count
No
1
0 to 10
Specifies the number of times to retry the HubSpot Web service after an initial unsuccessful attempt. A positive integer sets the number of retries.
If set to 0, no retry attempts are made.
If set to 1 or higher, the connectivity service retries the Oracle HubSpot web service the specified number of times. Unless your logs show a high number of retries, values higher than 1 are unlikely to provide significant value.

OData tab

The following table describes the controls on the OData tab. For information on using the Configure Schema editor, see Enabling OData and working with Data Source groups. For information on formulating OData requests, see "Formulating queries" under Querying with OData.
Click the thumbnail to view the screen. Required fields are marked with an asterisk.
OData tabOData tab
Table 38. OData tab connection parameters for HubSpot
Field
Description
Access URI
Specifies the base URI for the OData feed to access your DataDirect Cloud data source, for example, https://service.datadirectcloud.com/api/odata. You can copy the URI and paste it into your application's OData configuration.
The URI contains the case-insensitive name of the data source to connect to, and the query that you want to execute. This URI is the OData Service Root URI for the OData feed. The Service Document for the data source is returned by issuing a GET request to the data source's service root.
The OData Service Document returns the names of the entities exposed by the Data Source OData service. To get details such as the properties of the entities exposed, the data types for those properties and the relationships between entities, the Service Metadata Document can be fetched by adding /$metadata to the service root URI.
Schema Map
Enables OData support. If a schema map is not defined, the OData API cannot be used to access the data store using this Data Source definition. Use the Configure Schema editor to select the tables to expose through OData.
See Using the Configure Schema editor for more information.
Data Source Caching
Specifies whether the connection to the backend data source is cached in a session associated with the data source. Caching the back end connection improves performance when multiple OData queries are submitted to the same data source because the connection does not need to be created on every query.
Caching of the back end connection can get in the way when trying to configure a data source for OData. If a change is made to any of the DataDirect Cloud data source connection parameters, those changes will not be seen because the connection was established using the old data source definition, and was cached. The session that caches the backend connection is discarded if there is no activity to the data source for approximately 5 minutes.
When you configure a data source for OData, it is recommended that the OData session caching be disabled. Once you are satisfied with the OData configuration for the data source, enable the parameter to get the performance improvement provided by caching the connection to the backend data source.
Valid Values:
When set to 1, session caching is enabled. This provides better performance for production.
When set to 0, session caching is disabled. Use this value when you are configuring the data source.
Default: 1
Page Size
Determines the number of entities returned on each page for paging controlled on the server side. On the client side, requests can use the $top and $skip parameters to control paging. In most cases, server side paging works well for large data sets. Client side pagination works best with a smaller data sets where it is not as expensive to fetch subsequent pages.
Valid Values: 0 | n
where n is an integer from 1 to 10000.
When set to 0, the server default of 2000 is used.
Default: 0
Refresh Result
Controls what happens when you fetch the first page of a cached result when using Client Side Paging. Skip must be omitted or set to 0. You can use the cached copy of that first page, or you can re-execute the query to get a new result, discarding the previously cached result. Re-executing the query is useful when the data being fetched may change between two requests for the first page. Using the cached result is useful if you are paging back and forth through results that are not expected to change.
Valid Values:
When set to 0, the OData service caches the first page of results.
When set to 1, the OData service re-executes the query.
Default: 1
Inline Count Mode
Specifies how the connectivity service satisfies requests that include the $inlinecount parameter when it is set to allpages. These requests require the connectivity service to include the total number of entities that are defined by the OData query request. The count must be included in the first page in server-driven paging and must be included in every page when using client-driven paging.
The optimal setting depends on the data store and the size of results. The OData service can run a separate query using the count(*) aggregate to get the count, before running the query used to generate the entities. In very large results, this approach can often lead to the first page being returned faster. Alternatively, the OData service can fetch the entire result before returning the first page. This approach works well for small results and for data stores that cannot optimize the count(*) aggregate; however, it may have a longer initial response time for the first page if the result is large.
Valid Values:
When set to 1, the connectivity service runs a separate count(*) aggregate query to get the count of entities before executing the query to return results. In very large results, this approach can often lead to the first page being returned faster.
When set to 2, the connectivity service fetches all entities before returning the first page. For small results, this approach is always faster. However, the initial response time for the first page may be longer if the result is large.
Default: 1
Top Mode
Indicates how requests typically use $top and $skip for client side pagination, allowing the service to better anticipate how to process queries.
Valid Values:
Set to 0 when the application generally uses $top to limit the size of the result and rarely attempts to get additional entities by combining $top and $skip.
Set to 1 when the application uses $top as part of client-driven paging and generally combines $top and $skip to page through the result.
Default: 0
OData Read Only
Controls whether write operations can be performed on the OData service. Write operations generate a 405 Method Not Allowed response if this option is enabled.
Existing OData-enabled data sources are read only (write operations are disabled). To enable write operations for an existing OData enabled data source, clear the OData Read Only option on the OData tab. Then, on the Data Sources tab, regenerate the OData model for the data source by clicking on the OData model icon Synch completed successfully.
Valid Values:
true | false
When the check box is selected (set to true), OData access is restricted to read-only mode.
When the check box is not selected (set to false), write operations can be performed on the OData service.
Default: false
See the steps for:
Creating a Data Source definition