Zoho CRM

Connection Dialog

For connecting to Zoho CRM, Devart Excel Add-ins support Zoho CRM API v8 (Preferred) and API v2 (Deprecated).

To connect to Zoho CRM, you need to specify the following parameters:

•	Authentication Type - The authentication method to use.

•	API Version - The version of Zoho CRM API to use.

•	Domain - The Zoho CRM domain to connect to. The possible values are:

▪	crm.zoho.com

▪	crm.zoho.eu

▪	crm.zoho.in

▪	crm.zoho.com.cn

▪	crm.zoho.com.au

•	Refresh Token - Zoho CRM OAuth 2.0 refresh token used to obtain new access tokens when the current access token expires. This parameter is filled automatically when you perform Web Login.

•	Client ID - A unique identifier provided to every Zoho CRM client application when the application is registered with Zoho. This parameter is filled automatically when you perform Web Login.

•	Client Secret - A secret code assigned to a Zoho CRM client application and used together with the Client ID for OAuth authentication. This parameter is filled automatically when you perform Web Login.

OAuth Interactive authentication

OAuth Interactive authentication uses the authorization code flow with user sign-in in a browser window. This method enables you to obtain a refresh token without requiring a security token or manually entering the client ID and client secret.

To connect with the OAuth Interactive authentication:

1. In Authentication Type, select OAuthInteractive.

2. In API Version, select the API version to use—Preferred (v8) or Deprecated (v2).

3. In Domain, select the Zoho CRM domain for your account.

4. Click Sign In.

Import Data Wizard: Sign in

5. In the browser window, sign in to Zoho CRM with your username and password.

Sign in to your Zoho account.png

6. In the authorization window, grant Devart Excel Add-ins the requested permissions.

Grant permissions

7. Optional: To specify how connection data is saved and reused in Excel, configure the connection saving options. For more information, see Connecting and Importing Data.

8. Optional: To configure advanced connection options, click Advanced.

9. Optional: To verify that the connection details are valid, click Test Connection.

10. Click Next.

Import Data Wizard: Client credentials filled in

Advanced Connection Options

The following table describes the options that you can include in the Connection String using the Advanced Connection Editor dialog box:

Option

Description

API Version

Specifies the version of Zoho CRM API to use: Preferred (API v8) or Deprecated (API v2).

Authentication Type

Specifies the authentication method used to connect to Zoho CRM, such as API Key or OAuth 2.0.

Bulk Read

Determines whether to use the Zoho CRM Bulk Read API for querying large data volumes.

Client Id

Specifies a unique identifier provided to every Zoho CRM client application when the application is registered with Zoho. This parameter is filled automatically when you perform Web Login.

Client Secret

Specifies a secret code assigned to a Zoho CRM client application and used together with the Client ID for OAuth authentication. This parameter is filled automatically when you perform Web Login.

Connection Lifetime

Specifies the time span (in seconds), compared against a connection's creation time when it is returned to the pool; the connection is destroyed if this span is exceeded. The default value is 0 (connection always returns to pool).

Connection Timeout

Specifies the length of time (in seconds) to wait for a connection to the server before terminating the attempt and generating an error. The default value is 60.

Default Command Timeout

Specifies the time in seconds to wait while trying to execute a command before terminating the attempt and generating an error.

Domain

Specifies the Zoho CRM domain base URL. The possible values are:

•	crm.zoho.com

•	crm.zoho.eu

•	crm.zoho.in

•	crm.zoho.com.cn

•	crm.zoho.com.au

Enable Non Approved Records

Determines whether to include records that have not yet been approved in the returned results.

Failover Retries

Specifies the number of retry attempts to automatically re-run a command before displaying an error message in case when the command failed because of an error that may be temporary.

Initialization Command

Specifies a database-specific command to execute after establishing the connection.

Local SQL Engine

Determines whether to use local SQL engine for SELECT queries, that are too complex to translate them directly to Zoho CRM API calls or to show an error message.

Max Pool Size

Specifies the maximum number of connections allowed in the pool. Setting the Max Pool Size value in the connection string can affect performance. The default value is 100.

Min Pool Size

Specifies the minimum number of connections allowed in the pool. The default value is 0.

NormalizeDbNames

Determines whether database object names are normalized when retrieved from the database.

Persist Security Info

Indicates if security-sensitive information, such as the password, is not returned as part of the connection if the connection is open or has ever been in an open state.

Pooling

Draws the connection from the appropriate pool, or creates and adds it to the appropriate pool, when set to true. This is the default behavior.

Proxy Host

Specifies the host name or IP address of the proxy server.

Proxy Password

Specifies the password for the proxy server account.

Proxy Port

Specifies the port number of the proxy server. The default value is 3128.

Proxy User

Specifies the proxy server account name.

Query API

Determines whether to use the Zoho CRM Query API (COQL) to execute complex queries against Zoho CRM data.

Readonly

Indicates whether the connection is read-only (allows only SELECT statements).

Refresh Token

Specifies the Zoho CRM OAuth 2.0 refresh token used to obtain new access tokens when the current access token expires. This parameter is filled automatically when you perform Web Login.

Run Once Command

Specifies a database-specific command to execute after establishing the connection. Unlike Initialization Command, it is not executed for connections obtained from the connection pool.

SuppressExtendedRequests

Determines whether to suppress additional API requests required to retrieve extended data for Zoho CRM objects..

Token Server

Specifies the path to a file to store the refresh token between sessions. This parameter is specified automatically when performing web login, and in most cases there is no need to modify it. If you want, you may specify a custom path to use instead of the default one.

Use Display Name For Custom Tables

Determines whether display names are used to access custom Zoho CRM modules instead of the module names.

Use Display Name For Tables

Determines whether display names are used to access standard Zoho CRM modules instead of the module names.

UTC Dates

Converts dates to UTC format during import when set to True; the date values entered in Excel are then considered UTC dates when saving them to the data source.