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,
- About Canvas List Page
- Supported Events for List Page(Canvas)
- Supported ZDKs for List Page(Canvas)
- Use Case
- Solution
- Summary
- 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.
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.
- freezeColumns(option) - You can freeze list view and disable modifying columns.
- maskField(field_name, (length,character,reverse)) - You can mask fields in the List View
- sortByField(field_name, option) - You can sort field in the List View
- getRecords() - You can get Records in the List View
- selectRecords(criteria) - You can select Records in the List view by criteria
- selectRecordsByID(ids) - You can select Records in the List view by record ID
- clearSelection() - You can clear selected Records in the List view
- 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
- 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.
- // Mask phone number based on user role
- if ($Crm.user.role.name === "Sales Executive") {
- // Mask 7 digits for Sales Executive
- ZDK.Page.getList().maskField("Phone_Number", {
- length: 7,
- character: "#",
- reverse: true
- });
- } else if ($Crm.user.role.name === "Support Agent") {
- // Mask 10 digits for Support Agent
- ZDK.Page.getList().maskField("Phone_Number", {
- length: 10,
- character: "#",
- reverse: true
- });
} - // Highlight cancelled orders in light red
- ZDK.Page.getList().style({
- record: {
- backgroundColor: "#FFD6D6"
- }
- },
- "(Status:equals:Cancelled)"
- );
- // Highlight delivered orders in light green
- ZDK.Page.getList().style({
- record: {
- backgroundColor: "#D3F9D8"
- }
- },
- "(Status:equals:Delivered)"
- );
- Use $Crm.user.role.name to retrieve the role of the currently logged-in user.
- When the role is Sales Executive, use ZDK.Page.getList().maskField() on the Phone_Number field to mask the first 7 digits, where
- length defines how many characters should be hidden
- character: '#' specifies the masking symbol
- reverse: false ensures masking starts from the beginning, allowing partial visibility.
- 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.
- Use ZDK.Page.getList().style() to apply conditional styling to list records by configuring the record parameter to set the row backgroundColor.
- 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.
- Here is how the Client Script works for a "Sales Executive".
- Here is how the Client Script works for a "Support Agent".
- Here is how the Client Script works for a for other roles like, Manager and Admin.
6. Summary
- Mask sensitive fields dynamically in List Page Canvas
- Apply role-based logic using current user context
- Improve list view readability with conditional record styling
7. Related Links
Access your files securely from anywhere
Centralize Knowledge. Transform Learning.
All-in-one knowledge management and training platform for your employees and customers.
New to Zoho Recruit?
Zoho Developer Community
New to Zoho LandingPage?
Zoho LandingPage Resources
New to Zoho Survey?
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Bigin?
Topic Participants
Maadhari M
Sticky Posts
Kaizen #198: Using Client Script for Custom Validation in Blueprint
Nearing 200th Kaizen Post – 1 More to the Big Two-Oh-Oh! Do you have any questions, suggestions, or topics you would like us to cover in future posts? Your insights and suggestions help us shape future content and make this series better for everyone.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 thisKaizen #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 howKaizen #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
New to Zoho TeamInbox?
Zoho TeamInbox Resources
Zoho CRM Plus Resources
Zoho Books Resources
Zoho Subscriptions Resources
Zoho Projects Resources
Zoho Sprints Resources
Qntrl Resources
Zoho Creator Resources
Zoho CRM Resources
Design. Discuss. Deliver.
Zoho Show Resources
Get Started. Write Away!
Writer is a powerful online word processor, designed for collaborative work.
Zoho CRM コンテンツ
-
オンラインヘルプ
-
Webセミナー
-
機能活用動画
-
よくある質問
-
Ebook
-
-
Zoho Campaigns
- Zoho サービスのWebセミナー
その他のサービス コンテンツ
Nederlandse Hulpbronnen
ご検討中の方
Recent Topics
Read Thread Details
Does anyone know how to "read" the complete thread details in a ticket? I figured out how to pull a summary of the threads using a webhook, but it doesn't have all the details I want. I tried to create a loop in flow, which should have worked, but insteadHow to Structure Data in Zoho Creator Applications
Data structure is undoubtedly one of the most critical pillars in application development within Zoho Creator. Well-structured projects scale easily, enable more robust automations, and drastically reduce rework. Poorly modeled applications, on the otherApplication Architecture in Zoho Creator: Why You Should Think About It from the Start
Many companies begin using Zoho Creator by building simple forms to automate internal processes. This is natural — the platform is extremely accessible and allows applications to be built very quickly. The challenge begins to appear when the applicationCaptcha can't be enabled conditionally
Hi Problem: captcha on a form can't be enabled conditionally. Why is this a problem: Because I use the same form on our website (public) in the portal and mobile app. In the portal it works but in the mobile app it doesn't. So there should be a way toImproved RingCentral Integration
We’d like to request an enhancement to the current RingCentral integration with Zoho. RingCentral now automatically generates call transcripts and AI-based call summaries (AI Notes) for each call, which are extremely helpful for support and sales teams.WorkDrive issues with Windows Explorer Not Responding
We are using WorkDrive to collaborate on editing video content. We have a lot of files and quite a few are a few gigs. Recently anytime I try and work with the files Explorer freezes for a couple minutes whether it's dragging the files into Premiere orIs it possible to retrieve function (Deluge) code from Zoho CRM externally?
Hi Everyone, Is it possible to fetch or retrieve the Deluge function code from Zoho CRM using an external method (API or any other approach)? I would like to know if there is any way to access or extract the function script outside of Zoho CRM, or ifZoho CRM Integration Form + Custom Fields
Hi! I've created an Integration Form from Zoho CRM's Vendors Module, but I can choose a few standard fields and no custom fields I've created in Zoho CRM. There is a plan to add this feature soon? Thanks in advance.AI secretary
In our company, Claude is the secretary and creates inquiries and schedules from Gmail. You no longer have to enter them yourself. The secret is that we created an MCP server that connects to CRM. https://x.com/Mac_nishio/status/1917954562566328694Como estruturar dados em aplicações Zoho Creator
A estrutura de dados é um dos pilares mais críticos no desenvolvimento de aplicações no Zoho Creator. Projetos bem estruturados escalam com facilidade, permitem automações mais robustas e reduzem drasticamente retrabalho. Já aplicações mal modeladas rapidamenteCreditos API
Queria saber se alguém poderia me ajudar a resolver um problema na compra e utilização de créditos de mensagens API do WhatsApp. ja tentei todos o tutoriais porem não consegui realizar a compre, pois ao clicar no botão de comprar créditos aparece a mensagemUsing Zoho Forms vs Zoho Survey
Hello - I'm looking for advice on whether to use Zoho Survey or Zoho Forms for our small non-profit. We have a Zoho One subscription, so have access to both. The main use case at the moment is application forms for our professional development programs.Custom CSS for Zoho CRM Team Bookings embeded widget
Hello, we are adding Zoho CRM Team Bookings (crm.zoho.com) in our public website. We know that we can change Theme Color, Font Color and Background Color: Zoho CRM Booking Styling But is it possible to change other CSS attributes e.g. Font Family, likeDashboard target enhancements
Often individuals in IT are creating dashboards for their sales team. The ability to create a single dashboard that can be used by multiple people is key. A components for a dashboard have the ability to filter by logged in user which is great. HoweverEnable integration of CRM CPQ functionality for ZohoOne customers using Zoho Finance application
Hi there. I can't believe I'm needing to launch this idea as I would have thought this was a little obvious. Following a number of conversations with the technical team it's become evident that the CPQ functionality within CRM cannot integrate with ZohoZoho Certified Workshops in Berlin | 20. - 21. April
Liebe Mitglieder der deutschen Zoho-Community! Wir freuen uns, Ihnen mitteilen zu können, dass unsere Zoho Certified Workshops am 20. und 21. April nach Deutschland zurückkehren! 📍Wo finden die Workshops statt? Die zertifizierten Workshops finden imZoho Payroll Expansion Plans
Dear Zoho Team, I truly appreciate the continuous innovation and improvements you bring to your suite of products. However, I—and I’m sure many others—would love some clarity on your Zoho Payroll expansion roadmap. Currently, it’s only available in theUsar o Inventory ou módulo customizado no CRM para Gestão de Estoque ?
Minha maior dor hoje em usar o zoho é a gestão do meu estoque. Sou uma empresa de varejo e essa gestão é fundamental pra mim. Obviamente preciso que esse estoque seja visível no CRM, Inicialmente fiz através de módulos personalizados no próprio Zoho CRM,How do I setup the performance review module?
I am pretty adept when it comes to learning software and I've set up quite a few Zoho Apps over the past 3 years. But for the life of me, I can not figure out Zoho People performance reviews. I've figured out the "Organization" & LMS Modules, but theRecurring Addons
Hi, I know you can set the pricing interval for addons to weekly, monthly and yearly & set it for one off or recurring, which these are fine as a base addon item. It really would be helpful if when creating a subscription when you add on the addon itemCancellation Fees
Hi, It really would be good if Billing could take subscription management further with cancellations & being able to apply or set a cancellation fee for a plan that is either fixed or prorated. It is not uncommon in subscriptions for cancellation feesAllow agents to enable or disable feed notifications from certain departments
Hello everyone, Agents who are part of multiple departments receive feed notifications frequently from across the departments. They may not be actively involved in performing every action in all departments. For example, an agent could be a part of bothWorkDrive API returning empty response even after placing file in Team Folder
Hi everyone, I am trying to fetch a file from Zoho WorkDrive using a Deluge standalone function in Zoho People. The API call executes successfully using a configured connection, but the response is coming back empty. I have verified the following: TheAddress Typeahead Extension for Zoho Books
I installed the Address Typeahead extension for zoho books but when I went to configure it, it said that that version was deprecated. Is there a newer version somewhere?Transaction Rules & Customer Payments
So I have a situation as follows. We have many clients who are all invoiced on the 1st of each month on a recurring invoice for 1 of 10 plans. This means that almost all payment dates are the same (some people pay late) and that a lot of the amounts areCan I Integrate ADP Payroll with Zoho Books?
Hi, I am hoping that I can integrate ADP Payroll with Zoho Books so that I do not need to manually input the payroll journal entries. Is this possible? If so, how do I do that?Zoho Books | Product updates | February 2026
Hello users, We’ve rolled out new features and enhancements in Zoho Books. From Advanced Reporting Tags to the ability to mark projects as completed, explore the latest updates designed to improve your bookkeeping experience. Introducing Advanced ReportingDarshan Hiranandani : How many participants can join a Zoho Meeting at once?
Hi everyone, I'm Darshan Hiranandani, trying to find out the maximum number of participants that can join a Zoho Meeting at once. Has anyone here used Zoho Meeting for larger groups and can share their experience or knowledge about the participant limit?Ask The Expert: Deep Dive into Zoho CRM, Desk, SalesIQ, and Campaigns!
Are you using Zoho to power your sales, support, and marketing, and have questions about configuration, automation, or best practices? We have great news: the “Ask The Expert” session is coming to the Zoho Benelux Community! This session is specificallyHow to create a new Batch and update Stock via Inventory?
Hi everyone, We are building an automation where a user enters batch details (Batch Number, Mfg Date, Expiry, and Quantity) into a Custom Module. I need this to trigger an API call to Zoho Inventory to: Create the new batch for the item. Increase theZoho books Inventory valuation report VS Stock GL value
At one client, we track inventory using composite (bundled) items, and in the system settings we have enabled the option to prevent stock from going below zero. After the year-end physical count and quantity adjustments, we identified a mismatch: InventoryZoho Zoom extension for CRM
When meetings are booked through Zoho using the Zoom extension, the Zoom link in the invite is a host start link that contains an expiring ZAK token. The invite should instead use a standard attendee join link or a non-expiring host link - why is thisStereo audio
L.S. Is stereo audio supported in Zoho Meetings? I would like to conduct music lessons with Meetings, but the audio needs to be good (if not great!) and stereo, and not too much compressed and such.Zoho Surveys
Dear Zoho Support Team, I hope this message finds you well. I am writing to inquire about the availability and documentation for the Zoho Survey API. Background: I am currently working on a project that requires programmatic access to survey data andZoho FSM API Delete Record
Hi FSM Team, It would be great if you could delete a record via API. Thank you,Writing SQL Queries - After Comma Auto Suggesting Column
When writing SQL Queries, does anyone else get super annoyed that after you type a comma and try to return to a new line it is automatically suggest a new column, so hitting return just inputs this suggested column instead of going to a new line? AnyoneNew Enhancements to Zoho CRM and Zoho Creator Integration
Hello Everyone, We’ve rolled out enhancements to the Zoho Creator and Zoho CRM integration to align with recent updates made to the Zoho Creator platform. With enhancements to both the UI and functionality, This update also tightens access control byDesk API that can search Merged Tickets
Is there any method that can still search a ticket that was already merged? zoho.desk.searchRecords - doesn't explicitly mentionIssue with "Send Email" from Quotes not loading Email Template data
Hi everyone, I'm currently experiencing an issue when using the "Send Email" option from a Quote record in Zoho CRM. What’s happening: When I go to the Quotes module and select a record, then click Send Email, the attached file (Quote) correctly pullsSuggestions for Improved Table Management and Dashboard Filter Controls in Zoho Analytics
Dear Zoho Analytics Community, I hope you are doing well. I would like to share a few suggestions based on issues I am currently experiencing while working with visualizations and dashboards. Firstly, when I create a new visualization using the Sales-OrderNext Page