About custom functions | Zoho Sprints Help

About custom functions

Zoho Sprints comes with the capability for you to create custom functions and automate your business process.

A Custom Function is composed of a group of deluge statements that are combined to perform a certain task. This function can be invoked within an application whenever that particular task needs to be performed. Using functions, you can create modules of deluge scripts that can be used in multiple instances. Multiple functions can come together to perform a string of tasks.

Another important aspect is that functions can help your application interact with third party services, allowing you to update data in two separate applications with the script in one application. Zoho Sprints offers two types of functions: Automation and Standalone functions.

Benefits of using custom functions

  1. Custom function is an efficient and time-saving method to perform repetitive tasks.
  2. A chunk of deluge scripts with the aim of executing a particular task are encapsulated and implemented at multiple events, making it a reusable entity.
  3. It allows you to automate certain processes like calling a webhook, sending notifications, or performing an action at the trigger of an event.
  4. The modular nature of the code makes it easier to manage and use them.
  5. Deluge comes with built-in functions to make scripting easier.
  6. Sprints provides a list of pre-built functions that allows you to execute a few default tasks.
  7. Enable Sprints to interact with third party services using a secure authentication mechanism.
Gallery functions are predefined functions that are provided to enable you to start automating certain tasks. These are templates that you can start tweaking to suit your requirement and create a function. These provide solutions to specific use cases that are likely to come up during the course of your project in Sprints.



The following are the prebuilt functions:

Update Release status when an item is reopened or closed

This function is used to update the release status as Closed when all work items associated with that release are closed or to update the release status as Open when any of the associated work items are reopened.

Module: Item

Trigger Event: Item Closed, Item Reopened
 

Close parent item if all its subitems are closed

This function is used in the case of a parent item with multiple subitems. Executing this function will close the parent item when all its subitems are closed.

Module: Item

Trigger Event: Item Closed
 

Update Epic status when an item is reopened or closed

This function is used to archive an epic when all the work items associated with that epic are closed or to activate an archived epic when any of the associated work items are reopened.

Module: Item

Trigger Event: Item Closed, Item Reopened
 

Add status update note on linked items

This function is used to add item notes on all the linked items when an item's status is updated. Work items can be linked with one another. When the status of a work item is updated, that update can be added as an item note in the work items that are linked to it. This way, the web of work items remains up to date automatically.

Module: Item

Trigger Event: Item Updated, Item Closed, Item Reopened
 

Notify users mentioned in the comment via email

This function is used to automate email notifications to the email addresses of the users tagged in a comment.

Module: Item Comments, Sprint Comments, Meeting Comments

Trigger Event: Item Comment Add, Item Comment Update, ItemComment Delete, Sprint Comment Add, Sprint Comment Update,
Sprint Comment Delete, Meeting Comment Add, Meeting Comment Update, and Meeting Comment Delete
 

Post a message on Slack Channel

This function enables you to integrate Sprints with Slack, an external office communication service. You could have messages posted on Slack at the trigger of events like closing a work item, reopening a work item, starting a sprint, and more. So when an event is triggered, you can notify your team on Slack channel that is meant for your sprint team.

Module: All modules

Trigger Event: All events
Notes
Integrating with other services requires you to create a connection. Learn more.
  1. Create a connection for the Slack service with the scopes "chat:write:bot".
  2. Find 'slackconnection' & replace it with the connection name you've provided.
  3. Configure valid slack channel ID in "channelId" custom parameters on the left side.
  4. Switch off Use Credentials of Login User while creating the connection.

Post a message on Cliq Channel

This function enables you to integrate Sprints with Cliq, another Zoho service which is an office communication system. You could have messages posted on Cliq at the trigger of events like closing a work item, reopening a work item, starting a sprint, and more. So when an event is triggered, you can notify your team on Cliq channel meant for your sprint team.

Module: All modules

Trigger Event: All events
Notes
Integrating with other services requires you to create a connection. Learn more.
  1. Create a connection for the ZohoCliq service with the scopes "ZohoCliq.Webhooks.CREATE".
  2. Find 'cliqconnection' & replace it with the connection name you've provided.
  3. Configure valid Cliq channel name in "channelUniqueName" custom parameters on the left side.
  4. Switch off Use Credentials of Login User while creating the connection.

Points to remember

  1. A maximum of 20 parameters can be included while creating a function.
  2. A maximum of 15 custom parameters can be included while creating a function.
  3. A function can be disabled or enabled.
  4. The name of the function cannot be modified once created.
  5. When a function execution fails continuously for 15 times, a Function Disable Alert email will be sent to the team owner and to those who created and updated the function.
  6. A function will not be executed if it is disabled.
  7. Connections enable integration with other services. To create a connection, go to Automation and select Connections.
  8. A function can be manually executed but the parameter value will only be passed with 'null' value.
  9. Functions that are executed will be recorded under Function Logs.
  10. Function logs that are older than a month will be permanently deleted.
  11. You can try to execute a failed function thrice.
  12. You cannot execute a function that was already executed successfully.

      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

                                                              Use cases

                                                              Make the most of Zoho Desk with the use cases.

                                                               
                                                                

                                                              eBooks

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

                                                               
                                                                

                                                              Videos

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

                                                               
                                                                

                                                              Webinar

                                                              Sign up for our webinars and learn the Zoho Desk basics, from customization to automation and more

                                                               
                                                                
                                                              • Desk Community Learning Series


                                                              • Meetups


                                                              • Ask the Experts


                                                              • Kbase


                                                              • Resources


                                                              • Glossary


                                                              • Desk Marketplace


                                                              • MVP Corner

                                                                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

                                                                                                                        • Manage custom functions

                                                                                                                          You can perform the following actions for functions: Create function Edit function Delete function Create function from gallery Create function To create custom function: Click the gear icon at the top-right. The settings window will appear. Select ...
                                                                                                                        • Execute standalone functions

                                                                                                                          Use standalone functions to process data that are operated by external parameters. Zoho Sprints provides the ability to create functions and use REST APIs to execute them to arrive at simple business solutions. These functions can be triggered from ...
                                                                                                                        • Merge and store documents using Zoho Writer

                                                                                                                          You can now use template functions to merge and store documents using Zoho Writer. The document template is built using the fields being merged from Zoho Sprints. The in-built deluge functions deliver the values to the merge fields in the document, ...
                                                                                                                        • Zoho Sprints Quickstart Guide

                                                                                                                          Zoho Sprints is a project management tool that functions on the principles of Agile Scrum methodology. Here, each project is divided into multiple phases. Each phase comprises select work items for the team to complete. When those work items are ...
                                                                                                                        • Custom domain

                                                                                                                          A domain is the text that you key into the address bar when you're trying to locate a source on the web. If you want to locate Zoho's website you will enter https://www.zoho.com on the browser. Like all other Zoho applications, Zoho Sprints is hosted ...
                                                                                                                          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