User guide
- Jakub Kovář
- Matej Chvostek
- Samuel Spišák (Deactivated)
Migrated to MD
Guide is up to date with NAE 6.3.0
This guide is aimed at application users that wish to know, how to configure the navigation menu of their groups. If you are a developer that wishes to know more about the implementation and various way the system can be interacted with, you can find these information in the Developer guide
Overview
Owners of a group can configure the navigation menu for the members of the group.
The application developers can make some menu items permanent and they can designate a position in the navigation menu, where configurable entries will be inserted.
In this example, the first four entries are configurable entries and the last is fixed by the app developer.
The configurable group navigation can contain default entries specified by the application developer (as is the case in the above example), but they can be removed or modified by the group owner.
The group process contains a task - “Configure menu“, that is visible to the group owner and is used to configure the navigation menu.
The first section can be used to add new entries to the navigation menu.
The following sections each represent a single navigation menu entry and can be used to modify, rearrange or remove them.
Adding new entries
The “Select filter“ field can be used to search filters available to the group owner.
The options displayed contain the entered text as substring.
When an option is selected a preview of the filter is displayed. We can append the selected filter to the menu by pressing the “Add to menu“ button. The filter entry will be created and added at the bottom of the list, the input field will be cleared and the filter preview will be hidden.
The name of the new entry will be set to the name of the filter and the entry icon will also be set to the filter icon. The navigation will not reload automatically when a new entry is added, so you have to reload the website in order to see the new navigation entries.
The same filter can only be added to the menu once.
Modifying navigation entries
The navigation entry displays its name, buttons that can be used to rearrange the entries, or to remove them, role authorization management to enable or disable viewing the entry for specific roles, the icon configuration and the filter preview. If the filter preview is empty it means the entry holds an empty filter.
The navigation entries can be rearranged by pressing the “Up“ and “Down“ buttons. They can be removed by pressing the “Remove“ button.
Renaming the entry will change the name displayed in the menu. The navigation will not reload automatically when its configuration changes, so you have to reload the website in order to see the changes.
The entry icon can be disabled by switching the toggle.
The icons can be changed by entering the identifier for the appropriate material design icon from this list. A preview of the icon is displayed if the entered text is a valid icon identifier. Once again, in order to see the changes affecting the menu configuration, you have to reload the website.
Role view authorization management
If currently logged user is author of some deployed nets, he can choose from those nets roles which should or should not be able to view the navigation entry.
Allowed and banned roles are saved in separate lists. When adding new roles to these lists, user will at first choose one of his deployed nets (from all versions). Then he can select one or more roles available from selected process version.
Button “Allow view for roles“ will add selected roles to the list of roles which are able to view the entry.
Button “Ban view for roles“ will add selected roles to the list of roles which are NOT able to view the entry.
If the user wants to remove one or more roles from the list of allowed/banned roles, he can select them and click on “Remove from allowed / banned roles” button situated to the right of the list.
Special cases and specification
Author cannot add same roles from multiple versions of the same process.
Same roles cannot be present in both lists (allowed, banned) at the same time.
If Allowed roles list is empty, everybody will be able to view the entry unless one of their roles is present in the Banned roles list.
If a user has multiple roles and at least one of them is present in the Banned roles list, he will not be able to view the entry.