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
| Field | Type | Description | Required |
|---|---|---|---|
| id | string | Unique identifier for the menu item.This is the primary key and crucial for referencing menu entries. | ❌ |
| bundle_id | any | Identifier for the associated bundle. Links the menu to a specific content or feature bundle | ❌ |
| menuIndex | any | Index or order of the menu item. Possibly indicates the order of the menu item in the UI | ❌ |
| selectedNotes | any | Notes related to the selected menu. | ❌ |
| selectChildPage | any | References child pages tied to this menu, often used in nested or hierarchical navigation. | ❌ |
| selectChildNote | any | Notes related to selecting a child menu item. | ❌ |
| defaultLaunch | any | Boolean flag (true/false) indicates whether this menu should be the default landing or starting point upon login or access. | ❌ |
| override | any | Indicates if the menu settings should override defaults. Contains override settings for menu logic or configuration, allowing custom behavior. | ❌ |
| ref_id | any | Reference ID for linking to other menu items or configurations. | ❌ |
| title | string | Display name or title of the menu item. | ✅ |
| selectPage | array | Specifies the page associated with the menu. | ❌ |
| businessName | any | Represents the business object or function this menu is tied to. | ❌ |
| template_id | any | References a template used to generate or style this menu item. | ❌ |
| url | any | URL link for the menu item. | ❌ |
| target_page | any | The target page for redirection when the menu item is clicked. | ❌ |
| icon | any | Icon associated with the menu item. | ❌ |
| access | any | Access rules or conditions that determine who can view/use this menu. | ❌ |
| menu_type | any | The type/category of the menu. | ❌ |
| menuAccessType | any | Specifies whether access is role-based or user-based. | ❌ |
| bundleBuildId | string | Identifier for the bundle build version. | ❌ |
| package_id | string | Identifier for the package associated with the menu. | ❌ |
| applicationitem_id | any | Identifier linking to an application item. | ❌ |
| children | array | A structured list (possibly JSON) of child menu items that form a submenu or tree. | ❌ |
| roles | array | Roles authorized to see or interact with this menu item. | ❌ |
| menu_for | any | Specifies if the menu is for users, admins, or both. | ❌ |
| site_id | any | Identifier for the site associated with the menu.Links the menu to a particular site, allowing for site-specific configurations. | ❌ |
| org_id | any | Identifier for the organization linked to the menu. Essential in multi-org (multi-tenant) setups. | ❌ |
| created_at | date | Timestamp when the menu entry was created. | ❌ |
| modified_at | date | Timestamp when the menu entry was last modified. | ❌ |
| system_menu | boolean | Boolean flag (true/false) indicating whether this menu item is predefined or system-generated. | ❌ |
| description | any | Description of the menu item. | ❌ |
| menu_from | any | A short explanation or note about the menu’s purpose. | ❌ |
| application_id | string | Identifier linking the menu to an application. | ❌ |
| parent_menu | string | Identifier for the parent menu | ❌ |
| isCommon | boolean | Boolean flag indicating if the menu is commonly used. | ❌ |
| routeType | any | Type of routing mechanism used for navigation. | ❌ |
| businessObj | any | Associated business object or model. | ❌ |
| expanded | boolean | Boolean flag indicating if the menu is expanded by default. | ❌ |
| createType | any | Type of menu creation method used. | ❌ |
| static_page | any | Boolean flag indicating if this menu item links to a static page. | ❌ |
| isEnable | any | Boolean flag indicating if the menu item is enabled. | ❌ |
| className | any | CSS or styling class associated with the menu. | ❌ |
| event | any | Event or action linked to this menu item. | ❌ |
| menuItemTags | any | Tags associated with the menu item for categorization. | ❌ |
| apps | any | List of applications where the menu appears. Useful for multi-app dashboards. | ❌ |
| menuType | any | Specific type classification of the menu. | ❌ |
| script | string | Custom script associated with the menu item. | ❌ |
| screen | any | Screen associated with this menu item. | ❌ |
| isSystemGenerated | boolean | Boolean 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"
}