Overview
Configuration is provided for establishing connections with the Zoho CRM service. The configuration is used in the REST Connection Manager.
Setup
Press 
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Quick Start
In this task, we will show you step-by-step in How-To create a connection to Zoho CRM service using COZYROC's REST Connection Manager.
Step 1. Run "Visual Studio" under "Administrator account".
Select "Data Flow task" tab and Click "Add new Data flow task"
Step 2. Right click on Connection managers Tab and Select New Connection
Step 3. In "Add SSIS Connection Manager" scroll down and select REST "Connection managers for REST Connection" and click "Add"
Step 4. From Configuration drop-down menu select "Zoho CRM connection" and provide Authentication token for your Zoho CRM account, click Test to check your connection and next click OK
Step 5. In Connection managers Tab right click to rename "REST Connection" to "Zoho CRM connection"
Step 1. Open the right side panel and Drag and Drop REST Source component
Step 2. Double click on it and select "Zoho CRM Connection", select from available** Zoho CRM resources** listed in second drop-down menu and click OK
Step 3. Click on Columns and Select from Zoho CRM available columns. Click OK
Step 4. Click Preview columns
Step 5. Drag and drop OLE DB Destination component from the left side panel - SSIS Toolbox
Step 6. Double Click on OLD DB Destination and Select Connection manager and Table name. Click OK
Step 7. Drag the blue arrow to Connect Zoho CRM source and OLE DB Destination
Step 8. Click on OLE Destination Mapping tab and map the columns
Step 9. Run the package
Step 1. Right click on Connection managers Tab and Select New OLE DB Connection
Step 2. Select your DB connection and click OK
Step 3. Drag and drop OLE DB Source component from the left side panel - SSIS Toolbox
Step 4. Select your OLE DB connection and table name. Next click Preview to see the data. Click OK
Step 5. Click on Columns on the left menu and Select Columns you want to map
Step 6. Drag and drop REST Destination component from the SSIS Toolbox and Rename it to "Zoho CRM destination"
Step 7. Drag the blue arrow to Connect OLE DB source with Zoho CRM Destination
Step 8. Double click on "Zoho CRM destination" component and Select "Zoho CRM connection", Action and Resourse from drop down menu. Click OK
Step 9. Click on Mapping tab and map the columns
Step 10. Run the package
Configuration
Base URL address: https://crm.zoho.com/crm/private.
-
The authentication uses a parameters-based authentication.
The authentication has the following user-defined parameters:
- Authtoken:
The following request parameters will be automatically processed during the authentication process:
-
authtoken:
{{=connection.user.Authtoken}} -
scope:
crmapi
Documentation: https://www.zoho.com/crm/help/api/using-authentication-token.html.
- [Read] action
-
Endpoint URL address:
/json/Users/getUsers.
The result is extracted from:{{=_.flatten(jsonPath(response, 'users.user'))}}.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
Documentation: https://www.zoho.com/crm/help/api/getusers.html#Request_Parameters.
-
_includeUserParameters:
- id
A key field. Template: ShortText.
- zip
Template: ShortText.
- phone
Template: ShortText.
- fax
Template: ShortText.
- status
Template: ShortText.
- website
Template: ShortText.
- street
Template: ShortText.
- state
Template: ShortText.
- city
Template: ShortText.
- country
Template: ShortText.
- content
Template: ShortText.
- timezone
Template: ShortText.
- zuid
Template: ShortText.
Template: ShortText.
- role
Template: ShortText.
- language
Template: ShortText.
- confirm
Template: ShortText.
- profile
Template: ShortText.
- mobile
Template: ShortText.
- [Read] action
-
Endpoint URL address:
/json/Attachments/getRelatedRecords.
The result is extracted from:{{=_.map(_.flatten(jsonPath(response, 'response.result.Attachments.row')), function(item) { return _.object(_.pluck(item.FL, 'val'),_.pluck(item.FL, 'content')); })}}.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
Documentation: https://www.zoho.com/crm/help/api/getrelatedrecords.html#To_view_files_attached_to_a_record.
-
_includeUserParameters:
- [Create] action
-
Endpoint URL address:
/json/{{=parameters.parentModule}}/uploadFile.
The action uses POST method.The following request parameters will be automatically processed:
-
id:
{{=item.recordId}} -
content:
{{=item.Content}} -
_includeUserParameters:
{{=parameters}}
Documentation: https://www.zoho.com/crm/help/api/uploadfile.html.
-
id:
- [Delete] action
-
Endpoint URL address:
/json/{{=parameters.parentModule}}/deleteFile.The following request parameters will be automatically processed:
-
id:
{{=item.id}} -
_includeUserParameters:
{{=parameters}}
Documentation: https://www.zoho.com/crm/help/api/deletefile.html.
-
id:
- id
A key field. Template: ShortText.
- File Name
Template: ShortText.
- recordId
Template: ShortText.
- Content
Data type: DT_IMAGE The value is gathered from
/json/{{=parameters.parentModule}}/downloadFileaddress.- Size
Data type: DT_I4 A read-only field.
- Modified Time
Template: DateTime. A read-only field.
- Attached By
Template: ShortText. A read-only field.
Based on resource template ExternalResource.
- CONTACTID
Template: ShortText.
- ACCOUNTID
Template: ShortText.
The external resource list URL address: /json/Info/getModules.
The external resource list is extracted from: {{=response.response.result.row}}.
Based on resource template ExternalResource.
- [Read] action
-
The result is extracted from:{{=_.flatten(_.pluck(response.response.result, 'row'))}}.
The result is paginated.The following request parameters will be automatically processed:
-
fromIndex:
{{=parameters.iterator}} -
toIndex:
{{=parseInt(parameters.iterator) + parameters.batchSize - 1}} -
_includeUserParameters:
{{=parameters}}
-
fromIndex:
Based on resource template ExternalResourceRead.
- [Read] action
-
Endpoint URL address:
/json/{{=resource.type}}/getRecords.
- [Read search] action
-
Endpoint URL address:
/json/{{=resource.type}}/searchRecords.The action has the following user-defined parameters:
- search: Required. Specify search query (alias for "criteria").
The following request parameters will be automatically processed:
-
criteria:
{{=parameters.search}}
Documentation: https://www.zoho.com/crm/help/api/searchrecords.html.
- [Read searchColumn] action
-
Endpoint URL address:
/json/{{=resource.type}}/getSearchRecordsByPDC.The action has the following user-defined parameters:
- searchColumn: Required. Specify search column.
- searchValue: Required. Specify search value.
The following request parameters will be automatically processed:
-
searchColumn:
{{=parameters.searchColumn}} -
searchValue:
{{=parameters.searchValue}}
Documentation: https://www.zoho.com/crm/help/api/getsearchrecordsbypdc.html.
- [Read related] action
-
Endpoint URL address:
/json/{{=resource.type}}/getRelatedRecords.The action has the following user-defined parameters:
- related: Required. Specify parent module (alias for "parentModule").
The following request parameters will be automatically processed:
-
parentModule:
{{=parameters.related}}
Documentation: https://www.zoho.com/crm/help/api/getrelatedrecords.html.
- [Create] action
-
Endpoint URL address:
/xml/{{=resource.type}}/insertRecords.
The result is extracted from:{{=response.response.result && _.sortBy(_.flatten(jsonPath(response, 'response.result.row')), 'no')}}.
The action uses POST method.The following request parameters will be automatically processed:
-
version:
4 -
xmlData:
{{=ZohoCRM.getDataBatch(resource, batch)}} -
_includeUserParameters:
{{=parameters}}
Documentation: https://www.zoho.com/crm/help/api/insertrecords.html.
-
version:
- [Update] action
-
Endpoint URL address:
/xml/{{=resource.type}}/updateRecords.
The result is extracted from:{{=response.response.result && _.sortBy(_.flatten(jsonPath(response, 'response.result.row')), 'no')}}.
The action uses POST method.The following request parameters will be automatically processed:
-
version:
4 -
xmlData:
{{=ZohoCRM.getDataBatch(resource, batch)}} -
_includeUserParameters:
{{=parameters}}
Documentation: https://www.zoho.com/crm/help/api/updaterecords.html.
-
version:
- [Delete] action
-
Endpoint URL address:
/json/{{=resource.type}}/deleteRecords.The following request parameters will be automatically processed:
-
id:
{{=item.Id}} -
_includeUserParameters:
{{=parameters}}
Documentation: https://www.zoho.com/crm/help/api/deleterecords.html.
-
id:
- Id
A key field. Template: ShortText.
- [External]
-
The external fields URL address:
/json/{{=resource.type}}/getFields. The external fields list is extracted from:{{=_.flatten(_.pluck(_.flatten([response[resource.type].section]), 'FL'))}}.- {{=external.label}}
Template: {{=(external.type == 'DateTime') ? 'DateTime' : ''}}. Data type: {{=ZohoCRM.getDataType(external.type)}} ( length {{=external.maxlength}} )
- ShortText
Data type: DT_WSTR ( length 255 )
- DateTime
Data type: DT_DBTIMESTAMP Before setting, the value is processed with
{{=dateFormat(value, 'yyyy-mm-dd HH:MM:ss', true)}}expression.
What's New
- Fixed: Authentication errors because of failed token refresh (Thank you, Ramu).
- Fixed: Various fixes (Thank you, Michelle).
- New: Included configuration for v2 API.
- Fixed: Various fixes (Thank you, Michelle).
- New: Introduced connection.
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.