Kaizen #187 - Building a Timer and Worklog Widget (Part 1)

Howdy Tech Wizards!

Welcome back to a fresh week of Kaizen! 

This time, we are diving into a two-part series where you will learn how to build a Timer and Worklog Widget for Zoho CRM. This widget helps track active work time and log multitasking sessions using Zoho CRM APIs, Client Script, Functions, and Workflows.

Why It Matters?

Zoho CRM effectively captures stage/status transitions, like tracking when a case moves from Open to In Progress or On Hold. However, in dynamic work environments, employees juggle multiple work items and engage in impromptu tasks or conversations. 

Let’s take the On Hold status as an example. 

While it can be used to indicate pauses in progress, it does not always align with real-world workflows. Consider these scenarios:

Not all interruptions justify a status change 

Moving the case to On Hold for every minor detour (to clarify something with a colleague or respond to another emergency work item) would be impractical and could lead to under reporting actual work hours. Over time, this untracked effort adds up, creating a gap in visibility.

Frequent status changes may dilute their meaning 

In many teams, On Hold signifies a legitimate blocker like waiting on customer input or an external dependency. Using it frequently to reflect quick shifts in attention could compromise that clarity. 

A timer widget solves this by:

• Capturing hands-on work items.
• Logging context switches (unrelated tasks) with descriptive entries.
• Feeding structured entries into a custom module for reporting and subform sync.
  

Business Scenario: IT Service Desk & Ticket Resolution

A tech support team uses the Cases module to resolve customer issues. Some tickets are straightforward; others require follow-ups, escalations, or cross-team coordination. While CRM timestamps (like stage transitions or picklist tracking) track when changes happen, they do not reflect how long someone actively worked on a case.

This Timer Widget can be the ultimate solution to track down the active time spent on each case through out the day.

What are we Building?

By the end of this two-part guide, you will know how to:

• Build a timer widget to track time per task or any CRM record.
• Log work sessions into a custom module every time the timer is started/stopped.
• Automatically populate a subform in the corresponding record module using workflows and Deluge functions.
• Leverage the Reports module to analyze work patterns, SLA adherence, and productivity trends.

 In Part I, we will focus on:

-> Building and configuring the Timer Widget.

-> Capturing each timed session as a record in a custom module.

Prerequisites

1. Create a Custom Module

Create a custom module named Timer Entries to log work details and generate reports from the Reports module. A new record will be added to this module each time a timer is started.

Set up the following custom fields in the Timer Entries module:

Custom Fields	Data Type
Start Time	DateTime
End Time	DateTime
Total Duration (in mins.)	Formula  DateBetween(${Timer Entries.Start Time},${Timer Entries.End Time},'Minutes')
Related to Case	Lookup to Cases module
Work Description	Multi Line

2. Add a custom picklist option

Add a custom picklist option called In Progress to the Status picklist field in the Cases module for precisely identifying the status of the cases. 

Follow this Add/Remove Picklist Values help section for more details. 

3. Setup Custom Views for Contextual Filtering

To streamline the widget experience and ensure users only see relevant records to associate while tracking time, set up two smart custom views—one in the Cases module and another in the Timer Entries module. 

Active Cases View (Cases Module)

Create a custom view in the Cases module to list only the active tickets the logged-in user is working on. Use the following criteria tips:

• Use the Status field to filter records with values like In Progress, On Hold, or Escalated.
• Use the Case Owner field to show records that are assigned only to the currently logged-in user.

This view powers the drop-down inside the widget where users select the case they want to start the timer for.

Active Timers View (Timer Entries Module)

Set up a second custom view in the Timer Entries module to track entries where the timer has been started but not yet stopped. These represent active timers. Use the following logic for criteria:

• The End Time field is empty (i.e., timer still running).
• Timer Entry owner field matches the logged-in user.

This view is used internally by the widget to detect if a timer is already running and update the same entry once the timer is stopped.

Follow the Managing List View help page and use the specifications shown in the following image.

Building the Timer Widget 

Step -1: Review Basics

Refer to our earlier Kaizen on CLI Installation, Creating a Widget Project, and Internal hosting of the same.

Step 2 - Develop the Widget

After initializing your widget project using CLI, implement the timer logic:

Fetching Active Cases

On page load, the populateRecordsDropdown function initiates a Get Records API call to the Cases module, using the Active Cases custom view ID. This fetches all active case records assigned to the logged-in user. 

These records are then listed in a dropdown, allowing users to quickly select the relevant case they are about to work on.

async function populateRecordsDropdown() {             const recordsDropdown = document.getElementById("moduleRecords");             recordsDropdown.innerHTML = "";              try {                 const recordsResponse = await ZOHO.CRM.API.getAllRecords({                     Entity: casesModule,                     cvid: casesCVID,                     per_page: 10                 });                 if (recordsResponse.data && recordsResponse.data.length > 0) {                     recordsResponse.data.forEach(record => {                         const option = document.createElement("option");                         option.value = record.id;                         option.textContent = record.Subject || "Unnamed Record";                          recordsDropdown.appendChild(option);                     });                 } else {                     const placeholderOption = document.createElement("option");                     placeholderOption.value = "";                     placeholderOption.textContent = "No records found";                     placeholderOption.disabled = true;                     placeholderOption.selected = true;                     recordsDropdown.appendChild(placeholderOption);                 }             } catch (error) {                 console.error("Error fetching records:", error);             }         }

Starting the Timer and Creating an Entry

Once the user starts the timer, The createRecord function triggers a Create Record API call to log the session in the Timer Entries custom module. The record captures the start time and the related case and description (if provided).

Even if no details are entered or case is selected, a timer entry is still created with the start time. This ensures that spontaneous work sessions are tracked and not lost.

async function createRecord(startTime) {             try {                 const workDescription = document.getElementById("workDescription").value;                 const selectedRecordId = document.getElementById("moduleRecords").value;                 const selectedRecordText = document.getElementById("moduleRecords").options[                     document.getElementById("moduleRecords").selectedIndex                 ].text;                 const data = {                     Start_Time: startTime,                     Owner: currentUserId,                     Work_Description: workDescription,                     Related_to_Case: selectedRecordId,                      Name: selectedRecordText                  };                 const response = await ZOHO.CRM.API.insertRecord({                     Entity: timerModule,                     APIData: data                 });                 console.log("Start time recorded successfully");             } catch (error) {                 console.error("Error creating record:", error);             }         }

Stopping the Timer and Updating the Entry

When the timer is stopped, the widget uses the Active Timer Entry custom view to locate the most recent Timer Entry record created by the logged-in user that does not have an end time. 

The updateRecord is then triggered to update that active entry using the Update Record API call. It updates the End time of the session and the related case, descriptions, if it was not already provided when the timer was started.

async function updateRecord(endTime) {             try {                 const workDescription = document.getElementById("workDescription").value;                 const selectedRecordId = document.getElementById("moduleRecords").value;                 const response = await ZOHO.CRM.API.getAllRecords({                     Entity: timerModule,                     cvid: timerEntriesCVID,                     per_page: 1                 });                 const latestRecord = response.data[0];                 if (latestRecord) {                     const recordId = latestRecord.id;                     const data = {                         id: recordId,                         End_Time: endTime,                         Work_Description: workDescription,                         Related_to_Case: selectedRecordId                      };                     await ZOHO.CRM.API.updateRecord({                         Entity: timerModule,                         APIData: data,                         RecordID: recordId                     });                     console.log("End time updated successfully");                 }             } catch (error) {                 console.error("Error updating record:", error);             }         }

Step 3 - Validate and Pack the Widget

• Follow the steps given in the Widget help page to validate and package the widget.
• Go to Zoho CRM > Setup > Developer Hub > Widgets and click Create New Widget.
• Fill in the required details as shown in this image and ensure to select Button as the widget type.
  

Step 4 - Associate it with Flyout

• Go to Setup > Developer Space > Client Script. Click New Script.
• Enter a name and description for the script. Choose Command type in Category. 

• Create a Flyout and render a widget within it using its details like the API name of the widget, title, size, and animation type. You can get the Widget API name from the widget's detail page. 

let allowedUserEmails = []; allowedUserEmails.push('user1_email_address'); allowedUserEmails.push('user2_email_address'); allowedUserEmails.push('user3_email_address'); let currentUserEmail = $Crm.user.email; if (allowedUserEmails.indexOf(currentUserEmail) == -1) {     ZDK.Client.showMessage('Command access resticted', { type: 'error' });     return false; } ZDK.Client.createFlyout('myFlyout', {header: 'Timer', animation_type: 4, height: '600px', width: '500px', top: '10px', left: '10px', bottom: '10px', right: '10px' }); ZDK.Client.getFlyout('myFlyout').open({ api_name: 'Timer', type: 'widget' }); return true;

Refer to Creating a Client Script help page for more details. 

Try It Out!

A complete working code sample of this widget is attached to this post.

Now, let us see how this Timer widget works:

1. Start the Timer 

Open the widget and select an active case from the dropdown. As soon as you start the timer, a new record will be automatically created in the Timer Entries module to capture the session.

2. Stop the Timer 

When the task is complete, provide a description of the work you have done and stop the timer. The same Timer Entry record (created when the timer was started) will be updated automatically with the end time and your work description.

This forms the foundation for accurate time tracking at the record level. 

In Part 2, we will show how to:

-> Use a workflow and Deluge function to transfer these entries into the Work Log subform inside the relevant Cases record.

-> Use CRM Reports to slice and dice work time for better SLA and productivity insights.

In the meantime, would you like us to address any of your pain-points or have a topic to discuss? Let us know in the comments or reach out to us via support@zohocrm.com.

Until next time, Happy Coding! 

-----------------------------------------------------------------------------------------------------------------

Related Reading

• Custom Fields - Working with Custom Fields and Working with Picklist Field
• Widget - An Overview, CLI Installation, Working with Widgets, JS SDKs, Mobile Compatibility of Widgets and Kaizens
• Core APIs - GET Records, POST Records and UPDATE Records
• Client Script - An Overview, Creating a Client Script, Best Practices and Troubleshooting

-----------------------------------------------------------------------------------------------------------------

Previous Kaizen: Client Script Support for Subforms | Kaizen Collection: Directory

• Topic Participants

• Kiruthiga G

  

• 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 FAQs

• Kaizen #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

• Recent Topics

• Adding additional fields for batch information

  Hello, I am looking at adding additional information into our inventory module. we would like to be able to see up to 8 attributes that will be individual & different for each batch (i.e. batch specific information) but currently I seem to only be able

• Dynamic Pickup List Values using Deluge and Client Script

  I would like to dynamically show Pickup List Values For example we need to fetch some data from an on premise application and display it so they can choose and pick This can be done in Creator but I didn't find anything for CRM

• Validation Rule for Controlled Stage Movement in Deals Module (Deluge Script)

  For keeping a control over module stage or status, you can use the below deluge script. The below deluge script defines validation control over deals module stages: // Function to validate allowed stage transitions in the Deals module map validation_rule.LeadStatustValidation1(String

• Pick List Issues

  I have created a pick list that looks at a table in a sheet, it selects the column I want fine. Various issues have come along. The option to sort the pick list is simplistic, only allows an ascending alphabetical sort. Bad luck if you want it descending.

• Four types of task dependencies

  "Nothing is particularly hard if you divide it into small jobs."                                                                                                                  - Henry Ford Projects, small or large, are driven by simple work units called tasks. Monitoring standalone tasks might look simple but as the workflow becomes elaborate, tasks may start relying on one another. In project management, this relationship between tasks is termed as "Task Dependencies". Dependency between tasks arise

• 1099 tracking

  Do zoho books offer feature of tracking for 1099's for contractors, etc? Quick books offers this feature and wondered when/if Zoho books will do same

• VAT-type Taxes in US Edition?

  I'm located in the US, and I use the Zoho One US edition of Books. We are in the process of registering with Canadian authorities for their GST / HST, which is a VAT-type of scheme. It is not immediately obvious to me how one would deal with input tax

• 2 users editing the same record - loose changes

  Hello, I'm very new to Zoho so apology if this has been addressed somewhere i can't find. I have noticed the following: If we have 2 users put an inventory item in edit mode at the same time: say user1 click on edit and user2 while user1 is still in edit,

• Schedule sms to be sent later

  When will you make available an option to send sms's at a later time??? You finaly have this option available on emails, so it will be very useful to have it also with sms. Our sms provider, has already this available but we cannot use it because you

• Ecommerce integration with prestashop

  Development of campaigns integration with prestahop. When???

• How to create an article containing images and rich text via the api?

  Hi, I'm trying to migrate our kb articles from our previous helpdesk service, and import them to ZohoDesk. Is there any way to create an article that contains images?  Is it possible to add formatting to articles created via the API? Thanks, Adam.

• Number of statement execution limit exceeded on deluge scheduled function

  I'm working on a send email functionality in creator that sends out crew work orders at the end of the day each day for the next day. I'm running into the issue that zoho is unable to handle the number of statements that I am doing to be able to successfully

• Color of Text Box Changes

  Sometimes I find the color of text boxes changed to a different color. This seems to happen when I reopen the same slide deck later. In the image that I am attaching, you see that the colors of the whole "virus," the "irology" part of "virology," and

• Zoho SignForm In Progress But Cannot Be Completed

  If a person starts signing a document (via SignForm), but closes the window before submitting, Zoho marks the document "in progress", but how do they finish signing it?

• How to show Assemblies AND component items in a report

  Hi Is there any way in Analytics to create a report that shows the Composite Item AND the Component Items with mapped quantity? It seems that the component item is not exposed in any table that I can find. Also, the same question but for Stock on Hand.....this

• Mandatory Messages for Specific Members in Zoho Cliq Channels

  Hello Zoho Cliq Team, We hope you're doing well. We would like to request a feature enhancement to Zoho Cliq that would allow marking certain messages in a channel as mandatory for specific members — with built-in tracking and reminders. 🎯 Use Case:

• Admin Access to Message Read Statistics in Zoho Cliq

  Hello Zoho Cliq Team, We hope you're doing well. We would like to request a feature enhancement that would allow admins or channel owners to view read/unread statistics for messages, even if they were not the original sender. 🎯 Use Case: Currently, in

• Online Member Visibility in Channels (Similar to WhatsApp Group Presence)

  Hello Zoho Cliq Team, We hope you're doing well. We’d like to request an enhancement to Zoho Cliq’s channel experience by introducing online presence indicators for channel members — similar to how WhatsApp shows how many people in a group are currently

• Show ticket field in Zoho Desk only if that same field is not empty (API‑created records)

  Zoho Team , We have a ticket workflow where every ticket is created via API based on dynamic logic from an external form. That form has complex logic and already decides what’s relevant to ask, and the API only populates fields in Zoho Desk based on that

• Multiple Products on Ticket

  Good morning. We will classify all tickets based on the product. Users sometimes send different requests on the same ticket, so we are facing some challenges. Is there a way to add more than one product to the ticket, or is there a way to tie the product

• Não recebo Email de confirmação e validação de cadastro do PagSeguro

  Olá, utilizei uma das minhas contas de email Zoho para criar um cadastro no PagSeguro, contigo o email com o link de confirmação da conta não chega no meu email Zoho (nem.ma caixa de spam, nem na lixeira, e nem em outras pastas). Outros emails do PagSeguro

• Does Thrive work with Zoho Billing (Subscriptions)?

  I would like to use Thrive with Zoho Billing Subscriptions but don't see a way to do so. Can someone point me in the right direction? Thank you

• accounts payable and receivable subaccounts

  How to create accounts payable and receivable subaccounts? Being that I have several clients and in my balance sheet have to specify the accounts of each client and not only appear "accounts receivable or accounts payable" ??

• DUPLICATING WORKFLOWS IN CREATOR

  Hi all, I want to duplicate and slightly amend 3 workflows in Creator so that I don't have to keep typing in all the rules and properties each time. I can see lots of videos on CRM with the 3 dots at the top of the workflow, but nothing like that in Creator.

• Add SKU to query options in `items` API endpoint

  It would be very useful to be able to pull items by SKU in the API as this is a commonly used unique ID that tends to be consistent across systems.

• Estimates and invoices being sent from company-wide address, rather than individual

  In our organization, team members send estimates and invoices through Zoho Books by using the "Send Email" function. However, for certain users, the system defaults to sending estimates and invoices from a shared organizational email address (e.g., company@example.com)

• Need profit margins for books in estimates & invoice

  https://help.zoho.com/portal/en/community/topic/show-my-cost-or-profit-while-creating-estimate

• Decimal places settings for exchange rates

  Hello, We are facing issues while matching vendor payments with banking feeds. As we often import products/services exchange rate comes into play. Currently, ZOHO allows only six digits for decimal places. We feel that conversions like JPY to INR require

• Item Level Notifications

  I need to create a custom workflow based on the creation of an estimate that has a SKU/Item name that matches certain criteria. I can have it generated based on a total amount, but not at the item level. Is this possible?

• Cannot categorize a bank deposit to an income sub-account

  When I go to categorize a bank deposit, I am not able to see any income sub-accounts. If I set up an income account without a parent, then I am able to categorize a transaction into that account, but as soon as I make it a child account, it disappears

• ZV Extension passkey changes in v5.7.0

  Has there any changes to the how passkeys are managed in ZV - Chrome extensions v5.7.0? Namely, if the passkeys were already implemented/enforced as 2FA on a certain webpage, but ZV does not track them yet. Would that be the issue for my use case?

• What's New in Zoho Billing - August 2025

  Hello everyone, We are excited to share the latest updates and enhancements made to Zoho Billing in August 2025 to improve your overall billing management experience. Keep reading to learn more. Notify Customers About Subscriptions via WhatsApp Business

• How do I get my account id?

  Hello, I followed the instructions to get a list of accounts of the currently authenticated user (which is me, and I am logged in). But when I follow the below instructions I get the following error: ERROR: {"data":{"errorCode":"INVALID_TICKET","moreInfo":"Invalid ticket"},"status":{"code":400,"description":"Invalid Input"}} Instructions that I am following: GET - User account details Purpose The API retrieves the list of accounts of the currently authenticated user.  Request URL  http://mail.zoho.com/api/accounts

• Why are tasks not showing in Zoho Calendar?

  Hi there, I updated the Zoho calendar preferences for Task records to show on the calendar together with Meetings and Calls - see attached screenshot. Despite of that, Task records still won't show on the calendar. Is there a specific reason why this

• Zoho Payroll: Product Updates - July 2025

  Over the past month, we've focused on making Zoho Payroll more flexible, compliant, and easier to use—whether you're processing complex payouts, ensuring accurate calculations, or meeting local tax regulations. Here's what's new: One-Time Payments and

• Discussion for “sub product”, “sub item” or “child products”

  Hello everyone, In some CRM systems, there is the ability to associate products in a hierarchical manner within a quote. For example: Product A: Gold Plan Product B: Setup Product C: Connector Product D: Silver Plan Product B: Setup Product C: Connector

• Retrieve Accidental Deleted User

  Is there a way to undelete a user who accidentally deleted themselves?

• Request for Support - CRM Integration Issues

  I’m reaching out to request assistance with the following items: 1. Zoho Forms Integration with Zoho CRM We are currently using Zoho Forms to send the Global Credit Application form to our customers. The intended workflow is for the form submissions to

• Knowledge Base Module

  How to enable the knowledge base module in zoho crm account. I saw this module in one crm account but unable to find it other zoho crm account. can anyone know about this?

• Zoho sign changed Indexing of signing_order

  Because I missed this Announcement (is there even one?): when you work with the indexes of actions > signing_order. Previous those started with 0 now starts with 1. Changed somewhere between 15.07 and 23.07

• Next Page