Custom functions help in automation where procedural logic is required, which cannot be implemented with the default actions such as, Tasks, Webhooks, etc. With custom functions you can automatically update the data in the related Zoho Recruit modules or third-party applications by executing simple program scripts.
When a record matches the workflow criteria, Zoho Recruit automatically triggers the custom function and updates the Zoho Recruit records. With custom functions, you can program scripts using Deluge Scripting Language, associate them to workflow rules, and automate the business process.
Setting up a custom function includes the following steps:
- Create a custom function
- Test the custom function for accuracy.
- Associate the custom function with a Workflow Rule.
Target Audience
- Developers who set up custom workflow automation for Zoho Recruit.
- Programmers with REST API and Deluge Script skills.
Create Custom Functions
Custom functions are written using deluge scripting language to effectively manipulate data, communicate with third-party applications, and update responses in Zoho Recruit.
To create a custom function,
- Log in to Zoho Sigma console and click Extensions.
- Select the extension you'd like to modify and click Edit Extension.
You will be navigated to the Zoho Developers console. - Click Automation in the left pane of the Extension Details page and click Workflow.
- Select Custom Functions tab at the top of the page.
- In the Workflow Custom Functions page, click Configure Custom Function.
You can use a pre-written custom function or start one from scratch. - In the Workflow Custom Functions dialog box, do the following:
- Specify a name for the custom function.
- Select the module for which you want to trigger the custom function.
Note
Make sure you associate the custom function to the workflow rule that is created for the same module.
- In the deluge script editor, write the function.
- Click Save.
Test Custom Functions
Before you associate the custom function to a workflow rule, it is better to check if the function works properly. The custom function details page has an option for testing the custom functions by executing it.
To test the custom function,
- Log in to Zoho Sigma console and click Extensions.
- Select the extension you'd like to modify and click Edit Extension.
You will be navigated to the Zoho Developers console. - Click Automation in the left pane of the Extension Details page and click Workflow.
- Select the Custom Functions tab at the top of the page.
- From the list of custom functions, select the one that you want to test.
- In the View Workflow Custom Functions page, click Edit.
- Click Execute to test the custom function.
- In the Execute Script pop-up, enter the values and click Submit to test if the custom function is working properly.
Associate Custom Function to a Workflow Rule
The custom function that you create should be associated with a workflow rule. Whenever a record matches the criteria in a workflow rule and the workflow rule is triggered, the associated custom function will also be automatically executed.
To associate custom function to a workflow rule,
- Log in to Zoho Sigma console and click Extensions.
- Select the extension you'd like to modify and click Edit Extension.
You will be navigated to the Zoho Developers console. - Click Automation in the left pane of the Extension Details page and click Workflow.
- Select the Custom Functions tab at the top of the page and click Create Rule.
- In the New Rule page, specify the basic details and other workflow rule parameters.
- Under Actions, associated the already created custom function as an instant action or a time-based action.
- Click Save.
Manage Custom Functions
You can edit and delete the custom functions that you created as per your requirements.
To edit/delete custom function,
- Log in to Zoho Sigma console and click Extensions.
- Select the extension you'd like to modify and click Edit Extension.
You will be navigated to the Zoho Developers console. - Click Automation in the left pane of the Extension Details page and click Workflow.
- Select the Custom Functions tab at the top of the page.
A list of custom functions will be available. - Move your mouse pointer to a custom function for the following options:
- Edit - Click Edit icon to make changes to the custom function.
- Delete - Click Delete icon to delete the function. If you have associated the custom function to any workflow rule(s), please disassociate it before deleting.