|
Using FreshBooks data access provider with UniDAC in Delphi |
|
|
|
Using FreshBooks data access provider with UniDAC in Delphi |
|
This article provides a brief overview of the FreshBooks cloud provider for UniDAC used to access FreshBooks from Delphi and Lazarus. You will find the description of some useful features and how to get started quickly.
Main features of FreshBooks cloud provider are:
The full list of Cloud provider features can be found on the UniDAC features page.
Both Professional and Standard Editions of UniDAC include the FreshBooks provider.
FreshBooks provider supports supports FreshBooks data types and API.
Applications that use the FreshBooks cloud provider require Devart ODBC Driver for FreshBooks to be installed on the client computer. The driver is sold and distributed separately from UniDAC.
When an application was built without runtime packages (Link with runtime packages set to False in Project Options), you do not need to deploy any BPL files with it. For more information, see Deployment.
Note that UniDAC Trial requires deployment of additional BPL files regardless of Link with runtime packages.
To connect to FreshBooks Classic using Devart ODBC Driver, you should configure the driver and set up a DSN. In the TUniConnection component, specify the following parameters:
For more information on how to obtain FreshBooks AuthenticationToken, see the article.
To connect to FreshBooks New using Devart ODBC Driver, you should configure the driver and set up a DSN. In the TUniConnection component, specify the following parameters:
For more information on how to request FreshBooks AccessToken, see the article.
Though UniDAC is components that provide a unified interface to work with various cloud services, it also lets you tune behaviour for each cloud individually. For thin setup of a certain cloud, UniDAC provides specific options. These options can be applied to such components as TUniConnection, TUniQuery, TUniTable, TUniStoredProc, TUniSQL, TUniScript via their SpecificOptions property. SpecificOptions is a sting list.
Below you will find the description of allowed options grouped by components.
| Option name | Description |
|---|---|
| ApiVersion |
Used to specify the required FreshBooks version. The available values are:
Classic
New
The default value is Classic.
|
| CacheMetadata |
Allows caching and storing metadata in a temporary database. The option settings specify the frequency of resetting cached metadata ranging from 1 hour to 1 month.
False
The metadata caching is disabled.
Hour
Cached metadata is reset once per hour.
Day
Cached metadata is reset once a day (i.e. every 24 hours).
Month
Cached metadata is reset once per month.
True
Metadata caching won't reset until the driver is unloaded.
|
| ConnectionTimeout | The time to wait for a connection to open before raising an exception. |
| UseUnicode | Enables or disables Unicode support. Affects character data fetched from the server. When set to True, all character data is stored as WideStrings, and TStringField is replaced by TWideStringFiled. |
| UTCDates | Use the UTCDates option to return the datetime values from the data source as UTC values. |
| Option name | Description |
|---|---|
| AuthenticationToken | Authentication token is used to securely connect to your FreshBooks account. |
| Option name | Description |
|---|---|
| AccessToken | Access token is used to securely connect to your FreshBooks account. |
| CompanyName | The company name used when creating a FreshBooks account. |
| RefreshToken | A refresh token allows an application to obtain a new access token without prompting the user. Only one FreshBooks refresh token can be valid at any time per user per application. |
| Option name | Description |
|---|---|
| ProxyPassword | If Proxy User authorization is used, specify Proxy user password in this option. |
| ProxyPort | Specify the Proxy port here. You can learn Proxy Port in the same way as described above for the host. |
| ProxyServer |
If you are using Proxy for connection to your network, specify the Proxy server address in this option. To learn your Proxy server address, open Control Panel->Internet Options->Connections->LAN settings. |
| ProxyUser | If Proxy User authorization is used, specify Proxy user name (ID) in this option. |
| Option name | Description |
|---|---|
| CommandTimeout | The time to wait for a statement to be executed. |
| Option name | Description |
|---|---|
| CommandTimeout | The time to wait for a statement to be executed. |
| ExtendedFieldsInfo | If True, an additional query is performed to get information about the returned fields and tables they belong to. The default value is False. |
| FetchAll |
If True, all records of a query are requested from database server when the dataset is being opened. If False, records are retrieved when a data-aware component or a program requests it. The default value is False. |
| FieldsAsString | If set to True, all non-BLOB fields are handled as strings. The default value is False. |
| UnknownAsString | If set to True, all FreshBooks data types that are fetched as text and don't have the size limit, are mapped to TStringField with the default size 8192 bytes. If False (default value), such types are mapped to TMemoField. The TEXT data type is always mapped to TMemoField regardless of the value of this option. |
The TUniScript component has no FreshBooks-specific options.
The TUniLoader component has no FreshBooks-specific options.
The TUniDump component has no FreshBooks-specific options.