Customize main menu

You can customize the main menu by adding, editing, and moving menu items as well as exporting and importing the menu.

Prerequisites

To customize the main menu, the following requirements must be met:

  • The SideNav Menu feature toggle is turned on. For details, see Use feature toggles to turn on/off features.
  • You must the have the Configuration - Access to all Applications and their configuration, except User Administration license and the Sys Admin: Server Tools: Execute Admin Tools access grant.

Back to top

Add a folder or a menu item

You can add a new folder or a menu item. A menu item opens a specific page. A folder is a submenu that can be expanded or collapsed with menu items nested below.

To add a new folder or a menu item:

  1. Click the Administration button in the masthead.

  2. From the Administration menu, select System Appearance Customization > Menu Customization.

  3. On the Menu Customization page, hover over the folder where you want to add a new folder or menu item and click the Add button .

    • To add a folder, click Add Folder. This creates a new folder where you can organize related menu items. A folder can contain sub-folders up to three levels deep.

    • To add a menu item, click Add Menu Item. This creates a menu item that links to a specific page.

  4. Edit the new folder or menu item. For details, see Edit a folder or a menu item.

Back to top

Edit a folder or a menu item

Edit the attributes of a folder or a menu item, restrict its access, and rearrange its position and structure.

To edit a folder or a menu item:

  1. On the Menu Customization page, hover over the folder or menu item to edit and click the Edit button .
  2. In the Edit Folder or Edit Menu Item dialog box, edit the following attributes for the folder or menu item and click Save.

    Attribute Description

    ID

    The system identifier for the folder or menu item. You cannot edit this field for preconfigured menu items.

    Label

    System generated. This field is not editable.

    Key

    The name displayed for the folder or menu item.

    Bundle

    To translate the folder or menu item into multiple languages, provide the properties bundle used for translation. Leave this field blank if not needed. For details, see Multilingual User Interface.

    URL

    Applicable to menu items only. The URL for the linked page.

  3. By default, the folder or menu item is accessible to all users. You can restrict access to the folder or menu item in the Configure Menu Access area.

    • To add a condition that specifies a single criterion, click Add Condition.
    • To add a condition group that specifies multiple criteria, click Add Condition Group.

    You can use the following criteria or a combination of them. Access criteria set for a folder also applies to all the sub-folders and menu items under it.

    • Security group: The folder or menu item is available or not available to specified groups of users.

    • Access grant: The folder or menu item is available or not available to users with the specified access grant.

    • Feature toggle: The folder or menu item is available or not available when the specified feature toggle is turned on or off.

    • Server parameter: The folder or menu item is available or not available when the specified parameter is enabled or disabled.

      Note: Only server parameters with a value of True or False can be selected. Parameters with other values or no values set are not listed.

    • License: The folder or menu item is available or not available for users with or without the specified license.

To adjust the position of a folder or a menu item:

Drag and drop the folder or menu item to any place except under the My Links folder.

When you move a folder, all sub-folders and menu items in the folder are moved.

Back to top

Delete or hide a folder or a menu item

You can delete a custom folder or menu item. You cannot delete preconfigured folders or menu items; you can only hide them.

To delete or hide a folder or a menu item:

Hover over the folder or menu item and use the following options:

Option Description
Remove

Removes a custom folder or menu item.

Preconfigured folders or menu items cannot be removed.

Removing a folder also removes all its sub-folders and menu items.

Hide

Hides the folder or menu item.

Hiding a folder also hides all its sub-folders and menu items.

Back to top

Preview the menu

As you add, edit, hide, and move folders or menu items, the Preview area shows the changes in real time. The Preview area displays the menu based on the access criteria configured in the Configure Menu Access area. For details, see Configure menu access.

For example, if a menu item is configured to be available only to users in a specific security group and you are not part of that group, you will not see the menu item in the Preview area.

Back to top

Export and import the menu

You can export the menu from one instance and import it into another, for example, from a test environment to a production environment.

To export and import the menu:

  1. In the source instance, open the Menu Customization page and click Export to save the menu as a JSON file.

  2. In the target instance, open the Menu Customization page, click Import, and then select the JSON file.

  3. Click Yes to confirm the import.

    Importing the menu replaces all existing menu items in the target instance with those from the source instance. Menu items in the target instance that do not exist in the source instance are removed.

Back to top

See also: