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

• Display Client Name in Zoho Creator Client Portal Dashboard

  Hello Zoho Creator Team, We hope you are doing well. Zoho Creator recently introduced the option to set a client’s display name in the Client Portal settings, which is very helpful for providing a personalized portal experience. However, there is currently

• Customizable UI components in pages | Theme builder

  Anyone know when these roadmap items are scheduled for release? They were originally scheduled for Q4 2025. https://www.zoho.com/creator/product-roadmap.html

• Stop the Workarounds: We Need Native Multi-Step Forms

  After over 17 years of community requests, I'm hoping the Zoho team can finally address the lack of native multi-page form support in Zoho Creator. This has been one of the longest-standing feature requests in the community, with threads spanning nearly

• Amazon.in FBA multiple warehouse integration with Zoho Inventory

  My organisation subscribed to Zoho One looking at the opportunity to integrate Amazon.in with Inventory. But during the configuration, we understood the integration has severe limitations when it involves multiple warehouses in the same Organisation.

• Feature Request - Set Default Values for Meetings

  Hi Zoho CRM Team, It would be very useful if we could set default values for meeting parameters. For example, if you always wanted Reminder 1 Day before. Currently you need to remember to choose it for every meeting. Also being able to use merge tags

• Issues with Actions By Zoho Flow

  Hi, I have a workflow that fires when a deal reaches a stage. This then sends out a contract for the client to sign. I have connected this up through Actions by Zoho Flow. Unfortunately this fails to send out. I have tracked it down to the date fields.

• Adding custom "lookup" fields in Zoho Customization

  How can I add a second “lookup” field in Zoho? I’m trying to create another lookup that pulls from my Contacts, but the option doesn’t appear in the module customization sidebar. In many cases, a single work order involves multiple contacts. Ideally,

• CRM x WorkDrive: We're rolling out the WorkDrive-powered file storage experience for existing users

  Release plan: Gradual rollout to customers without file storage add-ons, in this order: 1. Standalone CRM 2. CRM Plus and Zoho One DCs: All | Editions: All Available now for: - Standalone CRM accounts in Free and Standard editions without file storage

• Windows Desktop App - request to add minimization/startup options

  Support Team, Can you submit the following request to your development team? Here is what would be optimal in my opinion from UX perspective: 1) In the "Application Menu", add a menu item to Exit the app, as well as an alt-key shortcut for these menus

• Ability for admin to access or make changes in zoho form without asking for ownership

  Currently in zoho form only form owner can make the changes in the form and if someone else has to make changes then we have to transfer the ownership to them and even admin also cant access it . So i think admin must have the ability or option to access

• Issue with WhatsApp Template Approval and Marketing Message Limit in Zoho Bigin

  We are facing issues while creating and using WhatsApp message templates through Zoho Bigin, and we request your clarification and support regarding the same. 1. Utility Template Approval Issue Until December, we were able to create WhatsApp templates

• Zoho CRM Calendar View

  Hello Zoho team, We need desperately a calendar view next to list, kandan and other views. I think it should be easy to implement as you already have the logic from Projects and also from Kanban View in CRM. In calendar view when we set it up - we choose

• Camera

  I can sign on to a meeting and see the other participants, but my screen is dark. The instructions for Zoho "Camera Settings" say "click on lock icon in address bar," but I don't see that icon! Suggestions?

• What is Workqueue and how to hide it?

  Hi， My CRM suddenly have this "Workqueue", may I ask how to set the permission of this tab?

• Batch/lot # and Storage bin location

  Hi I want to ask for a feature on Zoho inventory I own a warehouse and I've gone through different management software solutions with no luck until I found Zoho, it has been a game changer for my business with up to the minute information, I'm extremely happy with it. It's almost perfect. And I say Almost because the only thing missing for me (and I'm sure I'm not alone) is the need of being able to identify the lot number of my inventory and where it is located in the warehouse. Due to the nature

• Adding Sender Address with Basic Plan

  According to the knowledge base, I should be able to add Sender addresses with the Basic Plan. But whenever I try to add an email, it takes me to a search window and I cannot find any emails in the list. Even mine, which is the admin. email.

• Conditional Field Visibility in Bigin CRM

  I would like to request support for conditional field visibility within Bigin CRM. This feature should allow administrators to configure show/hide rules for fields based on predefined criteria (e.g., field values, picklist selections, stage changes,

• Bill automation in Zoho Books

  Hi I am looking for 3rd-party options for bill automation in zoho which are economical and preferably have accurate scanning. What options do I have? Zoho's native scanning is a bit pricey

• Reporting Tags

  We've been using reporting tags for years (before itemizing was available) and now we are finding reporting these tags are impossible to track. Reports have changed in the customization and our columns of reporting tags no longer show up. We do not use

• Function #53: Transaction Level Profitability for Invoices

  Hello everyone, and welcome back to our series! We have previously provided custom functions for calculating the profitability of a quote and a sales order. There may be instances where the invoice may differ from its corresponding quote or sales order.

• Consumption based inventory

  I am currently using Zoho Books for my hospitality business, which includes lodging and restaurant services. We purchase many items in bulk for storage and consumption as needed. I'd like these items to be recorded as inventory when purchased and categorized

• Smarter Access Control: Role-Based Access vs. Responsibility-Based Profiles

  Every business has roles, responsibilities, and workflows. While roles help define structure, responsibilities within those roles are rarely the same. As your team grows, some members need access to only a specific set of features. Others require visibility

• Partner with HDFC And Sbi Bank.

  Hdfc and sbi both are very popular bank if zoho books become partner with this banks then many of the zoho books users will benefit premium features of partnered banks.

• API in E-Invoice/GST portal

  Hi, Do I have to change the api in gst/e-invoice portal as I use zoho e books for my e-invoicing. If yes, please confirm the process.

• Member role in zoho meeting

  does a user with member role can see other users in the organization

• Clone Recurring Expenses

  Our bookkeeping practices make extensive use of the "clone" feature for bills, expenses, invoices, etc. This cuts down significantly on both the amount of typing that needs to be done manually and, more importantly, the mental overhead of choosing the

• Zoho Books - How to Invoke a Custom Function in Schedulers

  We have multiple schedulers that send emails to customers in batches. Currently, we are maintaining the same code across several schedulers. Is it possible to use a custom function inside a scheduler script? If yes, how can we invoke the custom function

• Importing into Multiselect Picklist

  Hi, We just completed a trade show and one of the bits of information we collect is tool style. The application supplied by the show set this up as individual questions. For example, if the customer used Thick Turret and Trumpf style but not Thin Turret,

• Special characters (like â, â, æ) breaking when input in a field (encoding issue)

  Hey everyone, We are currently dealing with a probably encoding issue when we populate a field (mostly but not exclusively, 'Last Name' for Leads and Contracts). If the user manually inputs special characters (like ä, â, á etc.) from Scandinavian languages,

• Set Custom Icon for Custom Modules in new Zoho CRM UI

• Portals-Adjust Column Sizes

  I am trying to adjust the column widths in Portals tabs. Columns that don't need to be wide are wide and longer ones are very short. I thought adding more to the digits box in Edit would widen them, but it doesn't. Anyone know how to adjust these?

• All new Address Field in Zoho CRM: maintain structured and accurate address inputs

  The address field will be available exclusively for IN DC users. We'll keep you updated on the DC-specific rollout soon. It's currently available for all new sign-ups and for existing Zoho CRM orgs which are in the Professional edition. Latest update

• is there any way to change the "chat with us now" to custom message?

  is there any way to change the "chat with us now" to custom message? I want to change this text

• Notes badge as a quick action in the list view

  Hello all, We are introducing the Notes badge in the list view of all modules as a quick action you can perform for each record, in addition to the existing Activity badge. With this enhancement, users will have quick visibility into the notes associated

• Is Zoho Live Chat compatible with WordPress CMS?

  Hello, I have a website called www.jjrlab.com and I'm interested in using Zoho Chat on it. Does it support WordPress CMS? Thanks.

• Introducing spam detection for webforms: An additional layer of protection to keep your Zoho CRM clean and secure

  Greetings all, One of the most highly anticipated feature launches—Spam Detection in webforms—has finally arrived! Webforms are a vital tool for record generation, but they're also vulnerable to submissions from unauthenticated or malicious sources, which

• Bring your CRM and Desk app inside SalesIQ with widgets

  Have you ever been confused and frustrated with multiple open tabs and switching back and forth from SalesIQ to other apps to perform your business-specific operations? How effective would it be to have all the required tools and data of the apps you

• Password Assessment Reports for all users

  I'm the super admin and looking at the reporting available for Zoho Vault. I can see that there is a Password Assessment report available showing the passwords/weak and security score by user. However I'm confused at the 'report generated on' value. Monitor

• Speak Your Customers' Language: SalesIQ's chatbots now support 30 languages 🤖

  We're unveiling some major upgrades to our chatbot that are set to revolutionize your experience! Now SalesIQ support 30 languages for both Zobot and Answer bot. By speaking your customers' language, you can enhance engagement, improve customer satisfaction,

• record submitted from creator and invoice is creating in books , but the workflow of books is not tiggering on create of record in books

  record submitted from creator and invoice is creating in books , but the workflow of books is not tiggering on create of record in books headermap = Map(); headermap.put("X-ZOHO-Execute-CustomFunction","true"); response_inv = invokeurl [ url :"https://www.zohoapis.com/books/v3/invoices/fromsalesorder?salesorder_id="

• Next Page