NavMenus Model

Overview

The navmenus table stores configuration information for the navigation menus used in applications. It defines properties related to menu items such as names, roles, access control, business objects, URLs, icons, and other related data. This table allows dynamic menu management, access control for different roles, and customization of the navigation behavior across various application sections.

Fields

Field	Type	Description	Required
id	string	A unique identifier for each navigation menu entry. This is the primary key and essential for referencing the menu.	❌
selectedHelpPages	array	List of selected help pages linked to the menu.Contains IDs or references to help or support pages linked with this menu item, possibly shown as tooltips or contextual guides.	❌
menu_devicetype	any	Specifies the device type (e.g., mobile, tablet, desktop) for the menu.This supports responsive or device-specific navigation structures.	❌
selectedNotes	any	Notes associated with the selected menu. Holds references to note objects related to this menu item. Notes might contain instructions, annotations, or documentation.	❌
bundle_id	any	Identifier for the associated bundle. Associates the menu with a specific bundle, allowing grouping or versioning of related elements.	❌
defaultLaunch	any	Boolean flag (true/false) indicating if this is the default launch menu. Indicates whether this menu item is the default launch target	❌
override	any	Indicates whether the menu settings should override defaults.Stores any configuration meant to override default menu behavior or settings.	❌
ref_id	any	Reference ID for linking to other menu items or configurations.	❌
menu_name	string	Name of the navigation menu.	✅
businessObjectName	any	Name of the business object associated with this menu.	❌
icon	string	A path, name, or class representing the visual icon to be displayed with the menu item.	❌
url	string	A direct link or internal route that this menu points to. Clicking the menu may open this URL	❌
url_required	boolean	Boolean flag indicating whether a URL is required for this menu. A flag (boolean) indicating whether the url must be provided for this menu to function correctly.	❌
showSidemenu	boolean	Boolean flag indicating whether the menu should appear in the side navigation. A flag determining whether the side navigation panel should be shown when this menu is active.	❌
menuTags	array	Tags used for categorizing the menu.	❌
roles	array	List of user roles that have access to this menu. Only users with certain roles will see this menu item.	❌
apps	any	List of applications where this menu appears. Useful in multi-app or modular environments.	❌
created_at	date	Timestamp when the menu entry was created.	❌
modified_at	date	Timestamp when the menu entry was last modified.	❌
system_menu	boolean	A boolean flag indicating if this menu was generated by the system or predefined (not user-created).	❌
menu_from	string	Defines the origin or source of the menu.	❌
site_id	string	Associates the menu with a specific site, supporting site-specific configurations or deployments.	❌
org_id	string	Associates the menu with a particular organization.	❌
isSystemGenerated	boolean	Boolean flag (true/false) indicating whether the menu is system-generated.	❌
applicationitem_id	string	Links the menu item to a specific application component or item.	❌
createType	string	Describes how this menu was created—possibly distinguishing between manual, auto, or import.	❌
template_id	string	Identifier for the template used in the menu. If the menu is based on a predefined template, this stores the template’s ID.	❌
application_id	string	Identifier linking the menu to an application.Associates the menu with a specific application for scoping in multi-app ecosystems.	❌
package_id	string	Identifier for the package associated with the menu. Links the menu to a particular package, potentially for packaging menus as part of deployable features.	❌
isCommon	boolean	Boolean flag indicating if the menu is commonly used.	❌
bundleBuildId	string	Identifier for the bundle build version. Useful for version control or deployment tracking.	❌
routeType	any	Type of routing mechanism used for navigation.	❌
script	string	Custom script associated with the menu item. Holds any client-side scripting logic that needs to run with this menu item.	❌
screen	any	Screen associated with this menu item. Stores screen layout or component definitions, defining how the view renders when this menu is selected.	❌

Sample JSON

{
  "id": "example_value",
  "selectedHelpPages": "example_value",
  "menu_devicetype": "example_value",
  "selectedNotes": "example_value",
  "bundle_id": "example_value",
  "defaultLaunch": "example_value",
  "override": "example_value",
  "ref_id": "example_value",
  "menu_name": "example_value",
  "businessObjectName": "example_value",
  "icon": "example_value",
  "url": "example_value",
  "url_required": "example_value",
  "showSidemenu": "example_value",
  "menuTags": "example_value",
  "roles": "example_value",
  "apps": "example_value",
  "created_at": "example_value",
  "modified_at": "example_value",
  "system_menu": "example_value",
  "menu_from": "example_value",
  "site_id": "example_value",
  "org_id": "example_value",
  "isSystemGenerated": "example_value",
  "applicationitem_id": "example_value",
  "createType": "example_value",
  "template_id": "example_value",
  "application_id": "example_value",
  "package_id": "example_value",
  "isCommon": "example_value",
  "bundleBuildId": "example_value",
  "routeType": "example_value",
  "script": "example_value",
  "screen": "example_value"
}