In this article we’re going to focus on load data in Salesforce using SSIS (Bulk Insert, Update, Delete and Upsert). If you like to know how to read from Salesforce then refer to previous post here. For Demo purpose we will use AdventuresWorks sample database as our source but you can use your own Database for testing.

Salesforce developer account

To develop ETLs in Salesforce using SSIS you’ll need a Salesforce developer account. If you don’t have one, don’t worry, you can create a limited version FREE developer account. Click here to Sign up for FREE developer account.

Video Tutorial – Salesforce Insert, Upsert, Delete, Update

Getting Started

In this section, we will see how to perform bulk insert, update delete and upsert operations using ZS Salesforce Destination

Configure Salesforce Connection

First, we’ll need setup a connection to read or write Salesforce data is to make sure we have a working connection in SSIS.

1. Create new or open existing SSIS Project in Visual Studio.
2. Open SSIS Package and Go to SSIS designer.
3. Right click in the connection manager panel and click New connection
   

   Create a new SSIS Salesforce Connection

4. In the connection type selection, Select the ZS-SALESFORCE Connection.
5. We’ll use this information: Username, Password, Security Token (click the link learn how to obtain Salesforce Security Token )
6. Click OK to add the connection.
   

   Salesforce using SSIS, Salesforce connection

7. Save all changes

Bulk Insert – Import data into Salesforce using SSIS

Let’s start with the a bulk insert in Salesforce using SSIS. On this section, we’re going to generate retrieve data from and OLEDB Source and proceed to Insert the records into Salesforce using ZS Salesforce Destination.

Configure SQL Server Source (OLEDB)

1. Open SSIS Package and drag Data Flow task from Control Flow SSIS Toolbox
   

   Dragging and dropping Data Flow Task into Control Flow

2. Go to data flow designer. Drag and drop an OLE DB Source
3. Open the OLE DB Source and configure as follow:
   

   Configure SQL Server Source

Configure SSIS Salesforce Destination for Bulk Insert

Once SQL Server source is configure. Now let’s configure Salesforce Destination for Bulk Insert like below.

1. Drag and drop ZS Salesforce Destination
2. Open the destination component
3. Connection Manager
   

   Salesforce using SSIS, upsert destination connection manager

4. Component Properties
   

   salesforce-using-ssis-insert-properties

5. Column Mappings
   

   salesforce-using-ssis-insert-mapping

6. Click OK
7. Drag and drop two Trash Destination components
8. Connect ZS Salesforce Destination for: New records Output and Error Output
9. Right click on the joining arrows and enable data viewers on all previous connections
10. Save all changes
11. Right click in the data flow designer, click Execute Task
    

    salesforce-using-ssis-insert-results

Bulk Update – Modify data in Salesforce using SSIS

In this section we’re going to perform a bulk update on Salesforce using SSIS. We’re going to list some information from our source, list all our Salesforce Account data, merge it and only update the data we match. In below example what we will do is Find out matching records in Salesforce and our Source System based on some External Key field (e.g. AccountNumber in our case). And then obtain Salesforce Record Id for matching AccountNumber and use it to Update target record.

Configure SQL Server Source (OLEDB Source)

1. Open SSIS Package and drag Data Flow task from Control Flow SSIS Toolbox
2. Go to data flow designer. Drag and drop OLE DB Source
3. Open the OLE DB Source and configure
   

   Salesforce using SSIS, Update OLEDB source

Configure SSIS Salesforce Source

1. Now lets Drag and drop ZS Salesforce Source
2. Open the ZS Salesforce and configure. You can select Query Mode and enter query like this because we only care about two fields for now. Use query mode whenever possible because it transfers less data.
   

   select Id,AccountNumber from account

   

   Salesforce using SSIS, Update Salesforce source

Configure Sort Transforms

Now lets sort both previous datasets using Sort Transforms. This is needed to JOIN dataset using Merge Transform (See next section)

1. Drag and drop: 2 Sort and 1 Merge Join components
2. Connect the OLE DB Source to the first Sort component, and configure
   

   Salesforce using SSIS, Update OLEBD sort

3. Connect the Salesforce Source to the second Sort component, and configure
   

   Salesforce using SSIS,update Salesforce sort

Configure Merge Transforms

No next step would be to join previous datasets based on AccountNumber and then we will output Id from Salesforce which is needed for later step.

1. Drag and Drop Merge Transform from SSIS Toolbox like below.
   

   Drag SSIS Merge Join Transform from Toolbox

2. Connect Sorts to the Merge component (sort from OLEDB Source most be on the left)
3. Configure the Merge component
   

   Salesforce using SSIS, update merge

Configure SSIS Salesforce Destination for Bulk Update

1. Drag and drop ZS Salesforce Destination
2. Open the ZS Salesforce Destination and configure
3. Connection Manager tab
   

   Salesforce using SSIS, update destination connection manager

4. Component Properties tab
   

   Salesforce using SSIS, update destination component properties

5. For Update purposes, Salesforce Destinations needs to map the ID from the Account object. For more information, please use the following link SSIS Salesforce Destination – Update / Insert with Lookup Fields (Text to Id)
6. Column Mapping
   

   salesforce using SSIS, update destination column mappings

7. Click OK
8. Drag and drop three Trash Destination components
9. Create two connections from ZS Salesforce Destination as follows: Update records and Error Output
10. Right click on the joining arrows and enable data viewers on all previous connections
11. Save all changes
12. Right click in the data flow designer, click Execute Task
    

    Salesforce using SSIS, update results

Bulk Upsert – Import/Modify data in Salesforce using SSIS

In this section we’re going to perform a bulk upsert of 25 record’s on Salesforce using SSIS. Upsert is an operation that combines both insert an update.

ZS Salesforce Destination allows Upserts operations. You’ll need to select the Upsert as an action and indicate the Key value for the comparison.

Creating External ID field for Salesforce Upsert

For the Upsert action we have to use an Upsert Keyfield (i.e. External ID field). For more information read here External ID. Follow these steps to add a External ID field on Salesforce Accounts object:

1. Login to your Salesforce account.
2. Click on the configuration icon and select “Service Setup”
   

   Salesforce using SSIS, Salesforce edit object

3. On the new Tab, look for USER INTERFACE -> Objects And Fields -> Object Manager
4. Select Account object
5. Select Fields & Relationships
6. Click New, to create a field
   

   Salesforce using SSIS, Salesforce Fields & Configuration

7. For the field type, choose Number and click next
8. For Field Label and Field Name, type TableID. Check Unique and External ID boxes and click next
9. Leave field-level security as default, click next
10. Leave page layouts as default, click next.
11. After finishing the configuration, the field should appear in the Fields & Relationships page

Configure SQL Server Source

1. Open SSIS Package and drag Data Flow task from Control Flow SSIS Toolbox
   

   Dragging and dropping Data Flow Task into Control Flow

2. Go to data flow designer. Drag and drop OLE DB Source
3. Open the OLE DEB Source and configure as follow
   

   Salesforce using SSIS, Upsert OLE DB source

Configure SSIS Salesforce Destination for Upsert

1. Drag and drop ZS Salesforce Destination
2. Open the ZS Salesforce and configure
3. Connection Manager
   

   Salesforce using SSIS, upsert destination connection manager

4. Component Properties
   

   Salesforce using SSIS, upsert destination component properties

5. Column Mapping
   

   salesforce using SSIS, upsert destination column mapping

6. Click OK
7. Drag and drop three Trash Destination components

Configure Error Handling, Outputs for New, Updated, Failed Records

If you like to capture which rows are inserted and which rows are updated then you can drag Blue arrows coming from Salesforce destination component. You can also connect Red arrow to detect failed records and reason for error.

1. Connect ZS Salesforce Destination for: New records Output, Updated Records Output and Error Output
2. Right click on the joining arrows and enable data viewers on all previous connections
3. Right click in the data flow designer, click Execute Task
   

   Salesforce using SSIS, upsert results

Bulk Delete – Delete data in Salesforce using SSIS

In this section, we’re going to perform a bulk delete on Salesforce using SSIS ZS Salesforce Destination. In this example we’re going to list all our source customers (from previous sections), merge it wit the Salesforce Account object, retrieve the Salesforce Account Id and delete the rows. Delete Operation also requires to map Id field so we will use similar technique we used for Update.

Configure SQL Server Source (OLEDB Source)

1. Go to data flow designer. Drag and drop OLE DB Source
2. Open the OLE DEB Source and configure as follow
   

   salesforce-using-ssis-delete-oledb-source

Configure SSIS Salesforce Source

1. Drag and drop ZS Salesforce Source
2. Open the ZS Salesforce and configure.
3. You can select Query Mode and enter query like this because we only care about two fields for now. Use query mode whenever possible because it transfers less data.
   

   select Id,AccountNumber from account

Configure Sort Transforms

Now lets sort both previous datasets using Sort Transforms. This is needed to JOIN dataset using Merge Transform (See next section)

1. Drag and drop: 2 Sort and 1 Merge Join components
2. Connect the OLE DB Source to the first Sort component, and configure
   

   Salesforce using SSIS, Update OLEBD sort

3. Connect the Salesforce Source to the second Sort component, and configure
   

   Salesforce using SSIS,update Salesforce sort

Configure Merge Transforms

No next step would be to join previous datasets based on AccountNumber and then we will output Id from Salesforce which is needed for later step.

1. Now drag Merge Transform from SSIS toolbox
   

   Drag SSIS Merge Join Transform from Toolbox

2. Connect both Sort to the Merge component (sort from OLEDB Source most be on the left)
3. Configure the Merge component
   

   salesforce-using-ssis-delete-merge

Configure SSIS Salesforce Destination for Bulk Delete

1. Drag and drop ZS Salesforce Destination
2. Connect the Merge and ZS Salesforce Destination components. Right click the arrow and enable data viewer
3. Connection Manager tab
   

   Salesforce using SSIS, delete destination connection manager

4. Component Properties tab
   

   Salesforce using SSIS, delete destination component properties

5. For Delete purposes, Salesforce Destinations needs to map the ID from the Account object.For more information, please use the following link SSIS Salesforce Destination – Update / Insert with Lookup Fields (Text to Id) 
6. Column Mapping
   

   salesforce-using-ssis-delete-destination-column-mapping

7. Click OK
8. Save all changes
9. Right click in the data flow designer, click Execute Task
   

   salesforce-using-ssis-delete-results

Error Handling

When working on Salesforce with SSIS, we recommend Trash Destination component to help debugging outputs without performing DML on destinations.

Main benefits of usage:

1. Enable data viewers and get live feedback of the data
2. Save the results on different formats (XML, JSON, plain text files).

Conclusion

In this article, We have seen how easy it is to integrate Salesforce using SSIS. Using drag and drop connector you can perform Bulk insert, update, delete and Upsert operations.

Download ZappySys SSIS PowerPack to learn more about other possible scenarios which are not discussed in this article.

The post Load data in Salesforce using SSIS – Insert, Upsert, Delete, Update appeared first on ZappySys Blog.

We will look at step-by-step instructions to read Zoho CRM data (e.g. Leads, Accounts, Contacts) and load into SQL Server Database Table. In the next section, we will look at Write scenario too.

Now let’s look at step-by-step approach to call Zoho API  using SSIS.

Authentication Using Zoho V2 REST API (OAuth 2.0)

Zoho recently released v2 API. It uses OAuth 2.0 instead of static Token based (described in the next section). OAuth approach is more secure an recommended. If you must use static token-method then check next section. Zoho may discontinue Token based method in future.

Register Zoho OAuth App and get ClientID/ Secret (*** MUST READ ***)

Check this article to register your OAuth App and obtain Client ID  /Client Secret

Create Zoho OAuth Connection in SSIS (for API call)

Once you create Zoho OAuth App now its time to call some Zoho API. We will use ZappySys REST API Task to make simple API call. In the next section we will see how to load data in SQL Server.

1. Open SSIS Package and go to SSIS Designer (Control Flow)
2. Drag ZS REST API Task from Control Flow SSIS Toolbox as below
   

   Drag and drop SSIS REST API Task from SSIS Toolbox

3. Double click the task to configure.
4. Change URL Access mode to URL from Connection
5. Enter API URL you like to call. For example you can enter below
   

   https://www.zohoapis.com/crm/v2/settings/modules

6. Select New ZS-OAUTH connection from Connection drop down
   

   Call Zoho REST API using OAuth 2.0

7. Configure your OAuth connection General Tab as below
   1. OAuth Provider: Custom
   2. OAuth Version: OAuth2
   3. Client Id , Client Secret
   4. Enter One Scope Per Line (For more info on scope read here)
      

      ZohoCRM.modules.READ
      ZohoCRM.settings.READ

   5. Auth URL : https://accounts.zoho.com/oauth/v2/auth
   6. Token URL:  https://accounts.zoho.com/oauth/v2/token
8. Configure Advanced tab as below
   1. Enter Callback URL : https://zappysys.com/oauth
   2. Enter Extra Attribute for /Auth : access_type=offline&prompt=consent
      This is needed to obtain refresh_token (if you ommit this then only access_token returned which cannot be renewed once expired after 1hr)

      

9. Now go back to general tab and Click Generate Token.
   

   Generate OAuth Token for Zoho CRM REST API Access

10. Click OK to save the connection UI

Call Zoho API using OAuth Connection

1. On the REST API Task click Test Request / Response
   

   SSIS REST API Task – Call Zoho REST API in SSIS (OAuth 2.0)

Read data from Zoho Table in SSIS JSON Source

In this section we will learn how to read data from Zoho using SSIS JSON Source. We will use OAuth connection created in earlier section.

Now lets look at step by step example of reading Zoho CRM data using SSIS (e.g. read Leads, Accounts, Contacts, Invoice etc). Zoho provides JSON API for read action so we will Use SSIS JSON Source for this purpose. Full sample package is attached at the end of this article but see below steps for high level configuration.

Configure JSON Source

So below steps shows example of reading from Zoho Lead modules using v2 records API Call.

1. Open SSIS Package
2. Drag data flow task from Control flow SSIS Toolbox
   

   Drag data flow from SSIS Toolbox

3. Go to data flow and drag ZS JSON Source from SSIS Toolbox
   

   Drag and drop SSIS JSON Source (REST API or File)

4. Double click JSON Source to configure. Enter URL as below. You can supply few more parameters. Click Here to get full list of parameters and usage. In below example we are reading records from Leads Module but you can replace Leads to something else (e.g. Accounts). Refer to above help link for available Modules.
   

   https://www.zohoapis.com/crm/v2/Leads?per_page=200

5. Check Use Credentials. Select OAuth connection manager we created in the previous section.
6. Under filter options tab, enter Array Filter as  

   $.data[*]

7. Now click Preview to see your data
   

   Read data from Zoho API v2 using SSIS – OAuth (Use Last Modified Date for Incremental Extract)

8. Click OK to save UI. In the next section we will see how to setup pagination and incremental extract of Zoho records. After that we will see how to load data into SQL Server Table.

Zoho API Pagination (Read all rows)

Just like most API zoho also uses pagination. See below for how to configure pagination in JSON Source for Zoho API.

1. Double click JSON Source
2. Go to the Pagination Tab and select URL Parameter Mode
3. For Page Num Indicator Enter

   page

4. For Last Page Detection select

   Detect last page based on status code

5. In the Status code field
   enter 304 (if you added If-Modified-Since header for incremental extract – See next section)
   enter 204 (if you do not add If-Modified-Since)

Once you configure this way now your API will return all records until last page is detected. For more information on pagination check this article

Paginate Zoho API records

Incremental Extract based on Last Modified Date/Time field

Each module in Zoho has Last Modified By and LastModified Date/Time fields. You can filter extracted data for incremental extract by supplying

If-Modified-Since

1. On the JOSN Source, click Raw Edit above HTTP Headers Grid.  We can define Header to extract data after last modified date. Skip this step if you like to extract all records.
   For example to read Lead records which are modified after 12/31/2019 you can enter header like below. Date/Time is UTC. When record is created Modified date is set as creation date too so this will include created records too.
   

   If-Modified-Since: 2019-12-31T00:00:00

   If you have local time saved in a variable and you like to use SSIS variable then you can use below way. In this example we converted Local time to UTC.
   

   If-Modified-Since: <<{{User::varExtractDate,yyyy-MM-ddTHH:mm:ss}},FUN_TO_UTC_DATE>>

Loading Zoho data into SQL Server Table / Other Target

ZappySys SSIS PowerPack makes it easy to load data from various sources such as REST, SOAP, JSON, XML, CSV or from other source into SQL Server, or PostgreSQL, or Amazon Redshift, or other targets. The Upsert Destination component allows you to automatically insert new records and update existing ones based on key columns. Below are the detailed steps to configure it.

Step 1: Add Upsert Destination to Data Flow

1. Drag and drop the Upsert Destination component from the SSIS Toolbox.
2. Connect your source component (e.g., JSON / REST / Other Source) to the Upsert Destination.

SSIS - Data Flow - Drang and Drop Upsert Destination Component

Step 2: Configure Target Connection

1. Double-click the Upsert Destination component to open the configuration window.
2. Under Connection, select an existing target connection or click NEW to create a new connection.
   • Example: SQL Server, or PostgreSQL, or Amazon Redshift.

Step 3: Select or Create Target Table

1. In the Target Table dropdown, select the table where you want to load data.
2. Optionally, click NEW to create a new table based on the source columns.

Configure SSIS Upsert Destination Connection - Loading data (REST / SOAP / JSON / XML /CSV) into SQL Server or other target using SSIS

Step 4: Map Columns

1. Go to the Mappings tab.
2. Click Auto Map to map source columns to target columns by name.
3. Ensure you check the Primary key column(s) that will determine whether a record is inserted or updated.
4. You can manually adjust the mappings if necessary.

SSIS Upsert Destination - Columns Mappings

Step 5: Save Settings

• Click OK to save the Upsert Destination configuration.

Step 6: Optional: Add Logging or Analysis

• You may add extra destination components to log the number of inserted vs. updated records for monitoring or auditing purposes.

Step 7: Execute the Package

• Run your SSIS package and verify that the data is correctly inserted and updated in the target table.

SSIS Upsert Destination Execution

Write data to Zoho CRM using OAuth 2.0

If you like to load data from any source (i.e. SQL Server) to Zoho CRM then you can use Records API (POST). Use combination of the following Transforms  / Components. Later in this article we have some more examples (Older API) which may give you one more ways to load data into Zoho (Use of Template Transform).

Basically you have to build POST Body using JSON Generator Transform or Template Transform and then use that data in Web API Destination to call POST API request to push data to Zoho.

	Web API Destination
	JSON Generator Transform
	JSON Parser Transform

Create JSON for POST request (Single dataset pattern)

Insert data to Zoho Table using SSIS (Lead, Account Modules) – Bulk Load using POST API call

Authentication Using Zoho Tokens

If you don’t want to use a newer version of Zoho API (v2) then you can use Token based Authentication method.

In Zoho Portal perform following steps to obtain API token

1. Click on Setup (Toolbox icon at the top-right corner)
2. Search for “API” > Select CRM API  or find under Developer space > APIs
3. Click on Gear icon found above Usage Panel (small icon so find carefully)
4. Click on Authentication Token generation
5. Specify the APP Name and Click Generate
6. This will direct to the new page which may contain text like below. Just copy AUTHTOKEN part (i.e. 8a08xxxxxxxxxx13630d )
   

   #
   #Mon May 15 12:21:42 PDT 2017
   AUTHTOKEN=8a083f76xxxxxxxxxxxxxxxxxxxdxxxxxxxx13630d
   RESULT=TRUE

7. Now use the newly created auth token to your API call.

How to get Zoho CRM API Token (For SSIS or other app integration)

Read data from Zoho using SSIS (Export Zoho CRM data to SQL Server Table)

Now lets look at step by step example of reading Zoho CRM data using SSIS (e.g. read Leads, Accounts, Contacts, Invoice etc). Zoho provides JSON API for read action so we will Use SSIS JSON Source for this purpose. Full sample package is attached at the end of this article but see below steps for high level configuration.

So below steps shows example of reading Zoho Lead modules using getRecords API Call.

1. Goto SSIS > Variable and create a new string variable called token. Enter your Zoho API token as value (see previous section to get API token)
2. Drag data flow task from Control flow SSIS Toolbox
3. Go to data flow and drag ZS JSON Source from SSIS Toolbox
4. Double click JSON Source to configure as below
   1. Enter URL as below. Note that we have use Variable for Token to make URL dynamic.To read from different module change URL (e.g. rather than Leads in URL use Accounts).  Click Here to get full list of Modules and Fields
      

      https://crm.zoho.com/crm/private/json/Leads/getRecords?newFormat=1&authtoken={{User::token}}&scope=crmapi&fromIndex=0&toIndex=200

      You can also use lastModifiedTime parameter along leads modified after certain date/time (this time is Local time and not the UTC). To extract leads modified after certain date (Create a datetime variable called varExtractDate) and use it as below in the URL. You can use any valid format specifiers for date time
      

      https://crm.zoho.com/crm/private/json/Leads/getRecords?newFormat=1&authtoken={{User::token}}&scope=crmapi&fromIndex=0&toIndex=200&lastModifiedTime={{User::varExtractDate,yyyy-MM-dd HH:mm:ss}}

   2. Click on the Select Filter and select node with Array icon as below. Each Module may have different structure for example for Leads module Filter may look like $.response.result.Leads.row[*]
      

      Configure SSIS JSON Source – Read Zoho CRM Leads (getRecords API call with lastModifiedDate Example)

   3. Now go to 2D Array Tab and configure like below
      1. Select Transform Type to Key/Value Pivot Mode.
      2. Select or type Column Filter as $.FL[*].val
      3. Select or type Row Value Filter as $.FL[*].content
   4. Once you configure 2D Array Transform click Preview to see sample data
   5. .
   6. Click OK to save JSON Source and attach it to target such as SQL Server Destination like below.
   7. Execute Package to test.
      

      SSIS Example : Loading Zoho CRM data to SQL Server Table (JSON API Source)

Write data to Zoho using SSIS (Import SQL Server Table to Zoho CRM)

Now you know how to read data from Zoho CRM using JSON API Source next step is to load data to Zoho CRM. For writing data we will use following three components

	Web API Destination
	Template Transform
	XML Parser Transform

For this example we will use hard coded data in CSV Source (Sample Leads ) but in real world you will have data coming from some RDBMS such as SQL Server.

1. Drag Data flow Task and double click to go to Data flow designer.
2. Drag ZS CSV Source from the SSIS Toolbox. Change Access mode to Direct Value. Enter following sample data for demo.
   

   Company,First Name,Last Name,Email,Lead Status,Lead Source,Phone
   Microsoft,TestMaawia,TestBrito,Maawia@outlook.com,Lunk Lead,Web Download,111-111-3333
   Microsoft,Testraja,Testvedaiyan,raja@outlook.com,Lunk Lead,Web Download,111-222-3333
   Yahoo,TestJayder,Testelnageib,Jayder@outlook.com,Lunk Lead,Web Download,111-333-3333
   Yahoo,TestStephen,TestTjebane,Stephen@outlook.com,Lunk Lead,Web Download,111-444-3333
   Google,TestHarold,TestBatista,Harold@gmail.com,Lunk Lead,Web Download,111-555-3333
   Google,TestVennon,TestMills,Vennon@gmail.com,Lunk Lead,Web Download,111-666-3333
   Google,TestMichael,TestTremblay,Michael@gmail.com,Lunk Lead,Web Download,111-777-3333

3. Now drag ZS Template Transform. Connect it with previous step.
4. Double click Template Transform to configure it with following sample Text (This transform was introduced in v2.6.6. If you dont see it then update your SSIS PowerPack to latest version). Use of XMLENC is optional for Non string columns or Alphanumeric values but if you not sure about column type then just add it anyways.
   

   <Leads>
    <row no="1">
     <FL val="Lead Status"><%Lead Status,XMLENC%></FL>
     <FL val="Company"><%Company,XMLENC%></FL>
     <FL val="First Name"><%First Name,XMLENC%></FL>
     <FL val="Last Name"><%Last Name,XMLENC%></FL>
     <FL val="Email"><%Email,XMLENC%></FL>
     <FL val="Phone"><%Phone,XMLENC%></FL>
     <FL val="Lead Source">Web Download</FL>
    </row>
   </Leads>

   
5. Now drag another ZS Template Transform and connect it with previous step.
6. Double click Template Transform to configure. Enter below text. This is final text we will use as Request Body in the Web API Destination.
   

   xmlData=<%TemplateOutput,URLENC%>

   
7. Drag Microsoft Derived Column Transform. Connect with previous step and double click it to configure.
8. Select Replace ‘TemplateOutput’ action. Type new column name in the first column e.g. TemplateOutput_Encoded
9. Now drag ZS Web API Destination, Connect with previous step and double click to configure as below.
   1. Select New HTTP Connection. Enter some valid URL e.g. https://zoho.com  (This will be ignored anyways because we will use Dynamic URL on main UI)
   2. Enter URL as below (see how we again added API token as dynamic variable) . If you inserting to different Module (e.g. Accounts rather than Leads then change accordingly).   Click Here to get full list of Modules and Fields
      

      https://crm.zoho.com/crm/private/xml/Leads/insertRecords?newFormat=1&authtoken={{User::token}}&scope=crmapi&duplicateCheck

   3. Select Input Body column as TemplateOutput_Encoded
   4. Enter Sample Body as below if you like to use Test feature else ignore this step. Click Test to see its working. Capture Response XML because you may need in the next step to feed as sample to XML Parser Transform (again optional step).
      

      <Leads>
       <row no="1">
        <FL val="Lead Status">Junk Lead</FL>
        <FL val="Company">ABCD Inc</FL>
        <FL val="First Name">Bob</FL>
        <FL val="Last Name">Smith</FL>
        <FL val="Email">bob@abc.com</FL>
        <FL val="Phone">111-222-3333</FL>
        <FL val="Lead Source">Web Download</FL>
       </row>
      </Leads>

      
10. Now once API destination is set we can optionally configure below steps if you want to store status and ID of newly created records. If you don’t care for that then skip below steps.
11. Drag ZS XML Parser Transform, Connect it Web API Destination (Response Output – Blue Arrow). Double click XML Parser to configure as below
    1. Select Input XMl Column as ResponseText
    2. Enter Sample Text as below
       

       <?xml version="1.0" encoding="UTF-8" ?>
       <response uri="/crm/private/xml/Leads/insertRecords">
       	<result>
       		<message>Record(s) added successfully</message>
       		<recorddetail>
       			<FL val="Id">1558554000015597002</FL>
       			<FL val="Created Time">2018-02-13 16:14:10</FL>
       			<FL val="Modified Time">2018-02-13 16:14:10</FL>
       			<FL val="Created By">
       				<![CDATA[ZappySys Support]]>
       			</FL>
       			<FL val="Modified By">
       				<![CDATA[ZappySys Support]]>
       			</FL>
       		</recorddetail>
       	</result>
       </response>

        
    3. Enter Filter as below
       

       $.response.result.recorddetail[*]

    4. 
    5. Now Go to 2D Array Transform Tab. Configure as below
    6. Select Transform Mode to Key/Value
    7. Column name filter as  

       $.FL[:3].@val

    8. Row value filter as  

       $.FL[:3].#text

       
    9. Now click OK to close.
12. Drag ZS Trash Destination or some other destination (e.g. SQL Server) and connect Red arrow coming from Web API destination to this component to capture any errors.
13. Thats it now you ready to run your SSIS sample package which Inserts Leads to Zoho CRM. See below for full package.

SSIS Example: Import data to Zoho CRM using SSIS Web API Destination (Loading Leads, Accounts, Contacts)

Things have gone bad: Error handling & debugging

Incidentally, bad things can happen. A remote server may go offline or your server may go out of memory. In any case, you may want to know when that happens and take actions accordingly. For that purpose, you have to redirect bad rows to some other destination. For this example, we will take and use Web API Destination, but basically, you can use any SSIS component:

Handling errors

1. Add a Derived Column above Web API Destination with expression "(DT_WSTR,4000)ZS_JSON_OUT" and name it "JsonAsString". This will let you see what JSON you are actually passing.
2. Then add a database or file destination or use another Trash Destination for debugging purposes and redirect the bad rows (red arrow) from Web API Destination into it. Don't forget to set Redirect row option for both, Error and Truncation columns:
   

   Redirected failed requests from Web API Destination to a desired destination when loading from SQL Server to REST API Service is failing. Derived Column JsonAsString added to be able to read JSON which was passed to Elasticsearch

3. Finally, add a Data Viewer for the red path, if you want to debug the flow. You will be able to see URL, JSON and the error message for each record. You may want to copy-paste ErrorMessage to Notepad if you want it to be more readable:
   

   Use Data Viewer to view HTTP requests that failed to be fulfilled.

NOTE: You can read more about redirecting rows in SSIS Error Handling (Redirect bad rows) article.

Debugging HTTP requests

A common thing you have to do when working with HTTP requests is to debug those requests; e.g. to check what headers, body or URL was passed. To test how things look behind the scenes we strongly suggest to use Fiddler - a popular web debugging tool.

Inside it, you can double-click the URL entry (Right side) to see Request and Response Panels. The top panel is Request (URL, Headers, Body) and Bottom Panel is Response. For https:// (secure URL) make sure you enable HTTPS option in Fiddler (Tools > Options > HTTPS > Check Decrypt https request):

Debugging Web API call using Fiddler in SSIS

Sample SSIS Package Download

Click here to download sample package (SSIS 2012 or Higher).

Conclusion

Zoho CRM API provides great way to automate data read/write operations. However to call Zoho API  you have to use SDK / coding approach (e.g. C#, Java, Python, Ruby). Luckily ZappySys SSIS PowerPack provides great way to integrate any Zoho API call via simple drag and drop approach without coding. Try  SSIS PowerPack for free and call virtually any REST API in few clicks.

The post Read / Write Zoho CRM data using SSIS REST API Call appeared first on ZappySys Blog.