Kaizen #62 - Using field related functions in Client Script
Welcome to another week of Kaizen!
This post is about the Field related functions in Client Script.
Field related functions in Client Script
You can use the ZDK functions to achieve desired actions for various events.
ZDK function | Description |
| getField | To fetch the field information by api name |
getFields | To fetch the list of fields in the Page as an array |
getApiName | To fetch the API name of field |
mask | To mask the field value |
showError | To show inline error message for an input field |
setValue | To set the value for a field |
getValue | To get the value of a field |
setMandatory | To set the mandatory attribute for the input field |
setMaxLength | To set the max length of field input |
setReadOnly | To set the read-only attribute of field input |
Use Case
ABC is a hardware manufacturing company. Let us consider that you want to achieve the following using Client Script.
- In the create page of Order module, whenever the field Product is selected, the field Categoryshould get auto-populated based on the following table.CategoryProductsIgnition systemSparking cable, Ignition box, Ignition coil, Spark plugGauges and metersSpeedometer,Odometer, Voltmeter, Temperature gauge
- If the Category is Ignition System, the field Number of Boxes should be mandatory.
- If the field Country is India, the maximum number of digits that the user can enter in the field Phone Number should be limited to 10.
- Whenever the user edits or adds the Phone Number with length less than 10, display an error message near the field.
- The last five digits of the Phone Number field value should be masked for all profiles except the Administrator.
Solution using Client Script
The requirements 1-4 are for the create page of Orders module. The 5th requirement is on the detail page of the module Orders. So create two scripts as follows.
- Client script for create page (requirements 1-4)
- Client script for detail page (requirement 5).
1. Client Script for create page (covers requirements 1-4)
- 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.
switch (field_name) { case 'Product': var product_name = ZDK.Page.getField('Product').getValue(); var category_field = ZDK.Page.getField('Category'); // requirement - 1 if (['Sparking cable', 'Ignition box', 'Ignition coil', 'Spark plug'].includes(product_name)) { // Populate value for picklist field 'Category' based on the condition category_field.setValue("Ignition system"); ZDK.Page.getField('Number_of_Boxes').setMandatory(true); // requirement - 2 } else if (['Speedometer', 'Odometer', 'Voltmeter', 'Temperature gauge'].includes(product_name)) { // Populate value for picklist field 'Category' based on the condition category_field.setValue('Gauges and meters'); } break; case 'Phone_Number': var phone_field = ZDK.Page.getField('Phone_Number'); if (phone_field.getValue().length < 10) { phone_field.showError('Enter a valid phone number'); // requirement - 4 } break; case 'Country': ZDK.Page.getField('Phone_Number').setMaxLength(10); break; case 'Category': if (ZDK.Page.getField('Category').getValue() === 'Ignition system') { ZDK.Page.getField('Number_of_Boxes').setMandatory(true); // requirement - 2 when category is changed in ui } break; } |
- Here is how the client Script works,
2. Client Script for detail(canvas) page (covers requirement 5)
- 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.
var user = ZDK.Apps.CRM.Users.fetchById($Crm.user.id); if (user.profile.name !== 'Administrator') { ZDK.Page.getField('Phone_Number').mask({ character: '*', length: 5, reverse: true }); } |
Note: $Crm is a constant supported by Client Script, using which you can get the org related information and use it in your script.
- You can see that the Phone Number is partially masked when you view the order canvas page as a Standard User.
- You can see that the Phone Number is not masked when you view the order canvas page as an Administrator.
We hope you found this post useful. We will meet you next week with another interesting topic!
If you have any questions let us know in the comment section.
Cheers!
Previous Kaizen post: Composite API
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
Sticky Posts
Kaizen #197: Frequently Asked Questions on GraphQL APIs
🎊 Nearing 200th Kaizen Post – We want to hear from you! 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 #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.Celebrating 200 posts of Kaizen! Share your ideas for the milestone post
Hello Developers, We launched the Kaizen series in 2019 to share helpful content to support your Zoho CRM development journey. Staying true to its spirit—Kaizen Series: Continuous Improvement for Developer Experience—we've shared everything from FAQsKaizen #193: Creating different fields in Zoho CRM through API
🎊 Nearing 200th Kaizen Post – We want to hear from you! 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.Client Script | Update - Introducing Commands in Client Script!
Have you ever wished you could trigger Client Script from contexts other than just the supported pages and events? Have you ever wanted to leverage the advantage of Client Script at your finger tip? Discover the power of Client Script - Commands! Commands
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
Bigin iOS app update: Built-in telephony and RingCentral support
Hello everyone! We are excited to introduce Built-In Telephony and RingCentral support in the latest iOS version(v1.11.13) of the Bigin mobile app. Once the integration is completed on the Bigin desktop site(bigin.zoho.com), you can choose the Built-InAdd Image or Update Image API - for Items Module
I am trying to add new Items to Zoho Inventory from Zoho Creator. I achieved this using Zoho Inventory Create Item API, but how to add or update the item image from Zoho Creator to Zoho Inventory Item Module?Introducing Booking Pages—a topping for your Calendar Scheduling needs!
Greetings, We're here with a new topping for Bigin! Let's dive into the details. What does this topping do? Scheduling appointments with customers is one of the most common challenges small businesses face on a daily basis, as it often involves frequentDebugging `try` blocks : Tip
I find it annoying that if one line inside a `try` block has an error, the Deluge arser points the beginning of the block to the location of the error. BUT, if you temporarily comment out the initial `try {`  The parser goes through the whole block and[Product Update] TimeSheets module is now renamed as Time Logs in Zoho Projects.
Dear Zoho Analytics customers, As part of the ongoing enhancements in Zoho Projects, the Timesheets module has been renamed to Time Logs. However, the module name will continue to be displayed as Timesheets in Zoho Analytics until the relevant APIs areUse approval workflow comments in record scripts
Greetings, i'm running an approval workflow for my records, during approval/rejection there is a step where comments are entered. i want to add there comments to the record and to use them in various deluge scripts like sending emails and so on. howZOHO Store
Not able to make a payment We are using Zoho One, and we are from India. The payment currency, which shows for us, is in USD. But the system says we can choose Country/Region India if it shows INR only. Attaching screenshots for more info.Support Migration into Aliases in Zoho Mail
Hello Zoho Mail Team, How are you? We are in the process of migrating some of our users from Google Workspace (Gmail and Google Drive) to Zoho. During this process, we noticed that Zoho Mail currently only supports migration into a primary mailbox andAPI for Z Workdrive Flow Make-Integromat ?
We are zoho workdrive fans Also we would like to have an api to work with Zoho Flow or with Make better known by its old name INTEGROMAT Is it planned and when? 3 months -6 months or more?Apps Pane no longer visible
I have read all the info and help and nothing works, I do not have a "show apps" anywhere and I can no longer see my Apps pane in the left hand side of mail, please advise how to get this backCanvas View - Print
What is the best way to accomplish a print to PDF of the canvas view?5名限定 課題解決型ワークショップイベント Zoho ワークアウト開催のお知らせ(8/21)
ユーザーの皆さま、こんにちは。Zoho ユーザーコミュニティチームの藤澤です。 8月開催のZoho ワークアウトについてお知らせします。 今回はZoomにてオンライン開催します。 ▷▷参加登録はこちら：https://us02web.zoom.us/meeting/register/eVOEnBsSQ2uvX4WN5Z5DeQ ━━━━━━━━━━━━━━━━━━━━━━━━ Zoho ワークアウトとは？ Zoho ユーザー同士で交流しながら、サービスに関する疑問や不明点の解消を目的とした「ZohoNew in Zoho Forms: Inline OTP Verification
Hello form builders, We are excited to announce the launch of Inline OTP Verification in Zoho Forms, a smarter way to ensure the authenticity of the contact details you collect. Until now, OTP Verification in Zoho Forms worked as a pre-access step: respondentsZoho Mail : Associate emails with Meeting records and allow multiple emails to be assocaited at once
Is there a workaround that would allow either of these? I want to associate emails with Meeting records. I also would like to be able to select multiple emails at once for association with a record.Create task from email
Is there a way on mobile to create a task from an email? I use this feature a lot and when traveling now I read email on mobile. By the time I get to my office I forget about them since I didn't add it to a task. Is this feature missing on moble?Zoho Socials - Unable to view Channels and SmartQ
Hi, The channel Facebook has been added by the admin, however, it is not visible on the User level (employee). Other channels are visible. Also, we have the premium account, and SmartQ is not working. Can anyone help? Regards, PriyankaEliminating Manual Consolidation: Automating Currency Field Sync from Task to Project
Hello Everyone, A Custom function is a user-written set of code to achieve a specific requirement. Set the required conditions needed as when to trigger using the Workflow rules (be it Tasks / Project) and associate the custom function to it. Requirement:We want to set the "Converted from Lead" value in Deals using a Workflow or via a Deluge script. How?
For use in Zoho Analytics, we need the field "Converted from Lead" filled in our deal records. This field is empty everywhere, because we do not create deals directly when converting a lead to a contact. We want to do that using the API or a workflowSales Orders: Quoted_Items + items in another subform -> into Ordered_Items ?
hello, When creating Sales Orders, is it posible to inherit/fill the Ordered_Items with all the items from Quoted_Items + all the items from a customized subform with similar fields? Since you can create a sales order in different ways (convert, new -How to cancel the GSTR1 pushed to GSTN
How to cancel the GSTR1 Pushed to GSTN, some rectifications to be done in HSN & SAC codeZoho Books API — Invalid Operation Type / Scope does not exist
Hello Team, We are unable to use the Zoho Books API from our registered application. We’ve already: Created a client in Zoho API Console using (Admin in Books) Generated the OAuth code and token successfully Used the correct scopes: ZohoBooks.fullaccess,ZohoOauth.userinfo.READEnhancements in Canvas
Dear All, Greetings! Canvas lets you design the record details page to suit your brand or business preferences. We are glad to introduce the following enhancements to uplift your design experience. Reusable Components Style Presets Let's go! ReusableMinimum order quantity
Is there a way to enforce a minimum order quantity - ie has to have a minimum of 250?【Zoho CRM】ポータル機能のアップデート：UIとポータルの作成フローの変更
ユーザーの皆さま、こんにちは。コミュニティチームの藤澤です。 今回は「Zoho CRM アップデート情報」の中から、ポータル機能のアップデートをご紹介します。 目次 概要 ユーザーグループの作成フローの変更 ユーザーグループ詳細画面内のタブについて 「タブと権限」タブについて 「設定」タブについて 概要 UIとポータルの作成フローが変更されました。ポータルの新機能に先立ち、UIを一部変更しました。タブやオプションの配置を見直し、機能へよりアクセスしやすくなっています。 また、「ポータルユーザーの種類」は今後、「ユーザーグループ」と呼称され、ページ上のボタンも「ユーザーグループを作成する」に変更されます。Tax on Imported goods charged by Shipping Company
Hi Folks, I imported goods from outside Canada, for better understanding I will give an example data. imported goods value: 2000$ The shipping company sent me an invoice containing the following information: Custom duty on imported goods: 400$ AdministrationPrefilled Date fields auto-changed and then locked when using “Edit as new”
If a document out for signature has date fields (not SignedDate fields) that were pre-filled before sending, and then you use “Edit as new” to create a new version of the same document, the value of those date fields gets automatically changed to todayZoho Webinar via Social Media
Hello, is it possible to stream a Zoho Webinar via Social Media like Linkedin or Facebook?Add Hebrew & RTL Support to Feedback Widget
Hello Zoho Desk Team, How are you? We are using Zoho Desk and would like to utilize the Feedback Widget. While Zoho Desk itself supports Hebrew and RTL, the Feedback Widget unfortunately does not. We kindly request that Hebrew and full RTL support beOAUTH2 isn't working with Power Automate and N8N (Zoho Desk)
Hello, I am trying to set up an OAuth2 connection to the Zoho Desk API, but the authentication flow fails immediately. I am experiencing this issue in two separate platforms: Microsoft Power Automate (using a Custom Connector) and n8n. Instead of beingKit Items Breaking Automations - "Provide mapped components for all kit items"
This has been brought up in other threads, but I believe this issue warrants its own topic. Whenever a sales document (Estimate, Sales Order, Invoice) is created or manipulated programmatically, trying to include a Kit as an Item throws this error: "ProvideShow item Cost value on Item screen
The Item screen shows Accounting Stock and Physical Stock. It would be very helpful if value information could be displayed here as well, for instance Cost Price. Currently, to find the Cost Price (as used for inventory valuations) from inside the itemMark shipment as delivered via api
Hellloooo again Zoho guys !! More help required if you would be so kind, pleeeezz..... var options = { 'method' : 'post', 'contentType' : 'application/json', 'muteHttpExceptions' : true }; var myPackNo = encodeURIComponent('###################');Setting Alternative units for an item.
Hello Team, How to create alternate units for an item. We are placing orders for stocks in boxes. One box contain 24 items. At the time of selling we have two categories of buyers wholesalers and retailers. So the sales will be in PCS and in boxes also.Zoho Inventory search when adding items to SO/PO, etc.
I do not see that Zoho Inventory searches within the item name for an item lookup. We have many products with variants. So when I search for a product, say a lighting system, and it comes in different sizes and colors, I can only get those products whereItem Group Attributes
Hello, I would like to see more attributes under grouped items. We sell car parts, there are several suppliers for the same part but under different brands. We want to group them together but the attributes under groups are lacking. For example, the productsRemove HTML Format - Deluge
Hello @all if you want to delete the HTML format from the text please follow the script. Data = "Text"; info Data..replaceAll("<(.|\n)*?>" , "").replaceAll(" " , " "); Apart from this if you require anything please let me know Thanks & Regards PiyushUsing multiple languages in template
I wanted to add the company name in the template in arabic. I found a way through the header and footer option, except when i print the quotation the arabic disappears both in the top and bottom of the page. I have attached pictures of the before andADDING 5% VAT TO PURCHASE ORDERS GENERATED ON ZOHO BOOKS UAE
Please guide on how to add 5% VAT to Purchase Orders generated on ZOHO Books UAE edition.Import from /csv file, some items fail with the error "Specify Tax Or Tax Exemption".
Hello! I am trying to import a csv file of all of my expenses for a complete financial year. I get errors for some items with the error message "Specifiy Tax or Tax Exemption". These errors only occur on lines where I have "Postage" as the expense account.About maximum number of requests per minute
Hi, Our company has integrated Zoho inventory and we're using the shipping order creation and update functions and so on. Currently we're receiving "For security reasons you have been blocked for some time as you have exceeded the maximum number of requestsNext Page