UniDAC

Using Zoho CRM data access provider with UniDAC in Delphi

This article provides a brief overview of the Zoho CRM cloud provider for UniDAC used to access Zoho CRM from Delphi and Lazarus. You will find the description of some useful features and how to get started quickly.

Overview

Main features of Zoho CRM 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 Zoho CRM cloud provider.

Compatibility

Zoho CRM cloud provider supports Zoho CRM data types and API.

Requirements

Applications that use the Zoho CRM cloud provider require Devart ODBC Driver for Zoho CRM to be installed on the client computer. The driver is sold and distributed separately from UniDAC.

Deployment

To deploy Win32 applications built with run-time packages, it is required to deploy the zohocrmproviderXX.bpl file.

For more information about deployment of the UniDAC-based applications, see the Deployment article.

Connecting

To connect to Zoho CRM 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 Zoho CRM AuthenticationToken, see the article.

Zoho CRM-specific options

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.

TUniConnection

Option name Description
AccessToken Access Token is deprecated now by Zoho CRM.
ApiVersion Used to specify the Zoho CRM API version. The choice of the API version will impact the syntax, output and methods available to you.

apiVer2
Zoho CRM API 2.0. will be used.

apiVer1
The default value. Zoho CRM API 1.0. is deprecated now by Zoho CRM.
AuthenticationToken Authentication Token is deprecated now by Zoho CRM.
ConnectionTimeout The time to wait for a connection to open before raising an exception.
RefreshToken The option is available when apiVer2 is chosen. Zoho CRM API access tokens are valid for only an hour. To generate a new access token, use the refresh token. Enter your refresh token in the field to refresh access tokens when they expire.
Server Specifies the URL to the Zoho CRM. Now the available domains are:
  • crm.zoho.com
  • crm.zoho.eu
  • crm.zoho.in
  • crm.zoho.com.cn
If the new ones appear, you can specify them by yourself in the connection string or in the Connection Editor dialog box.
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.

Proxy connection options

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.

TUniSQL

Option name Description
CommandTimeout The time to wait for a statement to be executed.

TUniQuery, TUniTable, TUniStoredProc

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 Zoho CRM 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.

TUniScript

The TUniDump component has no Zoho CRM-specific options.

TUniLoader

The TUniLoader component has no Zoho CRM-specific options.

TUniDump

The TUniDump component has no Zoho CRM-specific options.

© 1997-2020 Devart. All Rights Reserved. Request Support DAC Forum Provide Feedback