Hierarchy Model

Overview

The hierarchy table defines a structured representation of objects (like screens, modules, business entities, or UI elements) within an application. It is used to organize items into logical or functional levels for purposes like navigation, permissions, inheritance, or display order. This is especially useful in systems where object arrangements or relationships impact visibility, behavior, or execution flow — for example, hierarchical menus, business process steps, or organizational charts.

Fields

Field	Type	Description	Required
id	string	Unique identifier for the hierarchy record.Used to reference this hierarchy in other tables	❌
name	string	Name of the hierarchy structure.Used in UIs and internal systems to label the hierarchy.	✅
objectId	string	Reference ID of the object associated with the hierarchy. Helps group or filter hierarchies based on functionality.	✅
applicationId	string	ID of the application related to this hierarchy.Enables multi-app or multi-tenant systems to isolate hierarchies per app.	✅
default	boolean	Flag indicating if this hierarchy is the default one. Used to auto-load or prioritize this hierarchy when none is specified explicitly.	❌
description	string	A textual description of the hierarchy's purpose or scope. Helpful in admin panels or config screens for identifying the hierarchy.	❌
isDeleted	boolean	Boolean flag indicating whether the hierarchy is deleted. Keeps deleted hierarchies in the DB for historical or rollback reasons.	❌
tags	array	Additional metadata tags associated with the hierarchy.Useful for filtering, categorization, or tagging hierarchies.	❌
created_at	date	Timestamp when the hierarchy record was created. Used for audit, sync, or versioning purposes.	❌
modified_at	date	Timestamp when the hierarchy record was last updated.	❌
settings	object	Configuration settings for this hierarchy.Dynamically configures hierarchy behavior without changing schema.	❌

Sample JSON

{
  "id": "example_value",
  "name": "example_value",
  "objectId": "example_value",
  "applicationId": "example_value",
  "default": "example_value",
  "description": "example_value",
  "isDeleted": "example_value",
  "tags": "example_value",
  "created_at": "example_value",
  "modified_at": "example_value",
  "settings": "example_value"
}