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
How do I get the Text Account name instead of the Reference number?
Good Morning everyone! I am very new to zoho analytics. I'm trying to create some pivot tables and when I add the Account or Division name it comes up as a reference number. From my research, I need to use a lookup. I'm having a really hard time understandingCustom API - Need to create a string return value, not only MAP
@Support: When creating a Custom API it only allows a return from a function of MAP type. The service I'm using requires a string return, how can this be achieved?missing video-urgent
hi..I have a problem regarding zoho meeting. I already record almost 2hrs for my interview session. After end my session, i'm stop the recording. Its happened when i didn't received any meeting recording at my email.But i received recording 7minutes afterDuplicate New Ticket Emails
I am getting two Ticket emails when a ticket is created. The first one goes to me as the Admin helpdesk@ And because I am an Agent as well it also send to helpdesk@, support1@ and support2@ Is there any way to stop this?Ticket Response Email Template
Is there a way to have an email template automatically selected when I click on Reply for a ticket?Unpublishing Job Post for LinkedIn
Hi, We have experienced issue with the above. We did unpublish a job in Recruit but it still appear under Job section in our LinkedIn page. It did not remove from LinkedIn as it should be. Please check and advise. Regards, SnyderPower of Automation :: Automatically start / pause / stop timer on task status update.
Hello Everyone, A Custom function is a user-written set of code to achieve a specific requirement. Set the required conditions needed as when to trigger using the Workflow rules (be it Tasks / Project) and associate the custom function to it. Requirement:-Editor limitations to define screen types
Guys I have noticed that even in version 2.0 of the editor (which is this new one we use) we still have a lot to improve... When I compare to some more global solutions like Wix, Zyro, Go Daddy, Squarespace and Weebly feel that we have some limitationsDúvidas do Zoho Creator
Pessoal, Estou colocando um tópico para dúvidas do Zoho Creator. Um abraço, LeandroTropicalize Books
Books is an incredibly powerful tool that works well in many countries. But I feel that it is a product that is not yet "tropicalized" for Brazil as we speak (this would be like adapting the local reality). We have many strong competitors who do moreAutomatic Sitemap Generation
Guys are all right? Doesn't make sense for me to have to generate a map site and upload it... because it's not automatically generated just as it is done in WIX? where the customer doesn’t have to worry about this.SEO improvements with ZIA
Are you okay? I would like to bring an idea that would be amazing to improve the product that is the possibility of being able to improve the SEO of the pages (this of each page or each article on the blog) through ZIA so that it could create page SummaryAutomatically updating field(s) of lookup module
I have a lookup field, which also pulls through the Status field from the linked record. When the lookup is first done, the Status is pulled through - this works perfectly. If that Status is later updated, the lookup field does not update as well. AsInitiating a SalesIQ Zobot from a custom button on Zoho Sites
I have created a Zobot set to initiate on a custom action called "Fast_Answers". On Zoho Sites, I created a code snippet button and set it to on-click run the event called "Fast_Answers". I installed the SalesIQ integration code into the Zoho Sites PageZoho Desk -> Zoho Analytics : Where is the field for "Layout" ?
I have many different layouts on my helpdesks and I want to be able to identify the stats for each one, however I can not file the field in the raw data from the Zoho Desk datasource. I thought it might be under "Tickets" but there is nothing. There isSet resolution mandatory field
Hi, i have 2 questions:) : - i want to set the resolution field mandatory before close the ticket. Because for now, i can close the ticket without writing how i solve it - how can i setup zoho desk to receive ticket by email(e.g. clients sent email to support@mydomain.com) and it create a ticket in zoho deskImpuesto automatico en cotizaciones
Buen dia Mi pregunta es como se puede poner alguna operacion para que las cotizaciones me salgan automaticamente con impuestos ya que uno al cargarla al final tienen que añadir el porcentaje de impuesto SaludosZoho Assist "Agree and Download" Button "Greyed Out" ("Light Blued" Out)
Anyone else having issue where support clients are unable to click "Agree and Download" to access the client so that we can provide remote support? This is for "on demand" support via accessing the support page and entering the support key and name. ThisProject Billing with the Staff Hours Method in Zoho Projects
The Staff Hours Billing Method in Zoho Projects allows you to bill your clients based on the actual time spent by each team member on a project, at the rate set for each user. This is useful for projects where different skill sets are needed and serviceCreator Subform to CRM Subform
Hello all, Has anyone successfully written data from a Creator Subform into CRM subform? I have been able to get the rows to populate but none of the data will come through. I'll add my code and the result in CRM. Creator Subform is 'Delivery_Receiving_Hours'.custom fields not populating from deluge script into invoice
Hello, I've created some Deluge script that is meant to take a few inputted invoice custom fields and calculate a few others. I can see when I execute the function that my inputted custom fields are being passed, yet im still ending up with all "null"tax summation function - getting error
Hello, I'm trying to create a function that adds all of individual tax rates from a few jurisdictions. I'm getting an error on line 9 - Value is empty and 'get' function cannot be applied. I've checked that I have data in each of the required fields,Backstage / Zoho Books integration
Hello. We have Zoho One and have slowly started using Backstage. Loving it. Problem is, we have ZERO accounting control over what is sold through this product. When will we be able to connect it to our existing Zoho Books tenant? Thank you very much!Getting list of calendar events over api for zoho mail calendar
Hi, I am using just Zoho mail without using Zoho CRM. I wanted to get all events booked in my zoho mail calendar through an api at regular intervals. I could find such API support for Zoho CRM calendar but not for zoho mail calendar. Can you kindly letAllocate emails to user in a shared mailbox
Hi, This might be obvious, but I cannot find the answer. I have 3 shared mailboxes so any team member can see the emails. Is there a way of allocating a specific email to a user so that it is their responsibility to deal with it? Thanks in advance.Introducing Zoho Campaigns' own gateway for SMS campaigns
We are excited to announce the launch of our SMS Gateway to send SMS through Zoho Campaigns. We have also made a few other changes in our current SMS Campaign model to improve your over all user experience. These updates are planned with an aim to expandUpdate a lookup field in CRM from Creator using deluge
I have a Creator form that creates a new account. When it creates the new account in the Accounts Module, I need it to also populate the Parent Account, which is a lookup field coming from the Module Parent Accounts, field Parent Account Name. I haveSMS Keyword Tracking in Zoho CRM From Zoho Campaigns
Is there a way to track SMS leads in campaigns by associating them with specific keywords or codes? Additionally, can these leads be pushed to the CRM while retaining the keyword for tracking and reporting purposes?Projects Multiselect API
Having troubles setting a mutli select field via API. updateMap = map(); updateMap.put("UDF_MULTI1","picklist_id1,picklist_id2"); updateProjectRes = invokeurl [ url :"https://projects.zoho.com/restapi/portal/XXXX/projects/" + projectID + "/" type :POSTBill quantity received / PO quantity
PO's are raised & often the quantity received is greater than the PO quantity, so when we receive the bill & adjust the quantity on the bill we get.... Quantity recorded cannot be more than quantity ordered. This necessitates the adjustment of the POZOHO BOOKS - RECEIVING MORE ITEMS THAN ORDERED
Hello, When trying to enter a vendor's bill that contains items with bigger quantity than ordered in the PO (it happens quite often) - The system would not let us save the bill and show this error: "Quantity recorded cannot be more than quantity ordered."Adding Bluesky channel
Hello, Is Bluesky (AT protocol) soon added on Social ? Bluesky is being developped and is now open to anyone (no more invitation) Thank youUsing Queries with dynamic parameters in Kiosk Studio
Hi, I'm pretty new when it comes to developing within Zoho (I'm really a .NET developer), as it was just added to my responsibilities. For a new feature in the CRM, I'm trying to develop a Kiosk function to show a list of records (retrieved by the newUnused items should not count into the available number of custom fields
Hey, I realized that unused Items reduce the number of available custom fields. I can't see a case where that makes sense. Especially in our case where we have two different layouts in Deals with a lot of different fields, this causes problems.Introducing Bot Filtering for Accurate Email Campaign Analytics
Dear Marketers, We're excited to announce a new feature designed to enhance the accuracy of your email campaign analytics: bot filtering. This feature helps you filter out bot-generated opens and clicks, ensuring your campaign reports reflect genuineTip 37: Time Log Restriction in Zoho Projects
Timesheet in Zoho Projects helps you big time in entering log hours for the tasks and issues and approving them. Now, with the new Time Log Restriction option, you can set daily and weekly log hour limits. You can restrict users from entering extra log hours than the permissible limit. The limits are restricted to 24 hours per day and 168 hours per week by default based on business hours. To customize, navigate to Task & Timesheet settings under Portal Configuration in Zoho Projects setup and enableChart showing schedule
I want to be able to create a chart for everyday to check and which of which driver is available on the timeframe. Here's my table Name City Day Start Time End Time Driver1 Medicine Hat Monday 11:45 AM 4:45 PM Driver 2 Medicine Hat Tuesday 11:00 AM 7:00Multiple Vendor SKUs
One of the big concerns we have with ZOHO Inventory is lack of Vendor Skus like many other inventory software packages offer. Being able to have multiple vendor skus for the same product would be HUGE! It would populate the appropriate vendor Sku forIn Zoho Projects, is there a way to create a folders template under documents that can be used once a project is created?
We have a specific folder structure that we would like to use that is standard across every project. Instead of having to create this structure every time a project is created, is there a way to create a template for the folders that can be added?Zoho Payroll in France
When will Zoho Payroll be available in France ?Next Page