Menus Configuration¶

Navigation Bar¶

The application_menu is the main menu of the Management Console in Oro application. It resides on the top of every application page and you can use it to navigate through 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, unselect 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:

In a left position, Application Menu (Navigation Bar) may be collapsed into the icon bar:

or expanded for visible labels and sub-menu items:

Shortcuts¶

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

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.

User Menu¶

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

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.

Customize Default Management Console Menus¶

To customize one of the default management console menus (e.g. navigation bar or user menu):

1. Navigate to the management console menu list by clicking 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 Management Console Menus per Organization¶

To customize one of the management console menus (e.g. navigation bar or user menu) for a particular organization:

1. Navigate to the management console menu list by clicking 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 Management Console Menus for Your Own Use¶

To customize one of the management console menus (e.g. navigation bar or user menu) 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.

Generic Principles¶

A menu may be multi-level like, for example, a default OroCRM and OroCommerce Management Console main menu. The child menu items are nested under parent menu items (e.g. Accounts, etc are nested under the Customers).

Menu items on the same level of hierarchy may be visually separated by a divider that looks like a horizontal line.

Dividers help you logically organize menu items.

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 Management Console main menu (application_menu), the divider is not displayed.

Edit a 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.

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

Toggle the Menu Tree View¶

Hide / Show the Menu Tree¶

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

Expand / Collapse a Menu Tree¶

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

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.

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 drop-down on the top right and click Create Menu Item on the 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 Rearrange Menu Items / Dividers 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.

     

   • URI—An 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.

     Note

     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.

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.

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 Rearrange Menu Items / Dividers action description.

View / Edit a Menu Item¶

1. In the left panel, click a menu item that you want to view / edit.
2. In the right part of the page, review / edit the menu item settings. See step 3 of the Add a Menu Item action description for information about menu item fields.

Toggle Item Visibility¶

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.

Delete a Menu Item / Divider¶

1. In the left panel, click a menu item / divider that you want to delete.
2. Click Delete on the top right.
3. In the Delete Confirmation dialog box, click Yes, Delete.

Reset a Menu¶

To reset any customization changes and roll back to the menu that is provided out of the box in Oro application:

1. In the left panel, click a menu name.
2. Click Reset on the top right.
3. In the Reset Confirmation dialog box, click Yes, Reset.