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
Creator Simplified #10: Predefine Form Field Values and Make Them Read-Only for Users
Hey Creators, Ready for this week's tip in the Creator Simplified series? Today, we will explore how to have read only fields in a form. Use Case: Assume a scenario where the default value for a Department field needs to be English Literature, but youfetch records from analytics table from creator
I have a creator workflow that I am working in that will compare data from within the app to a table in zoho analytics. Is there a way to fetch a record from Analytics? I have attempted a custom connector with analytics and tried to use it with invokeDirectly Edit, Filter, and Sort Subforms on the Details Page
Hello everyone, As you know, subforms allow you to associate multiple line items with a single record, greatly enhancing your data organization. For example, a sales order subform neatly lists all products, their quantities, amounts, and other relevantAbility to Change Custom View After Cadence Creation
Dear Zoho Team, I hope you are well. We would like to request an enhancement to the Cadence feature in Zoho CRM. Currently, during the creation of a Cadence, we can select a Custom View under the "Who is this for?" section. However, once the Cadence isZoho Creator Integration with QuickBooks: A Step-by-Step Guide
Introduction: Integrating Zoho Creator with QuickBooks allows you to sync your business data between the two platforms, providing a seamless experience for managing accounting, invoicing, and financial data. This integration helps automate workflows andNote not being pulled for other modules in email template
Hi there, Currently i am creating an email template that is able to pull the data from notes field in estimate module and email it to procurement team where they will be able to receive the email with the contents of the note, i am unable to replicateNo Sales Returns on SO's with Dropped Shipped items + Inventory Items
We have encountered an issue in Zoho related to sales orders that include both dropshipped items and inventory items. Specifically, it is currently not possible to create sales returns for the company’s own inventory items from these sales orders. ThisPre-fill TO and CC fields for Email Templates
This would be a game changer to be able to set either specific email addresses or merge fields based on deal role titles into email templates. Please pass this along to *hopefully* add to future features of Zoho CRM.Pick list - Cannot save list "Special Characters not Allowed" error message
Bulk uploading values. All values are pretty standard - with the exception of a "-" (dash). Like: Industry - Prepared Food Is the simple dash a special character too? JanFlow with CRM
Hello, I have a simple flow that uses a web hook to enter data into a Sales Order. I have the web hook sending Flow data which has a PO field. If the PO has a special character like - or / or \ the task fails. How can I get the flow to be okay with theMaking the Resolution Tab Mandatory
Hello Everyone! This edition is here to show you how to make the Resolution mandatory when closing a ticket. The Ticket Resolution tab helps keep a record of the solution provided for the ticket query. The resolution can serve as a quick reference toRemove County field from Customer Address input screen (or allow input to be deleted)
We are in the USA and have just noticed that there is now a County field in the Customer Address input screen (and maybe other areas of Zoho Books, but this is the one affecting us at the moment). County is not important to our business, and in fact weNotificación de cumpleaños
Hola: Se puede enviar alguna alerta de felicitación al personal que cumple años, que se dispare solo? Si existe como se puede hacer? SaludosAutomation#25: Move Tickets to Unassigned When the Owner Is Offline
Hello Everyone, Welcome to this week's Community Series! 'Tis the holiday season—a time when work often takes a brief pause. The holiday spirit is in full swing at Zylker Techfix too, with employees taking some well-deserved time off. During this period,Callback URLs
I need to connect to an external service through an API that requires me to provide a Callback URL so that a status update can be sent back when the API request has been processed. Is there a way to do this in Creator without having to use a middlewareEmail signature not being included if user creates ticket / sends email
When I create a ticket (send email), the signature doesn't appear to be added to the ticket. Can you confirm if this is the case? It would obviously be useful to include the user's signature even when sending a client an email and not only on replieZoho Notebook window ignores taskbar
When maximized to full screen, the Zoho Notebook window ignores the presence of the taskbar and overlaps it. What could be the problem? Linux Mint 22 Cinnamon. Zoho Notebook 3.2.0URL for job opening
I would like to ask you to add this feature to the product: create an unique url for each job opening on Zoho Recruit, so that I can add a link to it when I post the opportunity in a mailing list or on a forum.Document images
We used to be able to rotate the images but this has now been removed ???VENDORS ARE NOT SYNCHED WITH CONTACTS IN CRM
Hello, While the ACCOUNTS and CONTACTS (Including the primary contact) are synced with the CONTACTS module in CRM, the vendor's CONTACTS are not synced with CRM - which basically forces the users to re-enter all vendor's contacts twice and then updateInvolved account types are not applicable when create journals
{ "journal_date": "2016-01-31", "reference_number": "20160131", "notes": "SimplePay Payroll", "line_items": [{ "account_id": "538624000000035003", "description": "Net Pay", "amount": 26690.09, "debit_or_credit": "credit" }, { "account_id": "538624000000000403", "description": "Gross", "amount": 32000, "debit_or_credit": "debit" }, { "account_id": "538624000000000427", "description": "CPP", "amount": 1295.64, "debit_or_credit": "debit" }, { "account_id": "538624000000000376", "description":KB Templates
* It would be nice if Zoho can provide users an option to create custom templates for KB articles. Also, it would be nice as well if the users can have an option to 1.) select a default template and 2.) declare default tag/tags, for KB articles created through Ticket's resolution.Zoho CRM Reports Module on Mobil App
I have the mobile app and the reports module doesn't appear in the sidebar for some reason. I saw a Youtube video where the user had the Reports module on mobile. Is there a setting to show it on mobile? Thanks.Contacts Don't Always Populate
I've noticed that some contacts can easily be added to an email when I type their name. Other times, a contact doesn't appear even though I KNOW it is in my contact list. It is possible the ones I loaded from a spreadsheet are not an issue and the onesZoho Projects Android app update - List view enhancement
Hello, everyone! In the latest android version(v3.9.15) of the Zoho Projects app update, we have enhanced the List view of tasks. We have also introduced a complete scroll of the tasks in the list view without scrolling the task fields(status, start date,Print PO receipt
Hi I would like to print the PO receipt. There does not seem to be any way to do this. I track batch numbers and printing the PO does not show this. Only the receipt would show the details of the receipt. Currently I print the screen which does not haveOn the US Data Centre rather than the UK but dont know how to migrate it
We have a new staff member with an external email address and cant add them to Zoho chat - we have been told its becuase we are in the UK but on a US Data centre - we therefore need to change it but no idea how to can anyone else as we are going roundZoho Sheet Custom function column showing Error #EVAL!
Hello I have a custom function in Zoho Sheet developed to convert a date time from one time zone to another. The custom function takes date and time columns and then using subHour( ) converts the time to PST time. However, though the custom function works,How to add a Data Updated As Of: dynamically in text?
I need to add a "Data Updated As Of" in the dashboard to show when was the last date the data was updated. I tried to create a widget but it does not look really good, see below. Is there a way I can do this through the text widget and update it automaticallyCreate Your Own Issue Management System
Effective issue management is a cornerstone of project success. Every bug or issue, no matter how small, needs to be tracked and resolved in time to maintain project momentum. In this post, we’ll explore how an issue management system in Zoho ProjectsResource utlisation
Dear Team, We use the excel for the weekly predicted people utilization how the resource are allocated , is there any way that i can use any of the zoho products.Ask the experts - A live Q & A discussion on Zoho Recruit
We are delighted to come back with another edition of Ask the Experts community series. This edition, we'll be focusing on everything about Zoho Recruit. The topics will focus on the features that are used/asked by the majority of users and also basedBug - OTP (email) and No Duplicates
Scenario: Form with an email field, Validation: "No Duplicates" (because I want to ensure 1 entry per email). Embedded form into website (JS option). Enabled email based OTP. 1st test (via my website) - entered my email address - sent OTP - entered pin,Personal Facebook page posting instead of Business Page
I have a Facebook page that is associated with my Personal Profile and I am the Admin of that Page. I would like to schedule and Post to my Personal Page not the Business Page. Each time I try to connect to the "Page" it takes me to the Business Page. Is there a way of connecting to my personal page?Fixed asset management
I want to know if there is any individual module for fixed assets managementRecording depreciation of fixed assets as a percentage of residual value
In India, fixed assets are depreciated as a percentage of their residual value at the beginning of each fiscal year. I went through the documentation for creating recurring journal entries, but could only find ways to depreciate by a fixed rupee amountFunction #28: Automatically calculate Customer Loyalty points
Hello everyone, and welcome back to our series! Today, we're excited to share a workflow designed to streamline the management of loyalty points. Many businesses offer incentives or rewards in the form of loyalty points to their customers as a way toFunction #6: Calculate Commissions for paid invoices
Zoho Books helps you automate the process of calculating and recording commissions paid to sales persons using custom functions. We've written a script that computes the commission amount based on the percentage of commission you enter and creates anHow to Add Product SKU in Invoice?
How to Add Product SKU in Invoice?Tracking movement between departments
I've been developing a reporting system in Zoho and one of the groups I want to develop a report on primarily moves tickets from department to another. Is there a way to set up the reporting on Zoho (or Zoho Reports) that can tell me the number of ticketsNext Page