Client Script Support for List Page (Canvas)

Hello everyone!

Welcome to another week of Kaizen. In today's post lets see how Client Script can be used in Canvas List Page to mask sensitive information from specific roles and add colors to Canvas List Page records based on custom criteria.This use case solves the question raised in this post.

In this Kaizen post,

---

1. About Canvas List Page
2. Supported Events for List Page(Canvas)
3. Supported ZDKs for List Page(Canvas)
4. Use Case
5. Solution
6. Summary
7. Related Links

---

1. About Canvas List Page

The Canvas List Page provides ways to customize the record display in the module list. You can add record images, use custom buttons to represent fields, use specific font style or size for the field labels, change the alignment of field types and more. 

2. Supported Events for List Page(Canvas)

You can write Client Script for three different views of the Canvas List page.

1. Custom List view
2. Tile view
3. Table view

You can trigger Client Script on your List Page (Canvas) using the following events.

Click here to know more about the Events.

3. Supported ZDKs for List Page(Canvas)

Client Script enables you  to customize List Views using the following list of ZDKs and Client Script functions.

1. freezeColumns(option) - You can freeze list view and disable modifying columns.
2. maskField(field_name, (length,character,reverse)) - You can mask fields in the List View
3. sortByField(field_name, option) - You can sort field in the List View
4. getRecords() - You can get Records in the List View
5. selectRecords(criteria) - You can select Records in the List view by criteria
6. selectRecordsByID(ids) - You can select Records in the List view by record ID
7. clearSelection() - You can clear selected Records in the List view
8. style(style_config, criteria) - You can style Records in the List View.
   

4. Use Case

Zylker uses Zoho CRM to manage high-volume orders where customer phone numbers are sensitive data. The CRM Admin wants role-based phone number masking on the Orders List Page (Canvas). To improve visibility and speed, the Admin also wants color-coded order cards in the List View based on order status.

Role-Based Phone Number Visibility

Order Status Color Coding

5. Solution

1. Go to Setup > Developer Space > Client Script. Click +New Script.
2. Specify the details to create a script and click Next.
   
   
   
   
3. Enter the following script and click Save.
   
   

1. // Mask phone number based on user role
2. if ($Crm.user.role.name === "Sales Executive") {
3. 
   
4.     // Mask 7 digits for Sales Executive
5.     ZDK.Page.getList().maskField("Phone_Number", {
6.         length: 7,
7.         character: "#",
8.         reverse: true
9.     });
10. 
    
11. } else if ($Crm.user.role.name === "Support Agent") {
12. 
    
13.     // Mask 10 digits for Support Agent
14.     ZDK.Page.getList().maskField("Phone_Number", {
15.         length: 10,
16.         character: "#",
17.         reverse: true
18.     });
    }
19. 
    
20. // Highlight cancelled orders in light red
21. ZDK.Page.getList().style({
22.         record: {
23.             backgroundColor: "#FFD6D6"
24.         }
25.     },
26.     "(Status:equals:Cancelled)"
27. );
28. 
    
29. // Highlight delivered orders in light green
30. ZDK.Page.getList().style({
31.         record: {
32.             backgroundColor: "#D3F9D8"
33.         }
34.     },
35.     "(Status:equals:Delivered)"
36. );

1. Use $Crm.user.role.name to retrieve the role of the currently logged-in user.
2. When the role is Sales Executive, use ZDK.Page.getList().maskField() on the Phone_Number field to mask the first 7 digits, where 
1. length defines how many characters should be hidden
2. character: '#' specifies the masking symbol
3. reverse: false ensures masking starts from the beginning, allowing partial visibility.
3. When the role is Support Agent, use ZDK.Page.getList().maskField() on the Phone_Number field to mask all 10 digits, fully hiding the phone number using the same masking parameters.
4. Use ZDK.Page.getList().style() to apply conditional styling to list records by configuring the record parameter to set the row backgroundColor.
5. Apply the condition (Status:equals:Cancelled) to highlight cancelled records in light red, and (Status:equals:Delivered) to highlight delivered records in light green, enabling quick visual identification.
   
   
6. Here is how the Client Script works for a "Sales Executive".
   
   
   
   
7. Here is how the Client Script works for a "Support Agent".
   
   
   
   
8. Here is how the Client Script works for a for other roles like, Manager and Admin.
   
   
   

6. Summary

1. Mask sensitive fields dynamically in List Page Canvas
2. Apply role-based logic using current user context
3. Improve list view readability with conditional record styling

7. Related Links

1. List Page Canvas
   
2. Client Script Overview
3. ZDK Documentation
4. Event dictionary
   
5. Client Script related Kaizen posts

Previous Kaizen post : Kaizen #226: Using ZRC in Client Script  | Kaizen Directory

• Topic Participants

• Maadhari M

  

• Sticky Posts

• Kaizen #226: Using ZRC in Client Script

  Hello everyone! Welcome to another week of Kaizen. In today's post, lets see what is ZRC (Zoho Request Client) and how we can use ZRC methods in Client Script to get inputs from a Salesperson and update the Lead status with a single button click. In this

• Kaizen #222 - Client Script Support for Notes Related List

  Hello everyone! Welcome to another week of Kaizen. The final Kaizen post of the year 2025 is here! With the new Client Script support for the Notes Related List, you can validate, enrich, and manage notes across modules. In this post, we’ll explore how

• Kaizen #217 - Actions APIs : Tasks

  Welcome to another week of Kaizen! In last week's post we discussed Email Notifications APIs which act as the link between your Workflow automations and you. We have discussed how Zylker Cloud Services uses Email Notifications API in their custom dashboard.

• Kaizen #216 - Actions APIs : Email Notifications

  Welcome to another week of Kaizen! For the last three weeks, we have been discussing Zylker's workflows. We successfully updated a dormant workflow, built a new one from the ground up and more. But our work is not finished—these automated processes are

• Kaizen #152 - Client Script Support for the new Canvas Record Forms

  Hello everyone! Have you ever wanted to trigger actions on click of a canvas button, icon, or text mandatory forms in Create/Edit and Clone Pages? Have you ever wanted to control how elements behave on the new Canvas Record Forms? This can be achieved

• Recent Topics

• Start/Stop Timmer in Chrome Extension

  The chrome extension is great and allows you to do allot however one of the most common things employees working on projects need to do is track their time. Having an easy start/stop timer to track time would be great.

• Invalid collection string

  I haven't changed anything in one of my functions. I'm trying to run it manually and suddenly "Invalid collection string" appears. My code has 6 lines and the error says that the error is on 7th line. Why? What does this error mean? Nothing has been changed

• Zoho Directory 2025: New Features | Security Enhancements | Enriched UI

  Hello everyone, Greetings from the Zoho Directory team! 2025 has been a highly successful year for Zoho Directory. We are delighted to introduce a fresh set of features, an enriched UI, and major product enhancements. These updates aim to deliver a smoother

• zoho people 5 report

  How do I customize my report in Zoho People Report? I understand that I can get the results of multi-table queries through SQL join statements, but I don't know the relationship between each table. I tried to create a report using Attendance User Report

• Leave Report Emailed Weekly

  I am wondering if someone knows how to have a report generated either weekly or monthly or both for department heads and ownership of upcoming employee leave. For instance, it would be nice to get an emailed report on Friday for the upcoming week of who

• Zoho Flow Decision Continuing Despite Not Meeting Conditions

  I have a picklist field called Lead Status in the leads module, with the following lead Statuses: New Lead Attempted Contact - 1 Attempted Contact - 2 Attempted Contact - 3 Attempted Contact - 4 Attempted Contact - 5 Attempted Contact - 6 Attempted Contact

• Tip #55- Accessibility Controls in Zoho Assist: Exploring Vision Settings- 'Insider Insights'

  As we approach the end of the year, it’s a good moment to reflect on how we can make our tools more inclusive and easier to use for everyone. Remote support often involves long hours in front of screens, varied lighting conditions, and users with different

• Zoho Recruit Slow and Freezing on all screens

  We have had an issue with Zoho Recruit for weeks being extremely slow and at times freezing.  We have 100 mega internet, and I went into each computer and updated the virtual memory so there is more available.  Also restarted all computers daily.  Still having the issues.  Almost unable to work.

• Credit Management: #2 Configuring Right Payment Terms for Credit Control

  Think about the last time you ordered something online and saw that little note at the checkout, "Pay on Delivery" or "Pay later". It's simple, but it actually sets the tone. As a business owner, you know exactly when payment is expected. Now, imagine

• Dependent (Conditional) Fields in Zoho Bookings Forms

  Hello Zoho Bookings Team, Greetings, We would like to request the ability to create dependent (conditional) fields in Zoho Bookings registration forms. Current Limitation: There is currently no way to make one field’s available options depend on the value

• Bug Report: Search fails to find existing notes after Evernote import

  Hello, I recently migrated from Evernote (~2600 notes across 23 notebooks), but the search functionality is currently broken. The Issue: I can manually browse to a specific note and see it exists. However, when I type the exact or partial title of that

• Marketing Tip #13: Win repeat customers with post-purchase emails

  The relationship with your customer doesn’t end after the sale; that’s when it begins. A thoughtful post-purchase message shows customers you appreciate them, keeps your brand top of mind, and can even lead to another sale. You can thank them, ask for

• Zoho Form

  I have problem with Zoho Form. One of form i don't received the PDF version. Others okay except this one. W904533

• Create & Update Zoho Vault Passwords via Zoho Flow

  Hi Zoho Flow / Zoho Vault Team, We’d like to request an enhancement to the Zoho Vault integration in Zoho Flow. Current Limitation: At the moment, Zoho Flow supports only the following selected Zoho Vault actions, such as: Fetch passwords, Share passwords

• Custom Related List Inside Zoho Books

  Hello, We can create the Related list inside the zoho books by the deluge code, I am sharing the reference code Please have a look may be it will help you. //..........Get Org Details organizationID = organization.get("organization_id"); Recordid = cm_g_a_data.get("module_record_id");

• Migrate different zoho subscription to zoho one

  Dear We have different zoho subscription we need to migrate it to zoho one. Currently we are paying for zoho email, zoho expense, zoho payroll etc under different admin We need to move it too zoho one flexlible plan for all my employees

• Features, Feedback and Votes

  We’re launching the Feedback Forum for our customers. This is 'THE' place where you can add everything you’d like to see in Zoho Books. If you don't find the specific feature you need, simply add it so others can also vote for it. While we cannot promise

• Payment system for donations management

  I manage an organization where we receive donations from payers. Hence, there is no need to first create invoices and then create payments received against the invoices. What are the recommended best practices to do this in ZohoBooks?

• There Might Be A Glitch in Determining If A String Represents A URL

  I suspect there might be a glitch in determining if a string represents a URL or not. For example, I cannot embed the following URL. Perhaps the exclamation mark or parentheses are the culprit? https://en.wikipedia.org/wiki/How_the_Grinch_Stole_Chri

• Customer Management: #4 Enhance Customer Journey

  When Neha started DefineOps, a growing IT support and consulting firm, most of her work was straightforward. A client would sign up for a free version, decide whether the service works for them, and then either continue or discontinue. Billing was simple,

• Android app sync problem - multiple devices have same problem

  Hello, I am having a problem with synchronization in the Android app. When I create a drawing, the data does not sync correctly—only a blank note is created without the drawing. I tested this on multiple devices, including phones and tablets, and the

• Marketing Tip #1: Optimize item titles for SEO

  Your item title is the first thing both Google and shoppers notice. Instead of a generic “Leather Bag,” go for something detailed like “Handcrafted Leather Laptop Bag – Durable & Stylish.” This helps your items rank better in search results and instantly

• Territory Assignment Issues (Lead to Account + Contact)

  1. Lead → Account & Contact Territory Assignment on Conversion A Lead is automatically assigned one or more territories using a workflow and Lead Assignment Rules. This works as expected, and we are able to assign multiple territories to a Lead automatically.

• Marketer's Space: Proven tips to improve open rates – Part II

  Hello Marketers! Welcome back to another post in Marketer's Space! We're continuing from where we left off a fortnight ago. We ended the previous post discussing the subject line, and we'll continue from there. Let's dive right in. Pre-header Pre-header

• SQL Table slowed to a crawl

  Hi all - I seem to have noticed an update. Now whenever I am typing in the script field for the SQL tables there is a huge delay and it is all very slow. This has never been the case for me in over 5 years of using Analytics - I really hope it's fixed

• Deluge Events/search API works in user environment but not in sandbox – why?

  I am creating an Extension for Zoho CRM using Zoho Sigma Platform I’m using the following Deluge code to search Events in Zoho CRM based on Start_DateTime: criteria = "(Start_DateTime:greater_than:2025-12-20T00:00:00+00:00)"; url = "crm/v8/Events/search?criteria="

• Ensure Consistent Service Delivery with Comprehensive Job Sheets

  We are elated to announce that one of the most requested features is now live: Job Sheets. They are customizable, reusable forms that serve as a checklist for the services that technicians need to carry out and as a tool for data collection. While on

• What are Zoho Meeting capabilities included in Zoho Workplace Standard?

  I am evaluating using Zoho Meeting for my organization, but it is not clear what Zoho Meeting capabilities are already included in Zoho Workplace Standard. - Are meeting recordings included in Workplace Standard? - Can we invite external meeting participants

• How can I get the participant list of a reoccurring meeting afterwards?

  I'm trying to use the Meeting Participant Report from the API docs but when I call it on a reoccurring meeting it returns that there are no participants because it thinks I'm talking about the meeting in the future. Is there a way to use webhooks or some

• Function #50: Send Mass emails to your customers

  Hello everyone, and welcome back to our series! We have reached a milestone of 50 Functions, which means that we have automated 50 different tasks in Zoho Books. Every Friday, we have shared a nifty function aimed at either automating a task or streamlining

• Full Hebrew Language Support for Client-Side Zoho Assist Interface

  Dear Zoho Assist Team, We would like to request an enhancement to Zoho Assist's client-side interface to support full Hebrew language customization, including all popups, notifications, and session-related messages. Current Limitation The Join page allows

• Add Hebrew & RTL Support to Feedback Widget

  Hello Zoho Desk Team, How are you? We are using Zoho Desk and would like to utilize the Feedback Widget. While Zoho Desk itself supports Hebrew and RTL, the Feedback Widget unfortunately does not. We kindly request that Hebrew and full RTL support be

• Merge Tickets Directly from Contact Page in Zoho Desk

  Dear Zoho Desk Support Team, We are writing to request a new feature that would allow users to easily merge tickets directly from the contact page in Zoho Desk. Currently, the only option to merge tickets is from the Tickets list view page, which can

• Different languages for users

  Hello, Do you plan to enable individual users to select their languages for interface? Currently language can be changed for everyone - it looks like a settings for a whole portal, which is not good when you are working internationally. Best regards,

• Kaizen #222 - Client Script Support for Notes Related List

  Hello everyone! Welcome to another week of Kaizen. The final Kaizen post of the year 2025 is here! With the new Client Script support for the Notes Related List, you can validate, enrich, and manage notes across modules. In this post, we’ll explore how

• 2025年 Zoho コミュニティ 活動の振り返り 🎉

  ユーザーの皆さん、こんにちは！コミュニティチームの中野です。 2025年も多くの学びと出会いがあったZoho コミュニティ。 本記事では今年の活動を振り返りながら、フォーラムの投稿・参加者の皆さん・イベントのハイライトをご紹介していきます。 目次 フォーラム：注目の投稿 フォーラム：多くの貢献をしてくださった方々 ユーザー交流会振り返り ワークアウト振り返り その他のトピックス 1. フォーラム：注目の投稿 本フォーラムでは様々な議論と知識の共有が行われました。 ユーザーの皆さんが日々の業務で直面する課題を投稿し、経験豊富なユーザーさん達が実践的な解決策を提供してくださいました。

• Customer Management: #3 Giving Customers Control & Privilege

  Rio, the founder of RenoTech Solutions, a fast-growing digital service company, found itself juggling a dozen different services for its clients. They handled one-time setup fees, recurring monthly invoices, and custom milestone-based billing for projects.

• Can I use a Standalone CRM Function as the Callback URL For Async Export Data API?

  I am creating an export job using this API https://www.zoho.com/analytics/api/v2/bulk-api/export-data-async/create-export/view-id.html There is a "callbackUrl" key in the CONFIG object. I tried copying the URL for a standalone function in CRM which can

• Add RTL (Right-to-Left) Text Direction Support Across All Zoho Learn Editing Interfaces

  Hi Zoho Learn Team, Hope you're doing well. We would like to request an important enhancement to Zoho Learn regarding support for right-to-left (RTL) languages such as Hebrew and Arabic. 🔹 Current Issue While the Knowledge Base Article editor provides

• Add Hebrew Support for Meeting Transcripts Provided by ZIA in Zoho Cliq

  Hi Zoho Cliq Team, Hope you're doing well. We would like to request the addition of Hebrew language support for the Meeting Transcript and Summary feature in Zoho Cliq. Currently the transcript and summary feature is available for recorded meetings and

• Next Page