Zoho CRM

ExpandedToggleIcon        Connection Dialog

For connecting to Zoho CRM, Devart Excel Add-ins support both API v1 and API v2. Note that Zoho CRM API v1 will be deprecated on Dec 31, 2018.

 

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

1.Domain - select the domain to connect to. The list of available domains includes:
crm.zoho.com
crm.zoho.eu
crm.zoho.in
crm.zoho.com.cn
crm.zoho.com.au
2.API version - the version of Zoho API to use.
3.Zoho time zone - the timezone that is specified in your Zoho CRM account settings.

 

For API v2, you need to click Web Login, and sign in to Zoho CRM. The necessary token is assigned automatically.

For API v1, you also need to specify Authentication Token - the automatically generated key that is used for logging in to Zoho CRM from an untrusted network. API v1 have already reached End-of-Life, and new API v1 tokens cannot be generated any more.
 

 

In addition to the required options, Advanced connection options may be set for more fine connection tuning.

 

ExpandedToggleIcon        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

The version of Zoho CRM API to use.

Client Id

A unique identifier provided to every Zoho CRM client application when a Zoho CRM client application is registered with Zoho. This parameter is used for connecting via API v2, and is filled automatically when you perform Web Login.

Client Secret

A secret code, mapped to a Zoho CRM client application. This parameter is used for connecting via API v2, and is filled automatically when you perform Web Login.

Connection Lifetime

When a connection is returned to the pool, its creation time is compared with the current time, and the connection is destroyed if that time span (in seconds) exceeds the value specified by Connection Lifetime. The default value is 0 (connection always returns to pool).

Connection Timeout

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 15.

Default Command Timeout

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

Domain

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

Failover Retries

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.

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

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

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

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

If true, by default, the connection is drawn from the appropriate pool or is created and added to the appropriate pool.

Proxy Host

The host name or IP address of proxy server.

Proxy Password

The password for the proxy server account.

Proxy Port

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

Proxy User

The proxy server account name.

Readonly

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

Refresh Token

Zoho CRM OAuth refresh token, used for connecting via API v2.

Security Token

Zoho CRM Authentication Token, used for connecting via API v1.

Token Server

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.

Trigger Workflow

Determines whether to trigger the workflow rule when inserting or updating data.

Upgrade Cache

Determines whether to upgrade the local cache database or to throw an exception in case when Devart Excel Add-ins version that uses a newer cache structure or newer version of Zoho CRM API discovers an old incompatible cache for the connection that is opening.

Use Display Name For Custom Tables

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

UTC Dates

If set to True, dates will be converted to UTC format during import, and the date values entered in Excel are considered UTC dates when saving them to the data source.

Zoho Time Zone

The timezone that is specified in your Zoho CRM account settings.