Zoho CRM Connector for Talend Studio
In this article you will learn how to integrate
Using Zoho CRM Connector you will be able to connect, read, and write data from within Talend Studio. Follow the steps below to see how we would accomplish that. The driver mentioned above is part of ODBC PowerPack which is a collection of high-performance Drivers for various API data source (i.e. REST API, JSON, XML, CSV, Amazon S3 and many more). Using familiar SQL query language you can make live connections and read/write data from API sources or JSON / XML / CSV Files inside SQL Server (T-SQL) or your favorite Reporting (i.e. Power BI, Tableau, Qlik, SSRS, MicroStrategy, Excel, MS Access), ETL Tools (i.e. Informatica, Talend, Pentaho, SSIS). You can also call our drivers from programming languages such as JAVA, C#, Python, PowerShell etc. If you are new to ODBC and ZappySys ODBC PowerPack then check the following links to get started. |
Connect to Zoho CRM in other apps
|
Create Data Source in ZappySys Data Gateway based on API Driver
-
Download and install ZappySys ODBC PowerPack.
-
Search for gateway in start menu and Open ZappySys Data Gateway:
-
Go to Users Tab to add our first Gateway user. Click Add; we will give it a name tdsuser and enter password you like to give. Check Admin option and click OK to save. We will use these details later when we create linked server:
-
Now we are ready to add a data source. Click Add, give data source a name (Copy this name somewhere, we will need it later) and then select Native - ZappySys API Driver. Finally, click OK. And it will create the Data Set for it and open the ZS driver UI.
ZohoCrmDSN
-
When the Configuration window appears give your data source a name if you haven't done that already, then select "Zoho CRM" from the list of Popular Connectors. If "Zoho CRM" is not present in the list, then click "Search Online" and download it. Then set the path to the location where you downloaded it. Finally, click Continue >> to proceed with configuring the DSN:
ZohoCrmDSNZoho CRM -
Now it's time to configure the Connection Manager. Select Authentication Type, e.g. Token Authentication. Then select API Base URL (in most cases, the default one is the right one). More info is available in the Authentication section.
OAuth Connection for Zoho CRM API [API Help..]
Steps to get Zoho CRM Credentials : OAuth [OAuth]
To register custom App, perform the following steps (Detailed steps found in the help link at the end)- Go to Zoho API Console
- Click Add Client link
- Select Server-based Applications option
- Enter desired client name (Display purpose only)
- Enter some URL for Company homepage
- For Authorized Redirect URI enter https://zappysys.com/oauth (Or enter your own but we recommend using ZappySys one if possible). This URL must match on Zoho Connector UI.
- Click CREATE.
- Copy Client ID and Secret and paste on Zoho Connector UI.
Fill in all required parameters and set optional parameters if needed:
ZohoCrmDSNZoho CRMOAuth [OAuth]https://www.zohoapis.com/crm/[$Version$]Required Parameters Optional Parameters ClientId Fill in the parameter... ClientSecret Fill in the parameter... Permissions Fill in the parameter... AccountUrl Fill in the parameter... RedirectUrl Fill in the parameter... API Version Fill in the parameter... RetryMode Fill in the parameter... RetryStatusCodeList Fill in the parameter... RetryCountMax Fill in the parameter... RetryMultiplyWaitTime Fill in the parameter... -
Once the data source has been configured, you can preview data. Select the Preview tab and use settings similar to the following to preview data:
-
Click OK to finish creating the data source.
Read Zoho CRM data in Talend Studio
To read Zoho CRM data in Talend Studio, we'll need to complete several steps. Let's get through them all right away!
Create connection for input
- First of all, open Talend Studio
- Create a new connection:
- Select Microsoft SQL Server connection:
- Name your connection:
-
Fill-in connection parameters and then click Test connection:
ZohoCrmDSN
-
If the List of modules not installed for this operation window shows up, then download and install all of them:
Review and accept all additional module license agreements during the process
- Finally, you should see a successful connection test result at the end:
Add input
- Once we have a connection to ZappySys Data Gateway created, we can proceed by creating a job:
- Simply drag and drop ZappySys Data Gateway connection onto the job:
- Then create an input based on ZappySys Data Gateway connection:
- Continue by configuring a SQL query and click Guess schema button:
- Finish by configuring the schema, for example:
Add output
We are ready to add an output. From Palette drag and drop a tFileOutputDelimited output and connect it to the input:Run the job
Finally, run the job and integrate your Zoho CRM data:Advanced topics
Create Custom Stored Procedure in ZappySys Driver
You can create procedures to encapsulate custom logic and then only pass handful parameters rather than long SQL to execute your API call.
Steps to create Custom Stored Procedure in ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here
-
Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
-
Enter the desired Procedure name and click on OK:
-
Select the created Stored Procedure and write the your desired stored procedure and Save it and it will create the custom stored procedure in the ZappySys Driver:
Here is an example stored procedure for ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here
CREATE PROCEDURE [usp_get_orders] @fromdate = '<<yyyy-MM-dd,FUN_TODAY>>' AS SELECT * FROM Orders where OrderDate >= '<@fromdate>';
-
That's it now go to Preview Tab and Execute your Stored Procedure using Exec Command. In this example it will extract the orders from the date 1996-01-01:
Exec usp_get_orders '1996-01-01';
-
Let's generate the SQL Server Query Code to make the API call using stored procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.
SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC usp_get_orders @fromdate=''1996-07-30''')
-
Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.
Create Custom Virtual Table in ZappySys Driver
ZappySys API Drivers support flexible Query language so you can override Default Properties you configured on Data Source such as URL, Body. This way you don't have to create multiple Data Sources if you like to read data from multiple EndPoints. However not every application support supplying custom SQL to driver so you can only select Table from list returned from driver.
If you're dealing with Microsoft Access and need to import data from an SQL query, it's important to note that Access doesn't allow direct import of SQL queries. Instead, you can create custom objects (Virtual Tables) to handle the import process.
Many applications like MS Access, Informatica Designer wont give you option to specify custom SQL when you import Objects. In such case Virtual Table is very useful. You can create many Virtual Tables on the same Data Source (e.g. If you have 50 URLs with slight variations you can create virtual tables with just URL as Parameter setting.
-
Go to Custom Objects Tab and Click on Add button and Select Add Table:
-
Enter the desired Table name and click on OK:
-
And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.
-
Select the created table, Select Text Type AS SQL and write the your desired SQL Query and Save it and it will create the custom table in the ZappySys Driver:
Here is an example SQL query for ZappySys Driver. You can insert Placeholders also. Read more about placeholders here
SELECT "ShipCountry", "OrderID", "CustomerID", "EmployeeID", "OrderDate", "RequiredDate", "ShippedDate", "ShipVia", "Freight", "ShipName", "ShipAddress", "ShipCity", "ShipRegion", "ShipPostalCode" FROM "Orders" Where "ShipCountry"='USA'
-
That's it now go to Preview Tab and Execute your custom virtual table query. In this example it will extract the orders for the USA Shipping Country only:
SELECT * FROM "vt__usa_orders_only"
-
Let's generate the SQL Server Query Code to make the API call using stored procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.
SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC [usp_get_orders] ''1996-01-01''')
-
Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.
Actions supported by Zoho CRM Connector
Zoho CRM Connector support following actions for REST API integration. If some actions are not listed below then you can easily edit Connector file and enhance out of the box functionality.Parameter | Description |
---|---|
sql_query |
|
Parameter | Description |
---|
Parameter | Description | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
module |
|
Parameter | Description | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
module |
|
Parameter | Description | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
module |
|
||||||||||||||||||||||||||||||||||||||||
Tag Id |
|
Parameter | Description | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
module |
|
||||||||||||||||||||||||||||||||||||||||
Record Id(s) (comma seperated list) |
|
||||||||||||||||||||||||||||||||||||||||
Tag Id |
|
||||||||||||||||||||||||||||||||||||||||
Overwrite |
|
Parameter | Description | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
module |
|
Parameter | Description |
---|---|
module |
|
Parameter | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|
Module |
|
||||||||
Last Modified Date - Read data modified after it |
|
||||||||
Custom View ID |
|
||||||||
Fields (Only for V2 API) |
|
||||||||
sort_by |
|
||||||||
sort_order |
|
||||||||
territory_id |
|
||||||||
include_child |
|
||||||||
converted |
|
Parameter | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|
Module |
|
||||||||
Last Modified Date - Read data modified after it |
|
||||||||
Custom View ID |
|
||||||||
Fields (Only for V2 API) |
|
||||||||
sort_by |
|
||||||||
sort_order |
|
||||||||
territory_id |
|
||||||||
include_child |
|
||||||||
converted |
|
Parameter | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Search By Criteria Expression |
|
||||||||||||||||
Search By Email |
|
||||||||||||||||
Search By Phone |
|
||||||||||||||||
Search By any Word |
|
||||||||||||||||
Search By Id |
|
||||||||||||||||
Include only converted records |
|
||||||||||||||||
Include approved records |
|
Parameter | Description | ||||||
---|---|---|---|---|---|---|---|
Record ID(s) - Use Comma for multiple (e.g. 111,222) |
|
||||||
Fire Wordflow Trigger |
|
Parameter | Description |
---|---|
Triggers |
|
Parameter | Description |
---|---|
Triggers |
|
Parameter | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|
Triggers |
|
||||||||
Duplicate_Check_Fields |
|
Parameter | Description |
---|---|
Url |
|
Body |
|
IsMultiPart |
|
Filter |
|
Headers |
|
Zoho CRM Connector Examples for Talend Studio Connection
This page offers a collection of SQL examples designed for seamless integration with the ZappySys API ODBC Driver under ODBC Data Source (36/64) or ZappySys Data Gateway, enhancing your ability to connect and interact with Prebuilt Connectors effectively.
Read all rows [Read more...]
SELECT * from Accounts
Update Owner of the record(s) - Account, Contacts, Deals, Leads (Update Lookup field) [Read more...]
This examples shows how to update a lookup type fields (e.g. Account, Contact, Owner) for any module. Lookup fields are jsonobject type of fields which has id, name and sometimes email (only for Owner). This example shows how to update using unique field (E.g. email, id or name). Below example shows how to set Owner of the Account (e.g.) 1558554000137221573. We will set owner to bob-the-salesman@abc.com (or you can set by id)
UPDATE Accounts
SET Owner='{email: "bob-the-salesman@abc.com"}'
--SET Owner='{id: "1558554000186378001"}' --you can also use Id
Where Id='1558554000137221573'
Update Account or Contact (Lookup field) by Name or Id for Deals [Read more...]
This examples shows how to update Account and Contact field on Deals module. We used name for account and id for contact just to show how unique field can be used.
UPDATE Deals
SET Account_Name='{"name": "Company ABCD"}', --by name or id
Contact_Name='{"id": "1558554000186378001"}' --by id
Where Id='1558554000137221573'
Create a Deal with Lookup fields (e.g. set Account, Contact, Owner etc by Id or Name) [Read more...]
This examples shows how to create a new record with Lookup field(s) e.g account, contact or owner.
INSERT INTO Deals(
Deal_name,
Amount,
Lead_Source,
Account_Name,
Contact_Name,
Owner
)
VALUES
(
'My Test Deal Creatyed on <<FUN_NOW>>', --deal name
1000.50, --amount
'Cold Call', --lead source
'{name:"ZappySys"}', --account name or use id '{id:"1558554000030180013"}'
'{id:"1558554000089352998"}' --contact id
'{id:"1558554000089352912"}' --owner id or use email {email: "bob-the-salesman@abc.com"}
)
Read single row by ID [Read more...]
SELECT * from Accounts Where Id=1558554000105110008
Read reacord(s) modified after certain date [Read more...]
SELECT * from Accounts WITH(ModifiedSince = '2020-01-07T00:00:00')
Read using COQL (Zoho Serverside Query Language) [Read more...]
You can write server side query so you dont have to read full data on client side. For COQL LIMIT clause must be 200 or less. For more information check this URL https://zappysys.com/links?url=https://www.zoho.com/crm/developer/docs/api/COQL-Overview.html
SELECT * from get_module_data_coql WITH(sql_query= 'select Last_Name, First_Name, Company from Leads where Company like ''Test'' limit 200')
Update table for specific record [Read more...]
Update Leads SET Designation='VP Sales', Company='Test' Where id=1558554000012181009
Update table for specific record (older version) [Read more...]
Update Leads SET id='1558554000012181009' /* id must be supplied */, Designation='VP Sales', Company='Test'
Get accounts modified after certain date [Read more...]
SELECT * from Accounts Where Account_Name LIKE 'Test%' WITH(ModifiedSince = '2020-01-07T00:00:00')
Search accounts by specific field (server side filter) [Read more...]
You can use criteria listed here https://www.zoho.com/crm/developer/docs/api/v2/search-records.html
SELECT * FROM search_Accounts WITH(criteria='Account_Name:starts_with:test')
Create a new record [Read more...]
INSERT INTO Accounts(Account_Name, Phone) VALUES('Company ABC','111-567-8888')
Create a new account record (with show output on / off) [Read more...]
INSERT INTO Accounts(Account_Name, Phone) VALUES('Company ABC','111-567-8888') WITH(Output=1)
Delete single record by Id [Read more...]
Delete exising record by Id (single row). You can supply upto 100 comma seperated Ids
DELETE FROM Accounts WHERE id=11111111111
Delete multiple records by Ids [Read more...]
This example shows how to delete Account Records by multiple Ids. You can supply upto 100 comma seperated Ids
DELETE FROM Accounts WITH(Id='11111,22222,33333')
Upsert account record (Update or Insert - based on unique field(s) for module) [Read more...]
UPSERT INTO Accounts(Account_Name, Phone) VALUES('Company ABC','111-567-8888') WITH(Output=1)
Upsert lead record (Update or Insert - based on unique field(s) for module) [Read more...]
UPSERT INTO Leads(Last_Name, Email) VALUES('Patel','zpatel@abc.com') WITH(Output=1)
Create new account(s) in BULK (read / write from external source) [Read more...]
This examples shows how to use SOURCE clause to read data from MS SQL Server (or other external system) and send data to Zoho using Bulk API
INSERT INTO Accounts
SOURCE(
'MSSQL' --ODBC or OLEDB
,'Data Source=localhost;Initial Catalog=Test;Integrated Security=true'
,'select ''Test Account-A'' as Account_Name,''111-111-1111'' as Phone
UNION
select ''Test Account-B'' as Account_Name,''222-222-2222'' as Phone
'
)
UPSERT (Update or insert) account(s) in BULK (read / write from external source) [Read more...]
This examples shows how to use SOURCE clause to read data from MS SQL Server (or other external system) and send data to Zoho using Bulk API. Record uniqueness is checked based on Unique field setup for module (i.e. email, account name, phone etc)
UPSERT INTO Accounts
SOURCE(
'MSSQL' --ODBC or OLEDB
,'Data Source=localhost;Initial Catalog=Test;Integrated Security=true'
,'select ''Test Account-A'' as Account_Name,''111-111-1111'' as Phone
UNION
select ''Test Account-B'' as Account_Name,''222-222-2222'' as Phone
'
)
Update Tag(s) for exising records (add or overwrite) [Read more...]
SELECT * FROM post_tags
WITH(
module='Accounts'
, ids='1558554000105151002'
, tag_names='mytag1,mytag2'
, over_write='true'
)
Conclusion
In this article we discussed how to connect to Zoho CRM in Talend Studio and integrate data without any coding. Click here to Download Zoho CRM Connector for Talend Studio and try yourself see how easy it is. If you still have any question(s) then ask here or simply click on live chat icon below and ask our expert (see bottom-right corner of this page).
Download Zoho CRM Connector for Talend Studio
Documentation
More integrations
Other application integration scenarios for Zoho CRM
Other connectors for Talend Studio
Download Zoho CRM Connector for Talend Studio
Documentation
How to connect Zoho CRM in Talend Studio?
How to get Zoho CRM data in Talend Studio?
How to read Zoho CRM data in Talend Studio?
How to load Zoho CRM data in Talend Studio?
How to import Zoho CRM data in Talend Studio?
How to pull Zoho CRM data in Talend Studio?
How to push data to Zoho CRM in Talend Studio?
How to write data to Zoho CRM in Talend Studio?
How to POST data to Zoho CRM in Talend Studio?
Call Zoho CRM API in Talend Studio
Consume Zoho CRM API in Talend Studio
Zoho CRM Talend Studio Automate
Zoho CRM Talend Studio Integration
Integration Zoho CRM in Talend Studio
Consume real-time Zoho CRM data in Talend Studio
Consume real-time Zoho CRM API data in Talend Studio
Zoho CRM ODBC Driver | ODBC Driver for Zoho CRM | ODBC Zoho CRM Driver | SSIS Zoho CRM Source | SSIS Zoho CRM Destination
Connect Zoho CRM in Talend Studio
Load Zoho CRM in Talend Studio
Load Zoho CRM data in Talend Studio
Read Zoho CRM data in Talend Studio
Zoho CRM API Call in Talend Studio