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

• Unable to access my Zoho forms account

  For some days now, I haven't had access to my Zoho Forms account. I keep getting an error that says, "You are an inactive user in your organization" via the mobile app and "You don't have permission to access this organization" via the web. I was removed

• Identify Unused Deluge Functions in Zoho CRM

  Hello Zoho Support Team, I would like to request a feature that helps administrators identify unused or rarely used Deluge functions in Zoho CRM. Currently, Deluge functions are distributed across different areas, and there is no centralized overview

• User Automation: User based workflow rules & webhooks

  User management is an undeniable part of project management and requires adequate monitoring. As teams grow and projects multiply, manual coordination for updating users & permissions becomes difficult and can give way to errors. User automation in Zoho

• Update on V2 API End-of-Life Timeline

  Dear Users, Earlier this year, we shared the launch of the V3 APIs and requested users to migrate from the older V2 APIs by December 2025. We have received valuable feedback from our users and partners regarding their migration timelines. We are happy

• Run a workflow after record merge

  Hello, We are wondering if there is a way to trigger a workflow after two records are merged? We have a sms service that use to text back and forth with Prospects and Contacts. To make it easy for our users, we automatically create them in this other

• Live webinar | The Evolution of Zoho Show: 2025 Feature Recap

  2025 has been a year of exciting updates and features for Zoho Show. From advanced design and formatting tools to smarter presentation delivery, enhanced collaboration, and AI-powered features—along with the launch of our desktop apps, Show has continued

• Batch Tracking custom function

  Hi fellow zoho users, We have our ecommerce site setup to shopify. I have some products I want to add batch tracking too, my only issue is that it breaks our shopify workflow (create sales order, invoice, payment, package) because it requires us to manually

• Include Suggested Articles in New Ticket Email

  When someone creates a new ticket, is there any way to include recommended knowledge base articles (like the ones Zia Suggests) in the email notification to the user? When they're waiting for a reply, it would be nice to have sent them some recommended

• Item Bulk Edit - Allow for Reorder Level

  We're implementing a process for using the Reorder Level field for Items, and I have to go through and add this value to a huge chunk of our Items. It's driving me bonkers that I have to do this individually through the UI rather than bulk updating. It

• Sharing my portal URL with clients outside the project

  Hi I need help making my project public for anyone to check on my task. I'm a freelance artist and I use trello to keep track on my client's projects however I wanted to do an upgrade. Went on here and so far I'm loving it. However, I'm having an issue sharing my url to those to see progress. They said they needed an account to access my project. How do I fix this? Without them needing an account.

• Zoho Flow + QuickBooks Estimates – Line items not created from CRM subform

  Hi everyone, I’m trying to create QuickBooks Estimates from Zoho CRM Quotes using Zoho Flow. I’m aware that Zoho Flow’s native “Create Estimate” action does not support multiple line items, so I followed the community guidance for Invoices using a custom

• SAP S/4 HANA Integration via ZOHO Flow

  Hi How do I change the SAP Client ID while creating a new connection ? MY client ID is 421. I believe the client id should be an input field for length 3 numbers rather then a drop down to select from a fixed set of values. Thanks

• VLOOKUP FUNCTION PROBLEM

     Hello, i have a problem with the VLOOKUP  function in my sheet http://public.sheet.zoho.com/public/tonimoreno/indicemasacorporal2 in cell D2. This function doesn't work correctly and always returns the last content of the range. Can you help me?

• Zoho Flow Completely Broken?

  Since December 13th, 100% of our flows have stopped working completely. Nothing is working or triggering??? I called support & sat on the line with them for 2 HOURS until they finally concluded it was a back-end problem on their end?? Now i'm calling

• Print / Export full Dashboard page

  Hello Zoho team, It is currently only possible to print/export one component of a dashboard at a time. Requesting the option to print/export a full dashboard page with all components to a pdf or picture. Doing through the browser doesn't give good results.

• emails duplicated in my outlook client

  Hello I am just new here and I have a litle problem that I do not find how to solve. I sumarise here after. Your help would be very appreciated. I have just recently contracted this zoho mail servicesservices as an initial evaluation yesterday night. I then:   - opened a free account  - created 1 initial email address ..........@domain.com  - created a second email address ..........@domain.com - proceeded with the config instructions (checking the ownership of my domain, changing MX etc... ) as

• How to check task starting time in zoho mobile app?

  I am using the Zoho mobile app on my iPhone, and I am not able to see the task's starting and finishing times. When opening the Task information / Details, I can only see the Task start date and due date, but not the time. Is there any way to check a

• Creating an extension in Sigma: Zoho CRM isn't selectable as a service

  I have 2 Zoho accounts which are part of 2 different workplaces. One workplace is able to select 'Zoho CRM' as a service option when creating a new extension, the other one is not. I'm not sure what the exact differences are between them. What do I need

• List of packaged components and if they are upgradable

  Hello, In reference to the article Components and Packaging in Zoho Vertical Studio, can you provide an overview of what these are. Can you also please provide a list of of components that are considered Packaged and also whether they are Upgradable?

• How to track a list of ALL the items that ONE customer bought?

  Hello, I am interested in getting a list of all the items that only ONE of my customers bought, and the invoices are what show up instead. It's very tedious to go through every single invoice when we sell a lot of items to this customer. Surely there

• RouteIQ for Zoho FSM

  Beste, Zou wel top zijn dat we een RouteIQ hebben voor FSM aangezien we constant moeten zien wat de beste route is voor onze monteurs. Nu moeten we een speciale aparte programma hebben om de beste route te berrekenen voor onze monteurs aangezien de planning

• Export Tickets from the Help Center

  Hello everyone! We are now allowing end users to export tickets directly from the help center. The ticket export allows users to: Filter tickets by Department, Priority, and Account before exporting. Download files from Export History (Setup > Data administration

• Is it possible to remove filtering options?

  My CRM has a lot of custom fields that should not be used in filters or views. Fields that are automated and exist only to store temporary values that get used in functions. These create a lot of noise in the list of fields to filter. Isn't there any

• Function #18: Associate invoice templates automatically based on customer language

  For businesses dealing with a diverse linguistic clientele, it becomes crucial to send out invoices in the customer's preferred language to ensure effective communication. This requirement can be handled in Zoho Books by creating invoice templates in

• Changing field types

  Question im a Zoho CRM user and curious, if I change a flied type from single or multi line text to a URL field type will i lose the data in the field or will it be converted to website link automatically. Thanks

• Quote PDF – Header image stopped rendering suddenly

  Hello Zoho Support Team, We are facing an issue with Quote PDF templates in Zoho Books. Previously, images added inside the Quote header HTML were rendering correctly. However, recently the header image is no longer appearing, while header text still

• Changing Default PDF Name

  Is it possible to change the default name of a PDF? As of right now, all of my quotes are named 'QT_$QuoteNumber' (i,e: 'QT_19803471298374) - would it be possible to change this to: '$CompanyName - $AccountName - $QuoteNumber' for instance?

• Tip 2: Recursive functions in Deluge: How to dynamically run a function for a specified number of times.

  Hi folks, As part of the Zoho Creator - Tips and Tricks series every fortnight, we are back today with a new tip on Recursive functions.  Let us first quickly understand what Recursive functions are: A function that calls itself one or more times is known as a Recursive function. That is, you can execute a function to perform a particular action a specific number of times. And, at the end of each iteration, a new output is generated. Recursive functions are commonly used by programmers as it enables

• Function #48: Manage fixed installment payments using Zoho Books

  Hello everyone, and welcome back to our series! Businesses offer installment payment options to their customers, particularly for expensive purchases, to ease the financial burden on them. By breaking down the total cost into smaller, more manageable

• Spotlight series #6: The Show app for Android TV has a new look!

  Hello everyone! We are delighted to introduce our revamped and redesigned Show app for Android TV.  Smart TVs are exploding in popularity. Android TV alone has over 110 million active monthly devices. Zoho Show, as part of a constant effort to improve

• Can’t create alias “Email alias already exists”

  Hi, I’m trying to create the following alias for my domain email. contact@ personal@ private@ But I get a email alias already exists. I had a soho account previously which I deleted which I suspect is causing the issue. Can someone assist? Kind Rega

• Appraisals - Order of Previous Reviews Should Be Newest to Oldest

  The new Zoho People layout generally does a decent job at providing the necessary information for performing appraisals of employee performance. One example of this is the Previous Reviews section: This information is helpful when conducting a review.

• Paging through API results. a major gap in your documentation.

  There is no way for me. to get all of my data through a single API call. Typically REST APis have mechanisms for paging through API results. But the documentation for the API I am using: https://desk.zoho.com/DeskAPIDocument#Introduction Has no mention

• Recurring invoices were generated with old template...

  I have recurring invoices setup. Ones generated on 10.20.2025 used the modified template I had used. But for some reason, on the ones created on 11/20/2025, it seems the invoices created reverted to the previous version of the invoice template. Notably,

• Tip #54- Exploring the Files Icon in Zoho Assist- 'Insider Insights'

  As we’re already in mid-December, it’s a good time to take a closer look at one of the most useful options in the Zoho Assist remote support dashboard—the Files icon. To get started, log in to Zoho Assist using your credentials. Once you’re in, navigate

• Tip#47: Estimation planner

  Sprint planning becomes easier, smoother, more collaborative and more accurate with the Estimation Planner extension. Most work items involve multiple users, and each user's role and effort vary. To provide an unbiased and fair estimation point to the

• Time Tracking on Iphone doesn't stop

  When I start a time tracking session the timer starts as expected. However when I hit stop, the timer remains on that project. The only buttons available are discard and start. Start runs the timer more and discard says it will throw away the data from

• Zoho Sign - Zoho CRM extension upgrade

  Hi everyone, We've updated Zoho Sign extension for Zoho CRM with significant internal changes. Impact on existing Zoho Sign extension users Users using the extension without customization If you are using the integration without implementing Zoho Sign's

• Group by Owner/ Owner Kanban /Group by Custom Field

  Hi, We are missing the option of viewing Tasks grouped by their owner, as it is an essential function for us to manage our employees' working tasks. We find it hard to inspect what are the tasks that our employees are working on.  We are seeking an option

• Flow using way too many tasks

  I built a flow that is using way too many tasks for what it is doing. I reached out to support a week ago but never heard back so hoping the community can help. Does a filter count as a task? I am seeing tons of records filtered with < 1 Sec Time Taken

• Next Page