Kaizen #59 - Creating alerts and custom messages using Client Script

Hello everyone! 

We are happy to resume our Zoho CRM Developer Community series - The Kaizen series!

Welcome back to the new start of Kaizen!

This post is about Client Script and its simple use cases involving ZDK Client functions.

What is Client Script?

The Client Script feature gives you a seamless platform for achieving and extending your business cases in Zoho CRM by allowing Java Script code execution in your browser. It enables you to configure events for the UI components and define the actions once those events are triggered. 

The ZDK Client Functions available in Client Script are,

ZDK Client Function	Description
showMessage	To display a text message on create/clone/edit/detail(canvas) page.
showConfirmation	To display a confirmation box with accept and reject message on  create/clone/edit/detail(canvas) page.
showAlert	To show alert message on create/clone/edit/detail(canvas) page.
openMailer	To open mailer component from detail(canvas) page.

Use Case

Let us consider that you want to achieve the following using Client Script.

1. Calculate age based on Date of Birth and display the message "Age is more than 80" whenever the age is above 80 in create page of Policyholder module.
2. Show the alert message "You cannot change the Rating of a verified account" whenever you try to update the field Rating in Accounts module.
3.  When you click the mail button on detail(canvas) page, ask for confirmation and open a mailer window.
   

Solution using Client Script

Note:

The solution listed in this post includes detail(canvas) page and create page.

To create a canvas page, 

• Go to Setup > Customization > Canvas
• Click Create Record Detail Page. 
• On the Create a Custom Record pop up that appears, select the module as "Accounts" and select the required layout for the canvas page
• Choose a template from the gallery and click Select.
• Enter a name and save the canvas page.
• Click Canvas Assignment and assign the page to the required profiles.
•  Click here for more details on creating a canvas page(Customizing the record detail page).
  

1. Calculate age based on Date of Birth and display the message "Age is more than 80" whenever the age is above 80 in create page of Policyholder module

• Go to Setup > Developer Space > Client Script. Click +New Script.
• Specify the details to create a script and click Next.

• Enter the following script in the Client Script IDE and click save.
  

1. function  getAge(dateString) 
   
2. {
   
3. var today = new Date();
   
4.  var birthDate = new Date(dateString);
   
5. var age = today.getFullYear() - birthDate.getFullYear();
   
6.  var m = today.getMonth() - birthDate.getMonth();
   
7.  if (m < 0 || (m === 0 && today.getDate() < birthDate.getDate())) 
   
8. {
   
9.    age--;
   
10. }
    
11.  return age;
    
12. }
    
13. let age = getAge(value);
    
14. var age_field = ZDK.Page.getField("Age");
    
15. var category_field = await ZDK.Page.getField("Category");
    
16. age_field.setValue(age);
    
17. if (age > 80) {
    
18. ZDK.Client.showMessage('Age is more than 80', { type: 'info' });
    
19. }

• You can see the code working from the create page.  You can also see how the client script works using the Run component of the Client Script IDE.
  

• You can use any of the following types in showMessage() function
  

Possible 'type'	Script
info	ZDK.Client.showMessage('message', { type: 'info' });
warning	ZDK.Client.showMessage('message', { type: warning });
error	ZDK.Client.showMessage('message', { type: error });
success	ZDK.Client.showMessage('message', { type: success });

2. Show the alert message whenever you try to update the field Rating

• Go to Setup > Developer Space > Client Script. Click +New Script.
• Specify the details to create a script and click Next.
  

• Enter the following script in the Client Script IDE and click save.
  

1. ZDK.Client.showAlert('You cannot change the Rating after account creation');

• Here is how the Client Script works. You can also see how the client script works using the Run component of the Client Script IDE.
  

3. Configure the mailer box with the click of a button

First of all, you need to add the button to the detail(canvas) page.

• Go to Setup > Customization > Canvas.
• Right click on the Canvas page for Accounts module and click Edit.
• Click Elements, drag and drop the button wherever required and specify a label for the button.
• Right click on the button, select Add Element ID and enter the ID of the button in the pop up that appears.
• Once the button is created, you can configure Client Script in two ways:
• Right click on the button--> Add Client Script-->onClick. The Client Script IDE appears with the event type as Canvas Button Event.
  

                                                             (or)

• Go to Setup > Developer Space > Client Script. Click +New Script.
• Specify the details to create a script and click Next.
  

• Enter the following script and click save.
  

1. var isProceed = ZDK.Client.showConfirmation('Do you want to open the mailer window?','Proceed','Cancel');
2. //If user clicks Proceed button
   
3. if (isProceed) {
   
4. ZDK.Client.openMailer({ from: '', to: [{ email: '', label: 'ABC Industries' }], cc: [{ email: '', label: 'ABC Industries' }], subject: 'Greetings from ABC Industries!', body: ' ' });
   
5. }

• The showConfirmation() function will return a boolean value based on the user selection. You should capture this boolean value using a variable and write the actions based on the boolean value returned. Here the variable isProceed will capture the user response and based on that boolean value, the mailer box will get displayed.
• Here is how the client Script works,
  

We hope you found this post useful. We will meet you next week with another interesting topic!

If you have any questions let us know in the comment section.

Cheers!

Click here for more details on Client Script in Zoho CRM.

Related Links

Client Script Overview

Creating a Client Script

Client Script Events

Client Script IDE

Use cases of Client Script

• Topic Participants

• Maadhari M

  

• tbiedma

• Joe Sweeney

  

• Anz

• Jason

• Sticky Posts

• How to reach the official Zoho Support channels and avoid fake ones.

  Dear Customers, Thanks a lot for choosing Zoho! Our applications are built to help achieve your day-to-day business goals. We are committed to engaging with you, to understand and develop solutions that enhance your productivity.  We are happy and ready to help you use our services effectively. Understanding and avoiding fake support Just like using popular bank names and financial applications for phishing purposes, using Zoho and claiming to be providing Zoho Support or services with false numbers

• Function #35: Close all tasks associated with a lead and create a new task.

  Welcome back everyone! Last week, we learnt how to close all tasks of a deal depending upon the deal stage. This week, let's look at a custom function that lets you close all of the tasks associated with a lead while simultaneously creating a new task, like when you need to halt all progress towards a lead while the lead is not available at the moment but create a reminder task. Business scenario: The success of a company, in one way or another, is determined by the leads it gets. Each lead is just

• Zoho CRM Webinar - Redesigning Daily User Experiences with Canvas

  &lt;br&gt; Your users across roles use the CRM for day-to-day tasks that are necessary. Whether they perform their tasks on time, the right way, or at all depends on a lot of factors, including User Experience. Many businesses struggle with rigid layouts,

• Join us at the Canada ZUG Meetup: What’s New in Zoho CRM

  Hello Zoho Community! Start your year with fresh insights into Zoho CRM’s latest updates and tools. Whether you're a CRM beginner or a experienced user, this meetup is crafted to help you optimise your processes and leverage new features. Explore practical

• CRM Hack #2: Automate sending of birthday greetings to your customers.

    Hello everyone! What sets you apart as a sales person is your ability to add that personal touch to your business relationship with your customers. Sending a gift on a special day, or leaving a note wishing them on their birthdays, are small, yet significant actions that show your customers that you care. And these are actions done without any expectations :) You must be engaging with a lot of customers and it is highly unlikely that they all are your friends on Facebook or some social channel,

• Recent Topics

• Problem - cant add Users (i.e. Zoho one / CRM Users) to BCC or CC in email, i.e. Sales orders or Retainers

  I can go to zoho books email templates, and select any email template, and automatically include any Zoho One user, i.e. member of staff. However in the context of sending an email, it will not let us add a member of staff from the user list, instead

• UK MTD ITSA

  UK Making Tax Digital for Income Tax I have had notice this is to apply from April 2026. What is Zoho doing about this? I will need to start planning to implement this in the next months so need an update as to what I will and will not be able to do in

• Partial refunds

  I am trying to process refund for a one item invoice, however the refund is partial: i am getting this error while creating credit note, can anyone share some wisdom about this

• Zoho Books Roadshows are back in the UAE!

  Hello there, Business owners and accounting professionals of the UAE, we’re coming to your cities! FTA accredited Zoho Books is now officially one of the Digital Tax Integrators in the UAE. With the newly launched direct VAT filing capabilities, we're

• New user After moving over from QBO

  New user observations/suggestions. QBO took away a lot of features I was used to with the desktop version. Chaos ensued. Zoho Books has a lot of what I was used to and a bit more. Good deal Some things I have run into and suggest some upgrades. 1: The

• Sole Trader - Financial Advisor (Appointed Representative) - Paid via Capital Account but no Invoicing...

  Hi. I'm about to venture into a new business after 12 months of intensive learning/exams. A little chuffed if I may say so especially at 52! I really like the look of ZoHo Books for my modest enterprise but I'm in need of some guidance, please. My services

• Multi-Unit Inventory with Flexible Unit Selection (Purchase in One Unit, Sell in Another)

  We need multi-unit inventory management in Zoho Books with the flexibility to choose units (e.g., Box or Piece) at the time of purchase or sale. For example, if 1 Box = 10 Pieces, we should be able to record purchases in Boxes but sell either in Boxes

• Disputed Purchase Invoices

  We have recently moved to Zoho Books from Sage. In Sage we were able to post a purchase/vendor invoice but mark it as on dispute. This would usually be a pricing query or if something was damaged. It would show in their ledger, so we could agree their

• No TDS Deduction

  In some of our case, where we are reselling items at the same rate we purchased. In this scenario, Indian IT Law has a provision to request customer not to deduct TDS if the transaction value is same. TDS is paid by us (intermediary reseller) before we

• CBSA - GST CHARGES on imports

  Hi there, We have a questions about landed cost categorization. We received a shipment from overseas. CBSA invoiced us for the GST on the items. Now we entered the CBSA-GST as a separate bill and attached it as landed cost to the main invoice based on

• Zoho Books

  How do I manually insert opening balance?

• Sales order & purchase order item links for item details

  This is fantastic for checking lots of things, I use it a lot. It would be great to see it extended to invoices & bills On another note, may as well throw in my favourite whinge ..... Wish you guys would get the PO receive differences sorted urgently,

• Bank charges are applied. Please select a bank account.

  Hello, I'm trying to add bank charges to a customer payment, but I get the error message "Bank charges are applied. Please select a bank account." I found this old thread, where it says that I need to "select a Bank account for the 'Deposit To' dropdown

• How to add receipts

  How to add receipts

• Support for auto-upgrade in TrueSync (for Windows)

  WorkDrive TrueSync app now supports auto-upgrading to the latest version for Windows OS. You must manually download and install the TrueSync app version 3.4.0 to avail this feature. Download the latest TrueSync app for Windows (version 3.4.0) Supported

• WorkDrive API Documentation

  WorkDrive provides users and developers an extensive set of APIs to help integrate functionalities of Zoho WorkDrive with other Zoho applications and third-party tools. We have published the official WorkDrive API Documentation page for all external users.

• March 15, 2023: Zoho Docs is discontinued

  As of today (March 15, 2023) Zoho Docs is discontinued for all users. We would like to thank our customers for trusting us for so many years! Going forward, we're confident you'll enjoy using Zoho WorkDrive for all your advanced file management and collaboration

• Introducing WorkDrive 4.0: Enhanced productivity. Advanced data administration. (Phase 1)

  Hello All, We're excited to share the release of WorkDrive 4.0, which includes important new features and enhancements focused primarily on productivity, secure collaboration, data administration, integrations, and user experience. Read the official announcement

• External download link limit

  Can You please help us to understand this For Zoho WorkDrive external users, the download limit is a maximum of 5 GB total download size and a maximum of 50 first-level files and folders What is the meaning of first level? We are using these files in

• Dynamically catching new file creations

  I have a team folder with many subfolders, and in those folders we add new documents all the time. I'd like to have a workflow or script to notify me (and then take other actions) when a file is added anywhere in that structure that ends in "summary.txt".

• Rotate an Image in Workdrive Image Editor

  I don't know if I'm just missing something, but my team needs a way to rotate images in Workdrive and save them at that new orientation. For example one of our ground crew members will take photos of job sites vertically (9:16) on his phone and upload

• Workflow workdrive rollout

  Hi! When will workflow be rolled out to all users? Thanks.

• Creating and managing a Team Folder using WorkDrive TrueSync

  Hello everyone, Are you tired of constantly switching between your Desktop TrueSync app and the WorkDrive web app to create and manage Team Folders? We’ve made things easier for you. You can now create and manage Team Folders directly within the TrueSync

• Edit images seamlessly with WorkDrive's built-in Image Editor

  Are you tired of switching between multiple tools just to make simple edits to your images? We understand the hassle, which is why Zoho WorkDrive now comes with a built-in image editing tool, powered by Zoho Annotator. This tool allows you to edit images

• Supercharge your email workflow with WorkDrive's add-in for Microsoft Outlook

  Consider this: You’re handling a critical project, and your inbox is packed with important attachments, email threads, and client communications. The back-and-forth routine of downloading files to your computer, uploading them to WorkDrive, and manually

• Secure and promote your content with Custom Watermarking

  Imagine this: You’re a professional photographer who regularly shares your work online with potential clients and collaborators. Recently, you notice that some of your images have been reposted without any credit or permission. This not only impacts your

• Join us in Singapore for the Zoho WorkDrive User Group meetup!

  Hello, everyone! Exciting news! We'll be hosting an upcoming Zoho WorkDrive user group meetup in the beautiful city of Singapore this November. At this Zoho User Group meetup, we'll guide you through ways to use WorkDrive as a platform and build custom

• WorkDrive TrueSync now supports ARM64-based Windows devices!

  We’re excited to announce that the Zoho WorkDrive TrueSync app now fully supports Windows devices with ARM64 architecture! Whether you're working on an ARM-based device or an x64 processor, you can now enjoy the same seamless file synchronization experience

• Option to Disable Download for Documents Shared via Permalink

  Dear Zoho Writer Team, Currently, when sharing a Writer document using the regular permalink (Collaborators with external users), there is no option to restrict the ability to download the document. While the external share link allows such restrictions,

• How to Download a File from Zoho WorkDrive Using a Public Link

  How to Download a File from Zoho WorkDrive Using a Public Link If you're working with Zoho WorkDrive and want to download a file using a public link, here's a simple method to do so using API or a basic script. This approach helps developers or teams

• domain not verified error

  Hi when i try to upload a video from zoho creator widget to zoho work drive iam getting domain not verified error.I don't know what to do .In zoho api console this is my home page url https://creatorapp.zoho.com/ and this is my redirect url:www.google.com.Iam

• Live Webinar: Getting Started with Zoho WorkDrive - A Complete Overview

  Hello everyone, We’re excited to invite you to our upcoming live webinar! Discover how to set up your team, bring in your data, and make the most of WorkDrive’s collaboration, organization, AI, and security capabilities. This session is perfect for anyone

• Calendly One-way sync- Beta Access

  Hello Community, Many of our Zoho Calendar users have expressed their interests in Zoho Calendar and Calendly integration. We've been tightly working on with Calendly team to provide a two-way sync between Calendly and Zoho Calendar. However, there have

• The year that was at Zoho Calendar 2023- Part 2

  In continuation with our previous post on all the exciting updates and improvements that have shaped Zoho Calendar over the past 12 months, Lets delve into more: Bring your calendars together- Introducing Zoho Calendar and Outlook calendar synchronisation

• Tip of the week #18: Change the event organizer in Zoho Calendar.

  We cannot always be available to conduct an event when we organise one. In these circumstances, you can use Zoho Calendar to change the event organizer at any moment before the event begins. This way, you can avoid cancelling the event while still taking

• Tip of the week #20: Create and manage multiple personal calendars.

  Zoho Calendar provides users with the facility to create and manage as many calendars as required. All these calendars can be managed and edited as per user requirements. You can alter the calendar view, make changes to the calendar theme, share the calendar

• Tip of the week #24: Subscribe to the calendars of a Zoho Calendar user.

  Calendars that are created by Zoho Calendar users can also be added to your Zoho calendar. All public calendars listed by the users will be available when you enter the email address. You can choose the calendar you need to subscribe to. Once the email

• Tip of the week #26: Import/ Export calendars in Zoho Calendar.

  Any calendar on the web or calendars that you create in any other calendar application can be imported in to Zoho Calendar. This will help you to add the events from the calendars that you import to your Zoho Calendar. You also have the option to export

• Removing calendar for zoho email group

  How do I make it so that an email group created in Zoho Mail does NOT have a calendar? I have a couple groups for our phone systems voicemails - one for each department. Voicemail recordings are sent to this groups email address so they have access to

• Tip of the week #27: Edit personal calendars in Zoho Calendar.

  In Zoho Calendar, the personal calendars you create can be edited to make changes you need to make. Edit a Personal Calendar The following changes can be made to the personal calendar by editing it: Calendar title Calendar color Reminders and Description

• Next Page