Zoho CRM

1 Authenticating to Zoho CRM

The provider is already registered with Zoho CRM as an OAuth application. As such,

You can connect without setting any connection properties for your user credentials. After setting the following, you are ready to connect: InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken. When you connect the provider opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The provider then completes the OAuth process.

1. Extracts the access token from the callback URL and authenticates requests.

2. Obtains a new access token when the old one expires.

3. Saves OAuth values in OAuthSettingsLocation to be persisted across connections.

If you prefer to use your own custom OAuth app:

Before you get started with authorization and make any calls to the Zoho CRM API, you need to register your application with Zoho CRM. You can follow the procedure below to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties.

1. Go to accounts.zoho.com/developerconsole

2. Click Add Client, then Server-Based Application

3. Enter the client name, homepage URL, and redirect URL.

4. If you are connecting from a desktop application, set the callback URL to http://localhost:33333, or another port number of your choice.

If you are connecting from a Web application, set the callback URL you want to be used as a trusted redirect URL, where the user will return with the token that verifies that they have granted your app access.

1. Click Create.

After setting the following connection properties, you are ready to connect:

• InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken connection property.

• OAuthClientId: Set this to the client Id you defined for your OAuth app.

• OAuthClientSecret: Set this to the client secret you defined for your OAuth app.

• CallbackURL: Set this to the callback URL you defined for your OAuth app.

When you connect, the provider opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The provider then completes the OAuth process:

1. Extracts the access token from the callback URL and authenticates requests.

2. Obtains a new access token when the old one expires.

3. Saves OAuth values in OAuthSettingsLocation to be persisted across connections.

The Zoho CRM provider defaults UseServerSideFiltering to True for higher performance, though it may return incorrect results.

2 Connection Properties

The following are the connection properties for ZohoCRM. Not all properties are required. Enter only property values pertaining to your installation. Several properties will be automatically initialized with the appRules defaults.

Property	Description
Firewall
FirewallPassword	A password used to authenticate to a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallType	The protocol used by a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
Logging
Logfile	A path to the log file.
MaxLogFileCount	A string specifying the maximum file count of log files. When the limit is hit, a new log is created in the same folder with the date and time appended to the end and the oldest log file will be deleted.
MaxLogFileSize	A string specifying the maximum size in bytes for a log file (for example, 10 MB). When the limit is hit, a new log is created in the same folder with the date and time appended to the end.
Verbosity	The verbosity level that determines the amount of detail included in the log file.
Misc
ConnectionLifeTime	The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed.
ConnectionString	***
MaxRows	Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
Other	These hidden properties are used only in specific use cases.
PoolIdleTimeout	The allowed idle time for a connection before it is closed.
PoolMaxSize	The maximum connections in the pool.
PoolMinSize	The minimum number of connections in the pool.
PoolWaitTime	The max seconds to wait for an available connection.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Readonly	You can use this property to enforce read-only access to Zoho CRM from the provider.
SSLServerCert	The certificate to be accepted from the server when connecting using TLS/SSL.
SupportEnhancedSQL	This property enhances SQL functionality beyond what can be supported through the API directly, by enabling in-memory client-side processing.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UseConnectionPooling	This property enables connection pooling.
Miscellaneous
Domain	Determines the domain where authentication calls will be sent to.
IncludeCustomViews	If set to true, the provider will display custom views among the other views and make them available for use.
UseDisplayNames	If set to false, the provider will use api names for some operations.
UseSandbox	Determines whether the calls will be sent to a Sandbox instance instead of a regular one.
UseServerSideFiltering	If set to false, the provider will not send the filters server-side but will process them client-side.
UseSimpleNames	Boolean determining if simple names should be used for tables and columns.
OAuth
CallbackURL	The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.
InitiateOAuth	Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.
OAuthAccessToken	The access token for connecting using OAuth.
OAuthClientId	The client ID assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.
OAuthRefreshToken	The OAuth refresh token for the corresponding OAuth access token.
OAuthSettingsLocation	The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, this can be held in memory by specifying a value starting with memory://.
OAuthVerifier	The verifier code returned from the OAuth authorization URL.
Proxy
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyAutoDetect	This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
ProxyExceptions	A semicolon separated list of hosts or IPs that are exempt from connecting through the ProxyServer .
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.