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
- Custom function is an efficient and time-saving method to perform repetitive tasks.
- 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.
- It allows you to automate certain processes like calling a webhook, sending notifications, or performing an action at the trigger of an event.
- The modular nature of the code makes it easier to manage and use them.
- Deluge comes with built-in functions to make scripting easier.
- Sprints provides a list of pre-built functions that allows you to execute a few default tasks.
- Enable Sprints to interact with third party services using a secure authentication mechanism.
Availability: Premier, Enterprise and Zoho One planGallery functions
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
Integrating with other services requires you to create a connection. Learn more.
- Create a connection for the Slack service with the scopes "chat:write:bot".
- Find 'slackconnection' & replace it with the connection name you've provided.
- Configure valid slack channel ID in "channelId" custom parameters on the left side.
- 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
Integrating with other services requires you to create a connection. Learn more.
- Create a connection for the ZohoCliq service with the scopes "ZohoCliq.Webhooks.CREATE".
- Find 'cliqconnection' & replace it with the connection name you've provided.
- Configure valid Cliq channel name in "channelUniqueName" custom parameters on the left side.
- Switch off Use Credentials of Login User while creating the connection.
Points to remember
- A maximum of 20 parameters can be included while creating a function.
- A maximum of 15 custom parameters can be included while creating a function.
- A function can be disabled or enabled.
- The name of the function cannot be modified once created.
- 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.
- A function will not be executed if it is disabled.
- Connections enable integration with other services. To create a connection, go to Automation and select Connections.
- A function can be manually executed but the parameter value will only be passed with 'null' value.
- Functions that are executed will be recorded under Function Logs.
- Function logs that are older than a month will be permanently deleted.
- You can try to execute a failed function thrice.
- You cannot execute a function that was already executed successfully.
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 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 Workerly Home
- Forums
- Connect With Us:
- Zoho Recruit Home
- Forums
- Connect With Us:
Centralize Knowledge. Transform Learning.
All-in-one knowledge management and training platform for your employees and customers.
New to Zoho Writer?
Create. Review. Publish.
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
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?
Zoho Sheet Resources
Zoho Forms Resources
New to Zoho Sign?
Zoho Sign Resources
Sign, Paperless!
New to Zoho TeamInbox?
Zoho TeamInbox Resources
New to Zoho ZeptoMail?
Design. Discuss. Deliver.
New to Zoho Workerly?
New to Zoho Recruit?
New to Zoho CRM?
New to Zoho Projects?
New to Zoho Sprints?
New to Zoho Assist?
New to Bigin?
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, ...Create and manage connections
You can create connections using the available default services or add a new service based on your requirement. Create connection To create connection: Click the gear icon at the top-right. The settings window will appear. Select Connections under ...View function logs
Function logs help you monitor those functions that have been deployed in your application. This will enable you to audit the status of the executed functions and the execution responses. When a function fails to be executed, you can view the ...
New to Zoho LandingPage?
Zoho LandingPage Resources