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
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 #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 areKaizen #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 achievedKaizen #142: How to Navigate to Another Page in Zoho CRM using Client Script
Hello everyone! Welcome back to another exciting Kaizen post. In this post, let us see how you can you navigate to different Pages using Client Script. In this Kaizen post, Need to Navigate to different Pages Client Script ZDKs related to navigation A.
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
New in CPQ: Smarter suggestions for Product Configurator by Zia, and additional criteria in Price Rules
Hello everyone! CPQ's Product Configurator in Zoho CRM allows sales teams to define structured product bundles through configuration rules, ensuring that the right product combinations are applied consistently in quotes. Admins set up these configurationsProcess between CRM and Campaigns to ensure double opt-in contacts?
I would like to ask for a few clarifications to ensure we fully comply with best practices and legal requirements: According to the documentation (Zoho Campaigns CRM sync – Default option), the best and recommended way to sync contacts is by using theZoho Books - New Interface keep details with PDF View
Hello, The Zoho Books Interface has changed for estimates etc... One thing is causing issues though. Before the change, in PDF view you could see the detail information including custom fields entered for the estimate. Now, you have to switch betweenTip #52- Zoho Assist Downloads: Everything You Need in One Place- 'Insider Insights'
Looking to start remote support sessions faster, manage unattended devices effortlessly, or join sessions without any hassle? The Zoho Assist Downloads Center has all the tools you need—across desktop, mobile, IoT, and browser environments. With our rangeCondition based aggregate fields in subforms
Hello everyone, We're excited to inform you about the latest enhancements made to our aggregate field capabilities in subforms; create aggregate fields based on conditions! An aggregate field is a column on which a mathematical function has been applied.SalesInbox
Sorry for saying this but SalesInbox is a really mess. BIG FAIL. Bad UX and VERY bad IMAP sync. I don't know how can someone use this to be more productive. It's just the oposite. I'm trying to use SalesInbox for a while but sales people do not have just sales activities so we still have to came back to the mail app anyway. Folders of SalesInbox are not in sync with folders of mail server (wich syncs Ok to mobile) and vice-versa wich leads to double work as now you have to cleanup 3 inboxes (MailPrint labels on selected view
How can I print labels for select view. Always defaults to ALL contacts when I select View = Mailing Labels. Thanks!!Update CRM Price Books to include volume discounts as per Zoho Books/Inventory
Once again, Zoho has 3 great products that all store information in different ways (which is not helpful when you attempt to integrate the 3 products - one of the best features of Zoho). Zoho CRM Price Books are basic at best. Zoho Books/Inventory PriceTip #40- Strengthen Remote Support with IP-based Restrictions in Zoho Assist– ‘Insider Insights’
Protecting sensitive data and preventing unauthorized access is a top priority for any organization. With IP-based restrictions in Zoho Assist, you can ensure that only users from trusted networks can initiate remote support sessions. Say your IT teamPrinting Client Lists
I was looking for a way to print out client lists based on the account. For example if I want all my contacts from company A on one sheet, how would I do this. Moderation Update (3rd December 2025): There are two challenges discussed in this thread. 1.Qwen to be the default open source Generative AI model in Zoho Desk
Hello everyone, At Zoho Desk, we will make the latest Qwen (30B parameters) the default LLM for our Generative AI features, including Answer Bot, Reply Assistant, and others. As a subsequent step, we will discontinue support for Llama (8B parameters).ZOHO Blueprint and Workflow
Hi, Correct me if i'm wrong, Blueprint triggers when a record that meets the criteria is created. It follows a specific transition that you will be setting up. Does blueprint work if the first state was triggered by a workflow? For example, In my custom module 1, I have a field named status. The statuses are 1, 2, 3 and 4. As soon as I create a new record, a workflow triggers that updates the status field to 1. Can a blueprint start from 2? My other concern is, can blueprint transitions work at theZoho CRM Participants Automatic - Invite Using Deluge
Hi Zoho! Is there a way to make the invitations automatic via API? I'm using this one but it doesn't work or reflect in the CRM: participantUser = Map(); participantUser.put("type","email"); participantUser.put("participant",email); participantUser.put("invited",Greek character in Deluxe script
Hi, We have been using a script since 2022 which replaces characters in Greek contact names using replaceAll. Since this morning, all the Greek characters used in the script have turned to question marks. I tried retyping the characters, copy-pastingWork Order Assignment for Engineers Handling Their Own Requests
I’m setting up FSM for a business where there are multiple engineers, but each engineer handles their own process end-to-end receiving the service request, creating the work order, and completing the field service job. I noticed that I must create anExperience Zoho Show on Mac now!
Work today isn’t tied to a single place, time, or routine. It happens in cafes between meetings, on flights, or late at night when ideas strike. And when ins, your tools need to be ready, wherever you are. That’s why we built the Zoho Show app for Mac.【開催報告】東京 ユーザー交流会 Vol.4 | Zoho CRM 自動化のコツ ・Bookings のビジネス活用シーンとおすすめ機能を紹介
ユーザーの皆さま、こんにちは。コミュニティチームの藤澤です。 11月28日(金)に新橋で「東京 ユーザー交流会 Vol.4」を開催しました。ご参加くださったユーザーの皆さま、ありがとうございました。ユーザー交流会の年内開催は、今回が最後でした。 この投稿では、当日のセッションの様子や使用した資料を紹介しています。残念ながら当日お越しいただけなかった方も、ぜひチェックしてみてください😊 ユーザー活用事例セッション：関数やクライアントスクリプトまで、CRMをもっと便利に Zoho CRM には、ワークフローやブループリントなど、さまざまな自動化に役立つ標準機能が備わっています。さらに、関数（Deluge）のようにスクリプトを記述して高度な自動化を実現することもできます。Kiosk Button Actions
I need to add an action to a Kiosk Button to loop me back to start the kiosk again and I am not sure what that looks like (function, etc.).Dependent drop-downs... how?
Good day. I have 2 different situations where I need a dependent drop-down field. First is for a subform, where I want to show related fields for a specific customer on the main form. In my case it is a parent whose children make use of our school transportReporting Limitation on Lead–Product Relation in Zoho CRM
I noticed that Zoho CRM has a default Products related list under Leads. However, when I try to create a report for Lead–Product association, I’m facing some limitations. To fix this, I’m considering adding a multi-lookup field along with a custom relatedSeries Label in the Legend
My legend reads 'Series 1' and 'Series 2'. From everything I read online, Zoho is supposed to change the data names if it's formatted correctly. I have the proper labels on the top of the columns and the right range selected. I assume it's something inDynamic Signature - Record owner
Hi everyone, I’m using Zoho Writer merge templates from Zoho CRM and have two questions: Owner signature: How can I automatically insert the CRM record owner’s signature in the merged document? I’m not sure where this signature is stored or how to referenceSet Warehouse based on Vendor
Greetings. I would like to set automaticaly the Warehouse based on the Vendor. Context: I am working on an adaptation of a Purchase Order to be used as a Quotation. I have defined that when a user has to raise a quote the Vendor will be "PROCUREMENT" I would like to set the Warehouse to a predefined value when "PROCUREMENT" is set as Vendor. I have tried to do with the Automation feature using the Field Update option, but Warehouse does not is listed as a field. Can you help? Thanks in advance.Printing from Zoho Creator hosted on my own server to printers hosted on my clients local network
Hello. Fairly new to Zoho Creator and looking for best options to be able to print from my application hosted on my own server to any printer hosted on my clients own local network. Any advice is welcome. Thank you.Add System Pre-Defined Lookup Field to Subform?
Hi there! New to using Zoho, so this may already exist, but I'm having trouble figuring it out. Is there a way to get the system pre-defined Account Lookup field (in our case, renamed to Company Name), as the starting point for a subform? In our company,Numbered / bullet point List in Zho Cliq
Hi, is there a way to format chat messages in Cliq like this Topic 1 Hey, I finished this project yesterday etc... Topic 2 I am still working on this etc...Cannot Access Subform Display Order in Deluge
As highlighted in this community post, we still have to deal with the significant limitation of not being able to access the user-sorted order of subform rows through Deluge. This creates a major disconnect between the UI capabilities and backend automation,How many groups in Zoho Mail can I make?
I'm currently on the free plan, which has a limit of 10 users. Does that limit includes groups too? If not, what is the limit for groups? Thanks!Feature Suggestion for Zoho Social: Auto-reply to Comments or Keywords
Hi Zoho team, I'd like to suggest a very specific feature that would be extremely helpful for customer engagement: the ability to automatically send a reply to comments on posts — either all comments or those containing specific keywords. For example,Already have Zoho account. Not letting me log in
I already have a Zoho account that is associated with my Google email and my phone number. Even though I'm already logged in to Zoho, when I click on the mail icon to access my email, it takes me to the pricing page. When I click on the free option, itZOHO Mail App Not working
There seems to be an issue with Zoho Mail App today. It is not connecting to server, internet is working fine, tried uninstalling app and reinstalling, loading circle keeps spinning round. Is there an update on the way?facing error 550 5.4.6 while sending emails
Please help me fix this issueAllow Itemization for Recurring Expenses
For whatever reason, one cannot itemize a Recurring Expense. This capability should be added. The use cases to support this are largely the same as what they were to allow for itemization in Expenses. Anything that would need to be itemized for a regularZoho reply to not working. just reply to my self
Hello. i using on my wordpress website a contact form from Wsform. i can set the reply to email there. normally it works. but since i am using your wordpress plugin zoho mail it doesn`t work. its not using the reply to (email from customer). I just canCan't receive any email from other platform
Hello,everyone, i'm just join zoho and create two email accounts for my own business. I was using it to get a verified email from stripe, but can't receive it. and I use my private gmail account to send test email twice, first time show below reply, butYour Incoming has been blocked and the emails will not be fetched in your Zoho account and POP Accounts
Can some on help me regarding our account . thank you so muchZoho Creator integration with Sage 50
Hi, Wondering if anyone has had any experience connecting Zoho to Sage 50 and could share any information on this matter. Thank you.Conditional Email Forwarding
How can I set conditional email forwarding of the users? For example: Mail should be forwarded to a address only if it comes from a particular sender. So, I want such email forwarding, which forwards mails based on particular conditions, like the incomingIncoming emails not appearing in Inbox
Hello, I have an issue with incoming emails sent from my website (domain: h2ostop.si). Emails are visible in the Sent folder, which means they are successfully sent through Zoho SMTP, but they never appear in my Inbox. Nothing arrives in Inbox, Spam,Automatic Matching from Bank Statements / Feeds
Is it possible to have transactions from a feed or bank statement automatically match when certain criteria are met? My use case, which is pretty broadly applicable, is e-commerce transactions for merchant services accounts (clearing accounts). In theseNext Page