HowTo: Define a Menu using GAM

Official Content
This documentation is valid for:

When using GeneXus Access Manager (GAM), your Web application menu can be defined (dynamically) at runtime, based on the Permissions and Roles of the user logged in.

The purpose is to filter the menu options according to the end user's permission. Here, GAM returns the menu structure depending on the permissions of the user so that this structure may be loaded at runtime with any User Control.

The menu has to be defined for a particular GAM Application (multiple menus can be defined within a GAM Application).
A menu option will have a permission and a resource associated with it.


The menu may be set using the GAM Backoffice or the GAM API. For this purpose, see GAM API for Menus.

1. Select the GAM application where you will define the Menu, and click on the "More options" button > "Menus" at the right-hand side:

Create Menu for app GAM v18

2. Click the "ADD" button to add a Menu:

Add menus to an app - GAM v18

3. Define the Menu name and its description

Define Menu in app GAM 18

4. Add the Menu options with the "OPTIONS" button in each Menu:

Add Menu options GAM v18

5.Click in the "ADD" button to add the options:

Add Menu options GAM v18-1

6. When you add a Menu option, you will get a dialog like this:

Define Menu options in GAM v18

A menu option is associated with a GAM Permission and a resource.

The permission can be selected from a combo box that includes all the GAM permissions defined for that GAM Application, including the Automatic Permissions generated by GeneXus and the Permissions Created by the User.

Note that if it's a Permission created by the user, the permission is used only to decide whether to show the menu option to the user or not. The permission isn't checked at the execution of the resource itself.

A Resource is any GeneXus object that may be executed from the URL or a URL itself. Since GeneXus 16 upgrade 10, you can use a relative URL, e.g: /
If the GeneXus object is inside a module, include the module in the Resource field, for example.: module1.webpanel1.

By default, the resource of a menu option which is associated with an Automatic Permissions generated by GeneXus is any Object that has that permission as Permission Prefix property.

The option type can be

  • Simple
  • Menu (a submenu may be defined here)

Environment settings of the Application

The Environment settings of the Application influence in the behavior of this feature.

Environment settings in app - GAM v18

Since GeneXus 15 upgrade 5, the URL can be absolute or relative, depending on the UseAbsoluteUrlByEnvironment property value. 

The menu is defined automatically afterwards, based on the permissions of the resources and the user's Roles. The end user will view only the Menu options linked to resources associated with the permissions that the user may access.

The menu may be displayed using any User Control. See HowTo: Display a GAM Menu using Jscookmenu UC.

Note: The Menu of the GAM Web Backoffice is automatically defined in the GAM Backend Application. It is created when GAM repository creation for the first time from GeneXus.

Deployment: When the application is deployed to production using the Application Deployment tool, you have to add all the objects of your application related to the menu options manually.