Functions

‌Custom functions are used for defining custom business logic, formulating processes, and automating repetitive tasks. They are used for manipulating details of one or more FSM modules through record creation, updation or deletion. They are also used for implementing functionalities with the use of third-party applications. Custom functions are used by associating them with workflows. They are written using Deluge Scripting Language.

Custom functions can be used primarily in two ways:

For automating basic actions like sending emails
For accessing data from Zoho or third-party services

- Permission Required: Manage Automation

- Find out the Edition-specific limits for Custom Functions.

‌Create a Custom Function

You can use functions for automating routine activities. For example, the sendmail task enables you to send notifications.

To create a function that will notify the customer by email when a new request is created for them:

Navigate to Setup > Automation > Functions.
Only users with the profile Administrator will have this option.
Click Create Function.
‌In the Create Function overlay, do the following:

‌Enter the Function Name as SendNotification.
Select Requests as the Module for which you want to trigger the custom function.

In the Deluge Script Editor, write the below script for the custom function.

void SendUpdate(Map request , Map organization , Map user){

//Get customer name

customer = request.get("Contact");

custName = customer.get("name");

//Get customer email

email = request.get("Email");

//Get request name

reqName = request.get("Name");

//Send notification

sendmail

[

from :zoho.loginuserid

to :email

subject :"New Request"

message :"Hi " + custName + "," + "<br>" + "A new Request " + reqName + " has been created for you." + "<br>" + "Thanks," + "<br>" + "Support Team"

]

}

Click Save.

To test the function, do the following:

In the Deluge Script Editor, click Save & Execute.
In the Execute Function pop-up, enter a Request record ID or click Click here to get the list to obtain the list of available Request IDs.
Select a Request ID and click Execute.

The results of the function will be displayed in the console. You can use this to test and debug your custom functions.

To use this function, you need to associate this function with a workflow.

Data Manipulation using Custom Functions

You can use custom functions for accessing data from Zoho or third-party services. You can use the Deluge tasks for data manipulation to do so. For example, the task for creating records (zoho.fsm.createRecord) in FSM.

There are two ways in which these tasks can be used:

Using a System Connection. E.g. zoho.fsm.createRecord(<module>, <KEY-VALUE>);
Using a Connection of a Service (Default/Custom). E.g. zoho.fsm.createRecord(<module>, <dataMap>, <optionalDataMap>, <connection>);

What is a Connection?
There are some services that cannot be integrated directly with Zoho FSM. In these cases, you can use a connection to expand FSM's third-party support. Connection uses OAuth 2.0 protocol to facilitate this integration.

There are three types of connections:

System Connection: The connection used by the built-in integration task, for accessing the data from FSM and other Zoho services (CRM, Projects, Books, etc). Individual internal connections will be created for individual Zoho integration tasks.
Connection using Default Services: You can choose from the already available list of services, provide your credentials, and establish a connection.
Connection using Custom Services: If the desired service is not available in the default services list, you can configure it on your own and connect to it.

Create a Function using the System Connection

The system connection used for the FSM data manipulation tasks is listed under System Connections at Setup > Automation > Connections. Ensure that the status of the connection is Connected. The green dot [

] indicates that the connection is Connected.

To write the function that inserts a new record in the Requests module, do the following:

Navigate to Setup > Automation > Functions.
Click Create Function.
In the Create Function overlay, do the following:

Enter the Function Name as CreateRequests.
Select Requests as the Module for which you want to trigger the custom function.
From the tasks tray on the left in the Deluge Script Editor, drag and drop the Deluge task you want to use. In our case it is create record.

Write the below script for the custom function.

void CreateRequests(Map request , Map organization , Map user){

newRecordInfo = Map();

newRecordInfo.put("Summary","Sample");

newRecordInfo.put("Status","New");

newRecordInfo.put("Contact","1011000000141106");

newRecordInfo.put("Territory","1011000000139148");

serviceAddress = Map();

serviceAddress.put("id", "1011000000141109");

serviceAddress.put("Service_Street_1", "10 Oak St");

serviceAddress.put("Service_Street_2", null);

serviceAddress.put("Service_City", "Oconee");

serviceAddress.put("Service_State", "Illinois");

serviceAddress.put("Service_Country", "United States");

serviceAddress.put("Service_Zip_Code", "62553");

serviceAddress.put("Service_Latitude", "39.287425");

serviceAddress.put("Service_Longitude", "-89.108759");

serviceAddress.put("Service_Address_Name", "Service Address");

billingAddress = Map();

billingAddress.put("id", "1011000000141108");

billingAddress.put("Billing_Street_1", "Locust St");

billingAddress.put("Billing_Street_2", null);

billingAddress.put("Billing_City", "Oconee");

billingAddress.put("Billing_State", "Illinois");

billingAddress.put("Billing_Country", "United States");

billingAddress.put("Billing_Zip_Code", "62553");

billingAddress.put("Billing_Latitude", "39.286597");

billingAddress.put("Billing_Longitude", "-89.107787");

billingAddress.put("Billing_Address_Name", "Billing Address");

newRecordInfo.put("Service_Address", serviceAddress);

newRecordInfo.put("Billing_Address", billingAddress);

resp = zoho.fsm.createRecord("Requests", newRecordInfo);

info resp;

}

Click Save.

To test the function, do the following:

In the Deluge Script Editor, click Save & Execute.
In the Execute Function pop-up, enter a Request record ID or click Click here to get the list to obtain the list of available Request IDs.
Select a Request ID and click Execute.

A new Request record has been created and you can view the details of the record in the console.

To use this function, you need to associate this function with a workflow.

Create a Function using the Connection of a Default Service

Following are the steps to create a function that inserts a new record in the Requests module.

Create a Connection for a Default Service (Zoho FSM)
Write the function

Create a Connection for a Default Service (Zoho FSM)

Navigate to Setup > Automation > Connections > My Connections.
Only users with the profile Administrator will have this option.
Click Create Connection.
Select the Default Services tab and click on the service to which you want to connect your Zoho Service. In our case, we need to select Zoho FSM.
Enter a Connection Name.

Choose Scopes.

The following scopes are available for FSM. Select the appropriate scopes as per your requirements.

Scope	Description
ZohoFSM.modules.custom.READ ZohoFSM.modules.contacts.READ ZohoFSM.modules.accounts.READ ZohoFSM.modules.Requests.READ ZohoFSM.modules.Estimates.READ ZohoFSM.modules.WorkOrders.READ	Used to retrieve records. Will be used in the following tasks: zoho.fsm.getRecords(<module>, <page>, <perPage>, <optionalDataMap>, <connection>); zoho.fsm.getRecordById(<module>, <id>, <optionalDataMap>, <connection>); zoho.fsm.getRelatedRecords(<relationName>, <parentModuleName>, <id>, <page>, <perPage>, <optionalDataMap>, <connection>);
ZohoFSM.modules.custom.CREATE ZohoFSM.modules.contacts.CREATE ZohoFSM.modules.accounts.CREATE ZohoFSM.modules.Requests.CREATE ZohoFSM.modules.Estimates.CREATE ZohoFSM.modules.WorkOrders.CREATE	Used to create records. Will be used in the following tasks: zoho.fsm.createRecord(<module>, <dataMap>, <optionalDataMap>, <connection>);
ZohoFSM.modules.custom.UPDATE ZohoFSM.modules.contacts.UPDATE ZohoFSM.modules.accounts.UPDATE ZohoFSM.modules.Requests.UPDATE ZohoFSM.modules.Estimates.UPDATE ZohoFSM.modules.WorkOrders.UPDATE	Used to edit records. Will be used in the following tasks: zoho.fsm.updateRecord(<module>, <id>, <dataMap>, <optionalDataMap>, <connection>);

Click Create and Connect.
Click Accept in the permissions page.
The connection is created. The Link Name will be used as an argument in the task zoho.fsm.createRecord.

Write the function

Navigate to Setup > Automation > Functions.
Click Create Function.
‌In the Create Function overlay, do the following:

Enter the Function Name as CreateRequests.
Select Requests as the Module for which you want to trigger the custom function.

Write the below script for the custom function:

void CreateRequests(Map request , Map organization , Map user){

newRecordInfo = Map();

newRecordInfo.put("Summary","Sample");

newRecordInfo.put("Status","New");

newRecordInfo.put("Contact","1011000000141106");

newRecordInfo.put("Territory","1011000000139148");

serviceAddress = Map();

serviceAddress.put("id","1011000000141109");

serviceAddress.put("Service_Street_1","10 Oak St");

serviceAddress.put("Service_Street_2",null);

serviceAddress.put("Service_City","Oconee");

serviceAddress.put("Service_State","Illinois");

serviceAddress.put("Service_Country","United States");

serviceAddress.put("Service_Zip_Code","62553");

serviceAddress.put("Service_Latitude","39.287425");

serviceAddress.put("Service_Longitude","-89.108759");

serviceAddress.put("Service_Address_Name","Service Address");

billingAddress = Map();

billingAddress.put("id","1011000000141108");

billingAddress.put("Billing_Street_1","Locust St");

billingAddress.put("Billing_Street_2",null);

billingAddress.put("Billing_City","Oconee");

billingAddress.put("Billing_State","Illinois");

billingAddress.put("Billing_Country","United States");

billingAddress.put("Billing_Zip_Code","62553");

billingAddress.put("Billing_Latitude","39.286597");

billingAddress.put("Billing_Longitude","-89.107787");

billingAddress.put("Billing_Address_Name","Billing Address");

newRecordInfo.put("Service_Address",serviceAddress);

newRecordInfo.put("Billing_Address",billingAddress);

resp = zoho.fsm.createRecord("Requests", newRecordInfo, Map(), "fsmconnection");

info resp;

}

Click Save.

To test the function, do the following:

In the Deluge Script Editor, click Save & Execute.
In the Execute Function pop-up, enter a Request record ID or click Click here to get the list to obtain the list of available Request IDs.
Select a Request ID and click Execute.

A new Request record has been created and you can view the details of the record in the console.

To use this function, you need to associate this function with a workflow.

Understanding the CreateRecord Task

Let's look at how the zoho.fsm.createRecord is used. The syntax for the task is given below.

Method Used	Syntax
Using the Internal Connection	<Response> = zoho.fsm.createRecord(<module>, <KEY-VALUE>);
Using the Connection of a Service (Default/Custom)	<Response> = zoho.fsm.createRecord(<module>, <KEY-VALUE>, <optionalDataMap>, <connection>);

where,

<Response> is the task response returned as a Map.

<module> specify the API name of the module from which you want to fetch records

<KEY-VALUE> is a map with details of the record that needs to be inserted into the module.

<optionalDataMap> is a map parameter to pass any additional values

<connection> is the connection created for Zoho FSM

The <module> argument

The API name of the module, i.e. Requests needs to be used.

The <KEY-VALUE> argument

The details of the fields and its values required for constructing the <KEY-VALUE> map can be viewed by clicking the Map argument (request) of the module.

The <optionalDataMap> argument

In case you need to pass any additional data you can use this argument else pass an empty map, Map().

The <connection> argument

The value to be used for the <connection> argument is the Link Name of the connection created for FSM. To view this detail, click the connection.

Associate with Workflow Rules

You can either associate an existing function to the workflow or create a new function and associate it to the workflow. The module for which the workflow and function is created should be the same. If you create a workflow for the Requests module, then the new function that you create or the existing function you can associate should also be of the Requests module.

Manage Custom Functions

You can edit, delete, or clone a function.

Function Failures

When a workflow is triggered, its associated function gets executed. The function might fail when executed on some records. The details of such errors and the records that caused it can be viewed under the Function Failures tab at Setup > Automation > Functions.

Create. Review. Publish.

Write, edit, collaborate on, and publish documents to different content management platforms.

Get Started Now

Access your files securely from anywhere

Zoho CRM Training Programs

Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.

Redefine the way you work

with Zoho Workplace

Start your free trial

Zoho DataPrep Personalized Demo

If you'd like a personalized walk-through of our data preparation tool, please request a demo and we'll be happy to show you how to get the best out of Zoho DataPrep.

Create, share, and deliver

beautiful slides from anywhere.

Get Started Now

Zoho Sign now offers specialized one-on-one training for both administrators and developers.

BOOK A SESSION

Zoho Workerly Home
Forums
Connect With Us:

Zoho Recruit Home
Forums
Connect With Us:

Start tracking your website metrics today

Use PageSense to understand what your visitors are looking for, how they are behaving, and where they are facing problems on your website.

Ready to improve your website's performance?

Install the PageSense code snippet on your site in a matter of minutes and start collecting in-depth data about the website visitors to grow your business.

Track and measure every business goal

Set up goals in PageSense to measure every single action performed by visitors on your website like button or link clicks, form submissions, and page engagements.

Understand the customer journey on your website

Create funnels in PageSense to quickly see which pages visitors use to enter your website, where they navigate to next, and which pages they decide to leave without converting.

Visualize your visitor's behavior with color codes

Set up heatmaps in PageSense to see where users have clicked more, how far they've scrolled, and on which parts of a page they've spent the most time using color-coded patterns in reports.

Measure customer engagement with your web forms

Use form analytics in PageSense to see how people interact with different fields in your form, whether they complete the form successfully or not, and where exactly they drop out on your form.

Record real visitor interactions on your website

Use session recordings in PageSense to watch a video of all the visitor actions performed on your website including the pages they navigate, the buttons they click, the UX issues they face, and more.

Test and optimize webpages for better conversions

Run A/B or Split URL tests in PageSense to figure out which version of your web page works best for your business and results in the best conversion rate.

Give each customer a unique website experience

Use personalization in PageSense to deliver customized versions of your website for every individual customer based on their demographics, local weather, browsing history, and more.

Grow your business through customer feedback

Run polls on your website using PageSense to understand what your customers think about your products/services and what needs improvement on your site.

Send timely updates that customers love

Use web push notifications in PageSense to schedule and notify your customers about an upcoming flash sale, product releases, promotional coupons, and a lot more that can spark conversions on your website.

Advertise your business to website visitors

Use pop-ups in PageSense to instantly grab the attention of visitors by showing attractive signup offers, coupon code discounts, or email newsletters that can eventually convert them into subscribers.

Access more advanced settings in PageSense

Use PageSense's advanced features like creating mutually exclusive groups, enabling cross-domain tracking, configuring customized project JS, and more to get deeper insights about your website.

Try easy-to-use extensions

Download the PageSense extension app available for your web browser with a few clicks and start collecting all of your required website metrics in real time.

Discover your favorite integrations with PageSense

Get a deeper look at your website's data by seamlessly integrating PageSense with a host of popular third-party apps like Google Analytics, Mixpanel, Intercom, and more.

Quick Links	Workflow Automation	Data Collection
Web Forms	Enterprise	Online Data Collection Tool
Embeddable Forms	Banking	Begin Data Collection
Interactive Forms	Workplace	Data Collection App
CRM Forms	Customer Service	Accessible Forms
Digital Forms	Marketing	Forms for Small Business
HTML Forms	Education	Forms for Enterprise
Contact Forms	E-commerce	Forms for any business
Lead Generation Forms	Healthcare	Forms for Startups
Wordpress Forms	Customer onboarding	Forms for Small Business
No Code Forms	Construction	RSVP tool for holidays
Free Forms	Travel	Features for Order Forms
Prefill Forms	Non-Profit
Intake Forms	Legal	Mobile App
Form Designer	HR	Mobile Forms
Card Forms	Food	Offline Forms
Assign Forms	Photography	Mobile Forms Features
Translate Forms	Real Estate	Kiosk in Mobile Forms
Electronic Forms
Drag & drop form builder
Notification Emails for Forms	Alternatives	Security & Compliance
Holiday Forms	Google Forms alternative	GDPR
Form to PDF	Jotform alternative	HIPAA Forms
Email Forms		Encrypted Forms
		Secure Forms
		WCAG

Quick Links

New to Zoho Writer?

Signup Now

Zoho Writer

What's new

Help Guide

Blogs

Forums

Webinars

API

Developers

Build Extensions

Create. Review. Publish.

Write, edit, collaborate on, and publish documents to different content management platforms.

Get Started Now

Zoho Campaigns Resources

Campaigns Community Learning Series

New to Zoho CRM Plus?

Deliver unforgettable customer experiences

ACCESS ZOHO CRM PLUS

New to Zoho CRM Plus?

Deliver unforgettable customer experiences

ACCESS ZOHO CRM PLUS

New to Zoho Marketing Plus?

Everything you need to run your marketing

ACCESS ZOHO MARKETING PLUS

New to Zoho Marketing Plus?

Everything you need to run your marketing

ACCESS ZOHO MARKETING PLUS

Zoho Pagesense Resources

You are currently viewing the help pages of Qntrl’s earlier version. Click here to view our latest version—Qntrl 3.0's help articles.

New to Zoho Survey?

Access Zoho Survey

Latest Feature Updates

Explore our Pricing & Plans

Zoho Survey Resources

Android Mobile Surveys

Insurvey Blogs

Insight Blogs

Tips & Tricks

New to Zoho Social?

Manage your brands on social media

Access Zoho Social

New to Zoho Desk?

Access Zoho Desk

What's New in Zoho Desk

Use cases

Make the most of Zoho Desk with the use cases.

Learn More

eBooks

Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho Desk.

Download eBooks

Videos

Watch comprehensive videos on features and other important topics that will help you master Zoho Desk.

Watch Now

Webinar

What's New in Zoho Desk

Desk Community Learning Series
Meetups
Ask the Experts
Kbase
Resources
Glossary
Desk Marketplace
MVP Corner

Zoho Sheet Resources

New to Zoho Forms?

Latest Feature Updates

Explore our Pricing & Plans

Zoho Forms Resources

Secure your business

communication with Zoho Mail

Get started

Mail on the move with

Zoho Mail mobile application

Go Mobile

Stay on top of your schedule

at all times

Get started

Carry your calendar with you

Anytime, anywhere

Get started

Latest Announcements

New to Zoho Sign?

Zoho Sign Resources

Sign, Paperless!

Sign and send business documents on the go!

Get Started Now

Zoho SalesIQ Resources

New to Zoho TeamInbox?

Zoho TeamInbox Resources

Connect with us

New to Zoho ZeptoMail?

LEARN MORE

Latest Feature Updates

Zoho DataPrep Resources

New to Zoho DataPrep?

Access Zoho DataPrep

Zoho DataPrep Demo

Get a personalized demo or POC

Design. Discuss. Deliver.

Create visually engaging stories with Zoho Show.

Get Started Now

New to Zoho Workerly?

Access Zoho Workerly

New to Zoho Recruit?

Access Zoho Recruit

New to Zoho CRM?

Signup Now

Access Zoho CRM

Latest Feature Updates

New to Zoho Projects?

Access Zoho Projects

New to Zoho Sprints?

Access Zoho Sprints

New to Zoho Assist?

Access Zoho Assist

New to Bigin?

Signup Now

Access Bigin

Latest Feature Updates

Related Articles
Standalone Functions
Field service management will be at its optimal level when there is proper synergy between all the people and processes involved. Crucial data conveyed on time to the correct stakeholder is paramount in maintaining the KPIs. To this end, Zoho FSM ...
Audit Log
The Audit log captures the activities performed within the Setup of your FSM organization. This audit log can be viewed at Setup > Data Administration > Audit Log. Click on an entry to see the details. Filters Any of the following filters can be ...
Integrate with QuickBooks
QuickBooks is an accounting software. This help document details the steps to integrate QuickBooks with FSM. It broadly consists of the following: Create a connection for QuickBooks Create a custom function in FSM Create a connection for QuickBooks ...
Create an event in Zoho Calendar for a Service Appointment
Use Case: Whenever a service appointment is dispatched in Zoho FSM, create an event in Zoho Calendar. Step 1: Create a custom function Step 2: Create a workflow rule Step 1: Create a custom function Add a custom function that will create an event in ...
Data Retention in Zoho FSM
Zoho FSM's data retention policy defines the storage duration for various types of data, detailing how long they are retained after deletion. Particulars of Data Deletion Scenario Retention Period In BackUp server Zoho FSM Account On customer request ...