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
Access your files securely from anywhere
New to Zoho Recruit?
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
Kiruthiga G
Piyush Goyal
Sticky Posts
Kaizen #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 achievedKaizen #142: How to Navigate to Another Page in Zoho CRM using Client Script
Hello everyone! Welcome back to another exciting Kaizen post. In this post, let us see how you can you navigate to different Pages using Client Script. In this Kaizen post, Need to Navigate to different Pages Client Script ZDKs related to navigation A.Kaizen #210 - Answering your Questions | Event Management System using ZDK CLI
Hello Everyone, Welcome back to yet another post in the Kaizen Series! As you already may know, for the Kaizen #200 milestone, we asked for your feedback and many of you suggested topics for us to discuss. We have been writing on these topics over theKaizen #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.
New to Zoho TeamInbox?
Zoho TeamInbox Resources
Zoho CRM Plus Resources
Zoho Books Resources
Zoho Subscriptions Resources
Zoho Projects Resources
Zoho Sprints Resources
Qntrl Resources
Zoho Creator 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セミナー
その他のサービス コンテンツ
Nederlandse Hulpbronnen
ご検討中の方
Recent Topics
Creating my 2nd email account
After creating my first email address, I decided to get another email address. I would like to use this new address as the primary address too. I don't know how to set it up there doesn't seem to be an option for thatCannot - create more email account - Unusual activity detected from this IP. Please try again after some time
Hello, I come across the error message in Control Panel. Unusual activity detected from this IP. Please try again after some time and i cannot create any more users We are an IT company and we provide service for another company Please unlock us."Unable to send message;Reason:553 Relaying disallowed. Invalid Domain"
Good day. When I try to send mail through ZOHO mail I get the following error : "Unable to send message;Reason:553 Relaying disallowed. Invalid Domain" I need help with this. My zohomail is : @eclipseweb.site Thank you,Transfert de domaine pour création des comptes emails
Bonjour , je ne parviens point à créer des mails avec le domaine 'raeses.org' suite à la souscription du domaine auprès d'un autre hébergeur, dont j'ai fait la demande du code de transfert qui est le suivant : J2[U8-l0]p8[ En somme, attente de l'activationHelp! Unable to send message;Reason:554 5.1.8 Email Outgoing Blocked.
Kindly help me resolved this issue that i am facing here.How are people handling estimates with Zoho inventory?
We are often using Zoho Books for estimates that then get converted to invoices within Books. We would like the sales team to migrate entirely to Zoho Inventory and no longer need to use Zoho Books so that they are only on one system. How are people managingRelative Date Searches
Currently in the search options, it has "date", "from date" and "to date". I think it would be great if there were options like "date greater than x days ago" and "date less than x days ago". I realise that as a once off you can just use the existingPerformance is degrading
We have used Mail and Cliq for about three years now. I used to use both on the browser. Both have, over the past 6 months, had a severe degradation in performance. I switched to desktop email, which appeared to improve things somewhat, although initialAsk the Experts 23: Customize, utilize, and personalize with Zoho Desk
Hello everyone! It's time for the next round of Ask the Experts (ATE). This month is all about giving Zoho Desk a complete makeover and making it truly yours. Rebrand Zoho Desk with your organization’s details, customize ticket settings based on yourDear Zoho CEO: Business Growth is about how you prioritise!
All of us in business know that when you get your priorities right, your business grows. Zoho CRM and Zoho Books are excellent products, but sadly, Zoho Inventory continues to lag behind. Just this morning, I received yet another one-sided email aboutPlease review and re-enable outgoing emails for my domain
Hello Zoho Support, I have recently purchased a new domain and set up email hosting with Zoho. However, my account shows "Outgoing Email Blocked". I am a genuine user and not sending bulk/spam emails. Please review and re-enable outgoing emails for myPayroll without tax integrations (i.e. payroll for international)
It seems as though Zoho waits to develop integrations with local tax authorities before offering Zoho Payroll to Zoho customers in a country. Please reconsider this approach. We are happy Zoho Books customers, but unhappy that we have to run payroll ingoingout e mail block
info@ozanrade.com.trIncoming mails blocked
Zoho User ID : 60005368884 My mail Id is marketing#axisformingtechnology.com .I am getting following message "Your Incoming has been blocked and the emails will not be fetched in your Zoho account and POP Accounts. Click here to get unblocked." PleaseConfiguring Email Notifications with Tautulli for Plex
Hi I'm new to Zoho. I am from Canada and I have a I use a web based application called Tautulli for Plex that monitors my Plex media server. It also sends a newsletter to my followers. To set this up they require a "From" email address., a smtp serverHow to Set Up Zoho Mail Without Cloudflare on My Website
I'm having some trouble with Cloudflare here in Pakistan. I want to configure Zoho Mail for my domain, but I'm not sure how to set it up without going through Cloudflare. My website, https://getcrunchyrollapk.com/ , is currently using CF, but I'd likeSpam is Being Forwarded
I am filtering a certain sender directly to the Trash folder. Those messages are still being forwarded. Is this supposed to happen?IMAP Block
My two accounts have been blocked and I am not able to unblocked them myself. Please respond to email, I am traveling and this is urgent."DKIM not configured"
Hello. I have been attempting get the DKIM verified but Toolkit keeps sending the message that it is not configured, but both Namecheap and Zoho show it as configured properly. What am I missing?Zoho mail with custom domain not receiving email
i registered zoho mail with my own domain. I can login and access the mail app. I tried to send email from an outlook email account and an icloud email account. Both emails were not received. My plan is free. I also tried to send email from this zohoSet connection link name from variable in invokeurl
Hi, guys. How to set in parameter "connection" a variable, instead of a string. connectionLinkName = manager.get('connectionLinkName').toString(); response = invokeurl [ url :"https://www.googleapis.com/calendar/v3/freeBusy" type :POST parameters:requestParams.toString()Waterfall Chart
Hello, I would like to create a waterfall chart on Zoho analytics which shows the movement in changes of budget throughout a few months, on a weekly basis. Should look something like the picture below. Does anyone know how to?Issue with Importing Notes against Leads
Hi, I am attempting to import some Notes into Zoho CRM which need to be assigned to various Leads. I have created a csv file which I am testing that contains just one record. This csv file contains the following columns: Note Id Parent Id (I haveTrigger a Workflow Function if an Attachment (Related List) has been added
Hello, I have a Case Module with a related list which is Attachment. I want to trigger a workflow if I added an attachment. I've seen some topics about this in zoho community that was posted few months ago and based on the answers, there is no triggerOption to Hide Project Overview for Client Profiles
In Zoho Projects, the Project Overview section is currently visible to client profiles by default. While user profiles already have the option to restrict or hide access to the project overview, the same flexibility isn’t available for client profiles.Creator Add Records through API - Workflows not triggered ?
Hi Everyone, I am trying to add records to my Creator application through a third party app that I am developing. Currently, I am testing this through Postman. The records I need to add have a lot of workflows to run to populate dropdowns, fields, useImportant Update: Changes to Google Translate Support in Zoho SalesIQ
We’re updating our default chat translation options across all Zoho SalesIQ data centres to offer a more secure, in-house solution for your translation needs. What’s changing? We will be offering Zoho Translate (our in-house tool) as the default translationZoho CRM Community Digest - July P1 | 2025
Hey everyone, The start of July 2025 marked a special milestone: 200 posts in our Kaizen series! For those new here, Kaizen is a go-to series for Zoho CRM developers, where we regularly share best practices, tips, and expert insights to help you buildWhat’s New in Zoho Expense (April – July 2025)
Hello users, We're happy to bring you the latest updates and enhancements we've made to Zoho Expense over the past three months, which include introducing the Trip Expense Summary report in Analytics, extending Chatbot support to more editions, rollingWeekly Tips: Insert frequently used phrases in a jiffy using Hotkeys
You often find yourself using similar phrases in an email —like confirming appointments or providing standard information. Constantly switching between the mouse and keyboard interrupts your flow and slows you down.Instead of typing the same phrases overUndo Command in Notebook
It would be handy to have an Undo in the row of icons at the bottom of the notes.Narrative 9: GC—Meaningful conversations that benefit your customers
Behind the scenes of a successful ticketing system - BTS Series Narrative 9: GC—Meaningful conversations that benefit your customers Customers often seek immediate solutions, which is why self-service options are essential. Guided Conversations providesFSM App Oddity
We recently rolled out FSM to our technicians, and only one technician is having an issue. He's using an iPhone with iOS 18.6 installed. When he goes to service appointments using the calendar icon at the bottom of the app, he gets a list view only. Typically,Cliq Not Working !
Zoho Cliq has been experiencing connectivity issues since this morning. The app is unable to establish a connection with the server.Injecting CSS into ZML pages
Is there a way to inject CSS into ZML pages? Use case: 1. Dashboard displays 'Recent Activities' card displaying a list of newly added records 2. Each item in list links to the record onClick 3. When a user points the cursor over an item in the list,Power of Automation :: Automated Weekly Notifications for Unapproved Timesheets
Hello Everyone, A custom function is a software code that can be used to automate a process and this allows you to automate a notification, call a webhook, or perform logic immediately after a workflow rule is triggered. This feature helps to automateExtracting Data from Sitelink APIs
Hi All, I'm working to pull data on Sitelink using API calls but i can't seem to extract it. If you click expand, you will see it has a lot of data in it. I tried extracting from the map but it's not giving me anything. Is there a workaround on this orExport a list of fields for all modules in a spreadsheet with specific field data
Many of my clients are using spreadsheets to create lists of fields for all modules when starting a new implementation or when updating an existing setup. This is a useful process but also a very time consuming one. It would be good a list of fields could[Important announcement] Zoho Writer will mandate DKIM configuration for automation users
Hi all, Effective Dec. 31, 2024, configuring DKIM for From addresses will be mandatory to send emails via Zoho Writer. DKIM configuration allows recipient email servers to identify your emails as valid and not spam. Emails sent from domains without DKIM【Zoho Backstage】2025年7月のアップデート紹介
本投稿は、本社のZoho Desk コミュニティに投稿された以下の記事を翻訳し、一部抜粋したものです。 What's New - July 2025 | Zoho Backstage ユーザーの皆さま、こんにちは。コミュニティチームの中野です。 本投稿では、Zoho Backstage の直近のアップデートを3点抜粋して、ご紹介します。 目次 1.参加可否の確認：RSVP 2.証明書作成ツール：Certificate Builder 3.登録の承認 ：Registration Approval 1.参加可否の確認：RSVPNext Page