Kaizen #21 - Functions in Zoho CRM
Hello everyone!
Welcome back to another week in the Kaizen series!
What will you learn from this post?
- What are Functions in Zoho CRM?
- Creating a function
- Choosing a function category
- Function body
- Integration Tasks
- Triggering Functions
- From Zoho CRM functionalities
- From third-party applications
- Limits of Functions
1. What are Functions in Zoho CRM?
- Functions help you accomplish the tasks that are not available by default in Zoho CRM.
- You must write custom functions using DELUGE [Data Enriched Language for the Universal Grid Environment]—An online scripting language.
- Using custom functions, you can automate actions within Zoho CRM, across Zoho products, or between Zoho CRM and any other third-party application.
Note:
Functions are supported only in the enterprise and ultimate editions.
2. Creating a function
To create a function:
Step 1: Go to Setup > Developer Space > Functions
Step 2: Click +New Function
Step 3: Enter details like the Function Name, Display Name, Description, and choose the function category.
2a. Choosing a function category
Functions can fall under five categories:
- Button: The function gets executed when the user clicks the custom button.
- Automation: The function gets executed based on workflow rules.
- Schedule: The function gets executed based on a schedule.
- Related List: The function gets invoked from a related list.
- Standalone: A stand-alone function that can be triggered externally.
- Validation Rule: The function gets executed based on a validation rule.
Here is an example of a function that automatically generates a quote from a deal on just the click of a button. In DealToQuote() function, the input values are extracted from deals. You can also choose to get them from the users as arguments or JSON request body.
2b. Function Body
potDetails = zoho.crm.getRecordById("Deals",potId.toLong());//integration task /*Extracting details from the deal*/ quotesubject = ifnull(potDetails.get("Deal_Name"),""); contact = ifnull(potDetails.get("Contact_Name").get("id"),""); account = ifnull(potDetails.get("Account_Name").get("id"),""); description = ifnull(potDetails.get("Description"),""); RelatedProducts = zoho.crm.getRelatedRecords("Products","Potentials",potId.toLong()); product_items = List(); sub = 0.0; /*Extracting product details from the deal and adding it to quote*/ for each product in RelatedProducts { proid = product.get("id"); proname = product.get("Product_Name"); productDesc = ifnull(product.get("Description"),"Manque Description Produit !!!"); quantity = 1; price = ifnull(product.get("Unit_Price"),"0.0").toDecimal(); listprice = price * quantity; lineitem = Map(); lineitem.put("product",{"name":proname,"id":proid}); lineitem.put("product_description",productDesc); lineitem.put("quantity",quantity); lineitem.put("net_total",listprice); lineitem.put("total",listprice); lineitem.put("list_price",listprice); sub = sub + listprice; product_items.add(lineitem); } /*Storing quote details*/ paramap = Map(); paramap.put("Product_Details",product_items); paramap.put("Subject",quotesubject); paramap.put("Contact_Name",contact); paramap.put("Account_Name",account); paramap.put("Deal_Name",potId.toLong()); paramap.put("Sub_Total",sub); paramap.put("Grand_Total",sub); paramap.put("Description",description); createResp = zoho.crm.createRecord("Quotes",paramap); info paramap; info createResp; newid = createResp.get("id"); return "Success"; |
Step 5: Once you have written your logic, click save and execute.
Step 6: Enter the argument values, if any.
Step 7: If your function gets executed successfully, you will get a success message.
Step 7: Click Save.
3. Integration Tasks
Integration tasks are pre-defined functions that allow you to get, create, and update records in Zoho CRM. You can simply use these method names in your Deluge script along with the required data to make API calls.
In the above example, we have used the getRecordById() integration task that retrieves the details of the deal. For instance, the Deal Name, Contact Name, Account Name, and so on.
Syntax:
<response>=zoho.crm.getRecordById(<module_name>, <record_ID>, <connections>); |
Parameters:
| Parameter | Description |
response | The response with the list of records matching the criteria. |
module_name string, mandatory | The API name of the module you want to fetch the records from. |
record_ID string, mandatory | The unique ID of the record. |
connections string, optional | The connectors that are associated with the function. |
Example:
potDetails = zoho.crm.getRecordById("Deals",potId.toLong()); |
Some of the other available integration tasks are:
- zoho.crm.convertLead(): To convert a lead into a contact and and an account.
- zoho.crm.getRelatedRecords(): To get records related to a parent record. Example: The products associated with a deal.
- zoho.crm.updateRelatedRecords(): To update the records related to a parent record.
- zoho.crm.searchRecords(): To search for specific records by specifying the criteria for the search.
4. Triggering functions
A function needs a trigger to get executed. You can trigger a function in two ways:
4a. From Zoho CRM functionality
4b. From third-party applications
Scenario:
Functions are primarily used to write custom business logic in Zoho CRM. Consider a scenario, where you want your sales representatives to create a quote after reviewing the deal. Instead of letting them create each quote manually, you can add a custom button in the Edit Deal page, which when clicked upon, triggers a function that creates a quote.
Also, you can configure a third-party system to automatically create a quote in Zoho CRM when the deal amount is less than 1000 OR the deal stage is closed-won. Thus, avoiding manual intervention and enabling them to emphasise on substantial deals.
Let us discuss how to trigger the DealToQuote() function via a custom button and a third-party application. You can also trigger the same function from a third-party application as a REST API webhook.
4a. From Zoho CRM functionality (Custom Button)
- Go to Setup > Customization > Modules and Fields.
- From the List of Modules, select the required module.
- In the Links & Buttons tab, click Create New Button.
- In the Create Your Button page, do the following:
- Enter the name of the button. The button name should not exceed 30 characters.
- Click the Add Description link and specify the details of your custom button. The description should not exceed 250 characters.
- Choose the location of your custom button from the drop-down list.
- Custom buttons can be placed in 6 different places in your CRM account - Create/Clone page, Edit page, View page, List View page, a button to each record in the list view and Related Lists Page. Note that you can create up to 50 buttons for each module.
- Choose an action to be executed when a user clicks the custom button. You can either choose a predefined action from the gallery or the existing functions that were already created by the users in your organization. Also, define your own action by writing a custom function, open a new web tab or invoke a URL based on your needs. It is mandatory to choose the button action. In our case, From Existing Actions in Functions. Choose the function and click Configure.
6. Map the input values to the fields in that module and click Save.
Once the custom button is associated with an action, CRM Administrators can manage permissions by assigning only specific profiles to view and access the custom button.
Similarly, you can associate functions with Schedules, Workflows, Validation Rules, and Related Lists.
4b. From third-party applications
Here, we are going to configure a third-party system to automatically create a quote in Zoho CRM when the deal amount is less than 1000 OR the deal stage is closed-won, thus avoiding manual intervention.
To achieve this, we are going to trigger the DealToQuote() function from a third-party application (automate.io), whenever the above conditions are met.
If you want to trigger a function from a third-party application, you must make it available as REST API.
1. Go to Setup > Developer Space > Functions
2. Choose the function > Click more options > Click REST API
3.Enter the API name for the function.
4. Enable OAuth 2.0 to share the function as an API within your organization and enable API key to share the function as a webhook with any third-party user.
Click Save.
You must make the API call from the third-party application using the request URL received here.
The DealToQuote() function is triggered from a third-party application (automate.io). You can achieve the same using:
- Zoho Flow
- Zoho CRM workflow rule that is triggered whenever a deal is updated
Sample bot configuration in automate.io:
We have triggered the DealToQuote() function using custom button as well as a third-party application.
5. Limits of Functions
Function calls in Zoho CRM are associated with credits. Each function call results in reduction of one credit from your account.
Maximum credit limit based on your edition
Edition | Allowed Credits | Maximum credits that can be availed in a 24 hour window |
Starter | 5,000 credits + (Number of User licenses x 200) | 10,000 credits |
Standard | 5,000 credits + (Number of User licenses x 200) | 15,000 credits |
Professional | 5,000 credits + (Number of User licenses x 200) | 20,000 credits |
Enterprise/Zoho One/CRM Plus | 20,000 credits + (Number of User licenses x 500) | 1,00,000 credits |
Ultimate | 20,000 credits + (Number of User licenses X 1000) | 2,00,000 credits |
Limits based on properties of a function
Functionality | Description | Limits |
Execution Time | Function should be executed within the specified time. | 1 minute |
Response Limit | Function should return the response within a particular size. | 10 MB |
Lines of execution | The number of lines in a function code has a limit. | 200,000 |
Send Mail | The number of emails that you can using the send mail syntax has a limit. | 1000 per day |
Webhooks | GET and POST URLs | 50,000 requests per day |
We hope you found this post useful. Stay tuned for more!
Cheers!
Previous 'Kaizen' - Node JS SDK
Next 'Kaizen' - Connections in Zoho CRM
Access your files securely from anywhere
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
Sneha Sridharan
Sticky Posts
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! CommandsKaizen #165 : How to call Zoho CRM APIs using Client Script
Welcome back to another exciting Client Script post! In this post, we will discuss one of the most frequently asked questions: How do you call Zoho CRM APIs from Client Scripts? In this kaizen post, 1. Ways to make calls to Zoho CRM APIs using ClientKaizen#162 : Add Tags and Open Pre-filled Email Drafts via Client Scripts
Hello everyone! Welcome to another informative Kaizen post. In this post, let us see how to accomplish the following using Client Script. 1. How to auto-tag a record based on field update? 2. How to Open a pre-filled email draft This post will provideExtension Pointers - JS SDK series #4: Managing data from a widget using ZOHO.CRM.HTTP
Handling and managing the data between two applications is a major factor for an efficient business. There are a variety of ways to handle data between Zoho CRM and other third-party applications. You can use deluge CRM tasks, create connectors, use APIKaizen #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 achieved
New to Zoho TeamInbox?
Zoho TeamInbox Resources
Zoho DataPrep Resources
Zoho CRM Plus Resources
Zoho Books Resources
Zoho Subscriptions Resources
Zoho Projects Resources
Zoho Sprints Resources
Qntrl Resources
Zoho Creator Resources
Zoho Campaigns 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
Blueprint - 'On hold' state with an automatic transition?
I think I'm missing something here so I'm hoping if I explain what I'm trying to achieve someone might be able to give me a way around it. We sometimes get request far in advance but we don't want to action them unless it is 7 days from when they areHOW TO VIEW INDIVIDUAL COST OF NEWLY PURCHASED GOODS AFTER ALLOCATING LANDED COSTS
Hello, I have been able to allocate landed costs to the purchase cost of the new products. however, what i need to see now is the actual cost price (original cost plus landed cost), of only my newly purchased products to enable me set a selling priceClient Script: $Client.refresh({ triggerOnLoad: true }); not triggering onLoad Client Scripts
Hey friends! I'm trying to store a temporary var, refresh the page for the user, then check that temporary var and do some actions. Theoretically using the title's code: $Client.refresh({ triggerOnLoad: true }); should refresh the page and trigger onCalculate months and years between 2 dates on subform
I am looking for a function syntax for an employment candidate to calculate the number of years and months (decimal format. eg 1.2 years) they are employed. I have their start date entered, but if the end date is blank, that tells me they are still employedCombine related grouping values into categories in CRM analytical components
Hello everyone, Analyzing large datasets can be challenging when dealing with numerous individual data points. It's often difficult to extract meaningful insights when information is scattered and ungrouped. To address this, we're adding options to createHow Kiosk Studio can simplify sales for bank employees | Kiosk Studio Session #4
Hello everyone, Banks can boost revenue by cross-selling to their current customers. For example, they can sell credit cards, personal loans, and more to existing account holders. To do this, bank employees move all around the CRM, open and close records,Tip #19 - Create checkbox tracker in your spreadsheet
Hello Sheet users! We are here with yet another tip to help you get the most out of Zoho Sheet. Spreadsheets can be used to handle a variety of tasks, but ever tried using checkboxes to track the progress of your action items dynamically? Here's a sampleIntegrate Oracle with ZOHO CRM
Please let me know if its possible to Integrate Oracle with ZOHO CRM. If yes then help me in doing it.UUIDs
Has anyone coded a Universal Unique Identifier (UUID) generator in Deluge?Introducing signer groups: Streamline signature collection and make it even faster
Hello everyone, We're excited to introduce signer groups, a feature designed to make your signing process quicker, more efficient, and collaborative. With signer groups, you can send an envelope to a group of people, and any member of the group can openCalendar - Recurring Event - End of Month and Last Weekday of Month
How do I set a calendar event to recur on the last day of every month? How do I set a calendar event to recur on the last weekday of the month?Duplicate Zoho Invoices and Sales Receipts
We have been running into an issue where upon saving an invoice or a sales receipt, we get a duplicate: same information saved twice but with a different invoice id/number and sales receipt id/number. I have logged a ticket but so far no response. ItIntroducing revamped Zoho Creator Developer Console—a powerful platform for developing and distributing apps
Hello everyone! We're thrilled to announce the launch of the revamped Zoho Creator Developer Console—a dedicated platform designed specifically for Creator developers and Partners to build, test, and distribute apps to your clients. Developer ConsolePhone App of CRM doesn't find contacts
I open the crm to and do a contact search but nothing comes up. If I do a full zia search it will find an old note that is attached to a contact and I can open the contact. BUT I still can't enter notes of calls, set appointments, etc. It requests I go[Product Update] Deprecation of 'Inbound Transport Details' module in Zoho Analytics - Amazon Seller Central integration
Dear Customers, Please be informed that the Amazon Seller Central will be deprecating the 'Inbound Transport Details' module APIs effective December 20, 2024. As a result, this module will no longer be supported in the Amazon Seller Central - Zoho AnalyticsIs there any support for Drivers license and other forms of ID scanning capabilities?
When scanning a drivers license barcode for data input to a Form, the scanning tool receives all the raw data but there doesnt seem to be a function to limit or remove the unnecessary fragmrnts, like a prefix. Is there any support or info in the helpExciting Update: Multi WhatsApp Business Account (WABA) Support Now Available in SalesIQ!
We’re pleased to share an important update that will enhance the way you manage your WhatsApp Business accounts (WABAs) within SalesIQ. With the launch of Multi WABA support, you can now connect and manage multiple brands more effectively, each underGravity Forms plugin not passing some fields
I use the gravity form zoho plugin to push data from my lead form into my lead page in Zoho CRM. Everything was working file for about 6 months. Suddenly on Oct 1st, some of the fields are no longer getting passed to Zoho. The fields with the problemCan't delete bank transactions (i changed from 14 days trail to free just now)
Hi, I manually added one bank transaction When i try to delete it, it say below: What should I do?Feature Request: Search in the PC client. Some thoughts about the search.
Hi all. I'm really excited to start using Zoho Notebook, but I'm missing some of the search capabilities on my desktop. There are also some thoughts on improving search in general. Search is very important to me, without it it is difficult for me to useLeave Policy for Brazil
Hi, Brazil asked us to configure Zoho People to apply the following policy: · To block starting vacations 2 business days before holidays or weekends; Employees cannot start their vacations 2 days before holidays or weekends. Example: If December 25thAdding date field to each individual Items when creating Invoices?
When adding items into an invoice I need to be able to have a date for each item. Example below: Date Item Description Qty Rate Discount(%) Tax Amount 31/07/13 Brown Sugar Performance 1.00 3,000.00 0.00 10% $3300 Is this possible or will it be in theAuto-Create OneDrive Folder Structure Upon Lead Creation
Hello, New to Zoho and looking for help on a critical process automation I'm looking to implement. My company currently utilizes OneDrive for file management and the folder structure is Proposals -> Client Name -> Address (where I need to initially createProfile Page View Customization
I need to change the fields, sections from the profile view of an emplyoyee.What do the Image Sizes mean in Zoho CRM Email Templates?
Below you can see the image options in email templates: Banner, Fit, Small, Medium, Original, Custom. Can someone from Zoho please share with me: What each is/means? How each will look on desktop AND mobile? How to edit "custom"? If I choose "Custom"Translate any published presentation to the language of your choice
As part of our constant effort to enrich your presentation experience, Zoho Show has rolled out a new feature for translating published presentations. Consider the following scenario: Zylker IT services, a multinational corporation, has announced productBlueprint: multi-select lookup field not available in the criteria option
I read this old forum post which stated that multi-select lookup fields are now selectable as an option in a Blueprint transition configuration: https://help.zoho.com/portal/en/community/topic/blueprint-multi-select-lookup-field-not-available-within-blueprint-transitionApply Credit Note Automatically
We need the ability to apply open Credit Notes toward invoices generated by recurring invoice as the first, priority payment. This should be an option that we can enable/disable in the recurring profile and/or the Credit Note. Other invoicing systems can do this. I'm not sure why Zoho Invoice doesn't have it. Here's an example for a Recurring Invoice... If a customer has open Credit Notes, and a saved credit card set for auto-pay, once an invoice goes out, the credit balance gets automatically appliedWorkflow for "Expenses" module?
Hi there, over the last 2 years, Zoho Expense has seen tremendous growth and we are happy with it. But, sometimes it is frustrating to see things are being implemented halfheartedly, or so it seems. For example, There is the possibility to create workflowsRecord Template - Conditionally printing sections
Is there a way to conditionally print a section of a Record Template? More specifically I am printing records from a Form "Invoice". That Form has 3 SubForms. I'd like to print the content of those SubForms using a Record Template but only if they have at least one line item. If they have no line items, I'd like to hide the headers for that section on the printout.User can choose the PDF report
Hi. I would like to find out if a user (Creator or customer portal) to choose from the different PDF customised reports that have been built?Query table pull last 12 months
I am tying to pull the following criteria and the date is always what causes me the issue. I want to pull people (pco_id) who have entries of "event_id" being these 2 events and whos "kind" is Regular or Guest and where the event_starts_at (date column)PLEASE FIX Search options and consider a Global seach option
A recent update has removed the ability to search for addresses and phone numbers under contacts. We cannot find where this moved to (If it is still available). Please put these options back as we cannot locate specific projects anymore. Also please consider allowing for a Global search. This would really improve the search engine. For example: If I search for "Sally Jones" then all invoices , estimates, vendors etc.. would populate.. Please let me know if you need any more information. Thank You....Customize your calendar based on personal preferences
Greetings, We're happy to introduce a few new capabilities to the Activities module's Calendar View! Now you can tailor your calendar's appearance and notification settings to suit your needs. In the past, the Calendar View lacked customization optionsBUG ALERT: Client Script + Commands -> $Page contextual data is not updated
When using the new Client Script Commands feature, there is an issue with the Client Script $Page contextual data not accurately being updated each time a Command is run. Assuming a Client Script Command called "Client Script Command Bug" with the followingShow iFrame of related List inside of Blueprint Transition
Hey, is it possible to show an iFrame of a related list like this inside of a Blueprint transition?Lookup Fields not Converting
I manage holiday properties. I have a lookup to the Accounts (Properties) in the Leads module. The lookup is connected to the property address field. When I convert it the lookup field does not update in Deals, although the property address does. There2024: A Year of Transformation with Zoho Forms
As we close the curtain on another exciting year, it’s time to reflect on the strides Zoho Forms has taken in 2024. From empowering businesses with advanced tools to simplifying workflows and enhancing user experiences, our updates this year were allStop selling out of stock Items.
Hi I have been using Zohobooks for a around 8 month now. I am not involved in selling process but my staff cant stop selling product which they do not hold in stock, this is a big headache for me as physical count never matches what is shown on the books.Bigin API Token Request ("invalid_client")
Hi people, I tried to connect to the API without success, I've read all of the documentation multiple time and tried just about everything. I tried to do it with Python Request module and with Postman, passing the information through both the URL parameterNext Page