Kaizen #166 - Handling Query Variables in Zoho CRM

Hello, Code Enthusiasts! 

Welcome to another week of Kaizen!

This week, we'll dive into handling variables in Zoho CRM Queries and see how they can be deployed in Kiosk to dynamically retrieve data. This technique is especially useful for integrating data from third-party applications or CRM itself into your custom interface, such as Canvas and Kiosk. 

Variables

Variables are placeholders in Queries that are replaced with real values at runtime. Instead of hard coding data, you can use variables to make your Queries flexible and reusable.

Syntax: {{Variable_Name}}

Query variables in Zoho CRM function differently from conventional Zoho CRM variables. While CRM variables act as containers for dynamic values that can be stored and reused anywhere within the organization, query variables are designed to receive their values at runtime.

Query variables enhance flexibility and are specifically used in:

• COQL: To dynamically filter and retrieve data.
• REST API: For runtime data fetching based on specific parameters.
• Query Criteria: To define conditions dynamically for fetching records.
  

How to Use a Variable?

To use variables, ensure the fields providing the variable values are available in the context where the Query is executed.

Let’s say you want to evaluate a marketing campaign's performance. For this, you need to fetch all leads with a specific lead source. Since each campaign is associated with a different lead source, you can define the lead source as a variable. When viewing a campaign's details, the lead source will be passed dynamically to the Query.

Business Scenario : Nearby Delivery Hubs

Imagine a telecommerce platform using Zoho CRM to manage sales and deliveries. When a customer provides their PIN code, the salesperson must confirm with the customer for a nearby post office for package pick-ups and drop-offs in Kiosk.

With Zoho CRM Queries, you can achieve this by dynamically fetching the nearby post offices list based on the customer's PIN code and displaying it on the Contact record’s detail page. Here's how to set it up using the Kiosk feature.

Setting Up the Query in Kiosk

1. Access Kiosk Studio

• Log in to Zoho CRM.
• Go to Setup > Customization > Kiosk Studio and click Create Kiosk.
  

2. Configure the Current Module

• Choose the module where the Kiosk will be deployed.
  For this example, select Contacts to use the PIN code from the Contact record.
  
  
• Configuring this Current Module is mandatory to use variables from the current record. 
  

3. Add a Screen

• Click the + icon on the flowchart and select Screen.
• Name the screen and click Add.
  
  

4. Add a Query

• Under Display Elements, choose Get Data Via Queries.
• Click New Query and then Add Query to create a new one.
  

5. Set Up the Data Source

• Any custom source has to be enrolled either in the Trusted Domains or in the Connections. For demo, 
• Add the base URL https://api.postalpincode.in/pincode to Trusted Domain.
  
• Skip Connections as the Postal PIN Code API is an open source.
• In the Add Query pop-up, click Source and create a new source.
  For this demo, we’ll add India Post to fetch post offices based on PIN codes.
  
• Add default Headers and Parameters to the source if any. This will be added by default whenever the source is used in a query. 
  

6. Define the Query

• In the Information section, provide the query’s Name and API Name to refer to the query wherever needed.
• Use the endpoint URL with a variable, e.g., https://api.example.com/post_offices/{{Mailing_Zip}}.
• You can add headers and parameters specific to the query, but let us skip that for the demo. 
• Add a JavaScript serializer to process the Query response. For our case, we will serialize the response with return result[0].PostOffice;. 
  
• You can test your serializer with the help of Preview. Once finished, provide a test value to the variable for generating Schema for the Query Response.
  The test value you provide is temporary and not permanent. The value of a variable will be declared using merge fields when you associate the query with a component. Check Step 7 to know how it is used in our demo. 
  
  You can also manipulate the response by changing data types of keys in the raw response. To keep the demo simple, let's go with the raw response. 
  

7. Link the Query to Kiosk

• Use Dynamic Parameters to map the variable to the Mailing Zip field from the Contact record. Enter # to merge the fields. 
• In Choose Fields, select which data to display in the Kiosk.
  
• You can further manipulate the query response in the Record Preferences section.
  Select your preference to view the response as a Single Record or Multiple Records.
• For Single Record, choose the data that has to be displayed from the query response and click Save.
• For Multiple Records, fill in the following details as shown in this image. 

• The Selection Limit helps you with the maximum number of records that have to be chosen in the kiosk after publishing. 
• Identifier field functions as the primary field to identify each record. 
• In the fields section, choose the data that has to be displayed from the query response.
  

Customize the Kiosk button and click Done to save your configuration.

8. Test and Publish

Test the Kiosk using a sample Record ID from the Contacts module. If successful, the list of nearby post offices will display in an iframe as it would appear on the Contact detail page.

Once satisfied, publish the Kiosk to make it live. 

Let us check the Kiosk from the Contacts detail page. 

Example Scenarios

• Loan Approval: You can display a customer's CIBIL score using their Social Security Number (SSN) directly within a Canvas. The SSN serves as a runtime variable, allowing you to approve loans without manual data entry and shifting tabs.
• Customer Support: In a Records Detail View kiosk, display all high priority tickets linked to an account. The current account's ID acts as a runtime variable, ensuring that support agents have immediate access to relevant queries and resolve issues faster.
• Insurance Verification: In a Records Detail View kiosk, the customer's ID proof number can be used to verify their details on official government sites. The ID proof number dynamically functions as a variable, streamlining the insurance verification process.
  

We hope you found this post informative and beneficial.

If you have any queries or a topic to be discussed, reach out to us at support@zohocrm.com or drop your comments below. 

Cheers!

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

Previous Kaizen: Kaizen #165 - How to call Zoho CRM APIs using Client Script | Kaizen Collection: Directory

• Topic Participants

• Kiruthiga G

  

• Piyush Goyal

• 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

• Function #9: Copy attachments of Sales Order to Purchase Order on conversion

  This week, we have written a custom function that automatically copies the attachments uploaded for a sales order to the corresponding purchase order after you convert it. Here's how to configure it in your Zoho Books organization. Custom Function: Hit

• Free webinar: Security that works: Building resilience for the AI-powered workforce

  Hello there, Did you know that more than 51% of organizations worldwide have experienced one or more security breaches, each costing over $1 million in losses or incident response? In today’s threat landscape, simply playing defense is no longer enough.

• "Subject" or "Narration"in Customer Statement

  Dear Sir, While creating invoice, we are giving in "Subject" the purpose of invoice. For Example - "GST for the month of Aug 23", IT return FY 22-23", "Consultancy", Internal Audit for May 23". But this subject is not coming in Customer Statement. Only

• Apply Vendor Credit Automatically

  Hello!!! Is there a way where in we can apply vendor credits automatically on the FIRST OUTSTANDING BILL of the vendor?? We have lots of VENDOR CREDITS ISSUES mostly!!! Applying it manually is a pain for us. Would be great if we have a way to apply the

• Zoho Notebook Sync problem

  I'm facing a problem with syncing of notebook on android app. It's not syncing. Sometimes it syncs after a day or two.  I created some notes on web notebook but it's not syncing on mobile app. Please help!!!!

• Apply Vendor Credits Automatically

  We are bulk importing Vendor credits in Zoho Books!!! Is there a way to apply vendor credits automatically to the first UNPAID bill of the Vendor?

• Cant Save Gauge on Creator Page

  How to Save Gauge on Creator Page see movie https://vimeo.com/1116410860?share=copy#t=0

• Apply Advance option not shown in report

  We are facing an issue in Zoho Expenses. While approving an Expense Report, the "Apply Advance" option is not appearing under the three dots (More Options). Details: Module: Expense Reports Issue: "Apply Advance" option not visible Status of Report: Awaiting

• Auto Capitalize First Letter of Words

  Hi I am completely new to ZOHO and am trying to build a database. How can i make it when a address is entered into a form field like this: main st it automatically changes is to show: Main St Thank You

• Follow-up emails via Workflow Automation not staying in the same thread

  Dear Zoho Support Team, I am currently using Workflow Automation in Zoho Campaigns to send follow-up emails. In my test case, I noticed the following behavior: All emails in the automation have the same subject line. If the follow-up email is sent within

• Client Script refuses to set an initial value in Subform field

  I tried a very simple, 1 line client script to set a default value in a custom subform field when the "Add Row" button is clicked and the user is entering data. It does not work - can someone tell me why? ZDK documentation suggests this should be doable.

• Emails Are Not Being Delivered to My Inbox

  Hello Zoho Support Team, I am experiencing an issue with my Zoho Mail account. The most important problem is that emails are not being delivered to my inbox. Details: My Zoho Mail address: info@coreforcelife.com What happens: I am not receiving any incoming

• Help Center IFrame Issue

  I have had a working Help Center on my website using an iframe for a while. But now for some reason the sign in page gets a refused to connect error. Can someone please help. If I go to the url manually it works correclty

• Comment Templates

  Is it possible to add a template option for comments? We have some agents in the process who's responses require a pre-formatted layout. It would be incredibly handy to have a template for them where they can insert the template and then add their responses

• [ZohoDesk] Improve Status View with a new editeble kanban view

  A kanban view with more information about the ticket and the contact who created the ticket would be valueble. I would like to edit the fields with the ones i like to see at one glance. Like in CRM where you can edit the canvas view, i would like to edit

• Adding Markdown text using Zoho Desk API into the Knowledge Base

  Hi Zoho Community members, We currently maintain the documentation of out company in its website. This documentation is written in markdown text format and we would like to add it in Zoho Knowledge Base. Do you know if there is REST API functionality

• An Exclusive Session for Zoho Desk Users: AI in Zoho Desk

  A Zoho Community Learning Initiative Hello everyone! This is an announcement for Zoho Desk users and anyone exploring Zoho Desk. With every nook and corner buzzing, "AI's here, AI's there," it's the right time for us to take a closer look at how the AI

• Shared values: From classroom lessons to teaching moments in customer service

  While the world observes Teachers’ Day on October 5, in India, we celebrate a month earlier, on September 5, to mark the birth anniversary of Dr. Sarvepalli Radhakrishnan, a great teacher, renowned scholar, educationist, and advocate for empowerment.

• Create a list of customers who participated in specific Zoho Backstage events and send them an email via Zoho CRM

  How to create a list of customers who participated in specific Zoho Backstage events and send them an email via Zoho CRM? I was able to do a view in CRM based on customer that registered to an event, but I don't seems to be able to include the filter

• Zoho Desk blank page

  1. Click Access zoho desk on https://www.zoho.com/desk/ 2. It redirects to https://desk.zoho.com/agent?action=CreatePortal and the page is blank. Edge browser Version 131.0.2903.112 (Official build) (arm64) on MacOS

• I hate the new user UI with the bar on the left

  How can I reverse this?

• Question regarding import of previous deals...

  Good afternoon, I'm working on importing some older deal records from an external sheet into the CRM; however, when I manually click "Add New Deal" and enter the pertinent information, the deal isn't appearing when I look at the "Deals" bar on the account's

• Client Script also planned for Zoho Desk?

  Hello there, I modified something in Zoho CRM the other day and was amazed at the possibilities offered by the "Client Script" feature in conjunction with the ZDK. You can lock any fields on the screen, edit them, you can react to various events (field

• One person/cell phone to manage multiple accounts

  Hi. I have a personal Free account to keep my own domain/emails. Now I need to create a Business account to my company's own domain, but I have only one mobile phone number I use to everything. How do I do to manage this? Can I manage a Free domain and

• Tracking KPIs, Goals etc in People

  How are Zoho People users tracking employee targets in People? For example, my marketing assistant has a target of "Collect 10 new customer testimonials every month". I want to record attainment for this target on a monthly basis, then add it to their

• Zoho Desk: Ticket Owner Agents vs Teams

  Hi Zoho, We would like to explore the possibility of hiding the ‘Agents’ section within the Ticket Owner dropdown, so that we can fully utilise the ‘Teams’ dropdown when assigning tickets. This request comes from the fact that only certain agents and

• Can not Use Attachment Button on Android Widget

  this always pops up when I touch the attach button on android widget. going to settings, there is no storage permission to be enabled. if I open the app, and access the attach feature there, I can access my storage and upload normally.

• Announcing new features in Trident for Mac (1.24.0)

  Hello everyone! Trident for macOS (v.1.24.0) is here with interesting features and thoughtful enhancements to redefine the way you plan and manage your calendar events. Here's a quick look at what's new. Create calendar events from emails. In addition

• Vendor Master Enhancements for Faster Purchase Entry

  I’d like to suggest a few features that will improve accuracy and speed during purchase voucher entry: Automated Item Tax Preference in Vendor Master Add an option to define item tax preference in the vendor master. Once set, this preference should automatically

• Mass Mail Statistics - Number of unsent emails

  How do I find out which emails were not sent?

• Est-il possible d'annuler l'envoi d'un mail automatique ?

  Bonjour, Lorsque je refuse un candidat, il reçois un mail dans les 24h pour l'informer que sa candidature n'est pas retenue. J'ai rejeté un candidat par erreur. Savez-vous s'il possible d'annuler l'envoi de ce mail ? Merci d'avance pour votre aide.

• embed a form in an email

  Hello, how to embed a form in an email that populates Zoho CRM cases? I would like to send emails to a selected audience offering something. In the same email the recipients - if interested - instead of replying to can fill in a Zoho CRM form that creates

• Zoho Bookings - Reserve with Google

  Does Zoho Bookings plan to to integrate with Reserve with Google?

• How to add Zoho demo site page designs to my Zoho Sites website

  Hi, I would like to add the design from the following demo URLs into my current Zoho website. I have already created two new pages on my site, named “Menu2” and “Menu3.” For the “Menu2” page, I want to use the design from this demo: https://naturestjuice-demo.zohosites.com/menu

• Digest Août - Un résumé de ce qui s'est passé le mois dernier sur Community

  Bonjour chère communauté ! Voici le résumé tant attendu de tout ce qui a marqué Zoho le mois dernier : contenus utiles, échanges inspirants et moments forts. 🎉 Découvrez Zoho Backstage 3.0 : une version repensée pour offrir encore plus de flexibilité,

• Global Sets for Multi-Select pick lists

  When is this feature coming to Zoho CRM? It would be very useful now we have got used to having it for the normal pick lists.

• Text snippet

  There is a nice feature in Zoho Desk called Text Snippet. It allows you to insert a bit of text anywhere in a reply that you are typing. That would be nice to have that option in Zoho CRM as well when we compose an email. Moderation Update: We agree that

• Kaizen #206 - Answering your Questions | Displaying Related Purchase Orders from Zoho Books in CRM Deals using Queries

  Hello everyone! We're back with another post in the Kaizen series. We're grateful for the feedback we received from all of you! One of the questions we received was "I would like to see the list of Purchase Orders in Zoho Books for a Deal in CRM." We

• Add Analytics function for Title case (capitalising each word in a string)

  At present, you can only capitalise each word in a string in Analytics during data import. It would be really useful to be able to do this with a formula column, but there is no Title Case function.

• How to conditionally embed an own internal widget with parameters in an html snippet?

  Hello everyone, I'm trying to create a dynamic view in a page using an HTML snippet. The goal is to display different content based on a URL parameter (input.step). I have successfully managed to conditionally display different forms using the following

• Next Page