Client Script for tags
Hello everyone!
Welcome to another informative Kaizen post. In this post, let us see how to accomplish the following using Client Script.
1. How to auto-tag a record based on field update?
2. How to Open a pre-filled email draft
This post will provide a quicker solution using Client Script for the queries mentioned in the posts Is it possible to auto fill email draft? and How to tag quickly?
In this Kaizen post,
- Tags in Zoho CRM
- ZDK functions related to Tags
- Use Case
- Solution
- Summary
- Related Links
1. Tags in Zoho CRM
Tags in Zoho CRM are not just a simple category; they can be more powerful since you can add multiple tags to a single record. You can also create tags in multiple locations in your CRM account, if required. Click here to know more about working with tags.
2. ZDK Functions related to Tags
Below are the ZDK Client APIs supported by Client Script related to tags. Click here to view the documentation.
- addTag() - Add a tag/tags to a record
- removeTag() - Remove a tag/tags to a record
- getTags() - Get the list of all tags of a record
Note :
These ZDKs can be used only for Detail Page(Canvas) and Detail Page(Standard)
Apart from these, you can use the below ZDK CRM APIs to add and remove tags.
- addTagsToRecord() - Add Tags to Record
- addTagsToRecords() - Add Tags to Record
- removeTagsToRecord() - Remove Tags from Record
- removeTagsToRecords() - Remove Tags from Records
Note
The above ZDKs implicitly invoke the Add tags API and Remove tags API. Click here for more details.The execution of the above ZDKs will impact your API credits.
To know more about Client Script's ZDKs to implicitly invoke CRM APIs, check this kaizen post. The event onTagChanged - This event occurs on the click of save button of Add tags.
3. Use Case
At Zylker, the manager seeks to optimize the handling of order complaints by automating the tagging and notification process. When a customer support agent who places an order on behalf of customers also logs a complaint in the "Order Issue" field of the Orders module, then the order should automatically be tagged as "Issue Reported." This action should open an email draft, pre-filled with a specific template , along with the "To," "From," and "Subject" fields automatically populated after getting confirmation from the customer support agent, and notify the delivery team to check and resolve the issue.
4. Solution
For the above requirement, you need to create a Client Script that triggers when the customer support agent updates the Order issue field.
- Configure a Client Script for Detail Page(Standard) Orders module, that triggers during onBeforeUpdate Event of Type Field event of Order Issue, as shown below and click Next.
- Click here to know how to configure a Client Script.
- Enter the following script in the IDE and click Save.
- if (value != null) {
- ZDK.Page.addTag('Issue Reported');
- ZDK.Client.showConfirmation('The Tag *Issue Reported* has been added successfully. Do you want to notify support team?', 'Yes', 'No');
- ZDK.Client.openMailer({ from: 'support@zylker.com', to: [{ email: 'zylker@zyldomain.com', label: 'zylker@zyldomain.com' }], cc: [{ email: 'info@zyldomain.com', label: 'info@zyldomain.com' }], subject: 'Issue Reported', body: '', templateId: "4967860000006521006" });
- }
- In the above script, whenever the customer support agent updates comments in this field, a new tag gets added by ZDK.Page.addTag(). Here is the syntax:
- Once the tag gets added, a message gets displayed using the ZDK.client.showConfirmation(). The message mentioned in the confirmation box supports markdown. Based on confirmation, the mail draft opens using ZDK.Client.openMailer(). Here is the syntax:
- Here, you need to specify the template ID of the email in the openMailer() ZDK along with the other details like from, to , cc.
- To get the template ID, go to setup-->templates-->select the template that you want and click edit.
- You can pick the template ID from the URL.
- Click here to know more about email templates. Here is how the Client Script works.
Summary
In this post, we have seen - How to add a tag automatically to a record when a Detail Page is updated.
- How to fetch the tags associated with a record using Client Script.
- How to open pre-filled email draft from Detail Page(Standard)
- How to fetch the template id of an email
Related Links:
- Creating a Client Script
- Client Script Events
- Client Script IDE
- Use cases of Client Script
- FAQs of Client Script
- Best Practices of Client Script
Let us know your thoughts in the comment section or reach out to us at support@zohocrm.com. Stay tuned for more insights in our upcoming Kaizen posts!
Previous Kaizen Post: Kaizen #161 - Global Sets using Zoho CRM APIs | Kaizen Directory | Kaizen Collection
Happy Client Scripting!
Access your files securely from anywhere
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#162 : Add Tags and Open Pre-filled Email Drafts via Client Scripts
Hello everyone! Welcome to another informative Kaizen post. In this post, let us see how to accomplish the following using Client Script. 1. How to auto-tag a record based on field update? 2. How to Open a pre-filled email draft This post will provideClient 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! CommandsExtension Pointers - JS SDK series #4: Managing data from a widget using ZOHO.CRM.HTTP
Handling and managing the data between two applications is a major factor for an efficient business. There are a variety of ways to handle data between Zoho CRM and other third-party applications. You can use deluge CRM tasks, create connectors, use APIKaizen #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 achievedExtension 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 becomes
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 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セミナー