Functions in Zoho Vertical Studio | Vertical Studio Help Guide

Functions

Functions are custom scripts in Vertical Studio that help address complex business requirements in your application. They are written using Deluge (Data Enriched Language for the Universal Grid Environment). 

The Deluge scripts can be used for a wide range of actions, including performing complex calculations, manipulating data, and interacting with both Zoho apps and third-party applications. It allows developers to handle processes beyond default functionalities, enabling them to create highly customized and efficient applications.

For more details, refer to our guide on Functions and Deluge Script

An Overview of Functions in Vertical Studio 

Functions can be created either as stand-alone scripts or associated with Buttons, Schedules, Related Lists and various components within the application. Following are the types of functions categorized based on it: 
  1. Standalone Function
  2. Button
  3. Related List
  4. Automation
  5. Schedule
  6. Validation Rule
  7. Variable Function
  8. Connector Function
  9. Signup Function
  10. Upgrade Function

Standalone Function

Standalone functions are independent scripts designed to perform tasks not directly associated with workflows or other components. These functions can be invoked using REST API calls, enabling external applications to interact with your application's data. You can create and manage standalone functions in the Developer Console under Build > Automate > Functions.

Following are the key details of a standalone function:
  1. Arguments and Return Types: Void, Integer, Float, String, Date, Map, Boolean, or List.
  2. Namespace: Always the domain of your application.
  3. Syntax: ReturnType namespace.function_name()

Button 

Button functions are triggered when a specific button is clicked within the application. Check the Custom Button help page to learn more details. 

Following are the key details of a button function:
  1. Namespace: button
  2. Return Type: String
  3. Argument: Map with the module name.
  4. Syntax: returnType nameSpace.function_name(map module_name)
Related list functions customize related lists to suit various business needs within a record in your application. For more information, refer to the Function Related List Help Page.

Following are the key details of a related list function:
  1. Namespace: related_list
  2. Return Type: String
  3. Argument: Map with the module name.
  4. Syntax: returnType nameSpace.function_name(map module_name)

Automation

Automation functions are linked to workflows and blueprints. They automate repetitive tasks and execute complex actions based on predefined triggers or conditions.

Following are the key details of an automation function:
  1. Namespace: automation
  2. Return Type: Void
  3. Argument: Map with the module name.
  4. Syntax: returnType nameSpace.function_name(map module_name)
Refer to the Workflow help document to learn more details about it.

Schedule

Functions associated with a schedule automate the execution of specific actions, either once or at recurring time intervals. Check the Schedules help document to learn more. 

Following are the key details of a schedule function:
  1. Namespace: schedule
  2. Return Type: Void
  3. Arguments: No arguments
  4. Syntax: returnType nameSpace.function_name()

Validation Rule

Functions associated with Validation rules help you validate field inputs based on custom business logic in your application. 

Following are the key details of a validation rule function:
  1. Namespace: validation_rule
  2. Return Type: Map
  3. Argument: String with CRM API request.
  4. Syntax: returnType nameSpace.function_name(string crmAPIRequest) 
Info
The Validation Rule function is currently in Early Access and not yet publicly available. Contact our support team to enable the feature for your account. 

Variable Function

Variable functions support On Change scripts to replace old variable values with new ones. It ensures the processes associated with the old variable value functions without any disruptions. 

Following are the key details of the On Change Script in variables:
  1. Namespace: VariableAction
  2. Return Type: Void
  3. Argument: Map variableMap (to retrieve the old and new values of the variable)
  4. Syntax: returnType nameSpace.function_name(map variableMap)
Check the Variables help document to learn more. 

Connector Function

You can invoke connector APIs using custom functions and enable seamless integration with third-party applications for data exchange and communication between your application and external services. 

Following are the key details of the connector function:
  1. Namespace: ConnectorAction
  2. Return Type: Void
  3. Arguments: No arguments
  4. Syntax: returnType nameSpace.function_name()
Refer to the Connector help guide to learn more about it. 

Signup Function 

The Sign Up Function enables developers to configure automated functions to be triggered when a user signs up for the application built using Vertical Studio. 

Following are the key details of the signup function:
  1. Namespace: Install_Function
  2. Return Type: Void
  3. Argument: Map signupMap (to fetch the organization ID)
  4. Syntax: returnType nameSpace.function_name(map variableMap)
For more details, check the Signup function help page.

Upgrade Function

The Upgrade Function is a startup action that automatically triggers when a subscriber is upgraded to a new version. 

Following are the key details of the upgrade function:
  1. Namespace: Install_Function
  2. Return Type: Void
  3. Argument: Map upgradeMap (to fetch the organization ID, previous version and current version)
  4. Syntax: returnType nameSpace.function_name(map upgradeMap)
Refer to the Upgrade function help page to learn more. 

Packaged Functions

Packaged Functions are created in the developer console and deployed to subscriber organizations during signup or through upgrades. Any new function that is created in the developer console will be included in the next version of the application.
To know more about packaging, please refer to our guide on Components Packaging in Zoho Vertical Studio.
The following table explains the upgrade behavior of an existing packaged function already deployed in the subscriber's organization.

Property
Upgrade Type
Modify Access
Function Name
Upgradable
Developer Only
Display Name
Upgradable
Developer Only
Description
Upgradable
Developer Only
Invoke as REST API
Non-Upgradable
Non-Editable
Return Type
Upgradable
Developer Only
Arguments
Upgradable
Developer Only
Deluge Code
Upgradable
Developer Only

With Stand-alone Functions, you can define arguments, specify a return type, and invoke the functions as a REST API. However, for functions associated with other components in the Developer Console, these properties cannot be defined.

Changes and Impacts

When a packaged Function is modified, published, and pushed as an upgrade to subscriber accounts, the effects on subscriber orgs vary depending on the changes made. Following is a detailed breakdown of the changes and its impacts:  

1. Editing a Function

Updates to the function’s Name, Description, and Display Name will not impact the associated components in the subscriber organizations.
Changes to the function's code, arguments, or return type can significantly impact the custom action it performs within the subscriber's organization. Depending on the extent of the modifications, subscribers may observe changes in the behavior or functionality of the custom action. 

2. Deleting a Function

Deleting a function would entirely disrupt the automation and other associated components in the subscriber organizations. 

Warning
Caution! 

Deleting a Function is a destructive change. It can have lasting effects on your subscriber data and configurations. Please consider the consequences carefully before proceeding, and only move forward if absolutely necessary.

      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.

          Zoho CRM Training
            Redefine the way you work
            with Zoho Workplace

              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.

              Zoho CRM Training

                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







                              Quick LinksWorkflow AutomationData Collection
                              Web FormsEnterpriseOnline Data Collection Tool
                              Embeddable FormsBankingBegin Data Collection
                              Interactive FormsWorkplaceData Collection App
                              CRM FormsCustomer ServiceAccessible Forms
                              Digital FormsMarketingForms for Small Business
                              HTML FormsEducationForms for Enterprise
                              Contact FormsE-commerceForms for any business
                              Lead Generation FormsHealthcareForms for Startups
                              Wordpress FormsCustomer onboardingForms for Small Business
                              No Code FormsConstructionRSVP tool for holidays
                              Free FormsTravelFeatures for Order Forms
                              Prefill FormsNon-Profit
                              Intake FormsLegalMobile App
                              Form DesignerHRMobile Forms
                              Card FormsFoodOffline Forms
                              Assign FormsPhotographyMobile Forms Features
                              Translate FormsReal EstateKiosk in Mobile Forms
                              Electronic Forms
                              Drag & drop form builder

                              Notification Emails for FormsAlternativesSecurity & Compliance
                              Holiday FormsGoogle Forms alternative GDPR
                              Form to PDFJotform alternativeHIPAA Forms
                              Email FormsEncrypted Forms

                              Secure Forms

                              WCAG

                                      Create. Review. Publish.

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

                                      Get Started Now






                                                        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.




                                                            Manage your brands on social media


                                                              • Desk Community Learning Series


                                                              • Digest


                                                              • Functions


                                                              • Meetups


                                                              • Kbase


                                                              • Resources


                                                              • Glossary


                                                              • Desk Marketplace


                                                              • MVP Corner


                                                              • Word of the Day


                                                              • Ask the Experts


                                                                Zoho Sheet Resources

                                                                 

                                                                    Zoho Forms Resources


                                                                      Secure your business
                                                                      communication with Zoho Mail


                                                                      Mail on the move with
                                                                      Zoho Mail mobile application

                                                                        Stay on top of your schedule
                                                                        at all times


                                                                        Carry your calendar with you
                                                                        Anytime, anywhere




                                                                              Zoho Sign Resources

                                                                                Sign, Paperless!

                                                                                Sign and send business documents on the go!

                                                                                Get Started Now




                                                                                        Zoho TeamInbox Resources





                                                                                                  Zoho DataPrep Demo

                                                                                                  Get a personalized demo or POC

                                                                                                  REGISTER NOW


                                                                                                    Design. Discuss. Deliver.

                                                                                                    Create visually engaging stories with Zoho Show.

                                                                                                    Get Started Now









                                                                                                                        • Related Articles

                                                                                                                        • Related List

                                                                                                                          Related Lists are customizable components that allow you to associate a record with other records in your vertical application. They provide contextually relevant data from other modules or third-party integrations, displayed directly within a ...
                                                                                                                        • Sign-Up Function

                                                                                                                          The Sign Up Function enables developers to configure automated functions to be triggered when a user signs up for the application built using Vertical Studio. Using Sign Up functions, you can adjust various settings, automate initial setup, and ...
                                                                                                                        • Schedules

                                                                                                                          Schedules in Vertical Studio allow you to automate the execution of specific actions, either once or at recurring time intervals, in your application. You can execute actions like sending emails, updating records, or triggering workflows ...
                                                                                                                        • Components and Packaging in Zoho Vertical Studio

                                                                                                                          Components are fundamental building blocks of Vertical Studio applications, comprising functionalities, configurations, and customizations. These components, such as fields, modules, blueprints, widgets, and templates, work together to create a ...
                                                                                                                        • Upgrade Function

                                                                                                                          The Upgrade Function is a startup action in Zoho Vertical Studio that automatically triggers when a subscriber is upgraded to a new version. This function allows developers to execute custom logic during the upgrade process. This functionality is ...
                                                                                                                          Wherever you are is as good as
                                                                                                                          your workplace

                                                                                                                            Resources

                                                                                                                            Videos

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



                                                                                                                            eBooks

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



                                                                                                                            Webinars

                                                                                                                            Sign up for our webinars and learn the Zoho CRM basics, from customization to sales force automation and more.



                                                                                                                            CRM Tips

                                                                                                                            Make the most of Zoho CRM with these useful tips.



                                                                                                                              Zoho Show Resources