mulesoft zoho crm connectormulesoft.isteer.com/zoho-crm-connector/1.0/zohocrm... · mulesoft zoho...

Mulesoft Zoho CRM Connector Introduction The purpose of ZohoCRM Connector is to enable ZohoCRM integration with other modules with Mule applications. Audience Who have knowledge on Anypoint Studio (Eclipse based Integration Development Environment for Mule applications) and want to use Zoho CRM in Mule applications. Prerequisites: The connector is designed to work with Zoho CRM and therefore this document assumes you are familiar with Zoho CRM API operations. Dependencies: Zoho CRM account Mule Enterprise runtime of Anypoint Studio Compatibility Matrix

Application/Service Version

Mule Runtime 3.5.0 or higher

Zoho CRM Connector 1.1.0 or higher

Installation Steps: Step1: In Anypoint studio, navigate to Help → Install New Software

iSteer Technologies Private Limited, www.isteer.com

Copyright © 2016 iSteer Technologies and/or its affiliates. All rights reserved

http://www.isteer.com/

Step2: In a “work with” pull down menu, select Anypoint Connector update site.

Step3: Expand Certified and navigate to ZohoCRM connector. Alternatively type as Zoho in the filter field.

Select ZohoCRM connector and press next then proceed with installation screenflow, accept the license agreement and complete the installation. Generating Authentication token from Zoho CRM.




Step1: Login into to https://www.zoho.com Step2: Select CRM module

Step3: Click on setup tab.

Step4: Click on Developer Space



https://www.zoho.com/


Step5: Select CRM API Step6: Click on settings button

Step7: Click on Authetication Token Generation




Step8: In Browser Mode field enter Application name and click on generate button. Zoho CRM module generates authentication token. Authentication token generation completed

Connector Configuration: We recommend to generate a new flow with global name if not exist already. Open global flow and click on Global Elements after navigate to create button and click on.




Global configuration popup window appears and in filter tab type zoho to appear zoho connector configuration




Select ZohoCRM configuration then click on ok button ,which leads to zoho crm configuration window.




Enable Datasense to fetch modules dynamically. Specify authtoken (Authentication token), which is mandatory field generated from ZohoCRM module Scope field contains default value as “crmapi” , if any other scope applicable please specify. Now ZohoCRM connector supports proxy settings. After specifying details click on Test Connection button to check your details. Connector Operations The ZohoCRM connector is an operation based connector, which means that when you add the connector to your flow, you need to configure a specific operation the connector is intended to perform. The connector supports the following operations




Operation Description

getMyRecords To retrieve data by the owner of the Authentication Token specified in the API request

getRecords To retrieve all users data specified in the API request

getRecordById To retrieve individual records by record ID

getDeletedRecordIds To retrieve the list of IDs of deleted records from recylce bin

insertRecords To insert records into the required Zoho CRM module

updateRecords To update or modify the records in Zoho CRM

getSearchRecordsByPDC To search the values based on predefined columns

deleteRecords To delete the selected records

convertLead To convert lead to potential, account and contact

getRelatedRecords To retrieve records related to a primary module

updateRelatedRecords To retrieve details of fields available in a module

getUsers To update records related to another record

updateFile To update records related to another record

delink To disassociate the relationship between parent and child records

downloadFile To download a file attached to a record

deleteFile To delete a file attached to a record

uploadPhoto To add a photo to a contact or lead

downloadPhoto To download the photo of a contact or lead

deletePhoto To delete a photo of a contact or lead

searchRecords To retrieve the records that match your search criteria

Configuring insert single operation:




This is the sample example will create a single record in the Zoho CRM. Drag the ZohoCRM connector onto the flow and select it to open the Mule Properties Configure the connector properties

Select your operation in Basic Settings tab select module.

Fields Description Default

Display name Enter a unique label for the connector in your application.

ZohoCRM

Connector Configuration Select the global ZohoCRM_Configuration connector element that you just created.

Operation Select insert single

Module Select Accounts

Object Accounts Object payload

Once select radio button and click on next button will popup Object Builder for selected module fields as shown below




In object builder you can fill the columns data with your values. Here shown above with sample example. Click on ok button once completed. Xml configuration as looks below




Connector Features: Cache: Zoho CRM Connector has cache mechanism to reduce the network calls and increase bandwidth. All fetch operations has “cacheInMin” parameter. This parameter takes input as Integer for how many minutes data should store in cache. MetaData: Connector has feature to fetch dynamic data. While configuring connector please enable data sense. Object Builder: To fill module data connector supports object builder with ease development for developers. References: ZohoCRM API documentation https://www.zoho.com/crm/help/api/ Installing Connectors https://docs.mulesoft.com/muleuserguide/v/3.7/installingconnectors



https://www.zoho.com/crm/help/api/

https://docs.mulesoft.com/mule-user-guide/v/3.7/installing-connectors


mulesoft zoho crm connectormulesoft.isteer.com/zoho-crm-connector/1.0/zohocrm... · mulesoft zoho...

Documents