Role required: admin.
In SimpleOne, navigation is based on these entities:
- Categories (physically stored in the Menu Category (sys_menu_category) table)
- Child categories (physically stored in the Menu Category (sys_menu_category) table)
- Menu items (physically stored in the Menu Item (sys_menu_item) table)
- Dynamic categories (physically stored in the Dynamic Menu Category (sys_menu_dynamic_category) table).
A category can have one or more child categories. Child categories never have other child categories.
The hierarchy of a category containing child categories and items is shown below:
To add a menu item, follow the steps below:
- Navigate to System Settings → Menu Items.
- Click New and fill in the fields.
- Click Save or Save and Exit to apply changes.
A category can also be a dynamic one that is an entry point to a separate submenu. The order of a dynamic category containing child categories, subcategories and its items, and its own items is shown below:
Categories
To create a new category, please follow these steps:
- Navigate to System Settings → Menu Categories.
- Click New and fill in the fields. See an example below.
- Click Save or Save and Exit to apply changes.
Service Portfolio category form fields
The Edit button is marked with a pencil icon .
It allows you to modify the properties of a specific category or category item. Click it to open the property editing form.
Menu category form fields
Field | Mandatory | Description |
---|---|---|
Title | Y | Displayed category title. |
Active | N | Select the checkbox to activate the category. |
Dynamic | N | Select the checkbox if you want that the category to be dynamic. |
Order | Y | Category order in the interface (categories are arranged in the ascending order). |
Dynamic category | Y | Specify the dynamic category to extend the category you are creating. |
Description | N | Brief category description. |
User Roles | N | User roles that have access to the category can be specified here. If the list is left blank, then the category will be available to all users. |
Parent | N | The category which is parent to the current one. This allows to change the level of a category. A category cannot be a parent to itself. A category with a child category cannot become a child category itself (child categories cannot have their child categories). In other words, if the Service Portfolio has a child category Service Option, the Service Portfolio cannot become a child category itself. The maximum level hierarchy is shown below:
1.1. Service Option Service Option item Service Item |
If the newly created category contains no items, then it will not appear in the navigation panel. To display it, create one or more menu items for this category. To learn how to create a menu item, please refer to Menu Items section of this article.
Child category
Child category is an optional level for a category that allows you to implement hierarchy in the Navigator.
To create a new category, please follow these steps:
- Navigate to System Settings → Menu Categories, open a record you want to create a child category for.
- Find the Child Categories tab in the Related Lists area.
- Click New and fill in the fields.
- Click Save or Save and Exit to apply changes.
You can also open the form this way:
- Navigate to System Settings → Menu Categories.
- Click New and fill in the fields.
- Click Save or Save and Exit to apply changes.
Please note that in this case, you need to fill in the Parent field manually.
A child category cannot have any child categories.
If the newly created child category contains no items, then it will not appear in the navigation panel. To display it, create at least one menu item for this child category. To learn how to create the menu item, please refer to Menu Items section of this article.
Menu items
SimpleOne administrators can use menu items as links to content pages (e.g., lists or forms of table records). Menu items can be related to a category or to a child category.
To make a menu item point to an external source, on the Link type tab, fill in the URL field with a link to the source.
To create a new category item, please follow these steps:
- Navigate to System Settings → Menu Categories, open a record you want to create a menu item for.
- Find the Menu Item tab in the Related Lists area.
- Click New and fill in the fields.
- Click Save or Save and Exit to apply changes.
Menu item form fields
Field | Mandatory | Description |
---|---|---|
Title | Y | Specify displayed menu item title. |
Category | Y | The category of the item. Move it from one category to another by clicking on the magnifier icon and choosing the new category from the list. |
User Roles | N | User roles that should have access to the menu item can be specified here. If the list is left empty, the category will be available to all users. |
Visibility tab | ||
Active | N | Select the checkbox to display the element in the navigator. |
Order | Y | The element order in the interface (elements are sorted in the ascending order). |
Link type tab | ||
Table | Y | Specify the table to which the menu item refers to. |
Link Type | Y | The Choice field. Available options: List of Records or Record. |
Filter | N | The Condition Builder field that allows to tune up a filter that will be applied to a list view. Notes
|
URL | N | Enter a URL if a navigation item should point to an internal or external source. If you enter a URL, values of the Table and Link Type fields will be ignored. |
Favorites
The "Favorites" functionality provides the ability of quick access to the frequently used categories (including their child categories), child categories (including their items but not the parent category), category items, and also filters.
List of favorite items is available in the "Favorites" tab marked with the star icon. Every user has their own Favorites. Physically, they are stored in the Favorites (sys_menu_favorite) table.
To add a category, child category, or category item to Favorites, click a star near it (in other words, star it). Also, you can add a filter of the list view that was prepared earlier to the Favorites. For this, just drag and drop it to the "Favorites" navigation tab.
There are two ways to delete the category, category item or the filter from Favorites:
(applicable for categories, category items and filters)
- When you are in Favorites, click the Delete icon in front of the desired item.
(applicable for categories and category items)
- When you are in the Categories tab, unmark the item you want to delete from Favorites.
Dynamic categories
Dynamic menu is a special navigator element that is the entry point to a separate submenu. Categories and items of such a menu are formed based on table data. There are two options for forming a dynamic menu structure while creating it:
- Specify one table, so its records will be both categories and category items. To do so, specify the field in Category parent column that defines the parent-child relationship.
- Specify two tables, one for the category and one for the items included in the category. To do so, specify the field that defines the parent-child relationship for the category and subcategories table, and also specify the field in Item parent column that defines the item-to-category relationship for the table with items.
Dynamic Menu Category form fields
Field | Mandatory | Description |
---|---|---|
Title | Y | Specify the category title. |
Use categories | N | Select the checkbox if you need to create a hierarchy using two tables. |
Category table | Y | Define the table that will be used as a category for items The field appears when the Use categories checkbox is selected. |
Category parent column | Y | Specify the column to define parent-child relationship between the category elements. The field appears when the Use categories checkbox is selected. |
Category icon source | N | Specify the vector image for the category. The field appears when the Use categories checkbox is selected. |
Category UI list | N | Specify the List Layout for the category. The field appears when the Use categories checkbox is selected. |
Category conditions | N | Specify the conditions that must be met to filter categories. The field appears when the Use categories checkbox is selected. |
Item table | Y | Define the table which records will be used as items. |
Item parent column | Y | Specify the column that will define parent-child relationship between items and categories. |
Item icon source | N | Specify the vector image for items. |
Item UI form | N | Specify the Form layout for items. |
Item conditions | N | Specify the conditions must be met to filter items. |
Navigator filtering
You can use the search bar at the top of the navigator to reduce the number of items displayed. It may be helpful if there are many items displayed, and it is hard to find the preferred one.
For this, enter some characters or keywords in the search bar at the top of the navigator:
Initial filtration is performed by the category name.
- When you enter some characters of a keyword, the navigator displays categories whose titles contain characters, and all their items.
- When a full keyword is entered, items with the keyword and their categories will be shown.
- No labels