Zoho CRM Connector for SSIS

Zoho CRM Connector can be used to integrate Zoho CRM API in your App / BI Tools. You can exchange data on Accounts, Leads, Contacts and many other modules.

In this article you will learn how to quickly and efficiently integrate Zoho CRM data in SSIS without coding. We will use high-performance Zoho CRM Connector to easily connect to Zoho CRM and then access the data inside SSIS.

Let's follow the steps below to see how we can accomplish that!

Download Documentation

Video Tutorial - Integrate Zoho CRM data in SSIS

This video covers the following topics and more, so please watch carefully. After watching the video, follow the steps outlined in this article:

  • How to download and install the required PowerPack for Zoho CRM integration in SSIS
  • How to configure the connection for Zoho CRM
  • Features of the ZappySys API Source (Authentication / Query Language / Examples / Driver UI)
  • How to use the Zoho CRM in SSIS

Prerequisites

Before we begin, make sure the following prerequisites are met:

  1. SSIS designer installed. Sometimes it is referred as BIDS or SSDT (download it from Microsoft).
  2. Basic knowledge of SSIS package development using Microsoft SQL Server Integration Services.
  3. SSIS PowerPack is installed (if you are new to SSIS PowerPack, then get started!).

Read data from Zoho CRM in SSIS (Export data)

In this section we will learn how to configure and use Zoho CRM Connector in API Source to extract data from Zoho CRM.

  1. Begin with opening Visual Studio and Create a New Project.

  2. Select Integration Service Project and in new project window set the appropriate name and location for project. And click OK.

    In the new SSIS project screen you will find the following:

    • SSIS ToolBox on left side bar
    • Solution Explorer and Property Window on right bar
    • Control flow, data flow, event Handlers, Package Explorer in tab windows
    • Connection Manager Window in the bottom
    SSIS Project Screen
    Note: If you don't see ZappySys SSIS PowerPack Task or Components in SSIS Toolbox, please refer to this help link.
  3. Now, Drag and Drop SSIS Data Flow Task from SSIS Toolbox. Double click on the Data Flow Task to see Data Flow designer.

    SSIS Data Flow Task - Drag and Drop
  4. From the SSIS toolbox drag and API Source (Predefined Templates) on the data flow designer surface, and double click on it to edit it:

    SSIS API Source (Predefined Templates) - Drag and Drop
  5. Select New Connection to create a new connection:

    API Source - New Connection
  6. Use a preinstalled Zoho CRM Connector from Popular Connector List or press Search Online radio button to download Zoho CRM Connector. Once downloaded simply use it in the configuration:

    Zoho CRM
    Zoho CRM Connector Selection
  7. Now it's time to configure authentication. Firstly, configure authentication settings in Zoho CRM service and then proceed by configuring API Connection Manager. Start by expanding an authentication type:

    Zoho CRM authentication

    OAuth Connection for Zoho CRM API [API reference]

    To register custom App, perform the following steps (Detailed steps found in the help link at the end)
    1. Go to Zoho API Console
    2. Click Add Client link
    3. Select Server-based Applications option
    4. Enter desired client name (Display purpose only)
    5. Enter some URL for Company homepage
    6. 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.
    7. Click CREATE.
    8. Copy Client ID and Secret and paste on Zoho Connector UI.
    API Connection Manager configuration

    Just perform these simple steps to finish authentication configuration:

    1. Set Authentication Type to OAuth [OAuth]
    2. Optional step. Modify API Base URL if needed (in most cases default will work).
    3. Fill in all the required parameters and set optional parameters if needed.
    4. Press Generate Token button to generate the tokens.
    5. Finally, hit OK button:
    Zoho CRM
    OAuth [OAuth]
    https://www.zohoapis.com/crm/[$Version$]
    Optional Parameters
    ClientId
    ClientSecret
    Permissions ZohoCRM.settings.all ZohoCRM.modules.all ZohoCRM.coql.READ
    AccountUrl https://accounts.zoho.com
    RedirectUrl https://zappysys.com/oauth
    API Version v2
    RetryMode RetryWhenStatusCodeMatch
    RetryStatusCodeList 429
    RetryCountMax 5
    RetryMultiplyWaitTime True
    ZappySys OAuth Connection
  8. Select the desired endpoint, change/pass the properties values, and click on Preview Data button to make the API call.

    API Source - Zoho CRM
    Zoho CRM Connector can be used to integrate Zoho CRM API in your App / BI Tools. You can exchange data on Accounts, Leads, Contacts and many other modules.
    API Source - Select Endpoint

  9. That's it! We are done! Just in a few clicks we configured the call to Zoho CRM using Zoho CRM Connector.

    You can load the source data into your desired destination using the Upsert Destination , which supports SQL Server, PostgreSQL, and Amazon Redshift. We also offer other destinations such as CSV , Excel , Azure Table , Salesforce , and more . You can check out our SSIS PowerPack Tasks and components for more options. (*loaded in Trash Destination)

    Execute Package - Reading data from Zoho CRM and load into target

Write data to Zoho CRM using SSIS (Import data)

In this section we will learn how to configure and use Zoho CRM Connector in the API Destination to write data to Zoho CRM.

Video tutorial

This video covers following and more so watch carefully. After watching this video follow the steps described in this article.

  • How to download SSIS PowerPack for Zoho CRM integration in SSIS
  • How to configure connection for Zoho CRM
  • How to write or lookup data to Zoho CRM
  • Features about SSIS API Destination
  • Using Zoho CRM Connector in SSIS

Step-by-step instructions

In upper section we learned how to read data, now in this section we will learn how to configure Zoho CRM in the API Source to POST data to the Zoho CRM.

  1. Read the data from the source, being any desired source component. In example we will use ZappySys Dummy Data Source component.

  2. From the SSIS Toolbox drag and drop API Destination (Predefined Templates) on the Data Flow Designer surface and connect source component with it, and double click to edit it.
    SSIS API Destination (Predefined Templates) - Drag and Drop

  3. Select New Connection to create a new connection:

    API Destination - Zoho CRM
    Zoho CRM Connector can be used to integrate Zoho CRM API in your App / BI Tools. You can exchange data on Accounts, Leads, Contacts and many other modules.
    API Destination - New Connection

  4. Use a preinstalled Zoho CRM Connector from Popular Connector List or press Search Online radio button to download Zoho CRM Connector. Once downloaded simply use it in the configuration:

    Zoho CRM
    Zoho CRM Connector Selection

  5. Proceed with selecting the desired Authentication Type. Then select API Base URL (in most cases default one is the right one). Finally, fill in all the required parameters and set optional parameters if needed. You may press a link Steps to Configure which will help set certain parameters. More info is available in Authentication section.

    Zoho CRM authentication

    OAuth Connection for Zoho CRM API [API reference]

    To register custom App, perform the following steps (Detailed steps found in the help link at the end)
    1. Go to Zoho API Console
    2. Click Add Client link
    3. Select Server-based Applications option
    4. Enter desired client name (Display purpose only)
    5. Enter some URL for Company homepage
    6. 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.
    7. Click CREATE.
    8. Copy Client ID and Secret and paste on Zoho Connector UI.
    API Connection Manager configuration

    Just perform these simple steps to finish authentication configuration:

    1. Set Authentication Type to OAuth [OAuth]
    2. Optional step. Modify API Base URL if needed (in most cases default will work).
    3. Fill in all the required parameters and set optional parameters if needed.
    4. Press Generate Token button to generate the tokens.
    5. Finally, hit OK button:
    Zoho CRM
    OAuth [OAuth]
    https://www.zohoapis.com/crm/[$Version$]
    Optional Parameters
    ClientId
    ClientSecret
    Permissions ZohoCRM.settings.all ZohoCRM.modules.all ZohoCRM.coql.READ
    AccountUrl https://accounts.zoho.com
    RedirectUrl https://zappysys.com/oauth
    API Version v2
    RetryMode RetryWhenStatusCodeMatch
    RetryStatusCodeList 429
    RetryCountMax 5
    RetryMultiplyWaitTime True
    ZappySys OAuth Connection

  6. Select the desired endpoint, change/pass the properties values, and go to the Mappings tab to map the columns.

    API Destination - Zoho CRM
    Zoho CRM Connector can be used to integrate Zoho CRM API in your App / BI Tools. You can exchange data on Accounts, Leads, Contacts and many other modules.
    API Destination - Select Endpoint

  7. Finally, map the desired columns:

    API Destination - Zoho CRM
    Zoho CRM Connector can be used to integrate Zoho CRM API in your App / BI Tools. You can exchange data on Accounts, Leads, Contacts and many other modules.
    API Destination - Columns Mapping

  8. That's it; we successfully configured the POST API Call. In a few clicks we configured the Zoho CRM API call using ZappySys Zoho CRM Connector

    Execute Package - Reading data from API Source and load into target

Load Zoho CRM data into SQL Server using Upsert Destination (Insert or Update)

Once you configured the data source, you can load Zoho CRM data into SQL Server using Upsert Destination.

Upsert Destination can merge or synchronize source data with the target table. It supports Microsoft SQL Server, PostgreSQL, and Redshift databases as targets. Upsert Destination also supports very fast bulk upsert operation along with bulk delete.

Upsert operation - a database operation which performs INSERT or UPDATE SQL commands based on record's existence condition in the target table. It inserts records that don't have matching records in the target table or updates them, if they do, by matching them by key columns.

Upsert Destination supports INSERT, UPDATE, and DELETE operations, so it is similar to SQL Server's MERGE command, except it can be used directly in SSIS package.

  1. From the SSIS Toolbox drag-and-drop Upsert Destination component onto the Data Flow designer background.

  2. Connect your SSIS source component to Upsert Destination.

  3. Double-click on Upsert Destination component to open configuration window.

  4. Start by selecting the Action from the list.

  5. Next, select the desired target connection or create one by clicking <New [provider] Connection> menu item from the Target Connection dropdown.

  6. Then select a table from the Target Table list or click New button to create a new table based on the source columns.

  7. Continue by checking Insert and Update options according to your scenario (e.g. if Update option is unchecked, no updates will be made).

  8. Finally, click Map All button to map all columns and then select the Key columns to match the columns on:

    Configure SSIS Upsert Destination component to merge data with SQL Server, PostgreSQL, or Redshift table
  9. Click OK to save the configuration.

  10. Run the package and Zoho CRM data will be merged with the target table in SQL Server, PostgreSQL, or Redshift:

    Execute Package - Reading data from API Source and load into target
  11. Done!

Deploy and schedule SSIS package

After you are done creating SSIS package, most likely, you want to deploy it to SQL Server Catalog and run it periodically. Just follow the instructions in this article:

Running SSIS package in Azure Data Factory (ADF)

To use SSIS PowerPack in ADF, you must first prepare Azure-SSIS Integration Runtime. Follow this link for detailed instructions:

Actions supported by Zoho CRM Connector

Learn how to perform common Zoho CRM actions directly in SSIS with these how-to guides:

Conclusion

In this article we showed you how to connect to Zoho CRM in SSIS and integrate data without any coding, saving you time and effort.

We encourage you to download Zoho CRM Connector for SSIS and see how easy it is to use it for yourself or your team.

If you have any questions, feel free to contact ZappySys support team. You can also open a live chat immediately by clicking on the chat icon below.

Download Zoho CRM Connector for SSIS Documentation

More integrations

Other connectors for SSIS

All
Big Data & NoSQL
Database
CRM & ERP
Marketing
Collaboration
Cloud Storage
Reporting
Commerce
API & Files

Other application integration scenarios for Zoho CRM

All
Data Integration
Database
BI & Reporting
Productivity
Programming Languages
Automation & Scripting
ODBC applications