Connection String Options
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.
For more information on establishing a connection, see Basic Tab.
| Property | Description |
| Region | The Top-level domain in the Server URL. |
| Property | Description |
| InitiateOAuth | Set this property to initiate the process to obtain or refresh the OAuth access token when you connect. |
| 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. |
| OAuthAccessToken | The access token for connecting using OAuth. |
| OAuthSettingsLocation | The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH . Alternatively, you can hold this location in memory by specifying a value starting with 'memory://'. |
| CallbackURL | The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings. |
| OAuthVerifier | The verifier code returned from the OAuth authorization URL. |
| OAuthRefreshToken | The OAuth refresh token for the corresponding OAuth access token. |
| OAuthExpiresIn | The lifetime in seconds of the OAuth AccessToken. |
| OAuthTokenTimestamp | The Unix epoch timestamp in milliseconds when the current Access Token was created. |
| Property | Description |
| SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| FirewallType | The protocol used by a proxy-based firewall. |
| FirewallServer | The name or IP address of a proxy-based firewall. |
| FirewallPort | The TCP port for a proxy-based firewall. |
| FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
| FirewallPassword | A password used to authenticate to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | This indicates whether to use the system proxy settings or not. |
| ProxyServer | The hostname or IP address of a proxy to route HTTP traffic through. |
| ProxyPort | The TCP port the ProxyServer proxy is running on. |
| ProxyAuthScheme | The authentication type to use to authenticate to the ProxyServer proxy. |
| ProxyUser | A user name to be used to authenticate to the ProxyServer proxy. |
| ProxyPassword | A password to be used to authenticate to the ProxyServer proxy. |
| ProxySSLType | The SSL type to use when connecting to the ProxyServer proxy. |
| ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . |
| Property | Description |
| LogModules | Core modules to be included in the log file. |
| Property | Description |
| Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
| Schema | The type of schema to use. |
| Property | Description |
| AccountsServer | The full Account Server URL. |
| AggregateColumnSize | Sets the length of a aggregate field for a provider. |
| APIDomain | The full URL of the API domain. |
| IncludeCustomViews | If set to true, the provider will display custom views among the other views and make them available for use. |
| IncludeRelatedLists | If set to true, the provider will display related List views among the other views and make them available for use. |
| MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
| Other | These hidden properties are used only in specific use cases. |
| PageSize | The number of results to return per page of data retrieved from Zoho CRM. |
| Readonly | You can use this property to enforce read-only access to Zoho CRM from the provider. |
| Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
| UseCOQL | Determines whether to use Query API. |
| UseDisplayNames | If set to false, the provider will use api names for some operations. |
| UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
| 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. |