Associate Functions

Associate Functions

Associate Functions

  • Business Scenarios
  • Target Audience
  • Set Up Functions
  • Business Scenario
  • Refer Error Codes


The CRM Functions help you to update the data in related CRM modules or third-party applications by executing simple program scripts. When a record matches the workflow criteria, workflow engine automatically triggers the function and update the CRM records. With Functions, you can program scripts using Deluge Script (powered by Creator), associate them to workflow rules, and automate the business process.

Business Scenarios

  • Roll up amount from each deal (status is closed won) to Total Revenue (custom field) to the related Account. If customer makes 10 payments, you can view the total revenue from Account page, instead of creating a report. Based on the total revenue generated from customer, you can grade them type A, type B, type C customers.
  • Create a project in  Projects or any 3rd-party project management application when the deal is won and closed in CRM. Also, view the project link under an Account or Deal record to monitor the progress of the project.
  • Automatically update the address information of contacts based on the mailing address of the parent account.
  • When the deal status is "closed won", push the deal, related contact and account details to Books or any 3rd-party accounting software. Once status of the invoice is changed to "paid" in accounting software, instantly update Deal record in CRM.

Target Audience

  • CRM Administrators who set up workflow rules for Users
  • Programmers with REST API and Deluge Script skills
Availability
Permission Required
Users with Manage automation permission in their profile can access this feature.

Set Up Functions

You can set up Functions in three steps:

  • Create a function.
  • Associate function to a workflow rule.
  • Test Functions integration.

To create a function

  1. Go to Setup > Automation > Workflow Automation > Function.
  2. In the Workflow Functions page, click the Configure function.
  3. In the Configure function page, select a function from Gallery, existing function or write a new one using Deluge Script.
    Custom Function
  4. Click Save.

To associate function to a workflow rule

  1. Go to Setup > Automation > Workflow Automation > Rules.
  2. In the Workflow Rules page, click the Create Rule.
  3. In the Create New Rule tab, specify workflow rule parameters.
  4. Select function, under Instant Actions.
  5. Now select the function to be triggered.
  6. Click Save.
    Custom Function

To test the function integration

  1. Add test data in the CRM according to your workflow rule criteria.
  2. Check for the data received from the CRM via function, in your application.
  3. Modify your function code in the CRM, if data is not received or if there is a data mismatch.
  4. Continue this test until you obtain the required data from the CRM to your Application.

Important Notes

  • You can associate up to 6 (1 Instant Action and 5 Time-Based Actions) Functions per workflow rule.
  • You can execute only 5000 lines (Statements) in a single function call.
  • You can transfer data for a maximum of 10 CRM fields from the CRM to third-party applications using function.
  • You can retrieve data from other Apps to the CRM using function.
  • You must update the API ticket regularly according to limits in third-party applications.
  • You will not receive any email notification, if the function integration stopped functioning due to any issue in a third-party API.
  • If there is any failure while connecting to Creator service, function will send the second notification after 15 min. Thereafter, the system will not send any notifications for that particular workflow trigger. Errors returned from Creator are shown under Reason for Failures section.
  • If you exceed the maximum count per day, the system will not send remaining function notifications to third-party applications and will notify the failure to Administrator.
  • The CRM will the send the data in following standard format for Date and Date Time fields to third-party applications:
    • Date: yyyy-MM-dd
    • Date Time: yyyy-MM-dd hh:mm
  • Limits for Functions:
    • Calls per Day - 20000 calls/day or 200 calls per user license for the org. (whichever is lower)
    • Integration Tasks - 25000 API calls/day using deluge.
    • Get Data & Post Data - 25000 calls/day (totally) 
    • Send Email - 1000 emails/day

Business Scenario

Roll up the deal amount to parent account

Summary

Roll-up amount from each deal (status is closed won) to Total Revenue (custom field) to related Account. If customer buys 10 times, You can see the total revenue from Account page, instead of pulling a report. Based on the Revenue from customer, later you can grade them type A, type B, or type C customers.

To configure this function, follow these steps:

  1. Log in to the CRM.
  2. Open Setup > Automation > Workflow Automation > Rules > Create a workflow rule for the Deals module.
  3. Click Next.
    Custom Function
  4. Choose when you want to execute this rule. Now select Create or Edit option under execute based on a record action.
    Custom Function
  5. Click Done.
  6. Choose to which records you want to execute the rule. Select Records Matching the condition option and set the criteria as "Stage contains closed won".
    Custom Function
  7. Click Done.
  8. Now choose function as Instant action.
    Custom Function
  9. In the Configure function pop-up, click the Gallery link.

  10. In the Gallery page, click Configure for Roll-up Deal Amount to Account function.

  11. Specify values for the arguments as mentioned below:
    • Account-id: Choose "AccountId" column from the list of fields.
    • SumUpField: Specify the field you have in accounts module for the summation.
    • Click "Specify custom value" link and type your field name.

  12. Save the configuration. This will now automatically update the sum of the revenue generated by all the deals of an account in the account module.

Refer Error Codes

When the execution of function fails, one of the following error messages will be displayed in the CRM:

HTTP Status Codes

  • 400 Bad Request - Often missing a required parameter.
  • 401 Unauthorised - No valid API key provided.
  • 402 Request Failed - Parameters were valid but request failed.
  • 404 Not Found - The requested item doesn't exist.
  • 500, 502, 503, 504 Server errors - Error in the third-party application.
  • Error Code 1 - Temporarily not able to connect to the API server. Check API server logs, firewalls settings for requests sent from CRM.

Custom Errors

  • Internal process failure - When the function is not executed due to errors in processing of the script.
  • Day limit reached - When the company has reached the maximum limit for the day.
  • Deluge Script - When the execution of workflow triggers fail due to errors in Deluge Script.

View Functions Usage Graph

The CRM provides graphs that show the daily or weekly usage statistics of Functions across various features. You can view the alert usage from Settings > Setup > Automation > Actions > Functions.

The More Info link provides detailed information on the usage stats. Please note that the graph will cover the usage stats of the past 7 days.




    • Related Articles

    • Functions in Formula Fields

      Functions in Formula Fields Function performs a specific operation on values that you specify and generates a new value. To compose a function, you need to type the function name, followed by a set of parentheses(). The CRM formula type custom field ...

    • Creating Actions in Workflow Rules

      Creating Actions in Workflow Rules The CRM allows you to create specific set of actions that aide in automating your sales and marketing activities. There are totally 5 actions that you can create and these actions can be associated with Workflow ...

    • Automating Workflows - An Introduction

      Automating Workflows - An Introduction Workflow management helps you to automate your sales, marketing and support. You can automatically assign tasks to users, based on the criteria defined in the rules and update certain fields.  Workflow ...

    • Configuring Workflow Rules

      Configuring Workflow Rules Create Workflow Rules in Zoho CRM Part 1 - Enter the basic details of the rule Part 2 - Specify the rule trigger Part 3 - Create a workflow condition Part 4 - Associate instant and scheduled actions Associate Actions to ...

    • Creating Formula Fields

      Creating Formula Fields Create Numeric Formula Field Create String Formula Field Create DateTime Formula Field Create Boolean Formula Field Formula Syntax Reference Formula fields are used to calculate different types of values, including numeric ...