Related List in Zoho Vertical Studio | Vertical Studio Help Guide
Related List
Related Lists are customizable components that allow you to associate a record with other records in your vertical application. They provide contextually relevant data from other modules or third-party integrations, displayed directly within a record's detail page. This provides a holistic view of a record by consolidating all relevant information in one place, which improves user experience and decision-making.
In addition to the pre-defined Related Lists available in a module, you can create custom Related Lists in two ways:
- Using a custom Deluge Function
- Embedding a widget into the Related List as an iframe.
Function-Related List
You can create a Related List using a custom Deluge Function to map a module and display specific data. To create a Related List using function,
- Log into your application and navigate to Build > Components.
- Shift to the Related Lists tab and click Add Related List.
- In the Deluge code editor, define the following in the top bar:
- Related List Name: The name of your Related List.
- Module: The module to which you want to map the Related List.
- Write your custom Deluge function logic to fetch and display the desired data.
- Click Save and Close.
Check the Functions help page for additional guidance and packaging behavior.
Example
Below is a sample Deluge function code to create a Related List named Similar Customers in the Vehicles module. This Related List displays customers who own the same vehicle model as the parent record.
vehicleId = vehicle.get("Vehicles.ID"); vehicleRecord = zoho.crm.getRecordById("Vehicles",vehicleId.toLong()); vehicleName = vehicleRecord.get("Name"); crmResp = zoho.crm.searchRecords("Vehicles","(Name:equals:" + vehicleName + ")",1,10); //info crmResp ; responseXML = ""; rowVal = 0; if(crmResp.size() > 1) { responseXML = responseXML + "<record>"; for each vehicle in crmResp { data = vehicle.get("Vehicle_Contact_1"); contactId = data.get("id"); contactRecord = zoho.crm.getRecordById("Contacts",contactId); contactPhone = contactRecord.get("Phone"); contactName = contactRecord.get("Last_Name"); responseXML = responseXML + "<row cnt='" + rowVal + "'><FL val='Customer Name'>" + contactName + "</FL><FL val='Customer Phone'>" + contactPhone + "</FL></row>"; rowVal = rowVal + 1; } responseXML = responseXML + "</record>"; } else { responseXML = responseXML + "<error>=><message>No other customer has a vehicle with the same model.</message></error>"; } return responseXML; |
Widget-Related List
A Widget-Related List allows you to embed custom widgets within the Related List as an iFrame. These widgets can embed external applications or display dynamic content directly within the application.
Refer to the Widgets help page for more details.
Packaged Related Lists
Packaged Related Lists are created in the developer console and deployed to subscriber organizations during signup or through upgrades. Any new Related list that is created in the developer console will be included in the next version of the application.
To know more about packaging, please refer to our guide on Components Packaging in Zoho Vertical Studio.
The following table explains the upgrade behavior of an existing packaged Related List already deployed in the subscriber's organization.
Property | Upgrade Type | Modify Access |
Related List Name | Upgradable | Developer Only |
Module | Non-Upgradable | Non-Editable |
Function Code | Upgradable | Developer Only |
Connected App
| Upgradable | Developer Only |
Changes and Impacts
When a packaged Related List is modified, published, and pushed as an upgrade to the subscribers' accounts, the impacts to the existing records in the subscriber organization are explained below.
1. Editing a Related List
Changing the Related List name does not affect the associated records. The related records will still appear, but under the updated name.
Modifying the function code or widget code can impact the related records displayed, depending on the extent of the changes made.
2. Deleting a Related List
Deleting a Related List can result in the loss of visibility to relevant data for the parent record. Once deleted, the associated data will no longer be accessible through the Related List.
Caution!
Deleting a Related List is a destructive change. It can have lasting effects on your subscriber data and configurations. Please consider the consequences carefully before proceeding, and only move forward if absolutely necessary.
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:
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
Widgets
Widgets help you extend your vertical application's functionality by embedding or integrating third-party applications. It enables you to pull real-time data from external resources to improve decision-making and streamline workflows within the ...Functions
Functions are custom scripts in Vertical Studio that help address complex business requirements in your application. They are written using Deluge (Data Enriched Language for the Universal Grid Environment). The Deluge scripts can be used for a wide ...Components and Packaging in Zoho Vertical Studio
Components are fundamental building blocks of Vertical Studio applications, comprising functionalities, configurations, and customizations. These components, such as fields, modules, blueprints, widgets, and templates, work together to create a ...Managing List Views
A List View is grouping of records based on a defined set of criteria in your application. They are beneficial for displaying customer specific data according to your business requirements. Vertical Studio provides a set of pre-defined standard list ...Zoho Vertical Studio - Overview
Zoho Vertical Studio is a robust low-code platform designed to help developers and businesses create, customize, and deliver SaaS applications tailored to the unique needs of specific industries. By offering an extensive suite of pre-built tools, ...
New to Zoho LandingPage?
Zoho LandingPage Resources