Field of Lookup
The Field of Lookup feature in Zoho Vertical Studio helps enrich the primary module with contextual data from the associated module of a lookup field. You can select the necessary fields from the associated module and either map them to existing fields in the primary module or create new fields as needed.
For example, in a scenario where you have the Deals module linked to the Contacts module via a lookup field, you can bring in relevant fields from the Deals module (like Discount or Stage) to the Contacts module, either by mapping them to existing fields or creating new ones. This enhances the user experience by allowing them to see all relevant data without switching between modules.
For more detailed guidance on this feature and mapping fields, check out this help page.
Feature Availability in Vertical Studio
This section highlights the availability of the properties and functionalities of Field of lookup within both the developer console and the subscriber organizations. Following is the breakdown of the feature’s availability across various aspects:
Property | Availability in Developer Console | Availability in Subscriber Orgs |
Add Field of Lookup | Available | Available |
Add Field of Lookup as a new field | Available | Available |
Map Field of Lookup to a new field | Available | Available |
| Remove Field of Lookup | Available | Available |
Packaged Field(s) of Lookup
Packaged Field(s) of Lookup 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 fields.
To know more about packaging, refer to our guide on Components Packaging in Zoho Vertical Studio Platform.
Property | Upgrade Type | Modify Access |
Add Field of Lookup | Upgradable | Developer Only |
Edit Field of Lookup
| Upgradable | Developer Only |
Remove Field of Lookup | Upgradable | Developer Only |
Note: The properties of a Field of Lookup that is added and packaged by the developer cannot be edited by subscribers. However, subscribers can encrypt the field if required.
Changes and Impacts
When a packaged Field of Lookup module is modified, published, and pushed as an upgrade to the subscribers' accounts, the impacts to the existing records in the module are explained below.
1. Adding Field(s) of Lookup
Adding fields from a Lookup Module to an existing lookup field either creates a new field in the layout to display data from the associated module or maps the data to an existing field. These new or mapped fields will automatically populate with data when an update is made to the lookup field.
2. Editing a Field of Lookup Module
You cannot edit Field(s) of Lookup once they have been added. However, you can remove the existing fields or add new ones. The newly added fields will be available in existing records, and their data will be populated when the lookup field is updated.
3. Deleting a Field of Lookup Module
There are two ways to remove the Field of Lookup: You can either delete the entire lookup field at once, which will remove all associated fields, or remove the fields individually. In both ways, any newly added fields will disappear from existing records and moved to the Unused Fields section, while existing fields that are mapped to the lookup module fields will remain and continue displaying the module’s data, if any.
Caution!
Deleting Lookup field or removing a Field of Lookup 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.