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
Archiving Contacts
How do I archive a list of contacts, or individual contacts?Every time an event is updated, all participants receive an update email. How can I deactivate this?
Every time an event is updated in Zoho CRM (e.g. change description, link to Lead) every participant of this meeting gets an update email. Another customer noticed this problem years ago in the Japanese community: https://help.zoho.com/portal/ja/community/topic/any-time-an-event-is-updated-on-zohocrm-calendar-it-sends-multiple-invites-to-the-participants-how-do-i-stop-that-from-happeningConversion Rate – Won Deals over Assigned Prospects
Hello, I would like assistance configuring a KPI in Zoho Analytics titled: Objective of the calculation: Number of Won Deals divided by Total number of assigned prospects (not only converted prospects). Important clarification: The denominator must includeFeature Request – Conditional Visitor Information Request in Zoho SalesIQ
We would like to request the ability to conditionally ask for visitor details based on the communication channel used in Zoho SalesIQ. Specifically: When a visitor initiates a conversation through the live chat widget on the website, we want to continueApple Messages for Business in Omnichannel communications?
Hello, Apple launched "Apple Messages for Business" but Zoho CRM or Zoho Desk don't appear in the list of possible integrators. Zoho already promotes https://www.zoho.com/crm/omnichannel.html Omni Channel integration, but Apple Messages does not yet appear.Admin asked me for Backend Details when I wanted to verify my ZeptoMail Account
Please provide the backend details where you will be adding the SMTP/API information of ZeptoMail Who knows what this means?【Zoho CRM】通貨機能のアップデート：為替レートの自動更新やデータ更新オプションなど
ユーザーの皆さま、こんにちは。コミュニティチームの藤澤です。 今回は「Zoho CRM アップデート情報」の中から通貨機能のアップデートをご紹介します。 CRMの複数通貨機能を使うと、地域ごとに通貨を管理し、顧客の現地通貨で記録したデータを自国通貨に自動換算して分析やレポートに活用できます。 従来は、為替レートを管理者が手動で定期更新する必要があり、各データには作成時点のレートが固定されるため、その後の市場変動は反映されませんでした。 本記事では、この問題を解消する「為替レートの自動更新」をはじめ、さまざまな新機能をご紹介します。Can we add zoho sign to a custom module?
i understand out of the box it works with 8 modules. is it possible to add it to a custom module?This domain is not allowed to add in Zoho. Please contact support-as@zohocorp.com for further details
Selected date present employees roster
=CHOOSECOLS(FILTER(A2:E5;(INDEX(C2:E5;0;MATCH(VALUE(B8);INDEX(VALUE(C1:E1));0))<>"OFF")*(INDEX(C2:E5;0;MATCH(VALUE(B8);INDEX(VALUE(C1:E1));0))<>"EL"));1;2;2+MATCH(VALUE(B8);INDEX(VALUE(C1:E1));0)) This way sheet looks lFiltering in Help Center
Hi, our ticket system is based on a set of structured status categories. The customer must be able to filter by these status. How can we add "Status" as filter to the help center. In the same moment we do not need filters e.g. as "channel". How can weCan multiple agents be assigned to one ticket on purpose?
Is it possible to assign one ticket to two or more agents at a time? I would like the option to have multiple people working on one ticket so that the same ticket is viewable for those agents on their list of pending tickets. Is something like this currentlyWhere is the settings option in zoho writer?
hi, my zoho writer on windows has menu fonts too large. where do i find the settings to change this option? my screen resolution is correct and other apps/softwares in windows have no issues. regardsCRM gets location smart with the all new Map View: visualize records, locate records within any radius, and more
Hello all, We've introduced a new way to work with location data in Zoho CRM: the Map View. Instead of scrolling through endless lists, your records now appear as pins on a map. Built on top of the all-new address field and powered by Mappls (MapMyIndia),Zoho Sign Not Delivering
I have sent several contracts out via Zoho Sign. They do not seem to be getting delivered. I had one person receive it, but the others have not. I had one person tell me they sent it back to me and never got it and doesn't show as signed. I've sentBank Feeds Breaking Constantly
Hey Everyone, I have already reached out to support about this issue but I am wondering if anyone else is having the same issue. My bank feeds keep breaking within days of me fixing them by updating the credentials. Its been happening for a while andAutomatic 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 theseZoho Payroll's USA and KSA editions are available in Zoho One!
Greetings! We’re excited to share that Zoho Payroll, currently available only in India and the UAE, is now introducing the KSA (Kingdom of Saudi Arabia) edition and the USA (United States of America) edition, and these editions are now available in ZohoTip #63- Exploring Technician Console: Elevate to Admin Mode (Windows & Mac)- 'Insider Insights'
Hello Zoho Assist Community! Ever been in a remote support session where you couldn’t complete a task because you didn’t have admin privileges? Maybe installing software, accessing secure system areas, or rebooting into Safe Mode just didn’t work becausePrevent accidental duplicate entry of Customer Ordersome
Zoho Support has confirmed that Zoho currently does not have any method (using Deluge, flow or any other method) to alert a user when a sales order has been entered twice using the same customer reference number (i.e. a duplicate). Most ERP platformsZoho Mail - Email Reminder template (default)
Zoho Mail Users, Does anybody here use the email reminder template? I'm asking Zoho to allow and add us to select which one of our many templates will be our default. It allows us to operate more efficiently. It's a Checkbox. If you feel this can benefitWindows 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 menusCanva Integration
Hello! As many marketing departments are streamlining their teams, many have begun utilizing Canva for all design mockups and approvals prior to its integration into Marketing automation software. While Zoho Social has this integration already accomplished,Announcement integration between Zoho People and Zoho Connect
As we're using these 2 products, there're areas of overlapping especially in the Announcement. When there's a new announcement in Zoho People, can it push to the company wall in Zoho Connect?Does Zoho Mail Have Popout windows?
I recently switched my work email over to Zoho and everything I read said that you can popout the draft email as you're writing, however, all the pictures or info I've seen show the typical popout arrow in the top right, which I can not for the life ofCan I reorder how the staff are displayed on the booking page?
As the title suggests, can I change this? Either reorder manually reoreded to my preference, or automatically (a-z, z-a etc.)Bulk upload image option in Zoho Commerce
I dont know if I am not looking into it properly but is there no option to bulk upload images along with the products? Like after you upload the products, I will have to upload images one by one again? Can someone help me out here? And what should I enterSubheaders for Sections in forms
Currently, every form section has a field name, which one can choose to show/hide to the end user. It would be great if there was an option to show a SUB-HEADER in addition to a header. It would be useful for explaining to the end user what the sectionCustom view inconsistencies
Why is "is not" missing from criteria, along with other comparison operators ??? It makes it almost impossible to build required custom views, I don't want "void" invoices listed & why on earth would "Void" invoices be showing when the criteria includesPromote a layout to standard so I can delete one layout
Similar to this and many other topics: https://help.zoho.com/portal/en/community/topic/set-layout-as-standard The problem, every model has a standard layout, which is what we use most of the time... But as the business grows and evolves we may have toCan Zia summarize fields?
A great use case of AI for me would be summarizing company descriptions. We often get long winded descriptions from databases or scraping websites, then reduce them to a couple of sentences stating what a company actually does. Is there any way withinZoho Recruit Community Meet-up - India (Venues Finalised)
Zoho Recruit Community Meet-up - India (Venues Finalised) Namaste, India. 🙏🏼 The Zoho Recruit team is hitting the road—and we're absolutely excited behind the scenes. Join us for the Zoho Recruit India Meet-up 2026, a morning designed to make your recruiting[Webinar] Solving business challenges: Secure, real-time, and external collaboration
Hi Zoho Writer users, We are excited to announce Zoho Writer's webinar for March 2026: Solving business challenges: Secure, real-time, and external collaboration. Zoho Writer supports real-time collaboration by allowing teams to work together in documents.Table dimensions
I try changing the dimensions of the table on my computer but it doesn't change. Do I have to be a premium member or does it only work on the app?Zoho CRM Community Digest - January 2026 | Part 2
Hello Everyone! Here’s the second part of January’s Zoho CRM Community Digest, rounding up the remaining highlights from the month. From newly rolled out updates to thoughtful implementation questions and practical solutions, the community once againFind and Merge Duplicates to trigger webhook
My sales team uses the Find and Merge Duplicates feature often to cleanup records in the CRM. We use webhooks to signal to our internal tools database when new Contacts are created, updated, or deleted, in order to keep our DB in sync with Zoho CRM. However,Introducing WhatsApp integration and quick editing capabilities in Zoho Sign
Hi there, Zoho Sign already helps users collect signatures via email and SMS, and we're happy to announce that you can now send documents and authenticate recipients right through WhatsApp. Some of the key benefits include: Communication with recipientsDynamic Field Folders in OneDrive
Hi, With the 2 options today we have either a Dynamic Parent Folder and lots of attachments all in that one folder with only the ability to set the file name (Which is also not incremented so if I upload 5 photos to one field they are all named the sameLogging Out of FSM
I have tried to log out of FSM app of the last person and it will not let me do so. I need to log in to my account.Enhancement in Zoho CRM: Control who gets to participate in a forecast by customizing the user hierarchy
Include only users from the sales function; exclude the rest Dear Customers, We hope you're well! We started this year with a series of exciting enhancements to Zoho CRM and to this list, we are thrilled to add an enhancement to forecasting. Let's talkNext Page