Create and manage related lists | Customization | Zoho Sprints help

Create and manage related lists

Create related lists to provide quick access to related data through module relationship. Use conditional criteria to auto-populate existing data from other entities or create custom function to fetch and display data from external sources. Learn more

Related lists are supported in the following modules:
  1. Projects
  2. Epics
  3. Release
  4. Sprints
  5. Work Items
  6. Timesheet
  7. Meetings
  8. Users
  9. Expense
  10. Custom Modules
 

Availability

Info
The feature is available for users in Enterprise, Premier plan, and Zoho One.
To create related list:
  1. Click the gear icon and open to the Settings window.
  2. Select Related Lists option under Customization section.
  3. Click the Create button.
  4. Enter the Related List Name. This name will appear as the tab name in the related module detail view.
  5. Enter description for reference.
  6. Select List Type as Lookup
  7. Select Lookup Module. Lookup Module is the module from which related data is pulled and displayed in the list.
  8. Click the Save button to save the related list.

The saved list will be available in the Related List section under Customization. This list must be associated with the relevant layouts in which the list should feature. For instance, if the related list is created but not associated with any layout, the list will not be accessible within the details page.

To associate related list with layouts:
  1. Click the Save and Associate button while creating the related list.
  2. Select the required related module in which the list should appear. This is the target location for the related list to load.
  3. Select the layouts in which the related list should appear.
  4. Click the Associate button. The list will be accessible in the modules in which the selected layouts are applied.


Alternatively, navigate to the Related List listing page in Settings. Click the Associate button inline with the required list. Complete the module and layout association steps.

To create related list:
  1. Click the gear icon and open to the Settings window.
  2. Select Related Lists option under Customization section.
  3. Click the Create button.
  4. Enter the Related List name. This name will appear as the tab name in the related module detail view.
  5. Enter description for reference.
  6. Select List Type as Lookup.
  7. Select Lookup Module. Lookup Module is the module from which related data is pulled and displayed in the list.
  8. Select the Prefill list based on the following criteria option. This enables you to auto-populate the existing module data within the related list based on the defined criteria.

  9. Select the View related entities across projects option to display data across projects.
  10. Click the Save and Associate button.
  11. Select Related Module option to specify target module to display the list.
  12. Select layouts in which the list should be included.
  13. Click the Associate button to complete procedure.
The list will be accessible in the modules in which the selected layouts are applied.

Notes
Note: When the prefill option is applied, even the future records matching the criteria will be auto-associated.
Create related list with backlinks to ensure a bidirectional relationship between the related module and the source or parent module from which the data is fetched and displayed. This allows you to trace the relationship forward and backwards, creating a meaningful and navigable associate.

To create backlinks:
  1. Create the related list from the related list section as mentioned above.
  2. Select the Generate backlink option while creating the related list.
  3. Enter Backlink Name.
  4. Save and Associate the layout.
  5. Go to Custom Layouts under Customization.
  6. Select the relevant lookup module in which the related list is associated.
  7. Select the layout in which backlink is created.
  8. Select Detail View section.
  9. Click Associate related list.
  10. Select the related list layouts that should include backlinks.
  11. Click Edit to edit the backlink details of a specific related list.
  12. Enter the relevant backlink name.
  13. Click the Save button. The backlink option is enabled, facilitating traceability.
Related List creation through custom function is largely applicable when you need to fetch and display data from third party applications or external sources. Custom function allows you to fetch the details from third party apps or other Zoho products through Rest APIs. Learn more

Employ custom function to:
  1. Connect to external sources via Connections
  2. Script in Deluge using the script builder
  3. Fetch securely on demand
To create related list:
  1. Click the gear icon and open to the Settings window.
  2. Select Related Lists option under Customization section.
  3. Click the Create button.
  4. Enter the Related List Name. This name will appear as the tab name in the related module detail view.
  5. Enter description for reference.
  6. Select List Type as Custom Function.
  7. Enter function specifications.
  8. Create the function script in the script builder.
  9. Click the Save button to save script.
  10. Click the Save and Associate button.
  11. Select Related Module option to specify target module to display the list.
  12. Select layouts in which the list should be included.
  13. Click the Associate button to complete procedure.
The list will be accessible in the modules in which the selected layouts are applied.

Example Deluge script

The following illustrates the structure of a Deluge script that fetches open bug reports from an external bug tracker API and returns them for display in a Related List on a Work Item detail page.


  1.    workItemId = entityDetails.toMap().get("entityId");
       
    // Fetch issues from external bug tracker via Connection
    response = invokeurl
    [
       type: GET
       connection: "bugtracker_connection"
    ];
       
    issues = response.get("issues");
     
    if (issues == null || issues.size() == 0)
    {
      info "No linked issues found for this work item.";
    }
     
    response = Map();
    headers = List();
    headers.add("Issue ID");
    headers.add("Title");
    headers.add("Severity");
    headers.add("Status");
    headers.add("Assignee");
     
    listData = List();
    for each issue in issues
    {
    details = List();
    details.add(issue.get("id"));
    details.add(issue.get("title"));
    details.add(issue.get("severity"));
    details.add(issue.get("status"));
    details.add(issue.get("assigned_to"));
    listData.add(details);
    }
       
    response.put("keys",headers);
    response.put("values",listData);
    return response; 

The layout of the detail view page of the modules in Zoho Sprints can be customized from the Details View section under Custom Layouts. This section enables you to customize the visibility of columns in the related list. Learn more
  1. Click the gear icon and open to the Settings window.
  2. Select Layouts option under Customization section.
  3. Select the layout in which the related list needs to be customized.
  4. Select Detail View to access the layout fields.
  5. Go to the related list that requires customization.
  6. Click Customize to view fields available in the list.
  7. Disable the fields or columns that should be hidden from view.
  8. Click the Update button to save changes.

Notes
 Note:
The fields that are disabled will not be visible in the related list view of the modules associated with the selected layout.
The fields or columns for cannot be customized for backlinks.
To access the related list view:
  1. Select the required module or entity: project, epic, release, sprint, work Items timesheet, meeting, user, expense, or custom module.
  2. Navigate to the details page of the selected module.
  3. Select the required related list from the tabs listed on the detail view page.
The records prefilled in the list will be displayed. If no records are prefilled, click the Add button to add new records or Associate button to select and associate existing related from the related module.

Users with the profiles that have Manage Automation and Manage Custom Field permissions enabled will have the permission to view, create, update, and delete related lists.
  1. Click the gear icon and open to the Settings window.
  2. Select Profiles option under Manage Users section.
  3. Select the Profile for which related list permissions should be enabled.
  4. Select Workspace Permissions.
  5. Enable Manage Automation and Manage Custom Field permissions.
  6. Disable these permissions to restrict access to related list customization.
To remove related list from a layout:
  1. Click the gear icon and open to the Settings window.
  2. Select Layouts option under Customization section.
  3. Select the layout in which the related list needs to be customized.
  4. Select Detail View to access the layout fields.
  5. Hover over the related list that needs to be deleted. A red symbol will appear at the top right corner of that related list.
  6. Click the icon to Disassociate the list from the layout.
All the entities or modules associated with this layout will not include the related list in their respective detail view pages. However, the related list will still be available in the Related Lists section and can be associated again.


Disable a related list to temporarily hide it from all the associated layouts.

  1. Click the gear icon and open to the Settings window.

  2. Select Related Lists option under Customization section.

  3. Click the Disable toggle button to disable the related list from showing up in all the associated layouts.

When a disabled related list is enabled again, it will be enabled in all the layouts that it was previously associated with.

To edit the related list details:

  1. Click the gear icon and open to the Settings window.

  2. Select Related Lists option under Customization section.

  3. Hover over the required related list on the listing page.

  4. Click Edit. The edit window will appear.

  5. Edit the list name, description, and backlink name.

  6. Click the Update button to save changes. 

Notes

Note:

  • In the case of custom function list, make changes to the display name, description, and the script.

  • In the case of lookup module list, you cannot make changes to the lookup module.

To delete the related list:
  1. Click the gear icon and open to the Settings window.
  2. Select Related Lists option under Customization section.
  3. Hover over the required related list on the listing page.
  4. Click Delete. A confirmation pop-up will appear.
  5. Click the Delete button to complete the procedure.