The navigation menu and launch page

You can configure the items in the navigation menu on the left and on the launch page of Oracle Commerce Workbench by modifying the ws-mainMenu.xml file in %ENDECA_TOOLS_CONF%\conf (on Windows) or $ENDECA_TOOLS_CONF/conf (on UNIX).

By editing ws-mainMenu.xml, you can do any of the following:

A menu item is either a leaf or a node. A node is a top-level menu item that does not link directly to any pages.

Instead it has children that are leaf items and are displayed in a submenu. Each node is defined in a <menunode> element in ws-mainMenu.xml that takes the following attributes.

Note

The defaultName, defaultDescription, and defaultIcon values are only used if equivalent attributes are not specified in the resource property files in the conf/locales folder. For example, if you do not specify a menu node name for French locales in those resource property files, then the defaultName value is used. For more information on locales, see Localizing menu nodes.

Attribute name

Attribute value

Required

id

The id of a predefined node in Oracle Endeca Workbench or a unique string identifying a custom node. For more information on predefined nodes, see “Predefined menu nodes in Oracle Commerce Workbench.”

yes

defaultName

The display name for this node that appears in the navigation menu.

no

defaultTitle

Deprecated in release 4.0.0. Use defaultName instead.

 

defaultDescription

A brief description of this node that appears on the launch page in Oracle Commerce Workbench.

no

defaultIcon

An absolute or relative URL to a custom image for this node’s entry on the launch page. (Relative URLs are relative to <hostname>:8006.

no

A menunode element requires one or more child menuitem elements.

This example of a ws-mainMenu.xml file defines a custom menu node with extensions as its child items. 

<?xml version="1.0" encoding="UTF-8"?>

<mainmenu xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:noNamespaceSchemaLocation="mainMenu.xsd">
	<menunode id="myextensions" 
       defaultName="My Extensions"
       defaultDescription="These are my custom extensions.">
		<menuitem id="extensionA"/>
		<menuitem id="extensionB"/>
	</menunode>
</mainmenu>

There are several predefined menu nodes in Oracle Endeca Workbench. You can specify the placement of the predefined nodes in the menu and what items display under them, but you cannot modify the titles or specify localized titles.

The predefined nodes in Oracle Commerce Workbench are as follows:

Node id

Node description

reports

Reports

settings

Application Settings

administration

Administration

A leaf is a menu item that links to a page, and also has an entry on the launch page.

A leaf can be either in the top-level menu or in a submenu as the child of a node. Leaf items cannot have child items. Menu items display in the order in which they are listed in ws-mainMenu.xml.

Each leaf in the menu is defined in a menuitem element in ws-mainMenu.xml that takes the following attributes:

Attribute name

Attribute value

Required?

id

The id of a predefined page in Workbench or the id of an extension as defined in ws-extensions.xml. For more information about extensions, see “Workbench extensions."

yes

onLaunchPage

Deprecated and ignored in release 3.1.1. If set to true, the menu item displays on the launch page in the order in which it is listed in ws-mainMenu.xml. Default value is false.

no

Note

For a full list of predefined pages and their corresponding ids, see "Predefined menuitem elements."

This example of a ws-mainMenu.xml file defines a menu that shows top-level leaf items, items nested within a predefined node. 

<?xml version="1.0" encoding="UTF-8"?>

<mainmenu xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="mainMenu.xsd">

    <menuitem id="xmgr"/>
    <menuitem id="thesaurus"/>
    <menunode id="reports">
        <menuitem id="reports.today"/>
        <menuitem id="reports.daily"/>
        <menuitem id="reports.weekly"/>
    </menunode>
    <menunode id="settings">
        <menuitem id="user-segments"/>
        <menuitem id="preview-settings"/>
        <menuitem id="report-settings"/>
    </menunode>
    <menunode id="administration">
        <menuitem id="locks"/>
        <menuitem id="user-management"/>
        <menuitem id="eac-settings"/>
    </menunode>
				<menuitem id="eac-admin-console"/>
</mainmenu>

This section is a reference table listing all of the predefined pages and corresponding ids available in the ws-mainMenu.xml file.

The predefined pages and their corresponding ids are as follows:

Workbench page

Menu item id

Experience Manager

Note

This menu item is only available in installations of Oracle Commerce Guided Search that include Experience Manager.

xmgr

Rule Manager

Note

This menu item is only available in the Oracle Commerce Guided Search package.

rmgr

Thesaurus

thesaurus

Today's Reports

reports.today

Daily Reports

reports.daily

Weekly Reports

reports.weekly

Report Scheduler

report-settings

Preview Settings

Note

This menu item is only available in installations of Oracle Commerce Guided Search that include Experience Manager.

preview-settings

EAC Admin Console

eac-admin-console

EAC Connection Settings

eac-settings

User Segments

user-segments

User Management

user-management

The menu items on the launch page of Oracle Commerce Workbench are configurable.

You can configure the items in the menu and on the Workbench launch page by modifying the ws-mainMenu.xml file in %ENDECA_TOOLS_CONF%\conf (on Windows) or $ENDECA_TOOLS_CONF/conf (on UNIX).

To update the navigation menu and launch page:

  1. Stop the Endeca Tools Service.

  2. Navigate to %ENDECA_TOOLS_CONF%\conf (on Windows) or $ENDECA_TOOLS_CONF/conf (on UNIX).

  3. Open ws-mainMenu.xml in a text editor and add or modify menu items as necessary.

  4. Save and close the file.

  5. Start the Endeca Tools Service.

Copyright © Legal Notices