Explore: Step-by-Step Guide to Troubleshoot ZDK Errors in Zoho CRM Client Script
Concern
Occasionally, CRM users may encounter a common problem with Client Scripts, where a script fails at the ZDK (i.e., Zoho Development Kit) level and is unable to fetch data from CRM modules.
In such situations, users often wonder what steps they can take on their own to resolve the problem. In this post, we will walk through a few troubleshooting steps that you could try from your end and observe the outcome.
The purpose of this post is to explain the scenarios in detail. Also, to raise an awareness about the steps which needs to be taken on customer’s end to troubleshoot this problem and providing a guidance about the information that is required by Zoho to debug further on our end.
Common Errors in Logs/Console
When the user executes a client script, they may face any of the following errors.
- Unable to recognise any module (i.e., Leads)
- Undefined is not an object (evaluation ‘(await(await ZDK.Apps).CRM).Contacts’)
- ZDK.Apps.CRM: undefined
- When users type ZDK.Apps.CRM. -- It would not list any CRM modules
Example Code
- var leads = ZDK.Apps.CRM.Accounts.fetch();
- leads[0].Last_Name;
In the above first line, we use the ZDK method, and it may fail sometimes by throwing any of the above errors, which leads to a complete script logic failure.
Troubleshooting Guide
Let us try the below possible troubleshooting steps to resolve the above errors at the user's end:
Method1: Adding a Dummy Field into Layout
We request the user to add a dummy field into any module's layout and save. This action ensures that the ZDK in backend regenerates and it could resolve the problem instantly.
-> A user can go to any Module (i.e. Contacts) -> Layout in Zoho CRM and add a dummy field (i.e. Single Line), then Save the Layout.
Navigate to Setup (⚙️) in Zoho CRM >> Customization >> Modules & Fields >> Module >> Layout
-> Once the field is added and saved, the layout. Try performing a Hard Refresh of the browser page and check if the Client Script is working fine.
Method2: Changing API name of any field
We request the user to make a temporary API name change in any field (not used primarily) in the module (i.e., Contacts). This action will also regenerate the backend code level changes, and it could resolve the problem at the user's end immediately.
Navigate to Setup (⚙️) in Zoho CRM >> Developer Hub >> APIs and SDKs >> API Names >> Module >> rename API name
Once the above step is completed, try performing a Hard Refresh of the browser page and check if the Client Script is working fine.
We strongly recommend the users to revert the Module / Field API name to previous name to avoid any disruptions in future related to Integration with Zoho or Third Party service or avoid conflicts related to API based integrations.
What we need from Partners:
After performing the above methods, if it still does not work, then we would require to check the exact reason in our backend with logs. We would request you to provide the below information:
Please do not skip any questions.1. Share the user's CRM Org ID and email address so that we can check the details in our backend.
2. Type the following and confirm if it shows the CRM Module. If yes, select the module and complete the line as per syntax, then check if script works. Share the outcome on this.
Start Typing - ZDK. then selects Apps. then select CRM. then select check if CRM modules listed.
3. Share a Small Recording in which replicate it by executing a script and show the browser console logs.
To check the Browser Console Logs ==> Give a right click on the screen -> Click Inspect -> Choose the Console & Network tabs and check if there are any errors. Ensure to show the full-page recording.
4. Share the complete script as text file and usage in detail for us to understand in better.
5. Share the complete Client Script configuration screenshot – showing Module, Event & Event Type for our better understanding.
6. Since when you are facing the reported problem. Approximate Date & Time would be helpful to validate in our backend logs.
7. Check internally, if there are any recent configration or updates in Zoho CRM - such as: adding Picklist field or new options or any field with special character.
Likewise, for all Europe & UK Partners, please share the above information collectively with partner-support@eu.zohocorp.com.
Access your files securely from anywhere
Zoho CRM Training Programs
Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.
Zoho DataPrep Personalized Demo
If you'd like a personalized walk-through of our data preparation tool, please request a demo and we'll be happy to show you how to get the best out of Zoho DataPrep.
- Zoho Workerly Home
- Forums
- Connect With Us:
- Zoho Recruit Home
- Forums
- Connect With Us:
Centralize Knowledge. Transform Learning.
All-in-one knowledge management and training platform for your employees and customers.
New to Zoho Writer?
Create. Review. Publish.
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Zoho Marketing Plus?
Everything you need to run your marketing
You are currently viewing the help pages of Qntrl’s earlier version. Click here to view our latest version—Qntrl 3.0's help articles.
New to Zoho Survey?
Zoho Sheet Resources
Zoho Forms Resources
New to Zoho Sign?
Zoho Sign Resources
Sign, Paperless!
New to Zoho TeamInbox?
Zoho TeamInbox Resources
New to Zoho ZeptoMail?
Design. Discuss. Deliver.
New to Zoho Workerly?
New to Zoho Recruit?
New to Zoho CRM?
New to Zoho Projects?
New to Zoho Sprints?
New to Zoho Assist?
New to Bigin?
Related Articles
Client Script: Enforce Non-Overlapping Schedules with Subform Date Validation in Zoho CRM
Requirement Overview A Zoho CRM user wants to have an Error Pop-up Validation based on Date fields in a Subform. i.e. A new ‘Start Time’ should not fall between any existing visit's Start and End time for a record. Use-case In an Healthcare (i.e. ...Client Script: Enforcing Weekly Patient Visit Scheduling Validation in Zoho CRM
Requirement Overview A Zoho CRM user requires a validation mechanism to ensure consistency in scheduling hospital visits. The system should enforce, where users cannot skip any week while scheduling visits to the Hospital. Use-case In a Healthcare ...Client Script: Effective way to handle Data Validation before Lead Conversion in Zoho CRM
Requirement Overview A Zoho CRM organization wants to have validation within Lead module for all Contact's mandatory fields before Lead Conversion. i.e. The Business need an easier & best way to validate lead data before Lead Conversion using default ...Client Script: How to update in Record Detail Page with One-Time Auto Refresh for OnLoad scripts
Requirement Overview A Zoho CRM user is using a Client Script to update records in the detail page. However, users often face challenges when updating fields or subforms on the Record Detail Page using default methods. Also, a sales representative ...Explore How to Invoke a Widget using Client Script in Zoho CRM as a Validation Alert
Requirement Overview A Zoho CRM user wants to have a customized validation pop-up based on changes made in the record by any user. Use-case A Car Company that has multiple warehouses located in different locations (i.e., India, USA, UAE, etc.). It ...
New to Zoho LandingPage?
Zoho LandingPage Resources