Kaizen #99 - Render Widgets Using Client Script

Hello everyone!

Welcome back to another interesting post. In this post, let us see how you can render Widgets using Client Script.

Widgets are embeddable UI components that you can create and add to your Zoho CRM. You can use widgets to perform functions that utilize data from third-party applications. You can build widgets for Zoho CRM using our JS SDK.

You can render a Widget through Client Script and pass data from the Widget to the Client Script.

Use Case:

At Zylker, a manufacturing company, the Service Agent places orders using the Orders module. There is a sub-form named Product list. The user should add the products by clicking the "Add row" button every time.

To avoid this, Zylker wants the users to select multiple products from a single pop-up. Once the user selects the products from that pop-up , the sub-form "Product list" should get updated with all those products(one product in one sub-form row).

Solution:

Whenever the user picks the Product Category, you can create a Client Script to render the widget. The Products selected by the user on the widget , will be passed to the Client Script and will be added as separate rows in Product list subform.

1. Install Zoho CLI and add code to the app folder.

2. Upload the zip file as a Widget.

3. Create a Client Script to render the Widget and to add data to the Sub-form.

1. Install Zoho CLI and add code to the app folder

Follow the steps given in this post and add the html code, javascript file and css file.

Index.html

<!DOCTYPE html>

<html>

<head>

<meta charset="utf-8">

<meta name="viewport" content="width=device-width">

<script src="https://live.zwidgets.com/js-sdk/1.2/ZohoEmbededAppSDK.min.js"></script>

<title>Choose products</title>

<link href="styles/style.css" rel="stylesheet" type="text/css" />

<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">

</head>

<body>

<div class="wgt_cp_popupContent">

<section class="wgt_cp_contentWrap">

<div hidden="true" id="noProductDiv">

<pre>No products associated to the selected deal</pre>

</div>

<table width="100%" cellspacing="0" id="pTable">

<thead>

<tr class="wgt_productTblHead">

<th><input type="checkbox" id="selectAll" onclick="selectAllProducts(this)"></th>

<th>Product Name</th>

<th>Product Category</th>

<th>Unit Price</th>

<th>Quantity in Stock</th>

</tr>

</thead>

<tbody id="tbody"></tbody>

</table>

</section>

</div>

<script src="./script/script.js"></script>

</body>

</html>

Script.js

var count = 0;

var productData, maxRows = 0;

ZOHO.embeddedApp.on("PageLoad", async function (data) {

console.log("data from Client Script", data);

maxRows = data.max_rows;

const search_response = await ZOHO.CRM.API.searchRecord({ Entity: "Products", Type: "criteria", Query: "(Product_Category:equals:" + data.product_category + ")" })

if (search_response && search_response.data && search_response.data.length) {

productData = search_response.data;

var htmlString = "";

productData.forEach(({ id, Product_Category, Product_Name, Unit_Price, Qty_in_Stock }) => {

htmlString = htmlString.concat(

`<tr>

<td><input type='checkbox' onclick='selected(this)' id='${id}' class='products'></td>

<td>${Product_Name}</td>

<td>${Product_Category}</td>

<td>${Unit_Price}</td>

<td>${Qty_in_Stock}</td>

</tr>`

);

});

document.getElementById("tbody").innerHTML = htmlString;

} else {

document.getElementById("pTable").hidden = true;

document.getElementById("noProductDiv").hidden = false;}

});

ZOHO.embeddedApp.init();

function selected(element) {

element.checked ? count++ : count-- ;

document.getElementById("selectedCount").innerHTML = `${count} Products selected`;

}

function closewidget() {

if (count > maxRows) {

alert("Selected product is greater than the maximum subform rows.");

} else {

var selected_products = [];

for (product_element of document.getElementsByClassName('products')) {

product_element.checked && selected_products.push(productData.find(product => product.id === product_element.id));}

console.log("returning to Client Script ...", JSON.stringify(selected_products));

$Client.close(selected_products);}

}

As per the above script, the products are fetched from the "Products" module based on the "Product Category" selected by the user. This information is captured in "search_response" and is added to the body of widget.html.

Here, the code $Client.close(selected_products); will pass the selected products from Widget to the Client Script and close the widget rendered from Client Script. Click here for more details about the variable $Client.

Next step is to upload the zip file of the app folder.

Click here to view the complete code.

2. Upload the zip file as a Widget

Go to Setup > Developer Space > Widgets.
Click Create New Widget.

The Hosting should be "Zoho" and mention the html page of the app folder that you uploaded.

Note: The widget should be of "button" type in order to render through a Client Script.

3. Create a Client Script to render Widget and to add data to the subform

Go to Setup > Developer Space > Client Script. Click +New Script.
Specify the details to create a script and click Next.

The Client Script should render the Widget when the user selects Product Category. So Client Script should have field event on the field "Product Category".
On the Client Script IDE, you can see the below details.

Enter the following script in the Client Script IDE and click save.

var products_list = ZDK.Page.getField('Product_list').getValue();

if (products_list.length === 1) { // Clear subform if empty row

!Object.values(products_list[0]).every(value => !!value) && products_list.pop();

}

// Open widget with product category & max. allowed rows based on existing subform data

var selected_products = ZDK.Client.openPopup({

api_name: 'choose_products', type: 'widget', header: 'Choose Products', animation_type: 1, height: '570px', width: '1359px', left: '150px'

}, {

product_category: value, max_rows: 25 - products_list.length

});

// Update subform with Selected Products from the widget Popup

if (selected_products.length) {

selected_products.forEach(product => {

products_list.push({ Product_Name: { id: product.id, name: product.Product_Name }, Quantity: 1, Unit_Price: product.Unit_Price });

});

ZDK.Page.getField('Product_list').setValue(products_list);

}

To render a widget from Client Script, use openPopup(config, data) ZDK. You can specify the configuration details like api name of the widget, title, size, animation type as parameters and specify the data to be passed as 'PageLoad' event data in the Widget.

The response from the widget (i.e user selection) is captured by the variable "selected_products". Then each product (id,name,product_name,quantity and unit_price) is pushed to the list products_list. Finally, the product list value is updated to the Product Category sub-form using setValue(value) ZDK.

Here is how the Widget gets rendered through Client Script.

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.

Click here for more details on Client Script in Zoho CRM.

As we approach the 100th post in our Kaizen series next week, we invite you to share your queries and concerns with us. We are always looking for ways to improve our content and make it more relevant to our readers.

Please fill out this form to share your thoughts.

Related Links

Client Script Overview

Creating a Client Script

Client Script Events

Client Script IDE

Use cases of Client Script

Widget Overview

Installing the CLI

Creating your First Widget

Using Widgets

Happy Coding!

New to Zoho LandingPage?

Access Zoho LandingPage

Zoho LandingPage Resources

New to Zoho Survey?

Access Zoho Survey

Latest Feature Updates

Explore our Pricing & Plans

Zoho Survey Resources

Android Mobile Surveys

Insurvey Blogs

Insight Blogs

Tips & Tricks

New to Zoho CRM Plus?

Deliver unforgettable customer experiences

ACCESS ZOHO CRM PLUS

New to Zoho CRM Plus?

Deliver unforgettable customer experiences

ACCESS ZOHO CRM PLUS

New to Zoho Marketing Plus?

Everything you need to run your marketing

ACCESS ZOHO MARKETING PLUS

New to Zoho Marketing Plus?

Everything you need to run your marketing

ACCESS ZOHO MARKETING PLUS

New to Bigin?

Signup Now

Access Bigin

Latest Feature Updates

Zoho Desk Resources

Desk Community Learning Series
Digest
Functions
Meetups
Kbase
Resources
Glossary
Desk Marketplace
MVP Corner
Word of the Day

Tout forum

France ZUGs

Zoho SalesIQ Resources

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 becomes
Extension 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 make
Extension 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 users
Extension 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