show / hide menu

Global Menu 

The Global Menu feature allows you to define a menu structure once and reuse it across forms based on security settings or specific business scenarios. These menus can be displayed and accessed through form rules based on form validation and configured rules. It provides flexibility and control over menu navigation by allowing you to enable, disable, show, or hide individual menu nodes and links.

Follow the steps below to create a new Global Menu:

  1. Navigate to Global Menu from the Hamburger menu.
  2. Click the “New Menu” button to create a new Global Menu. The currently active Global Menu will be highlighted, as shown in the image below.
  1. The Properties window will appear. Configure the required properties as described below.

Global Menu Properties

  1. Menu Name: Enter a name for the Global Menu.
  2. Menu Alignment: Specify the alignment of the Global Menu in the Render View (App View). You can select either Top or Left. 

NOTE : To display the Global Menu in the webpart, either “Enable Top Navigation” or “Enable Left Navigation” must be enabled under the Menu Navigation tab in Navigation Settings.

  1. Load Menu By Default: Select this option to load the Global Menu automatically by default. If the tenant has multiple Global Menus, the selected default Global Menu will be highlighted in green.

Root Item Styles

The Root Item Style tab allows you to customize the appearance of the main menu items.

Root Item Style

  • Font Family: Specifies the font family for root menu items.
  • Font Color: Sets the font color of root menu items.
  • Font Size: Defines the font size of root menu items.
  • Background Color: Sets the background color of root menu items.
  • Height: Specifies the height of root menu items.

Root Item Hover Style

These properties define the appearance of a root menu item when the user hovers over it.

  • Font Family: Specifies the font family when hovering over a root menu item.
  • Font Color: Sets the font color when hovering over a root menu item.
  • Font Size: Defines the font size when hovering over a root menu item.
  • Background Color: Sets the background color when hovering over a root menu item.

Sub Item Styles

The Sub Item Style tab allows you to customize the appearance of submenu items.

Sub Item Style

  • Font Family: Specifies the font family for submenu items.
  • Font Color: Sets the font color of submenu items.
  • Font Size: Defines the font size of submenu items.
  • Background Color: Sets the background color of submenu items.
  • Height: Specifies the height of submenu items.

Sub Item Hover Style

These properties define the appearance of submenu items when the user hovers over them.

  • Font Family: Specifies the font family when hovering over a submenu item.
  • Font Color: Sets the font color when hovering over a submenu item.
  • Font Size: Defines the font size when hovering over a submenu item.
  • Background Color: Sets the background color when hovering over a submenu item.

After configuring all the required properties and styles, click Save to create the Global Menu.

The newly created Global Menu will appear in the Global Menu main window.

Global Menu Operations

The following operations are available for managing an already created Global Menu.

1. Edit Global Menu Properties

You can modify the properties of an existing Global Menu by clicking the Edit Menu button. This allows you to update the menu name, alignment, default loading option, and root and submenu styles.

2. Edit Global Menu Nodes

You can modify the properties of individual menu nodes using the Edit Child button.

3. Delete Global Menu

To delete an existing Global Menu:

  • Click the Delete Menu button corresponding to the menu.
  • A confirmation popup will appear.
  • Click OK to confirm the deletion.

Menu Editor

The Menu Editor provides options to create and manage menu nodes and subnodes. It allows you to add, edit, delete, copy, and paste nodes, as well as configure their general and style properties.

You can also modify previously configured Root Item and Sub Item styles through the Root Property section.

Save Menu

After making the required changes in the Menu Editor:

  • Click the Save button on the top toolbar.
  • A confirmation popup will appear.
  • Click OK to complete the saving process.

1. Add Node

You can add a new node in either of the following ways:

  • Click the Add Node option on the top toolbar.
  • Right-click the default node or any existing node in the left panel and select Add Node.

2. Add Sub Node

To add a subnode:

  • Right-click the desired node or subnode in the left panel.
  • Select the Add Sub Node option.
  • The new subnode will be added under the selected parent node.

3. Delete Node

To delete an existing node or subnode:

  • Right-click the desired node in the left panel.
  • Select the Delete Node option.
  • A confirmation popup will appear.
  • Click OK to confirm the deletion.

4. Copy Node

You can copy an existing node or subnode along with its configured properties.

  • Right-click the desired node or subnode in the left panel.
  • Select the Copy Node option.
  • The selected node and its properties will be copied.

5. Paste Node

You can paste a copied node as a subnode under any existing node or subnode.

  • Right-click the desired parent node.
  • Select the Paste Node option.
  • The copied node will be added as a child of the selected node, retaining its copied properties.

6. Expand and Collapse Nodes

Use the expand and collapse icons in the left panel to display or hide the child nodes under a parent node. This helps you navigate and manage the menu hierarchy efficiently.

Node Properties

To configure a node, select the required node from the left panel. Its properties will appear in the right-side panel.

Node properties are divided into two categories:

  • General Properties
  • Style Properties

1. General Properties

The following properties are available for configuring individual nodes.

PropertyDescription
Node IDDisplays the automatically generated unique identifier assigned to the node.
Node NameSpecifies the name of the node.
IconAllows you to select an icon for the node from the Icon View window. After selecting an icon, click OK to apply it.
OrderDefines the display sequence of the nodes in the menu.
Is EnableControls whether the node is enabled or disabled during rendering.
Is VisibleControls whether the node is displayed or hidden during rendering.
Navigation FormSpecifies the form that should open when the user clicks the corresponding menu node.
RulesAllows you to select a rule to execute when the menu node is clicked. The available rules are retrieved from the selected Navigation Form and are displayed after enabling the Trigger Rule property.
Trigger RuleDetermines whether the selected rule under the Rules property should be executed when the menu node is clicked.
Launch As New FormWhen enabled, the form is opened as a new form instance and is not cached after loading.
Is Hidden MenuHides the menu node from the App View (Render View) while allowing its configured rule to be executed programmatically.
Custom HTMLAllows you to configure custom HTML for the selected node.

Navigation Form Configuration

To configure the Navigation Form:

  • Click the Navigation Form option.
  • The Navigation Form popup window will appear.
  • Select the required form.
  • Click Select to complete the configuration.

Rules Configuration

Once a Navigation Form has been selected and the Trigger Rule property is enabled, the available rules associated with that form will be displayed under the Rules property. Select the required rule to execute when the corresponding Global Menu node is clicked.

Is Hidden Menu

Enable this property when you want to hide a Global Menu node from the App View without preventing its associated rule from being executed. 

You can invoke the following JavaScript function to execute the configured rule without navigating through the normal form-loading process (The function can be given on formload trigger in the configured form):

InvokeJavaScript(HandleGlobalMenuClick(NodeName))

Here, NodeName represents the name of the Global Menu node whose configured rule needs to be executed.

2. Style Properties

The Style Properties section allows you to customize the appearance of individual menu nodes.

Copy from Parent Menu: Select this option to apply the style properties of the parent menu to the selected node.

This helps maintain consistent styling across parent and child menu items.

Root Property

The Root Property section allows you to modify the previously configured Root Item and Sub Item styles of the Global Menu.

It contains the following sections:

1. Root Item Style

Allows you to configure the appearance of the main menu items, including:

  • Font Family
  • Font Color
  • Font Size
  • Background Color
  • Height

2. Sub Item Style

Allows you to configure the appearance of submenu items, including:

  • Font Family
  • Font Color
  • Font Size
  • Background Color
  • Height

Any changes made to these properties can be saved and applied to the Global Menu.

Me.TargetRule

Me.TargetRule is used to control the execution of actions based on the rule selected in the Rules property of a Global Menu node.

Its primary purpose is to determine whether specific actions should be executed when a form is loaded through a Global Menu node or when the form is loaded as the startup form.

This functionality helps avoid unnecessary action execution during form loading, thereby improving application performance and reducing form-loading time.

How Me.TargetRule Works

Consider a scenario where a form contains a FormLoad trigger with multiple actions and a decision condition based on Me.TargetRule.

  • Actions placed before the decision condition are always executed when the FormLoad trigger runs.
  • Actions inside the condition Me.TargetRule = “On_Button1” are executed only when the selected rule in the Global Menu’s Rules property is On_Button1 and the form is loaded by clicking the corresponding Global Menu node.
  • Actions inside the Else section are executed only when the form is loaded as a startup form.

Example Scenario

Suppose the Global Menu node is configured to execute the rule On_Button1.

When the user clicks this menu node:

  1. The associated form is loaded.
  2. The FormLoad trigger is executed.
  3. Actions defined before the decision condition are executed.
  4. The condition Me.TargetRule = “On_Button1” is evaluated.
  5. Since the selected Global Menu rule matches On_Button1, the actions inside that condition are executed.
  6. The actions inside the Else section are skipped.

However, when the same form is loaded as the startup form, the actions inside the Else section are executed instead.

This approach allows you to execute specific actions based on how the form is accessed, providing better control over form-loading behavior and improving overall application performance.