The Lookup field creates a Parent-Child relationship when the records are within the same module. This type of relationship is useful for managing records hierarchically where a parent record can have a child record associated with it. The following are few Parent-Child relationships you could establish within Vertical Solutions:
Across Different Modules
When the lookup field links two records of different modules, they help you to quickly refer to the related records across the modules. This cross-module referencing makes it easier to access relevant details without shifting between modules and thereby enhances the interconnectedness of data. The following are a few examples of it:
- Account to Contact: A contact in the Contacts module can be associated with an account in the Accounts module, displaying a complete view of the contact associated with the account.
- Case to Product: A case from the Customer Service Cases module can be linked to the relevant product in the Products module for a detailed context and additional information.
- Potential to Account: A deal in the Potentials module can be connected with the relevant account in the Accounts module for easy access.
Create a Lookup Field
- Log in to Zoho Developer Console and click Vertical Solutions.
- In the following page, click on the Edit icon of the solution to which the field has to be added.
- In the left menu, navigate to Modules.
- Select the desired module from the Modules tab and choose the layout of your module.
- From the New Fields section on the left pane, drag and drop the Lookup field to the layout.
- Now, fill in the Lookup Properties based on your business requirements.
- Field Label: It represents the display name of the lookup field.
- Lookup Module: Choose the module to which the field has to establish a relationship.
- Related List Title: Provide a display name for the related list, which will be created as a result of establishing a relationship between the two modules.
- Required: This marks the lookup field as a mandatory.
- Filter lookup records: Add criteria to refine the list of records shown in the lookup tab in order to associate it with a record.
- Validate lookup filter during record edit: If you want to automatically check if the look up field matches the filter criteria whenever you edit, select the 'Validate lookup filter during record edit' option.
- Click Done and Save the layout.
Lookup Filters
Lookup Filters are predefined criteria applied to lookup fields that help you to select only from a subset of records that meet specific conditions. This ensures only relevant records are associated and enhances data accuracy.
You can apply multiple criteria to filter the lookup records displayed for a lookup field. For example, filter contacts by both Lead Source and Mailing City.
Use conditional logic for constructing complex filters based on your specific business requirements. For example, you could create a filter for showing contacts from a specific region only if the lead source is Advertisement.
The filter validation can be enabled by selecting the "Validate lookup filter during record edit" option. Whenever a record associated with another record is edited, this will validate the linked record's details and check if it matches the filter.
For instance, a lookup field in the Deals module lists only active accounts from the Accounts module. If filter validation is enabled for this field, whenever a deal is edited, it automatically checks if the associated account is still active. This helps to retain the relationship of the records consistently, ensuring no updates to the linked record are missed.
Here are a couple of examples of lookup filters in Vertical Solutions:
- For support teams, you can apply a filter that lists only the cases with status "Open" and "Unresolved". It increases the team's focus on cases that need attention.
- For sales teams, you can filter deals based on the deal stage "Negotiation" and "Proposal" for prioritizing their efforts and time management.
Add Lookup Filters
You can define a lookup field property either in a new or existing lookup field, in its properties section.
Packaged Lookup fields are the ones that are created in the Developer console and deployed in the subscriber organizations during Signup or via upgrade. Following content will explain the behavior of such Lookup fields.
To know more about packaging, refer to our guide on
Components Packaging in Zoho Vertical Solutions Platform.
Property | | |
Field Label
| Non-Upgradable | Developer Only |
Lookup Module | | Non-Editable |
Related List Title | Upgradable | Developer Only |
Required | Upgradable | Developer Only |
Filter lookup records | Upgradable | Developer Only |
Validate lookup filter during record edit | Upgradable | Developer Only |
Show Tooltip | Upgradable | Developer Only |
Changes and Impacts
When a packaged Lookup field is modified, published, and pushed as an upgrade to the subscribers' accounts, the impacts to the existing records such as Leads, Contacts, Accounts, etc., are explained below.
1. Adding a new Lookup field
The new lookup field will be available to all the existing records with no value. Subscribers can update the existing records with the values after the upgrade.
2. Editing a Lookup field's properties
When editing a lookup field, certain changes may or may not impact existing records. Following are the behavior of different properties:
Field Label and Related List Title
Changes to the Field Label and Related List Title will not affect any existing records. It only updates how the field and related records are displayed in the UI going forward.
Required
- Enabled: If the field is set to 'Required' and pushed as an upgrade, any edits to existing records within the respective layout will require the field to be filled before saving the changes.
- Disabled: If the field is made optional and pushed as an upgrade, it will not impact existing records, and there will be no restrictions on saving edits without filling the field.
Filter Lookup Records
- Enabled with Conditions: If lookup filters are enabled and specific conditions are defined, they will impact existing records during edits. Records with values that no longer meet the criteria will remain unchanged unless edited, but new entries must meet the conditions.
- Disabled: If the lookup filter is disabled or removed, it will not affect existing records. The filter will simply no longer apply when records are edited in the future.
Validate Lookup Filter During Record Edit
This setting impacts existing records when they are edited. Any edits must comply with the defined filter conditions, ensuring that only valid records remain linked through the lookup field.
3. Deleting a Lookup field
Deleting the lookup field will lose the mapped values in the existing records.
Caution!
Deleting a Lookup field 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.