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

• Reusable Custom Functions Across Department Workflows

  Dear Zoho Desk Team, We appreciate the powerful workflow automation capabilities in Zoho Desk, particularly the ability to create and use custom functions within workflows. However, we have encountered a limitation that impacts efficiency and maintainability.

• Contact data removes Account data when creating a quote

  Hi, Our customer has address fields in their quote layout which should be the address of the Account. They prefill the information, adding the account name - the address data is populated as per what is in the account - great. However when they then add

• Feature Request - Gift Cards or Gift Voucher Capability in Zoho Commerce

  Hi Zoho Commerce team, I'm comming accross more and more retail businesses who sell gift cards. As there is currently no way to manage this in Zoho Commerce, it is a blocker to addoption. This is particularly popular in Europe and North America. I recently

• Don't Allow Customer to Edit Values After Submitting Ticket

  After a customer submits a ticket through the customer portal, they can go into the ticket and see some of the values from the questions they answered in the sidebar. Currently, a customer can edit these values even after they submitted them. This makes no sense. We ask very specific questions that we don't want customers to later change! Please disable the ability for customers to edit the values to their submission questions in the portal. Screenshot attached.

• Analytics <-> Invoice Connection DELETED by Zoho

  Hi All, I am reaching out today because of a big issue we have at the moment with Zoho Analytics and Zoho Invoice. Our organization relies on Zoho Analytics for most of our reporting (operationnal teams). A few days ago we observed a sync issue with the

• text length in list report mobile/tablet

  Is there a way to make the full text of a text field appear in the list report on mobile and tablet? With custom layouts, the text is always truncated after a certain number of characters.

• Automation #4 - Auto Delete Tickets based on Rules

  This is a monthly series in which we pick some common use cases that have been either discussed or most asked about in our community and explain how they can be achieved using one of the automation capabilities in Zoho Desk. Unwanted tickets spamming

• Automation #3 - Auto-sync email attachments to tickets

  This is a monthly series where we pick some common use cases that have been either discussed or most asked about in our community and explain how they can be achieved using one of the automation capabilities in Zoho Desk. Most of our customers use email

• Automation #11 - Auto Update Custom Fields with Values from Emails

  This is a monthly series designed to help you get the best out of Desk. We take our cue from what's being discussed or asked about the most in our community. Then we find the right use cases that specifically highlight solutions, ideas and tips to optimize

• Automation #13 - Auto assign tickets based on agent shift time

  This is a monthly series designed to help you get the best out of Desk. We take our cue from what's being discussed or asked about the most in our community. Then we find the right use cases that specifically highlight solutions, ideas and tips to optimize

• Automation #14: Capture Jira Issue Key/ID in a Ticket Custom Field

  Hello Everyone! This month's edition brings you a custom function to consolidate your records associated with Jira integration. Jira integration enables support engineers and R&D units to collaborate seamlessly on feature development, product improvement,

• Automation #16: Automate Ticket Reopening on Scheduled Timestamp

  Hello Everyone! This edition uncovers the option to schedule reopening a ticket automatically. Zylker Finance tracks insurance policyholder activities through Zoho Desk. For policyholders who pay monthly premiums, tickets are closed upon payment completion.

• Automation#19:Auto-Close Tickets Upon Task Completion

  Hello Everyone! We’re excited to bring you another custom function this week. In this edition, we’ll show you how to automatically close tickets when all associated tasks are marked as completed. Let’s see how ZylkaPure, a leading water filter company,

• Automation #15: Automatically Adding Static Secondary Contacts

  Rockel is a top-tier client of Zylker traders. Marcus handles communications with Rockel and would like to add Terence, the CTO of Zylker traders to the email conversations. In this case, the emails coming from user address rockel.com should have Terence

• How to apply customized Zoho Crm Home Page to all users?

  I have tried to study manuals and play with Zoho CRM but haven't found a way how to apply customized Zoho CRM Home Page as a (default) home page for other CRM users.. How that can be done, if possible? - kipi Moderation Update: Currently, each user has

• City field suggestion in Zoho Books

  Hi team, We are using Customers module in Zoho Books. In the Address section, we want to understand whether the City field can show suggestions while typing using any API or built-in feature. For example, if a user types “Mum”, can the system suggest

• Improved UX design for Projects CRM integration

  The current integration embeds the entier projects inteface into the CRM this is confusing and allows users to get lost. For example as a user i navigate to an account and go down to the related projects list and want to get information about a specific

• Link Purchase Order to Deal

  Zoho Books directly syncs with contacts, vendors and products in Zoho CRM including field mapping. Is there any way to associate vendor purchase orders with deals, so that we can calculate our profit margin for each deal with connected sales invoices

• Transformer vos stocks en décisions intelligentes avec Zoho Inventory et Zoho Analytics

  Zoho Inventory permet de suivre facilement les niveaux de stock et d’anticiper les restockages. Pour de nombreuses entreprises, cela suffit à gérer les opérations au quotidien. Mais à mesure que l’activité se développe, cette clarté peut commencer à montrer

• WorkDrive Download Issue

  My client has been sending me files via WorkDrive, which generally has worked fine. Recently files won't download at all. If you try and individually select and download a file, a popup will appear in the bottom right saying it's preparing and then it

• Zoho Commerce - Poor Features Set for Blogging

  Hi Zoho Commerce team, I'm sure you will have noticed that I have been asking many questions about the Blogs feature in Commerce. I thought that it would be useful if I share my feedback in a constructive way, to highlight the areas which I feel need

• Security Enhancements | Migrate to the Updated Policies

  Hello everyone, Zoho Directory's security policies have been updated and reorganized into three new policies with features that enhance the overall organization security. These policies provide a stronger and more secure sign-in methods and improve the

• Bring Zoho Shifts Capabilities into Zoho People Shift Module

  Hello Zoho People Product Team, After a deep review of the Zoho People Shift module and a direct comparison with Zoho Shifts, we would like to raise a feature request and serious concern regarding the current state of shift management in Zoho People.

• Quick Create needs Client Script support

  As per the title. We need client scripts to apply at a Quick Create level. We enforce logic on the form to ensure data quality, automate field values, etc. However, all this is lost when a user attempts a "Quick Create". It is disappointing because, from

• How to block a WhatsApp user for sending spam

  Is there a way to block those whatsapp users that just come to play and annoy our service, they also spam us. We have a waba service with sales iq

• Inquiry regarding auto-save behavior for Zoho Sign Embedded Sending

  Dear Zoho Support Team, I am currently integrating Zoho Sign's Embedded Sending functionality using iframes on my website. I would like to know if there is a way to ensure that the document state (including any added fields) is automatically saved as

• Introducing Connected Records to bring business context to every aspect of your work in Zoho CRM for Everyone

  Hello Everyone, We are excited to unveil phase one of a powerful enhancement to CRM for Everyone - Connected Records, available only in CRM's Nextgen UI. With CRM for Everyone, businesses can onboard all customer-facing teams onto the CRM platform to

• Automation#17: Auto-Create Tasks in Zoho Projects Upon Ticket Creation in Zoho Desk

  Hello Everyone, This edition delivers the solution to automatically create a task in Zoho Projects when a ticket is created in Zoho Desk. Zylker Resorts uses Zoho Desk for bookings and handling guest requests. Zylker resorts outsources cab bookings to

• Automation#20 : Auto-Add Ticket Tags based on Keywords

  Hello Everyone! Welcome to unveiling custom functions on our Community series. This week's post lets you add tags to your tickets automatically based on the keywords in the ticket subject and the ticket thread. Discover how this custom function helps

• Automation#21: Track Ticket Transfers Across Departments

  Hello Everyone! With Halloween just around the corner, we'd like to let you know the Zoho Desk team is always there to sweep away your customer service troubles! This week, we’re excited to introduce a custom function that tracks tickets moved between

• Email Integration - Zoho CRM - OAuth and IMAP

  Hello, We are attempting to integrate our Microsoft 365 email with Zoho CRM. We are using the documentation at Email Configuration for IMAP and POP3 (zoho.com) We use Microsoft 365 and per their recommendations (and requirements) for secure email we have

• Homepage not assignable to group

• MS Teams for daily call operations

  Hello all, Our most anticipated and crucial update is finally here! Organizations using Microsoft Teams phone system can now integrate it effectively with Zoho CRM for tasks like dialling numbers and logging calls. We are enhancing our MS Teams functionality

• Automation#22 Track Ticket Duration at Specific Status

  Hello Everyone! Welcome back to the Community Learning Series! Today, we explore how Zylker Techfix, a gadget servicing firm, boosted productivity by tracking the time spent at a particular ticket status in Zoho Desk. Zylker Techfix customized Zoho Desk’s

• Automation#23: Automate Guided Conversations in Zoho Desk with Business Hours

  Hello Everyone, This week's edition introduces a custom function designed to automate Guided Conversations in Zoho Desk, based on your business hours. With this feature, you can align the bot's behavior with your business schedule, ensuring a smooth and

• Address changes in quote form

  When entering a quote, the first piece of information required is the Account, which properly populates the billing and shipping address fields. Then I use the lookup function to select a contact, and when I do, the billing and shipping addresses are

• Automation#24: Auto-Update custom field from Accounts to Tickets

  Hello Everyone! Welcome back to the Community Learning Series! This episode dives into how Zylker Techfix streamlines account-related ticket references. Previously, employees had to manually check account details to retrieve specific customer information,

• Automation#31: Automate Splitting Names for New Contact Records

  Hello Everyone, This week, we present to you a custom function, which allows you to split the first and last names from the user's email ID based on the separator used in the ID. Having grown into a large firm, Zylker Techfix aims to optimize its processes,

• The same Contact associated to multiple Companies - Deals

  Hi, I would like to know if there is an option to associate the same contact with multiple companies (two or more) deals, using the same contact details for all. This is because we have contacts who are linked to different companies or branches of the

• local file csv import problem

  The issue occurs when I upload a CSV file via Databridge. In the preview, everything looks correct — the values are in the proper columns. However, after clicking Import, the first column becomes empty, and the values from that column appear in a new

• Next Page