Creator help

Search records by PDC in Zoho CRM

Overview

Zoho Creator and Zoho CRM have been integrated for efficient usability purposes. We have developed tasks in Zoho Creator to perform automatic actions in Zoho CRM, which would otherwise require manual execution. For example, you can search for records in Zoho CRM based on pre-defined column names and populate them in Zoho Creator Form fields for further action. You can specify the Module Name in which you want to search the records along with the pre-defined column name and it's value. This can be achieved using zoho.crm.searchRecordsByPDC() task in Zoho Creator.

Use Case Scenario

Let's say we need to fetch all "Test Accounts" in the "Accounts" module. The "account name" is a pre-defined column in Accounts module, hence a condition with column name as accountname and value as test will fetch all the test accounts. This can be achieved by using the searchRecordsByPDC() task. Further details on how to execute this task are explained below.

Syntax

<response>=zoho.crm.searchRecordsByPDC(<module_name>, <criteria_column_name>, <criteria_column_value>)

where,

Params Description

<response> 

is the response returned as MAP by Zoho CRM.

<module_name> 

is the name of the CRM module, of STRING datatype, where the records will be searched for. Following is the list of supported modules.

Leads

Potentials

Products

Solutions

Contacts

Campaigns

Vendors

Tasks

Accounts

Cases

Quotes

Events

Sales Orders  

Purchase Orders  

Invoices       

Notes            

<criteria_column_name>

is the specified Modules's pre-defined column name, of STRING datatype, where the values will be searched for. Following is the list of pre-defined column names for each Module.

Leads 

  • email
  • campaignid 

Solutions

  • solutionid
  • productid

Campaigns

  • campaignid
  • campaignname

Contacts

  • contactid
  • accountid
  • vendorid
  • campaignid
  • email

Potentials

  • potentialid
  • accountid
  • campaignid
  • contactid
  • potentialname 

Sales Orders

  • salesorderid
  • potentialid
  • accountid
  • contactid
  • quoteid

Accounts

  • accountid
  • accountname  

Vendors

  • vendorid
  • vendorname

 

Cases

  • caseid
  • productid
  • accountid
  • potentialid

Quotes

  • quoteid
  • potentialid
  • accountid
  • contactid

Invoices

  • invoiceid
  • accountid
  • salesorderid
  • contactid

Purchase Orders

  • purchaseorderid  
  • contactid
  • vendorid

Notes

  • notesid

Events

  • eventid

Tasks

  • taskid

<criteria_column_value>

is the specified pre-defined column name's value

Fetch all Test Accounts

To fetch all Accounts having "test" as account name, add the following script in the required Form Actions block of your Zoho Creator Form:

response=zoho.crm.searchRecordsByPDC("Accounts", "accountname", "test");

where,

response
is the response returned as map by Zoho CRM. The fetched records will be contained in the response. Check sample response here.
"Accounts"
is the module name, of string datatype, where the records will be searched for.
"accountname"
is a pre-defined column name in Zoho CRM.
"test"
is the pre-defined column name's required value

Response Format

The response returned is of the following format:

{"SIC Code":"0","Phone":"5645","Account Owner":"ZohoTest","Employees":"0","Account Name":"test",
"Account Number":"0","Created By":"ZohoTest","ACCOUNTID":"380146000000055003","MODIFIEDBY":"380146000000041003",
"Annual Revenue":"0","Created Time":"2011-07-26 13:59:03","Modified By":"ZohoTest","SMOWNERID":"380146000000041003",
"SMCREATORID":"380146000000041003","Modified Time":"2011-07-26 13:59:03"}

Limitation

CRM Tasks can be executed only in accounts which are under Flexible and Unlimited Plans. Accounts under Free Plan, kindly upgrade to use CRM tasks. For more details scroll down to Integration and Web Data on the pricing page.

Script Builder

You can also make use of Script builder to define the zoho.crm.searchRecordsByPDC() task. Navigate to your application’s Workflow and drag and drop the Call Function under Deluge Tasks > Miscellaneous. Select Integration tasks and fill out necessary information.

Related Links

  • To fetch the string value to which the specified key is mapped, use get()
  • To get values from fetched records, use getJSON()
  • To convert the json string to list format, use toJSONList().

Share this post : FacebookTwitter

Still can't find what you're looking for?

Write to us: support@zohocreator.com