This guide will walk you through the process of editing the user menu in the client application.
[!success]- Prerequisites for further work
To proceed, ensure you meet the following five basic prerequisites:
- Running a database server
- Running ORIGAM Server
- A project created in ORIGAM Architect
- A screen created
- The client application running in your browser
Once these prerequisites are set up, log into the client application using the username and password you created during the project setup.
Default menu items
A fresh client application comes with a few items already present in the user menu:
This is the default state, and you are not permitted to make changes to it. However, if you wish to hide the entire Settings folder or its individual parts, you must do so via role setup.
Creating custom items
To add custom items to the menu, go to the Model Browser and navigate to User Interface / Menu. Right-click on the Menu and select New / Screen reference:
In the screen reference details, you must fill in at least the following required fields:
Name: The name of the menu item in the model.DisplayName: The title of the menu item that users will see in the menu.Screen: The name of the screen that this menu item will open.Roles: The roles that will have access to this menu item. This can be one role, multiple roles separated by a semicolon, or all roles using the “*” symbol.
There are additional fields that may be useful:
Order: This field contains a number, which determines the order in which the menu items will be sorted (from lowest to highest).MenuIcon: The icon displayed alongside the menu item.
There are many more settings available, but this tutorial will not go into those details.
Save the screen reference, and your new menu item will be created.
Creating a submenu
A submenu is essentially a folder that contains multiple menu items. For example, a Directory submenu may contain menu items for Providers, Suppliers, Partners, etc.
The process for creating a submenu is the same as adding a menu item, except instead of selecting New Screen Reference, you choose New Submenu.
In the submenu details, you only need to fill in the Name, DisplayName, and optionally modify the Order field:
Menu in the client application
Once you’ve created all your menu and submenu items, restart the server, reload your browser, and you’ll see the changes reflected in the client application, as shown here:
