Kaizen #194 : Trigger Client Script via Custom buttons
Hello everyone!
Welcome back to another interesting and useful Kaizen post.
We know that Client Scripts can be triggered with Canvas buttons and we discussed this with a use case in Kaizen#180. Today, let us discuss how to trigger Client Script when a Custom Button is clicked. Using this, you can execute Client Script when a custom button is clicked.
In this post,
1. Event Details2. Supported Pages3. Use Case - Export Subform Rows to Zoho Sheet in a Single Click!4. Solution5. Summary6. Related Links
Client Script support for Custom Buttons opens up possibilities for automation, personalization, and enhanced user interactions in Zoho CRM when a custom button is clicked.
Here is a detailed walkthrough to help you understand it better.
1. Event Details
The Button event triggers the Client Script when a custom button is clicked. Each time this event is invoked, the context argument is passed to the Client Script. The context contains information about the page from which the button was clicked.
Click here to know more about Client Script Events.
2. Supported Pages
A Custom Button can be placed in different positions based on the Page.
You can add a custom button in the Util Menu, in Each Record or in the Mass Action Menu of the List Page.
Also, a Detail Page can have a custom button either In Record or in the Related List. Click here for more details about the different possible positions of a custom button.
The following table lists the supported pages and the corresponding context argument, which provides different details based on the page type.
To create a Client Script and make it trigger when a custom button is clicked, first create a Custom button and associate it with a Client Script as shown in the following image.
Click here to view the steps to create a custom button and configure a Client Script.
Note:
You can configure the Client Script only from the Buttons page to trigger it when a user clicks a custom button, and not the usual way of Creating Client Script via setup page. Once a script is created, it can be edited and updated from the Client Script setup page
3. Use Case - Export Subform Rows to Zoho Sheet in a Single Click!
Zylker manufactures medical instruments, and its sales representatives frequently need to share bulk order details with distributors and hospital partners using Zoho Sheets. These details such as product names, quantities, and prices are captured in a Subform on the Purchase Order Detail(Standard) Page.
To simplify this, the admin wants to add a custom button called "Export Products" on the Purchase Order Detail Page. When clicked, it should export the Purchase Items from the Subform and move the content to the specified sheet.
4. Solution
To export subform rows to Zoho Sheet with a single click, you can add a custom button to the Detail Page of the record. When clicked, a Client Script will be triggered to fetch the subform data from the Detail Page and pass it to a Function that uses zoho.sheet.createRecords() to insert data into Zoho Sheet.
Here’s how to implement this:
- Add “Export Products” custom button on the Detail Page.
- Add the script to collect subform rows which invokes the Function.
- Write a Function to create entry in Zoho Sheets
A. Add “Export Products” custom button on the Detail Page.
- Go to Setup → Modules and Fields under Customization.
- Select a Module as Purchase Order.
- Click on Buttons → Then click + New Button.
- Enter Button Name and select Action Type as "Client Script"
- Choose Button Position and Layout details as shown in the following image.
- Click Create in Configured Client Script, enter the script, and click Add.
- Select the profiles for which these buttons should be visible.
- Click Save.
B. Add the Script to collect subform rows and invoke the Function
Use the following Client Script when you configure the custom button.
- var casesheetid = ZDK.Client.getInput([{ type: 'text', label: 'Enter the Sheet ID' }], 'Sheet details', 'OK', 'Cancel');
- if (casesheetid == null) {
- ZDK.Client.showAlert("Enter the *Case Sheet ID - Import* to import data");
- }
- var purchase_items = ZDK.Page.getField('Purchase_items).getValue();
- ZDK.Client.showLoader({type: 'page', template:'spinner', message: 'Export in progress, please wait'});
- var c=1;
- if (sheetid == null) {
- ZDK.Client.hideLoader();
- ZDK.Client.showAlert("Enter the *Case Sheet - Export* ID to export data");
- }
- purchase_items.forEach((r,i) => {
- try {
- resp = ZDK.Apps.CRM.Functions.execute("csvWrite", { "Product_Name": r.Product_Name.name, "List_Price": r.List_Price, "Discount": r.Discount, "Total": r.Total,"Sheetid":casesheetid }); }
- catch (error) {
- c = 0;
- ZDK.Client.hideLoader();
- ZDK.Client.showAlert("Unexpected issue occured while adding data in row number "); }
- });
- ZDK.Client.hideLoader();
- if (c) {
- ZDK.Client.showMessage("Export completed. Please check the Sheet");
- }
- else
- {
- ZDK.Client.showMessage("Unexpected error "); }}
In this code, several ZDKs are used for various purposes. Click on the ZDK hyperlinks to learn more.
- User Input: The code uses ZDK.Client.getInput() to fetch a "Sheet ID" from the user. This input is crucial for further operations.
- Input Validation: If the user cancels or doesn't enter a sheet ID, the code checks for null and prompts the user to enter the ID using ZDK.Client.showAlert().
- Function Invocation: The entries of Purchase Order subform are fetched using ZDK.Page.getField('Purchase_items).getValue() and written to Zoho Sheet using the Function csvWrite(), which internally calls zoho.sheet.createRecords().
- Loader Display: To indicate that a process is running, a loader is displayed using ZDK.Client.showLoader().
- Show Message: ZDK.Client.showMessage() displays that the Export is completed.
Note
The Client Script you intend to link with the button will be saved only after the custom button is saved.
C. Write a Function to create entry in Zoho Sheets
- Go to Setup > Developer Hub > Functions.
- In the Functions page, click + Create New Function.
- Choose the category as Button.
- Click Create.
- In the Create Function page, enter a name as csvWrite and description for your function.
- Enter the following function code and click Save.
- string standalone.csvWrite(String product,String qty,String up,String amt, String Sheetid){
- queryData = Map();
- writeData = Map();
- header = Map();
- writeData.put("Product",product);
- writeData.put("Quantity",qty);
- writeData.put("Unit_Price",up);
- writeData.put("Amount",amt);
- SheetData = zoho.sheet.createRecords("Sheetid","Sheet1",writeData,queryData,"sheetconnection");
- return SheetData;
- }
In the code above:
- sheetconnection refers to the name of the Zoho Sheet connection, which must have the scopes: ZohoSheet.dataAPI.UPDATE and ZohoSheet.dataAPI.READ.
- Click here to know how to create a Connection with the required scopes.
- sheetid is the unique identifier of the Zoho Sheet, available in the sheet’s URL.
- Sheet1 represents the name of the worksheet (i.e., the tab name shown at the bottom of the Zoho Sheet).
- Now, when the custom button is clicked, the Client Script is triggered. It prompts for the Sheet ID, fetches the contents of the Purchase Order subform, and invokes a function that writes the content to the Sheet.
Here's how the Client Script works.
5. Summary
In this post we have seen,
- What is a Button event?
- How to configure Client Script for a custom button
- How to write data into Zoho Sheets from Client Script
- How to create a Function and call it from Client Script
6. Related Links
- Customize Buttons using Client Script
- Automating Data Transfer from Zoho Sheets to Zoho CRM Subforms
- Update - Client Script Support For Custom Buttons
We are thrilled to be nearing the 200th post in our Kaizen series. As we approach this exciting milestone, we would love to hear from you. Do you have any questions, suggestions, or topics you would like us to cover in future posts? Your input helps us improve and shape the series to serve you better.
Previous Kaizen Post : Kaizen #193: Creating different fields in Zoho CRM through API | Kaizen Directory
We hope you found this post useful!
Happy Client Scripting! 😊
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
Rakesh Kumar
Gray
Ishwarya SG
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
This version of app doesn't support this notecard type Error
So this problem is happening for any notes created within the last week, as well as any note recently edited on Android. I can open them on my phone fine, but they don't open on the website version. They DO work on the desktop app version. It's just webPDF's Give Unsupported Type Error Message
Many of the pdf files I add to Notebook work fine but in some cases when I try to open them on the Android App I get a message saying "Unsupported Type. Psst! You are using an older version of the app which does not support this note format. Please updateCliq iOS can't see shared screen
Hello, I had this morning a video call with a colleague. She is using Cliq Desktop MacOS and wanted to share her screen with me. I'm on iPad. I noticed, while she shared her screen, I could only see her video, but not the shared screen... Does Cliq iOS is able to display shared screen, or is it somewhere else to be found ? RegardsEstimate Module - Contact Field.
Hello Latha and Team, Is it possible to make the Contact field optional in the Estimate module? Best regards, Chethiya.I am not able to check in and checkout in zoho people even location access allowed
This issue i am facing in mackbook air m1, I allowed location in chrome browser and i also tried in safari but getting similar issue. Please have a look ASAP.Is multiple invoice e-mailing possible?
I wonder if following is possible: When you are in the invoice view, assume you have five invoices to five different customers that are pending (you have just created them, but not sent them away yet by email.) To the left of every invoice in the overviewHow to keep track of bags, cans, drums of inventory?
We buy and sell products that are packaged in bags 🛍️, cans🥫, drums🛢️, etc. with batch numbers. When we get a shipment of one of the products, how do we track we received (say) 10 cans each of 5L of a product and maybe we received 10 cans of anotherMultiple packages in one shipment
Guys we have been asking for this for years. we want to be able to ship multiple packages for one customer in the same shipment, so as to avoid entering shipping info repeatedly, and avoid customer getting multiple tracking emails. When does this arise?I can't add a new customer in Zoho invoice? Anyone had this issue before?
Ive been using Zoho invoice for over 6 years. Today I wanted to add a new customer to send an invoice to but it doesn't save when I try to access it from the pulldown menu when you go to send a new invoice.set up an opportunity progress bar in canva
Hi, set up an opportunity progress bar in canva I need help to set to reproduce the progress bar or equivalent of the opportunity steps in canva as in standard view (see capture ) Thank you in advance Amadousending email with another account
Hello there, i write there for an our costumer request. They want to send email from CRM with a different email (confirmed and added to zoho profile). For example they use account@zilium.com but with this account they want to send (not only with emailWhich Tool Is Best to Import MSG Files to HostGator?
The best tool to import MSG files to HostGator is the MacGater Mac MSG Converter. This professional utility is specifically designed to simplify the migration of Outlook MSG files into web-based email services, including HostGator. It supports directRecurring event sync via Microsoft 365 Meetings
I believe syncing Recurring through the Microsoft 365 Meetings integration is already in the works but I couldn't find a reference in the community to track the progress of this work.What's New in Zoho Invoice | April - June 2025
Hello everyone! We're excited to share the latest feature updates and enhancements we've made to Zoho Invoice from April to June 2025. In this, you will learn more about the following features: New Integrations via Zoho Marketplace Add Images to EmailClient Script | Update - Client Script Support For Custom Buttons
Hello everyone! We are excited to announce one of the most requested features - Client Script support for Custom Buttons. This enhancement lets you run custom logic on button actions, giving you greater flexibility and control over your user interactions.import customers
Is there a way to bulk import customers? I'm moving from Acuity and would rather not have to enter everyone manually.What's New in Zoho POS - February 2026
Hello everyone, Welcome to Zoho POS’s monthly updates, where we share our latest feature updates, enhancements, events, and more. Let’s take a look at how February went. Purchase and sell items on different units We have introduced a unit conversion functionalityBatch 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 manuallyComments aren't visible in shared spreadsheet
I would like to send a spreadsheet to people who can use it to help solve a problem as a one off use unique to them. They will have to enter data in the sheet. I have comments attached to some of the cells to explain the purpose of the data being collected.Kaizen #236 - Using Client Script Support in Quick Create to Automate Manual Data Entry
Welcome to another post in the Kaizen Series! In this post, we explore how Client Script support in the Quick Create form can be used to automate data entry. This solution addresses a common business scenario where Zylker Furniture sells sofas, wardrobes,Is it possible to make tags "required"
We would like to be able to make the tag field a requirement for agents before they can close a ticket. This would help with monthly reporting, where a lot of tickets end up with no tag, causing manual work to go back and add the correct tag for eachSerial Numbers.
I generated serial numbers for items and there is no way to generate more serial numbers that the number of items being "sold" or created. This is annoying as how does one know what serial number they left off with when they go to receive or sell thisEnsure every user starts right with Welcome Email Templates
Adding a new user to your organization extends beyond account creation–it requires delivering the right information at the right time to ensure a productive start. New users typically require key details upon joining, such as login instructions, securityHow to change the format for phone numbers?
Mobile phone numbers are currently formatted (###) ###-####. How can I change this to a more appropriate forms for Australia being either #### ### ### or (#)### ### ###?All new Address Field in Zoho CRM: maintain structured and accurate address inputs
Availability Update: 29 September 2025: It's currently available for all new sign-ups and for existing Zoho CRM orgs which are in the Professional edition exclusively for IN DC users. 2 March 2026: Available to users in all DCs except US and EU DC. 24Adding Images to a Quote in Zoho CRM
We are currently preparing to use Quotes in Zoho CRM and we are building out our Quote templates. We came across an issue of not being to add Images of the products to the Quote - specifically in the body of the Quote templates. This is a problem,Item with name in different languate
Hello, is there a way to have an item with its name in different languages? For example: I sell an item in different markets and I'd like to have a Proposal and the Invoice with the Item Name in a specific language. Rino Bertolotto Zoho Specialist, STESA srlIMPORTANT: It doens´t show full article name on search - Should add line break
When we search for articles, it doesn´t show the full name. There should be a line break so the user can see the full article name, otherwise the user can´t know if that´s the article he/she is looking for. This is very important, otherwise the user hasIMPORTANT: It doesn´t search for letters with portuguese characters.
Some of my articles have for example the word "vídeo". But if I search for "vídeo" it doesn´t find them. If I search for "video" it does find them. Idealy, it should find the articles either way. But if I have to choose, it would be better to find theHow to hide Activity Side Panel
How do you hide the activity side panel? Clicking on the link and reviewing the activity does not remove it and it does not seem to timeout. I have any activity that have been listed there since January. Thank you.Need a Universal Search Option in Zohobooks
Hello Zoho, Need a Universal Search Option in Zohobooks to search across all transactions in our books of accounts. Please do the needful ThanksOrdering of Teams
Hi there, Currently, we cannot order Teams in Zoho Desk. Teams are ordered as they were created. It would be really helpful if we could customise the order of Teams. For example: We have the following Teams: Shipping Customer Service Sales ComplianceZoho Mail Android app update: UI revamp
Hello everyone! We are excited to share that the first phase of the Zoho Mail Android UI revamp is now live. In this update, we have redesigned navigation bar at the bottom to quickly access the Email, Calendar, Contacts, and Settings modules. Also, theAdd Support for Authenticator App MFA in Zoho Desk Help Center
Hello Zoho Desk Team, We hope you are doing well. We would like to request an enhancement related to security for the Zoho Desk Help Center (customer portal). Currently, the Help Center supports MFA for portal users via SAML, JWT, SMS authentication,Resubscribe with Zoho Campaigns
Hi, I am new to Zoho Campaigns and sent a campaign to a contact list with only my email address. I wanted to see what the footer links did, so clicked unsubscribe and now can't include my email address into any more campaigns. I don't have a sign up form on my website to resubscribe and can't find how to resubscribe anywhere else. Can you help?Add a way to connect Log360 Cloud logs with Zoho analytics
Hi, Several month ago Log360 Cloud was added to zoho one - and this is great. But as far as I see there is no prebuilt way to connect Zoho analytics to the logs we have in Log360 Cloud. Please add a prebuilt connection like we have for so many other zohoDynamic Multi-Staff Selection for Ad-Hoc Bookings
Summary Allow customers or internal schedulers to select specific staff members at the time of booking, with Zoho Bookings automatically surfacing only the time slots where all selected members are simultaneously available. Current Behaviour Zoho BookingsShare Edit while in Workflow
There are times that while a writer document is in the middle of a workflow the user that's responsible for that stage of the workflow needs to bring in other people to work on the document. Currently there is no way for the user to be able to allow other'sHow can I use the API to add a drop-shipping address to a sales order for one-time use?
I need to be able to add a drop-shipping address for one-time use to a sales order via the API. Adding every such address to the contact (customer), then feeding the shippingaddress_id into the sales order, is not an acceptable approach; we have someNeed to set workflow or journey wait time (time delay) in minutes, not hours
Minimum wait time for both Campaigns workflows and Marketing Automation journeys is one hour. I need one or the other to be set to several minutes (fraction of the hour). I tried to solve this by entering a fraction but the wait time data type is an integerNext Page