Related Lists

IN THIS PAGE

  1. Custom related lists overview
  2. Create a custom related list
  3. Manage custom related lists

1. Custom related lists overview 🔗

A Related List in Bigin is a record that is associated with a parent or master record and ensures the data remains connected and accessible. Bigin Developer Console provides customizable related lists that can be associated with a parent record. These customizable related lists allow you to collect and display the useful information collected from various sources. For example, a Contact record in Bigin contains associated records such as Timeline, Notes, Activities, Emails, Social, Deals, and Files. In Bigin, the pre-defined and custom related lists are displayed on the Details page of a module.

2. Create a custom related list 🔗

To add a custom related list, access the Bigin Developer Console and navigate to Components > Related Details.

Click Add Related List. A Deluge Script editor appears, which allows you to add custom logic for the related list.

Provide the Related List Name, and then from the drop-down list, select a module.

In the Deluge Script editor, provide your logic for the custom related list function, and then click Save & Close.

Here's the sample function for a custom related list that displays deals associated with the company of the Pipeline record:

Sample Deluge code snippet

CopieddealId = pipeline.get("Deals.ID");
//Get Deal Details
dealMap = zoho.bigin.getRecordById("Pipelines", dealId, Map(), "customrelatedrecords__relatedlist");
//Get the account associated to the deal
company = dealMap.get("data").get(0).get("Account_Name");
if (!isnull(company)) {
    companyId = company.get("id");
    //Get all deals related to the company
    queryParam = Map();
    queryParam.put("fields", "Deal_Name,Stage,Amount,Closing_Date");
    relatedDeals = zoho.bigin.getRelatedRecords("Deals", "Accounts", companyId, queryParam, "customrelatedrecords__relatedlist");
    relatedDeals = relatedDeals.getJson("data");
    if (relatedDeals.size() > 0) {
        rowVal = 0;
        responseXML = "";
        responseXML = responseXML + "<record>";
        for each deal in relatedDeals {
            responseXML = responseXML + "<row no='" + rowVal + "'>";
            if (!deal.get("id") == dealId) {
                responseXML = responseXML + "<FL val='Deal Name'>" + deal.get("Deal_Name") + "</FL>";
                responseXML = responseXML + "<FL val='Stage'>" + deal.get("Stage") + "</FL>";
                responseXML = responseXML + "<FL val='Amount'>" + deal.get("Amount") + "</FL>";
                responseXML = responseXML + "<FL val='Closing Date'>" + deal.get("Closing_Date") + "</FL>";
            }
            responseXML = responseXML + "</row>";
            rowVal = rowVal + 1;
        }
        responseXML = responseXML + "</record>";
    } else {
        responseXML = "<error><message>No Other Deals</message></error>";
    }
} else {
    responseXML = "<error><message>No company is associated to this deal</message></error>";
}
info responseXML;
return responseXML;

How to configure the function to show related lists in Bigin 🔗

The sample function above shows that the response is returned in XML format. This confirms that configuring the result in XML format ensures the correct display of related lists and their data in Bigin.

In order to show the related list in a readable format, the function must return a defined XML format for Bigin.

You can use this format to construct any related list in functions:

Copied<response>
    <status> success </status>
    <record>
        <row>
            <FL val="Column_Name_1">Row_Data_Value_1</FL>
            <FL val="Column_Name_2">Row_Data_Value_2</FL>
        </row>
        <row>
            <FL val="Column_Name_1">Row_Data_Value_1</FL>
            <FL val="Column_Name_2">Row_Data_Value_2</FL>
        </row>
    </record>
</response>

You can use this format to construct the error messages in functions:

Copied<response>
    <status> Failed </status>
    <error>
        <message>
            Oops something went wrong, Please try after some time.
        </message>
    </error>
</response>

3. Manage custom related lists 🔗

After you create a custom related list for a topping in a module, you may need to update or delete it later on. In such cases, you can edit and delete the custom related lists from the toppings.

To edit a custom related list, access the Bigin Developer Console, navigate to Components > Related Details, and select the module.

Hover over the custom related list you want to modify and Click the Edit icon.

After updating the details and function logic, save the changes.

To remove a custom related list, hover over the custom related list you want to remove and click the Delete icon.

Confirm the deletion. This results in permanent loss of data.