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

• Approval Process Comments

  Is it possible to view the comments entered during the approval or rejection of a record in the approval process? If not, is there a way to require a field to be completed upon approval or rejection?

• Login for test case

  Had a few questions regarding authentication test cases and couldn't find an answer in the the docs. 1. If an app like Zoho Creator requires authentication before providing access, do I need to create a login function and add it to each test case? 2.

• Zoho / Outlook Calendar sync

  The current Marketplace -> Microsoft -> Meetings integration needs 2 changes. 1. The current language for the Two-Way sync option should be changed. It currently states, "Sync both your Zoho CRM Calendar and Office 365 Calendar meetings with each other."

• Customer members area

  Does FSM support a customer members area? If not what do you propose we use if we want the data used in FSM for customers to give them an area / login to see past orders, create new orders and general announcements.

• Zoho Books-Accounting on the Go Series!

  Dear users, Continuing in the spirit of our 'Function Fridays' series, where we've been sharing custom function scripts to automate your back office operations, we're thrilled to introduce our latest initiative – the 'Zoho Books-Accounting on the Go Series'.

• Desktop app doesn't support notecards created on Android

  Hi, Does anybody have same problem? Some of last notecards created on Android app (v. 6.6) doesn't show in desktop app (v. 3.5.5). I see these note cards but whith they appear with exclamation mark in yellow triangle (see screenshot) and when I try to

• Notes created in mobile can no longer be accessed in desktop

  Working with a 2013 Mac running OS 10.14.6; Desktop Notebook version 4.5.3. Using Motorola Moto G Power 5G - 2024; Android app version 6.7 I have been using Notebook for some years. Starting several weeks ago, the notes newly created ion the phone can

• Function #49: Manage varying installment payments using Zoho Books

  . Hello everyone, and welcome back to our series! Last week, we discussed automating the collection of fixed installment payments in Zoho Books. But what if your payment structure involves charging varying percentages of the invoice total as installments?

• Zoho Writer - Option to Export as .zdoc format

  I've noticed that it's not possible to export a Zoho Writer Document in the .zdoc format. Isn't zdoc, Zoho Writer's own format? My use case is that I sometimes need to create quite complex documents with floating elements, which sometimes need to become

• Is it possible for contacts to "Re-enter" a workflow in Zoho Campaign?

  We are currently working on a way to automatically add users to from one list to other lists based on specific criteria, but can't seem to find a native way of doing this so we are trying to use Workflows to do this. So, for example, if a user's status is set to "Active," then they should be added to the list "Active Users." If the same user's status is then set to "Paused," they should be added to the list "Paused Users" and removed from the list "Active Users." This works fine for the first go

• Bulk upload images and specifications to products

  Hi, Many users have asked this over the years and I am also asking the same. Is there any way in which we can bulk upload product (variant) images and product specifications. The current way to upload/select image for every variant is too cumbersome.

• Out of Office for Just One of My Alias Email

  Can I set up the Out of Office Reply for Just One of my Alias Email Addresses?

• Can I map multiple Surveys into the CRM using the same fields?

  Hello, We are a healthcare practice that offers two distinct services (Nutrition and Primary Care). We use Zoho Survey for our lead generation form (Get Started Survey), which allows people to express interest in one of the two services and even allows

• Dealing with API responses where integers have more than 16 digits

  Hi there How do I deal with an api response contaning an int or float with more than 16 digits (before any decimal places for a float). I constantly receive the response "Unable to cast the 'BigInteger' value into a 'BIGINT' value because the input is

• Can't change form's original name in URL

  Hi all, I have been duplicating + editing forms for jobs regarding the same department to maintain formatting + styling. The issue I've not run into is because I've duplicated it from an existing form, the URL doesn't seem to want to update with the new

• Need Inactive accounts to be visible in Reports in Zoho Books

  I N=need Inactive accounts to be visible in Reports in Zoho Books to do recons of the accounts but when i see the same they are not visible in the Accountant - Account Transactions report

• unblock e-mail

  please unblock my e-mails info@meatnews.gr and myrtokaterini@meatnews.gr

• Add Zoho Mail for users who do not need Zoho One

  We have licenses for ZOho One for teams that need to use the suite of products that Zoho One offers.  We have 8 more people who only need email access and we would like to add just a Zoho Mail.  They do not need the Zoho One license.  We are currently

• ZML vs HTML Snippet - which is better?

  Are there certain use cases where one is better than the other?

• Auto CheckOut Based On Shift.

  This Deluge script runs on a scheduled basis to automatically set the 'Actual_Check_Out' time for employees who haven't manually checked out. If the current time is past their scheduled 'Shift_End_Time', the script updates the check-out time to match

• How to remove some users in zoho accounts

  How to remove some users in Zoho accounts.

• Infinite loop of account verification

  Hi I can't do anything on my zoho account.  I always get this message Hi Sheriffo Ceesay As a security measure, you need to link your phone number with this account and verify it to proceed further. When ever I supply the details, it displays that the number is associated with another account. I don't have any other account on zoho so this is really annoying. 

• Load PO_Date field (Purchase Order) with current date in Deluge

  Hi, I'm not a full time developer, just helping to customize our CRM, in the small company I work for. There must be something wrong with me, because I can't do something so simple as complete a field with the current date in a function using Deluge.

• Zoho CRM in Microsoft Power Automate Custom Connector

  Hi everyone, I’m building a Power Automate flow that integrates Microsoft Bookings with Zoho CRM. The goal is to automatically create a meeting (event) in Zoho CRM whenever a new appointment is booked via Microsoft Bookings. To achieve this, I created

• Spell check sucks

  Come on guys, it's 2024 and your spell check is completely retarded. You gotta fix it.

• How to include total km for multiple trips in expense report.

  Whenever I create a mileage report it only shows the total dollar amount to be reimbursed. The mileage for each individual trip is included but I also need to see the total distance for all trips in a report? How do I do this?

• Outgoing blocked: Unusual activity detected.

  I just made payment for my Zohomail Today and have been debited so i will like to be Unblocked because this is what it says (Outgoing blocked: Unusual activity detected) Thank you i await your swift responses

• Zoho One Login Issue - Unable to receive OTP

  Hi Support Team, I am experiencing a unique login issue with Zoho One. I am attempting to log in from India using Zoho Login credentials provided by a USA-based client. Their Zoho account is hosted on a US data center. After entering the username and

• Question Regarding Managing Sale Items in Zoho Books

  Good day, I was wondering about something. Right now, Zoho Books doesn’t seem to have a way to flag certain items as being on sale. For example, if I want a list of specific items to be on sale from October 1 to October 12, the user would have to export

• In the Zoho Creator Customer Payment form i Have customer field on select of the field Data want to fetch from the invoice from based on the customer name In the Customer Payment form i Have subf

  In the Zoho Creator Customer Payment form i Have customer field on select of the field Data want to fetch from the invoice from based on the customer name In the Customer Payment form i Have subform update Invoice , there i have date field,Invoice number

• Problem of Import Client Users From CRM and or Expense

  I am premium plan user on Projects. I have about 500 customers on Expense and CRM that integrated with each other. According to at below link, I am trying to import clients from CRM, system not allowed to select any customer. If I import from Expense,

• Unable to see free plan option

  Hello Zoho Support Team, I hope you are doing well. I am trying to sign up for Zoho Mail, but I am unable to see the option for the free plan. Could you please guide me on how I can access or activate the free plan? Thank you for your assistance.

• unblock my zoho mail account. outlines@zoho.com

  please unblock my zoho mail account, outlines@zoho.com

• domain not verified error

  Hi when i try to upload a video from zoho creator widget to zoho work drive iam getting domain not verified error.I don't know what to do .In zoho api console this is my home page url https://creatorapp.zoho.com/ and this is my redirect url:www.google.com.Iam

• equest to Disassociate Bigin from Zoho One and Migrate to Standalone (Upgrade to Bigin Premier – 3 Seats, Annual)

  Dear Zoho One Support Team, I’m writing to request your assistance to disassociate (remove) the Bigin application from our Zoho One organization while preserving all existing Bigin data. After the disconnection is successfully completed, we intend to

• SMTP email sending problem

  Hello, I've sent emails before, but you haven't responded. Please respond. My work is being disrupted. I can't send emails via SMTP. Initially, there were no problems, but now I'm constantly receiving 550 bounce errors. I can't use the service I paid

• billing

  hi, I am being billed $12/year, and I can't remember why. My User ID is 691273115 Thanks for your help, --Kitty Pearl

• How to add receipts

  How to add receipts

• Unable to enable tax checkboxes

  Hi Zoho Commerce Support, I'm writing to report an issue I'm having with the tax settings in my Zoho Commerce store. I've created several tax rates under Settings > Taxes, but all of them appear with the checkbox disabled. When I try to enable a checkbox,

• Zoho Commerce - Enable Company Name and Tax Number collection for B2B orders in Global Edition

  Please enable Company Name and Tax Details option on checkout settings in Zoho Commerce Global Edition. It is still important to collect Company Name and Tax Number for B2B sales in many countries. My business is based in Ireland (in the EU) and I have

• Next Page