SQL Driver for Freshdesk
Freshdesk is a cloud solution for customer management. Freshdesk includes CRM as well as tickets. Existing functionality of Freshdesk can be extended by custom fields. The Freshdesk driver covers 100 tables and 1610 columns.
## Freshdesk Clients
Invantive UniversalSQL is available on many user interfaces ("clients" in traditional server-client paradigma). All Invantive UniversalSQL statements can be exchanged with a close to 100% compatibility across all clients and operating systems (Windows, MacOS, Linux, iOS, Android).
The clients include Microsoft Excel, Microsoft Power BI, Microsoft Power Query, Microsoft Word and Microsoft Outlook. Web-based clients include Invantive Cloud, Invantive Bridge Online as OData proxy, Invantive App Online for interactive apps, Online SQL Editor for query execution and Invantive Data Access Point as extended proxy.
The [[https://cloud.invantive.com/freshdesk|Freshdesk Power BI connector]] is based on the Invantive UniversalSQL driver for Freshdesk, completed by a high-performance OData connector which works straight on Power BI without any add-on. The OData protocol is always version 4, independent whether the backing platform uses OData, SOAP or another protocol.
For technical users there are command-line editions of Invantive Data Hub running on iOS, Android, Windows, MacOS and Linux. Invantive Data Hub is also often used for enterprise server applications such as ETL. High-volume replication of data taken from the Freshdesk API into traditional databases such as SQL Server (on-premises and Azure), MySQL, PostgreSQL and Oracle is possible using [[https://cloud.invantive.com/data-replicator/|Invantive Data Replicator]]. Invantive Data Replicator automatically creates and maintains Freshdesk datawarehouses, possibly in combination with data from over 75 other (cloud) platforms. Invantive Data Replicator supports data volumes up to over 1 TB and over 5.000 companies. The on-premise edition of Invantive Bridge offers an Freshdesk ADO.net provider.
Finally, online web apps can be build for Freshdesk using App Online of [[https://cloud.invantive.com/freshdesk|Invantive Cloud]].
Monitor API Calls
When a query or DML-statement has been executed on Invantive UniversalSQL a developer can evaluate the actual calls made to Freshdesk using a query on sessionios@DataDictionary. As an alternative, extensive request and response logging can be enabled by setting log-native-calls-to-disk to true. In the %USERPROFILE%\Invantive\NativeLog folder Invantive UniversalSQL will create log files per Freshdesk request and response.
## Specifications
The SQL driver for Freshdesk does not support partitioning. Define one data container in a database for each company in Freshdesk to enable parallel access for data from multiple companies. An introduction into the concepts of Invantive UniversalSQL such as databases, data containers and partitioning can be found in the [[Grammar|Invantive UniversalSQL grammar]].
The configuration can be changed using various attributes from the database definition, on log on and during use. A full list of configuration options is listed in the [[Attributes|driver attributes]].
The catalog name is used to compose the full qualified name of an object like a table or view. The schema name is used to compose the full qualified name of an object like a table or view. On Freshdesk the comparison of two texts is case sensitive by default.
The driver has the following properties:
- Driver code for use in settings.xml: `Freshdesk`
- Recommended alias: `fdk`
- More technical documentation as provided by the supplier of Freshdesk on the native connection used can be found at [[https://developer.freshdesk.com/api/#quick-reference|Technical 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.
API Version
The V2 API of Freshdesk is used. V1 APIs can be accessed using NativePlatformScalarRequests.
Usage Limits
Invantive SQL executes API calls to retrieve and upload data. The number of API calls allowed per hour depends on your Freshdesk plan, API version and whether you have chosen for rate limits per minute (most recent) or hour (older). The V1 API default usage limit is 1.000 calls per hour. On V2 the limit is 3.000 (blossom, garden) or 5.000 (estate, forest) calls per hour. The new V2 limits are 100 (blossom), 200 (garden), 400 (estate) or 700 (forest) calls per minute. Increased limits can be purchased. Invantive SQL ensures that within your session the number of calls allowed per hour is not exceeded.
To get an impression of how Invantive SQL translates into API calls, please query the data dictionary view 'sessionios', such as with 'select * from sessionios@datadictionary'.
## Objects
Per object category a list is available:
- [[Tables]]
- [[Procedures]]