Subforms in Zoho Vertical Studio | Vertical Studio Help Guide

Subforms

Subforms help you to include additional data tables within a primary module record in your vertical application. They are used to manage and display multiple related data entries associated with a single record, providing a structured way to organize detailed information.


Custom Fields: You can define multiple field types (e.g., text, number, date, lookup) within the subform to suit specific business needs.

Data Organization: It lets you capture and display multiple records related to the parent record in a tabular format.

Relational Data Management: It helps you establish a relationship between the parent record and multiple related data entries, ensuring comprehensive data capture.


Check out Building a Subform help page to learn more about the component. 

Packaged Subforms 

Packaged Subforms are created in the developer console and deployed to subscriber organizations during signup or through upgrades. Any new subform that is created in the developer console will be included in the next version of the application.

To know more about packaging, please refer to our guide on Components Packaging in Zoho Vertical Studio.

The following table explains the upgrade behavior of an existing packaged Subform already deployed in the subscriber's organization.

Property
Upgrade Type
Modify Access
Subform Name
Upgradable
Developer Only
Show Tooltip
Upgradable
Developer Only
Required
Upgradable
Developer Only
Maximum row entries allowed
Upgradable
Developer Only
Re-order option for row entries
Upgradable
Developer Only
Add Custom Fields
Upgradable
Developer Only

Changes and Impacts 

When a packaged Subform is modified, published, and pushed as an upgrade to the subscribers' accounts, the impacts to the existing records with that subform in the subscriber organization are explained below. 

1. Creating a Subform 

Creating a new subform will not impact the existing records in a module.

2. Editing a Subform 

Editing a subform's name, tooltip, and re-order options for row entries will be immediately reflected to the records on upgrading and will not have any significant impacts on the subscriber's organization data. However, editing other properties of the subform can have significant impacts. 

Required  

When a subform is made mandatory, it will apply to all newly created records. For existing records without subform data, the update will take effect only when the records are updated. At that point, the records cannot be saved unless the required subform data is provided.


Maximum Row Entries Allowed 

New records will follow the updated maximum number of row entries in the subform. For existing records, the updated limit will take effect only when the records are edited.

  • If the updated maximum row count is greater than the current entries in existing records, there will be no impact.

  • If the updated limit is lower than the existing entries, no new entries can be added. The existing entries will remain in the records until the subscriber manually removes them.


Custom Fields 

Adding new fields to a subform will not affect existing data. However, the new fields will appear when users edit any existing records.

  • If a new field is marked as required, this change will apply to existing records only when they are edited. At that point, the record cannot be saved without providing data for the newly marked mandatory field.

  • Once a field is added to a subform, it cannot be removed.


3. Deleting a Subform

Once a subform is created, you cannot delete a subform and push it as an upgrade to the existing subscribers.