Available in OroCRM Available in OroCommerce

Configure Back-Office Menus

In this section, you will learn the menu types available for the OroCommerce and OroCRM Backend and how to configure them.

Backend Menus Overview

All the menus for the Oro backend are located in the main menu under System > Menus.

../../../../_images/all_menus.png

Application_menu

The application_menu (navigation bar) is the main menu of the back-office in the Oro application. It resides on the top of every application page and you can use it to navigate through the Oro application. Subject to configuration, it may be displayed horizontally or vertically. To toggle the way it is displayed, navigate to the System > Configuration section using the main menu, and open System configuration > General Setup > Display Settings in the panel to the left. In the Navigation Bar section, clear the Use Default option and select the Top or Left position.

In the latter case, the menu items are displayed as icons. For more information, see Main Menu.

In a top position, application menu (navigation bar) looks like a top menu with a drop-down sub-menus that expand once you hover over the parent item:

../../../../_images/ApplicationMenu.png

In a left position, application menu (navigation bar) may be collapsed into the icon bar:

../../../../_images/ApplicationMenuVertical.png

or expanded for visible labels and sub-menu items:

../../../../_images/ApplicationMenuVerticalExpanded.png

Shortcuts

You can find the shortcuts menu in the top panel of the application, next to the organization name.

../../../../_images/shortcut_full1.png

It helps you pin the frequently used actions and have them handy. You can launch an action by clicking it in the dynamically generated Most Used Actions list. This list is updated as you are using the system, and will initially contain the actions that you use the most.

To access other shortcuts, click See the full list to see complete list of shortcut items or use search: start typing the name of a related entity or an action to choose from a list of matching items.

Usermenu

In the back-office, a user can access their profile configuration, emails, tasks and events via the usermenu (by clicking on your name on the top right of the application).

../../../../_images/user_menu.png

Calendar_menu

A calendar_menu is a service menu that is used on the My Calendar page and helps to change the displayed calendar color, hide or remove a calendar.

../../../../_images/menus_calendar_menu.png

Permissions Required to Customize Menus

The ability to configure menus globally, per organization, and for personal use is controlled by the two capabilities: Manage Menus and Access system configuration.

By default, only users with Admin role have these capabilities enabled and may customize menus on all configuration levels.

To enable a user to personalise menus for themselves and configure menus for each organization individually, include the Manage Menus capability into the user role.

To enable a user to configure menus globally, for all organizations, websites, and users whose configuration fall back to the global settings, both Manage Menus and Access system configuration capabilities should be enabled for the user role.

Backend Menus Configuration

In Oro applications, you can customize the backend menus look, and the elements they contain globally, per organization, and for your own use.

Customize Backend Menus Globally

To customize one of the default backend menus (e.g., application_menu or usermenu):

  1. Navigate to System > Menus in the main menu.
  2. Click on the menu you would like to edit.
  3. Update the menu contents following the guidelines provided in the Customize a Menu section. The changes apply automatically.

Customize Backend Menus per Organization

Note

This option is available in the Enterprise edition only.

To customize one of the backend menus (e.g., application_menu or usermenu) for a particular organization:

  1. Navigate to System > User Management > Organizations in the main menu.
  2. Click on the organization you would like to edit the menu for.
  3. Click Edit Menu.
  4. Update the menu contents following the guidelines provided in the Customize a Menu section. The changes apply automatically.

Customize Backend Menus for Your Own Use

To customize one of the backend menus (e.g., application_menu or usermenu) for your own use:

  1. Click on your name at the top right of the page and then click My User to open your profile.
  2. Select Edit Menus from the More Actions list at the top right of the page.
  3. Update the menu contents following the guidelines provided in the Customize a Menu section. The changes apply automatically.

Backend Menus Management

A backend menu may be multi-level like, for example, a default OroCRM and OroCommerce back-office main menu. The child menu items are nested under parent menu items (e.g., Accounts, Contacts, Customers, and others are nested under Customers).

../../../../_images/menus_general.png

Menu items on the same level of hierarchy may be visually separated by a divider that looks like a horizontal line and helps you logically organize menu items.

../../../../_images/user_menu_divider.png

Note

Some menus do not support displaying dividers (on a particular level in the tree, or in general). For example, if you add a divider to the top level of OroCRM and OroCommerce back-office main menu (application_menu), the divider is not displayed.

../../../../_images/ApplicationMenu.png

Edit a Backend Menu

To view and edit menu contents, click on the menu name or on the View icon in the corresponding row of the menu list.

../../../../_images/Menus.png

On the page that opens, the menu item tree is shown in the left panel. Center is reserved for the menu item configuration.

../../../../_images/menus_general.png

Toggle the Menu Tree View

  1. To minimize or maximize the left menu panel, click a double arrow on the top right of the panel.

  2. To expand / collapse all menu items, click the ellipses drop-down menu on the top right of the left panel and click Expand All or Collapse All.

  3. To expand / collapse a parent menu item, click an arrow in front of it.

    ../../../../_images/edit_menu.png
  1. To change the position of an item / divider in a menu, drag and drop it in the left panel. You can change the order of menu items at the same level as well as move an item / divider to the higher or lower level. When you drag-and-drop items, pay attention to the arrow that shows where the item will be placed:
  • If an arrow points to the place between items, that is where the moved item will be placed.

    ../../../../_images/menus_actions_d&dsame.png
  • If and arrow appears in front of a menu item, then the moved item will become a child of the item that the arrow points to.

Add a Menu Item

  1. In the left panel, click a menu item which will be parent for the menu item that you create.

  2. Click Create Menu Item on the top right and then Create Menu Item from the dropdown list.

    The created menu item will appear as the last one on the list of children of the same parent item. You can move it to the position that you need, as described in the Toggle the Menu Tree View action description.

  3. In the right part of the page, specify the following information:

    • Title—A name for the menu item. This is how this menu item will be represented in the menu.

      Click the Translations icon to provide spelling for different languages. Click the Default Language icon to return to the single-language view.

      ../../../../_images/menus_actions_create_translations.png
    • URI—A web address of the page or resource that this menu item opens.

      You can specify an absolute URI or one relative to the application URI (as specified in Application Settings in System Configuration).

      If this menu item serves as a non-clickable parent that does not link itself to any resource (like Customers in the default main menu), type #.

    • Icon—From the list, select the icon that will denote the menu item.

      Sometimes menus (or menu levels) may not be supposed to display icons. For example, icons added to the first level of the main menu (application_menu) are displayed only when this menu is set to appear on the left.

    • Description—Type a short but meaningful description of the menu item.

      Click the Translations icon to provide spelling for different languages. Click the Default Language icon to return to the single-language view.

  4. Click Save to save your changes. If you wish to start creating another menu item right away, click Save and New on the top right.

Important

You need to reload the page to see the changes.

Add a Divider

  1. In the left panel, click a menu item which will be parent for the menu divider that you create.
  2. Click Create drop-down on the top right and select Create Divider.
../../../../_images/menus_createdivider1.png

The created divider will appear as the last one on the list of children of the same parent item. You can move it to the position that you need, as described in the Toggle the Menu Tree View action description. Reload the page to see changes.

Note

Some menus (or some menu levels) cannot display dividers. For example, if you add a divider to the first level of the main menu (application_menu), this divider will not be displayed.

Toggle Item Visibility

  1. Hide a Menu Item — To hide the default menu items from the interface, click the necessary menu item in the left panel. Click Hide on the top right. Reload the page to see changes.

    Important

    • If a menu that you hide has child items, they will be hidden too.
    • You cannot hide non-default menu items.
  2. Show a Menu Item — To show a previously hidden menu item, click the necessary menu item in the left panel. Click Show on the top right. Reload the page to see changes.

    Note

    If a menu item that you want to show has a parent, it will become visible too.

  3. Find a Menu Item — To quickly find a menu item, enter its name into the search field and click the Search icon, or press Enter.

    ../../../../_images/menus_application_search.png
  4. Delete a Menu Item / Divider — To delete a menu item or a divider, click the necessary item in the left panel. Click Delete on the top right. In the Delete Confirmation dialog box, click Yes, Delete. Reload the page to see changes.

    Important

    • You cannot delete default menu items.
    • When you delete a menu item that has child items, they will not be deleted but moved to the parent of the menu item that you delete.
  5. Reset a Menu — To reset any customization changes and roll back to the menu that is provided out-of-the-box in the Oro application, click a menu name in the left panel. Click Reset on the top right. In the Reset Confirmation dialog box, click Yes, Reset. Reload the page to see changes.