Kaizen 127 - Circuits in Zoho CRM - Part 2
Hello everyone!
We're back with part 2 of Circuits in Zoho CRM!
We are as excited as you are with this topic! Let's dive right in!
As promised, in today's post, we will discuss a use case, see how execution happens, and associate that circuit with a workflow.
In our next post(Yes! There's going to be another one!), we will associate the circuit with a button and a blueprint, view logs, and debug issues.
Sample use case - Loan Verification Process
Consider that we have a module in CRM called Customers, where we have personal information of customers, tax-related details, tax and personal ID verification details and status. Our aim is to check the requested loan amount, check eligibility, and then grant or reject it.
Here is a screenshot of a record in the Customers module.
Our condition is that whenever the loan amount is less than Rs. 500,000, the circuit should directly proceed to document verification. When the requested loan amount is greater than Rs. 500,000, we must check a few eligibility criteria before proceeding to document verification.
We can automate this entire process using Circuits, and execute it through a button, associate it with a workflow or a blueprint.
Let's take a look at the Circuit's flow.
Here are the different states of the Circuit that explain the logic.
- Get the loan record.
- Check the loan amount.
- If the loan amount is less than Rs. 500,000, proceed to document verification.
- If the loan amount is greater than Rs. 500,000, check the tax filing status.
- If tax is not filed, update the record's Loan Eligibility field with the value "Tax not filed. Hence, not eligible for loan".
- If tax is filed, fetch the applicant's credit score and check the eligibility.
- If the credit score falls short, update the record's Loan Eligibility field with the value "Issue with credit score".
- If the credit score is up to the mark, proceed to document verification—Personal ID and Tax ID verification.
- Update the details of the record to sanction the requested loan.
Let's discuss each of these states in detail.
1. Get the loan record
Builder View
Type: Get Record from Zoho CRM's states.
Action: Gets the details of the loan record from the Customers module. The output is in the following format.
{ "ZohoCRM": { "record_id": "5575270000005762031", "user_id": "5575270000005379053", "module": { "api_name": "Customers", "tab_label": "Customers", "id": "5575270000001975002" } }, "record": { "data": [ { "Owner": { "name": "Patricia Boyle", "id": "5575270000001947001", "email": "p.boyle@zylker.com" }, "$currency_symbol": "$", "Tax_ID_Verification_Message": "Tax ID Verified Successfully", "$review_process": { "approve": false, "reject": false, "resubmit": false }, "$sharing_permission": "full_access", "Personal_ID_Number": "464694660655", "Personal_ID_Verification_Message": "Personal ID Verified Successfully", "Name": "Stephen Adams", "Manual_Approval": "Depends on score", "$state": "save", "$process_flow": false, "Tax_Score_Status": "Score is eligible for Loan", "$locked_for_me": false, "Tax_ID_Number": "GBHPS3618H", "id": "5575270000005762031", "Tax_ID_Verified_Date": "2024-02-26", "Loan_Eligibility": "Eligible for Loan", "$approval": { "delegate": false, "approve": false, "reject": false, "resubmit": false }, "Modified_Time": "2024-02-29T12:26:11+05:30", "Tax_ID_Verification_Status": "Verified", "Tax_Return_Availability": "Yes", "Tax_ID_Verified_Time": "2024-02-26 23:28:39.0", "Personal_ID_Verified_Time": "2024-02-26 23:28:39.0", "Created_Time": "2024-02-29T12:26:11+05:30", "Amount": 600000, "$editable": true, "Personal_ID_Reference": "6cefa3d4-b87b-46a6-8814-b21fb422a28d", "$orchestration": false, "Tax_ID_Reference": "f6697aa8-8efc-4ee9-8dcc-0bc838755cb4", "Tax_Score": 450, "Personal_ID_Verification_Status": "Verified", "Personal_ID_Verified_Date": "2024-02-26", "$in_merge": false, "Locked__s": false, "Tag": [], "$zia_owner_assignment": "owner_recommendation_unavailable", "$approval_state": "approved", "$pathfinder": false } ] } } |
You can use any part of this output as input to other states. You can achieve this by using the JSON Path expression in the “result path” to traverse the result JSON of the state.
Result path allows you to combine state result with state input to pass as output. You can add the result path in the "Input/Output" section in the Builder view as well as the JSON in Code view.
In our case, we want to use the data inside the “record” JSON object. So, the result path will be $.record.
Result path is mandatory when you use the Get Record Zoho CRM state.
Next state: Check Loan Amount
Code View
2. Check Loan Amount
Builder View
Type: Branch
Action: Checks for the condition specified in the branch—check if the loan amount < 500,000. If yes, and Go to Documents verification state, else go to Check tax filing status state.
Next state: Check Tax filing status(if loan amount > 500,000)
Code View
3. Check Tax Filing Status
Builder View
Type: Branch
Action: Checks for the condition specified in the branch—if the tax filing status is Yes, fetch the credit score. Else, update the record with "Tax not filed; not eligible for loan".
Next state: Fetch Applicant Credit Score
4. Fetch Applicant Credit Score
Builder View
Type: Function
Action: Executes the CRM function "Tax Score Check" that holds the logic to get the basic eligibility stored in the Org variable "eligibility", compare it with the tax score of the applicant, and update the record, accordingly. Here is the snippet of this function.
Next state: Check eligibility of Credit Score
Code View
5. Check eligibility of Credit Score
Builder View
Type: Branch
Action: Checks for multiple conditions—if Tax Score Status = Eligible, go to Document Verification.
If Tax Score Status = Not eligible & the value of the field "Manual Approval" = "Not approved", update the record with "Issue in Tax Score".
If Tax Score Status = Not Eligible & "Manual Approval" = "Approved", proceed to document verification.
Next state: Depends on the condition that is met in the "Check Tax Score Eligibility" state.
Code View
6. Documents Verification Process
Builder View
Type: Parallel
Action: Verifies the Tax ID and Personal ID of the applicant.
Next state: Verification Details - Update Record
Code View
7. Tax ID Verification
Builder View
Type: Function
Action: Executes the function "Tax ID Verification" that has the logic to verify the tax details of the applicant.
Here is the snippet of this function.
Next state: Verification Details - Update Record
Code View
8. Personal ID Verification
Builder View
Type: Function
Action: Executes the function "Personal ID Verification" that has the logic to check for the applicant's personal details.
Here is how the function looks.
Next state: Verification Details - Update Record
Code View
9. Verification Details - Update Record
Builder View
Type: Function
Action: Executes the function "Update Customer Record status" that uses the Deluge Update Record integration task to update the "Loan eligibility" field.
Here is how the function looks.
Next state: End
Code View
10. Update Record - Tax Not Filed, Not Eligible
Builder View
Input/Output
Type: Function
Action: When the requested loan is greater than Rs.500,000 and the Tax Filing Status in "Not Filed", this state executes the function "Update Customer Record status". This function uses the Deluge Update Record integration task to update the "Loan eligibility" field, and takes the parameters "rec_id" and "loan_eligibility" with the values "$.ZohoCRM.record_id" and "Tax Filing is missing, Hence not eligible for the loan.", respectively.
Next state: End
Code View
11. Update Record - Issue with Credit Score
Builder View
Type: Pass
Action: When the tax score eligibility does not meet the requirement, this state ends the circuit's execution.
Next state: End
Code View
Testing and Execution
Let us see the execution of this circuit with a sample record ID.
When you click each state, you can see the input and output of that state.
When you click "View Logs", you can see how execution has happened, the payload for each state, the response, etc.
Associating this Circuit with a Workflow
Follow the steps mentioned in this article to create a workflow.
The condition for this workflow to execute the circuit is when the requested loan is greater than Rs. 500,000.
The Action is to execute the circuit. Choose the option "Execute Circuit" from the Instant Actions and select the Verification Process Circuit.
Save the workflow.
Let's test this workflow by creating a record in the Customers module with the loan amount less than Rs. 500,000.
As you can see, the workflow is triggered and executes the circuit when the loan amount is less than Rs. 500,000.
You can view the circuit's execution and other details as a related list.
Summary
Circuits allow you to automate entire business processes by allowing you to orchestrate functions along with your business logic as you see fit.
As you witnessed in this example, we used multiple independent functions written in CRM to achieve our business case through utilizing them in a circuit. This gives you the benefit of writing functions that can be reused in multiple places while saving you from the grief of dealing with huge volumes of code that are hard to maintain and harder to debug when written as a single function.
We hope you liked this post. We'll see you next week with another post on Circuits.
Let us know if you have any questions or feedback. We are listening!
Cheers!
Shylaja S
Additional Reading:
Access your files securely from anywhere
Zoho Developer Community
New to Zoho LandingPage?
Zoho LandingPage Resources
New to Zoho Survey?
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
New to Bigin?
Topic Participants
Shylaja S
Sticky Posts
Kaizen#162 : Add Tags and Open Pre-filled Email Drafts via Client Scripts
Hello everyone! Welcome to another informative Kaizen post. In this post, let us see how to accomplish the following using Client Script. 1. How to auto-tag a record based on field update? 2. How to Open a pre-filled email draft This post will provideClient Script | Update - Introducing Commands in Client Script!
Have you ever wished you could trigger Client Script from contexts other than just the supported pages and events? Have you ever wanted to leverage the advantage of Client Script at your finger tip? Discover the power of Client Script - Commands! CommandsExtension Pointers - JS SDK series #4: Managing data from a widget using ZOHO.CRM.HTTP
Handling and managing the data between two applications is a major factor for an efficient business. There are a variety of ways to handle data between Zoho CRM and other third-party applications. You can use deluge CRM tasks, create connectors, use APIKaizen #152 - Client Script Support for the new Canvas Record Forms
Hello everyone! Have you ever wanted to trigger actions on click of a canvas button, icon, or text mandatory forms in Create/Edit and Clone Pages? Have you ever wanted to control how elements behave on the new Canvas Record Forms? This can be achievedExtension pointers for integrating Zoho CRM with Zoho products #8: Upload and manage Zoho Workdrive folders and files from within Zoho CRM
Keeping records on your customers and business prospects is essential for tracking data, conducting follow-ups, and running a business smoothly. When you use two separate applications, and store relevant data in each, checking and tracking data becomes
New to Zoho TeamInbox?
Zoho TeamInbox Resources
Zoho DataPrep Resources
Zoho CRM Plus Resources
Zoho Books Resources
Zoho Subscriptions Resources
Zoho Projects Resources
Zoho Sprints Resources
Qntrl Resources
Zoho Creator Resources
Zoho Campaigns Resources
Zoho CRM Resources
Design. Discuss. Deliver.
Zoho Show Resources
Get Started. Write Away!
Writer is a powerful online word processor, designed for collaborative work.
Zoho CRM コンテンツ
-
オンラインヘルプ
-
Webセミナー
-
機能活用動画
-
よくある質問
-
Ebook
-
-
Zoho Campaigns
- Zoho サービスのWebセミナー