Menus
Introduction
Menus are the primary navigation elements for interacting with processes and processors in the Dynamo system. The open gateways to interact with a particular process or processor.
Menu Overview
Menus are created from the Manage Menus process that can be found in the Dynamo developer interface (Dynamo-admin). If a menu is created and has a claim(s) attached, the menu will only be visible to users that have that particular claim.
Menu Object
| Property Name | Type | Description |
|---|---|---|
| _id | Mongo ObjectID | MongoDB generated ID for the Library. |
| displayLabel | String | The menu display label that the user sees |
| type | Enum values = ["CLIENT", "DYNAMO"] | The type of menu. DYNAMO menus are menus that can appear on a particular domains application while CLIENT menus are menus are menus that appear on the Developer interface (Dynamo-admin). |
| value | MongoID string | The ID of either the process or processor that the menu navigates to |
| icon | String | Valid material design icon used to define the icon the menu will use |
| category | Enum values = ["LOGIN", "PROFILE", "MAINMENU"] | Defines the position the menu will take on the screen |
| client | String | useful if the menu type is CLIENT. It defines the particular client to use. |
| group | String | used to implement a menu and submenu kind of functionality. |
| domain | MongoDB Object ID | ties the menu to a particular domain. If it isn't provided, it will be available in all the domains |
| uid | String | The unique ID for the menu |
| home | Boolean | Determines if the menu will be the default process that loads when the user is logged in |
| activated | Boolean | If true, the menu will be available to be shown. If not the menu will be disabled. |
| claims | Array | Determines the users that are authorized to view a particular menu. |