Skip to main content

MenuSystem Model

Overview

The menusystem table is designed to store configuration data for menu items and navigation structures in an application. It tracks various attributes of the menu system, including metadata such as icons, menu access levels, parent-child relationships, routes, and menu types. This table is used for dynamic menu generation, customizing access, and managing the menu items across different pages and applications.

Fields

FieldTypeDescriptionRequired
idstringUnique identifier for the menu item.This is the primary key and crucial for referencing menu entries.
bundle_idanyIdentifier for the associated bundle. Links the menu to a specific content or feature bundle
menuIndexanyIndex or order of the menu item. Possibly indicates the order of the menu item in the UI
selectedNotesanyNotes related to the selected menu.
selectChildPageanyReferences child pages tied to this menu, often used in nested or hierarchical navigation.
selectChildNoteanyNotes related to selecting a child menu item.
defaultLaunchanyBoolean flag (true/false) indicates whether this menu should be the default landing or starting point upon login or access.
overrideanyIndicates if the menu settings should override defaults. Contains override settings for menu logic or configuration, allowing custom behavior.
ref_idanyReference ID for linking to other menu items or configurations.
titlestringDisplay name or title of the menu item.
selectPagearraySpecifies the page associated with the menu.
businessNameanyRepresents the business object or function this menu is tied to.
template_idanyReferences a template used to generate or style this menu item.
urlanyURL link for the menu item.
target_pageanyThe target page for redirection when the menu item is clicked.
iconanyIcon associated with the menu item.
accessanyAccess rules or conditions that determine who can view/use this menu.
menu_typeanyThe type/category of the menu.
menuAccessTypeanySpecifies whether access is role-based or user-based.
bundleBuildIdstringIdentifier for the bundle build version.
package_idstringIdentifier for the package associated with the menu.
applicationitem_idanyIdentifier linking to an application item.
childrenarrayA structured list (possibly JSON) of child menu items that form a submenu or tree.
rolesarrayRoles authorized to see or interact with this menu item.
menu_foranySpecifies if the menu is for users, admins, or both.
site_idanyIdentifier for the site associated with the menu.Links the menu to a particular site, allowing for site-specific configurations.
org_idanyIdentifier for the organization linked to the menu. Essential in multi-org (multi-tenant) setups.
created_atdateTimestamp when the menu entry was created.
modified_atdateTimestamp when the menu entry was last modified.
system_menubooleanBoolean flag (true/false) indicating whether this menu item is predefined or system-generated.
descriptionanyDescription of the menu item.
menu_fromanyA short explanation or note about the menu’s purpose.
application_idstringIdentifier linking the menu to an application.
parent_menustringIdentifier for the parent menu
isCommonbooleanBoolean flag indicating if the menu is commonly used.
routeTypeanyType of routing mechanism used for navigation.
businessObjanyAssociated business object or model.
expandedbooleanBoolean flag indicating if the menu is expanded by default.
createTypeanyType of menu creation method used.
static_pageanyBoolean flag indicating if this menu item links to a static page.
isEnableanyBoolean flag indicating if the menu item is enabled.
classNameanyCSS or styling class associated with the menu.
eventanyEvent or action linked to this menu item.
menuItemTagsanyTags associated with the menu item for categorization.
appsanyList of applications where the menu appears. Useful for multi-app dashboards.
menuTypeanySpecific type classification of the menu.
scriptstringCustom script associated with the menu item.
screenanyScreen associated with this menu item.
isSystemGeneratedbooleanBoolean flag (true/false) indicating whether the menu is system-generated. important in managing user-vs-system-created menus.

Sample JSON

{
"id": "example_value",
"bundle_id": "example_value",
"menuIndex": "example_value",
"selectedNotes": "example_value",
"selectChildPage": "example_value",
"selectChildNote": "example_value",
"defaultLaunch": "example_value",
"override": "example_value",
"ref_id": "example_value",
"title": "example_value",
"selectPage": "example_value",
"businessName": "example_value",
"template_id": "example_value",
"url": "example_value",
"target_page": "example_value",
"icon": "example_value",
"access": "example_value",
"menu_type": "example_value",
"menuAccessType": "example_value",
"bundleBuildId": "example_value",
"package_id": "example_value",
"applicationitem_id": "example_value",
"children": "example_value",
"roles": "example_value",
"menu_for": "example_value",
"site_id": "example_value",
"org_id": "example_value",
"created_at": "example_value",
"modified_at": "example_value",
"system_menu": "example_value",
"description": "example_value",
"menu_from": "example_value",
"application_id": "example_value",
"parent_menu": "example_value",
"isCommon": "example_value",
"routeType": "example_value",
"businessObj": "example_value",
"expanded": "example_value",
"createType": "example_value",
"static_page": "example_value",
"isEnable": "example_value",
"className": "example_value",
"event": "example_value",
"menuItemTags": "example_value",
"apps": "example_value",
"menuType": "example_value",
"script": "example_value",
"screen": "example_value",
"isSystemGenerated": "example_value"
}