Invantive Data Hub
Provider Freshdesk: Freshdesk, customer happiness for exceptional customer service. |
Freshdesk, customer happiness for exceptional customer service.
Code for use in settings.xml: Freshdesk
Alias: freshdesk
Status: Production
Available in Editions: Paid
Technical Documentation: https://developer.freshdesk.com/api/#quick-reference
Documentation
Authentication
Authentication can be done using one of the following two alternatives:
1. Using the user log on code, password and company also used on the Freshdesk website.
2. Using an API key and company.
Authentication using user log on code and password is recommended for general use. The company is the name before '.freshdesk.com' in the URL used to log on to Freshdesk in a browser.
The API key can be found in the 'Edit Profile' page in Freshdesk, as described on https://support.freshdesk.com/support/solutions/articles/225435-where-can-i-find-my-api-key.
Usage Limits
Invantive UniversalSQL executes API calls to retrieve and upload data. The number of API calls allowed per hour depends on your Freshdesk plan. The default usage limits vary between 1.000 and 5.000 calls per hour. Invantive UniversalSQL ensures that within your session the number of calls allowed per hour is not exceeded.
To get an impression of how Invantive UniversalSQL translates into API calls, please query the data dictionary view 'sessionios', such as with 'select * from sessionios@datadictionary'.
Provider Attributes
The following provider attributes are available for Freshdesk:
Code |
Description |
Default Value |
Set from Connection String |
Set from Set SQL-Statement |
Set from Providers File |
|---|---|---|---|---|---|
api-url |
URL to access the API. |
|
✓ |
|
✓ |
company |
{res:itgen_freshdesk_company_description} |
|
✓ |
|
✓ |
download-error-internet-down-max-tries |
Maximum number of tries when the Internet connection seems down during retrieval of data. |
|
✓ |
✓ |
✓ |
download-error-internet-down-sleep-initial-ms |
Initial sleep in milliseconds between retries when the Internet connection seems down during retrieval of data. |
|
✓ |
✓ |
✓ |
download-error-internet-down-sleep-max-ms |
Maximum sleep in milliseconds between retries when the Internet connection seems down during retrieval of data. |
|
✓ |
✓ |
✓ |
download-error-internet-down-sleep-multiplicator |
Multiplication factor for sleep between retries when the Internet connection seems down during retrieval of data. |
|
✓ |
✓ |
✓ |
force-case-sensitive-identifiers |
Consider identifiers as case-sensitive independent of the platform capabilities. |
False |
✓ |
✓ |
✓ |
forced-casing-identifiers |
Forced casing of identifiers. Choose from Unset, Lower, Upper and Mixed. |
|
✓ |
✓ |
✓ |
http-disk-cache-compression-level |
Compression level for the HTTP disk cache, ranging from 1 (little) to 9 (intense). Default is 5. |
5 |
✓ |
✓ |
✓ |
http-disk-cache-directory |
Directory where HTTP cache is stored. |
C:\Users\gle3\Invantive\Cache |
✓ |
✓ |
✓ |
http-disk-cache-max-age-sec |
Maximum acceptable age in seconds for use of data in the HTTP disk cache. |
2592000 |
✓ |
✓ |
✓ |
http-get-timeout-ms |
HTTP GET timeout (ms). |
300000 |
✓ |
✓ |
✓ |
http-memory-cache-compression-level |
Compression level for the HTTP memory cache, ranging from 1 (little) to 9 (intense). Default is 5. |
5 |
✓ |
✓ |
✓ |
http-memory-cache-max-age-sec |
Maximum acceptable age in seconds for use of data in the HTTP memory cache. |
14400 |
✓ |
✓ |
✓ |
http-post-timeout-ms |
HTTP POST timeout (ms). |
300000 |
✓ |
✓ |
✓ |
ignore-http-400-errors |
Ignore HTTP 400 errors when exchanging results with the OData endpoint. |
False |
✓ |
✓ |
✓ |
ignore-http-403-errors |
Ignore HTTP 403 errors when exchanging results with the OData endpoint. |
False |
✓ |
✓ |
✓ |
invantive-sql-forward-filters-to-data-containers |
Whether to forward filters to data containers. |
True |
✓ |
✓ |
✓ |
invantive-sql-shuffle-fetch-results-data-containers |
Whether to shuffle results fetched from data containers. |
False |
✓ |
✓ |
✓ |
invantive-use-cache |
Whether to cache the results of a query. |
True |
✓ |
✓ |
✓ |
join-set-points-per-request |
Maximum number of values in a request when executing a join set. |
60 |
✓ |
✓ |
✓ |
maximum-length-identifiers |
Non-default maximum length in characters of identifier names. |
|
✓ |
✓ |
✓ |
pre-request-delay-ms |
Pre-request delay in milliseconds per request. |
0 |
✓ |
✓ |
✓ |
requests-parallel-max |
Maximum number of parallel data requests from individual partitions on the data container. |
32 |
✓ |
✓ |
✓ |
slot-based-rate-limit-length-ms |
Length in ms of a slot-based rate limit. |
60000 |
✓ |
|
✓ |
slot-based-rate-limit-slots |
Number of slots of a slot-based rate limit. Null means no slot-based rate limit |
|
✓ |
|
✓ |
standardize-identifiers |
Rewrite all identifiers to the preferred standards as configured by standardize-identifiers-casing and maximum-length-identifiers. |
True |
✓ |
✓ |
✓ |
standardize-identifiers-casing |
Rewrite all identifiers to the recommended standard platform-specific casing when changing a data model on a case-dependent platform. |
True |
✓ |
✓ |
✓ |
trace-native-calls |
Trace native calls to data container backend. |
False |
✓ |
✓ |
✓ |
use-http-disk-cache-read |
Whether to use HTTP responses from previous queries stored on disk to answer the current query. |
True |
✓ |
✓ |
✓ |
use-http-disk-cache-write |
Whether to memorize HTTP responses on disk. |
True |
✓ |
✓ |
✓ |
use-http-memory-cache-read |
Whether to use HTTP responses from previous queries stored in memory that can answer the current query. |
True |
✓ |
✓ |
✓ |
use-http-memory-cache-write |
Whether to memorize HTTP responses from previous queries for use by future queries. |
True |
✓ |
✓ |
✓ |
Generated 11-01-2019 19:46 on version 17.30.0-PROD+1821.
