Tabs / Menus
Tabs / Menus define the primary navigation elements for accessing application pages and their features. A tab serves as a top-level navigation container, while a menu functions as a child component within a tab.
In the Partial Locking Framework, lock states govern how Tabs and Menus can be modified in the destination tenant. This ensures a balance between customization flexibility and upgrade compatibility.
Locking Behaviour
The lock state of a Tab or Menu is determined during application installation or upgrade based on its source definition. A Tab or Menu may be in one of four states:
-
Unlocked (Custom) – Created in the destination tenant.
-
Unlocked – Originates from the source tenant but has no lock restrictions.
-
Partially Locked – Editable only in specific, controlled areas.
-
Locked – Fully protected from modification.
If a tab or menu is associated with multiple installed applications, the latest update from any source determines its effective lock status.
Tenant Admin Permissions
Tenant Admin permissions on Tabs / Menus are scoped based on their lock state. The table below lists the supported actions.
Application-Level Tab Actions
|
Action/Property |
Unlocked Application |
Partially Locked Application |
Locked Object Application |
|---|---|---|---|
|
New |
|
|
|
Tab-Specific Actions & Properties
|
|
Built on Destination Tenant |
Built on Source Tenant & Pushed to Destination Tenant |
||
|
Action/Property |
Unlocked (Custom) Tab |
Unlocked Tab |
Partially Locked Tab |
Locked Tab |
|
Tab Name |
|
|
|
|
|
Parent Tab |
|
|
|
|
|
Device Display |
|
|
|
|
|
Icon |
|
|
|
|
|
Description |
|
|
|
|
|
Role Pages Enabled |
|
|
|
|
|
Page Definition (Global or Role) |
|
|
|
|
|
Generic Page |
|
|
|
|
|
Add Child Menus |
|
|
|
|
|
Reorder Child Menus |
|
|
|
|
|
Remove Child Menus |
|
|
|
|
|
Delete |
|
|
|
|
Super Admins have full administrative control over all tabs and menus, regardless of their lock status. This includes the ability to preview, clone, synchronise, rename, delete, and modify.
If a Super Admin modifies properties that are restricted for Tenant Admins, the component continues to remain on the upgrade path. These changes are treated as temporary overrides and will be replaced by the source during the next application upgrade.
Upgrade Compatibility
When a permitted change is made to a Partially Locked Tab or Menu, the system automatically sets an Modified flag. This flag indicates that the tab has diverged from its source version and influences upgrade behaviour. This information is displayed in the tab or menu view page under the application setup. Likewise, a red exclamation triangle icon is rendered within the tab or menu that undergoes any modification.
Restoring Upgrade Path
To revert a Partially Locked Tab / Menu to its original state, use the Restore Upgrade Compatibility action. This is available only for tabs/menu marked as Modified components.
To restore the modified tab/menu to its original state, do the following:
-
Navigate to the tab/menu view page from the application setup page.
-
From the tab/menu view page, select Restore Upgrade Compatibility for the modified tab/menu that needs restoration.
-
A confirmation dialogue indicating that this action is irreversible. Confirm and proceed to restore the modified tab/menu to its original state, and the
Modifiedflag is cleared. -
During the next upgrade, all local configurations are overwritten, and the tab/menu is restored to its source version.
Tab/Menu Reordering on Application Upgrades
During an application upgrade, the order of tabs and menus in the destination tenant is updated based on the source tenant’s structure. However, any custom tabs or menus added by the destination tenant are preserved and never removed. The following rules explain how tabs are added, reordered, or removed during upgrades:
|
Scenario |
Behavior in Destination Tenant after Upgrade |
Custom Tabs/Menus Impact |
|
A new tab/menu is added in the source |
Inserted immediately after the preceding item in source order. |
Custom menus/tabs retain positions. |
|
A tab/menu is reordered in the source |
Repositioned relative to other OOTB items in the destination. |
Custom menus/tabs remain unmoved. |
|
A tab/menu is deleted in the source |
Removed from destination. Linked custom items are preserved and relocated to the end of the remaining menus/tabs. |
Preserved but may shift position. |
|
No custom tabs/menus exist |
Destination order exactly matches source order. |
Not applicable. |