Zoho Books

ExpandedToggleIcon        Connection Dialog

For connecting to Zoho Books, Devart Excel Add-ins requires you to have corresponding Zoho account credentials.

 

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

1.Data Center - select the data center your data is located in. The list of available data centers includes:
▪US
▪Europe
▪China
▪India
▪Australia
▪Japan
▪UK
▪Canada
2.Organization ID - your unique Organization ID for connecting to Zoho Books.
3.Refresh Token - renewable access token. Sign in with Zoho Books, the token will be assigned automatically.

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

Authentication Type

Specifies the authentication method to use when connecting to Zoho Books.

Client Id

Specifies the client ID of the OAuth app registered for connecting to Zoho Books.

Client Secret

Specifies the client secret of the OAuth app registered for connecting to Zoho Books.

Connection Lifetime

Specifies the maximum age of a connection (in seconds). When a connection is returned to the pool, its age is compared to this value. If the age exceeds the specified lifetime, the connection is destroyed; otherwise, it is returned to the pool. The default value is 0, which means connections are always returned to the 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.

Data Center

Specifies the Zoho Books data center location. The possible values are:

▪U.S.
▪Europe
▪China
▪India
▪Australia
▪Japan
▪UK
▪Canada

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

OrganizationID

Specifies your unique Organization ID for connecting to Zoho Books.

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.

Readonly

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

Refresh Token

Specifies the Zoho Books OAuth refresh token, used for connecting via API v2.

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.

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.