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
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
Extension pointers for integrating Zoho CRM with Zoho products #8: Upload and manage Zoho Workdrive folders and files from within Zoho CRM
Keeping records on your customers and business prospects is essential for tracking data, conducting follow-ups, and running a business smoothly. When you use two separate applications, and store relevant data in each, checking and tracking data becomesExtension pointers: Handle cases with personalized solutions using custom actions
In our last post, we detailed the steps involved in creating a custom action and the workflow from the developer and end user's side. Now let's look at a working example of how we can create a custom action and implement it in a Zoho CRM account to makeExtension pointers - Simple yet significant pointers #13: On change of field value for CRM variables
CRM variables provide global access to a variable across an entire extension. They also help in the storage of user-specific data provided by the user at the time of installation, which can later be fetched to perform data functionalities. Additionally,Extension pointers: Extend end-user benefits and allow personalization by implementing extensions with custom actions
From our earlier post on custom actions, we know that we can create templated actions, share them with end users, and allow them to reuse those actions to achieve personalized outcomes. In this post, we'll look at how custom actions make it easy for usersExtension pointers - Simple yet significant pointers #12: Functions for Zoho CRM extensions
Functions are essential in achieving logical functionality for an extension. You can easily code your functions in Deluge using drag-and-drop tools to meet your requirements. How to create functions for Zoho CRM extensions in Sigma Go to Sigma and select
New to Zoho TeamInbox?
Zoho TeamInbox Resources
Zoho DataPrep Resources
Zoho CRM Plus Resources
Zoho Books Resources
Zoho Subscriptions Resources
Zoho Projects Resources
Zoho Sprints Resources
Qntrl Resources
Zoho Creator Resources
Zoho WorkDrive Resources
Zoho Campaigns 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セミナー