Customization - Adding Custom Related Lists

Customization - Adding Custom Related Lists

This guide will help you with the following:
  1. Add Custom Related Lists
  2. Create Custom Functions 
  3. Example 
  4. Edit Custom Related Lists  
  5. Delete Custom Related Lists 
Each record created by your subscribers in your vertical CRM has the option to associate other records to it. For example, a Contact has notes, activities, potentials, products, attachments, etc. associated to it. These are called Related Lists and are provided by default but you can also have custom related list added to a record. Custom Related Lists helps your customer view data collected from other sources. You can add new related list or customize the existing related list.

Create Custom Functions

In addition to the pre-defined related lists, you can also create new related list by writing your own custom functions using DELUGE script. See Also Deluge Scripts, Functions 

Deluge Script

Deluge or Data Enriched Language for the Universal Grid Environment as we call it, is an online scripting language integrated with Zoho Creator. It enables users to add logic to the application, incrementally, making it more powerful and robust. The entire database layer is abstracted and you will only speak in terms of forms and fields, while scripting in Deluge. Read more 

Custom Function

A function is a set of statements grouped together under a name and can be invoked from anywhere within a program. Deluge Scripting supports Functions, using which we can structure the deluge script, in a more modular way, accessing all the potential that structured programming can offer. Related functions can also be grouped under a common category based on their purpose, called names pace, which helps in easy maintenance. Functions can be invoked from form/field action scripts or on selected records in a view. Read more 

To create a custom function

  1. Log in to Zoho Developer Console and click Vertical Solutions
  2. In the Vertical CRM page, select the application in which the related list has to be edited and click Edit.
  3. Click Components in the left pane and select Related List tab at the top of the page and click Custom.
  4. In the Add Related List page, click Add Related List.
  5. In the Workflow Custom Related List page, do the following:
    1. Enter a name for the function in the Function Name text box.
    2. Select the module in which the related list has to be added.
    3. In the Deluge script editor, code your own logic and click Save and Close.

Example

Consider a Garage CRM that has a module named Vehicles. Vehicles has a related list named Similar Customers which lists customers who have the same vehicle model as the parent record.
  1. vehicleId = vehicle.get("Vehicles.ID");
  2. vehicleRecord = zoho.crm.getRecordById("Vehicles",vehicleId.toLong());
  3. vehicleName = vehicleRecord.get("Car_Model");
  4. crmResp = zoho.crm.searchRecords("Vehicles","(Car_Model:equals:" + vehicleName + ")",1,10);
  5. responseXML = "";
  6. rowVal = 0;
  7. if(crmResp.size() > 1)
  8. {
  9. responseXML = responseXML + "<record>";
  10. for each vehicle in crmResp
  11. {
  12. data = vehicle.get("Vehicle_Contact");
  13. contactId = data.get("id");
  14. contactRecord = zoho.crm.getRecordById("Contacts",contactId);
  15. contactPhone = contactRecord.get("Phone");
  16. contactName = contactRecord.get("Full_Name");
  17. responseXML = responseXML + "<row cnt='" + rowVal + "'><FL val='Customer Name'>" + contactName + "</FL><FL val='Customer Phone'>" + contactPhone + "</FL></row>";
  18. rowVal = rowVal + 1;
  19. }
  20. responseXML = responseXML + "</record>";
  21. }
  22. else
  23. {
  24. responseXML = responseXML + "<error>=><message>No other customer has a vehicle with the same model.</message></error>";
  25. }
  26. return responseXML;
Use the format below for constructing the related list:
  1. <record>
  2.      <row no="0">
  3.           <FL val="Name1">value1</FL>
  4.           <FL val="Name2">value2</FL>
  5.      </row>
  6.      <row no="1">
  7.           <FL val="Name1">value1</FL>
  8.           <FL val="Name2">value2</FL>
  9.       </row>
  10. </record>
Error/Exception messages can be displayed in the custom related list by using the tags mentioned below:
  1. <error>
  2.       <message>Your error message goes here !!!</message>
  3. </error>
The custom related list will be displayed as depicted below:

Refer this page for details of how to create a custom related list using a widget.

To edit a related list
  1. Log in to Zoho Developer Console and click Vertical Solutions
  2. In the Vertical CRM page, select the application in which the related list has to be edited and click Edit.
  3. Click Components in the left pane and select Related List tab at the top of the page and click Custom.
  4. Select the module which has the related list to be edited, from the Module drop-down list box.
    Now a list of related list created for this particular module gets listed below.
  5. Move the mouse pointer to the related list that you want to edit and click the Edit icon.
  6. In the Edit Custom Related List popupbox, you can do the following:
    1. Modify the name of the Related List.
    2. In the Deluge Script Editor, edit the logic of the custom function.
  7. Click Save.
To delete a related list
  1. Log in to Zoho Developer Console and click Vertical Solutions
  2. In the Vertical CRM page, select the application in which the related list has to be edited and click Edit.
  3. Click Components in the left pane and select Related List tab at the top of the page and click Custom.
  4. In the Add Related List page, select the module which has the related list to be deleted, from the Module drop-down list box.
    Now a list of related list created for this particular module gets listed below.
  5. Move the mouse pointer to the related list that you want to edit and click the Delete icon.
    In the confirmation Pop up click OK.

    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 CRM Training
        Redefine the way you work
        with Zoho Workplace

          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 CRM Training

            Create, share, and deliver

            beautiful slides from anywhere.

            Get Started Now


              Zoho Sign now offers specialized one-on-one training for both administrators and developers.

              BOOK A SESSION









                                            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.




                                                Manage your brands on social media

                                                  Zoho Desk Resources

                                                  • Desk Community Learning Series


                                                  • Digest


                                                  • Functions


                                                  • Meetups


                                                  • Kbase


                                                  • Resources


                                                  • Glossary


                                                  • Desk Marketplace


                                                  • MVP Corner


                                                  • Word of the Day


                                                    Zoho Marketing Automation

                                                      Zoho Sheet Resources

                                                       

                                                          Zoho Forms Resources


                                                            Secure your business
                                                            communication with Zoho Mail


                                                            Mail on the move with
                                                            Zoho Mail mobile application

                                                              Stay on top of your schedule
                                                              at all times


                                                              Carry your calendar with you
                                                              Anytime, anywhere




                                                                    Zoho Sign Resources

                                                                      Sign, Paperless!

                                                                      Sign and send business documents on the go!

                                                                      Get Started Now




                                                                              Zoho TeamInbox Resources



                                                                                      Zoho DataPrep Resources



                                                                                        Zoho DataPrep Demo

                                                                                        Get a personalized demo or POC

                                                                                        REGISTER NOW


                                                                                          Design. Discuss. Deliver.

                                                                                          Create visually engaging stories with Zoho Show.

                                                                                          Get Started Now









                                                                                                              • Related Articles

                                                                                                              • Related Lists and Web tabs

                                                                                                                The guide will help you with the following: 1. Related lists Add a custom related list  Create a custom function with Deluge Script  Edit a custom related list  Delete a custom related list  2. Web tabs  Create a web tab  Delete a web tab Related ...
                                                                                                              • Customization - Creating Custom Fields

                                                                                                                This guide will help you with the following: Custom Fields Custom Field Limits Add Custom Fields Edit Custom Fields Delete Custom Fields Create Currency Fields Add Pick List Values Add Multi-Select Pick List Values Create Lookup Field Create Auto ...
                                                                                                              • Customization - Using Custom Buttons

                                                                                                                This guide will help you with the following: Create Custom Button  Define Button Action  Edit Custom Button  Delete Custom Button  In addition to modules, fields, pages, links, and a lot of other elements, Zoho Developer also allows you to create new ...
                                                                                                              • Customization - Working with Custom Modules

                                                                                                                This guide will help you with: Add Custom Modules  Edit Custom Modules  Link Custom Modules With Other Modules  Manage Modules  Delete Custom Modules  Zoho Developer offers more than 10 standard modules for Sales, Marketing, Customer Support and ...
                                                                                                              • Adding Developers

                                                                                                                The guide will help you with the following: Add a Developer to a Portal Add a Developer to an Extension Manage Developers You can assign a person to your Developer Console account as a developer. They can be then given access to any extension in the ...
                                                                                                                Wherever you are is as good as
                                                                                                                your workplace

                                                                                                                  Resources

                                                                                                                  Videos

                                                                                                                  Watch comprehensive videos on features and other important topics that will help you master Zoho CRM.



                                                                                                                  eBooks

                                                                                                                  Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho CRM.



                                                                                                                  Webinars

                                                                                                                  Sign up for our webinars and learn the Zoho CRM basics, from customization to sales force automation and more.



                                                                                                                  CRM Tips

                                                                                                                  Make the most of Zoho CRM with these useful tips.



                                                                                                                    Zoho Show Resources