Integrating tools into a Tools User Interface Center

The steps below describe how to integrate a tool into the WebSphere Commerce Accelerator. For other Tools User Interface Centers, follow the same steps using that tool's XML and resource bundle files.

  1. Open the following file:

    Add menu items, nodes, or both to the preceding XML file similar to the following example: 

    <menuitem name="customerService" enabled="true" component="CommerceAnalyzer" 
      users="cusRep merchant siteAdmin"> 
   <node name="customers" component="CampaignManagement" 
         url="/webapp/wcs/tools/servlet/Calendar" users="merchant" />
.
.
.
</menuitem>

    Both the <menuitem> and the <node> elements support the following attributes, as used in the preceding code sample:

    Attribute Description
    name A required attribute that names the menu. This name is a key in the resource bundle file. If null, a default message is used. For example, 
    menuName ="myMenuText"
    enabled A required attribute for the <menuitem> element, which determines whether the menu is available for selection. The value can be either true or false.
    component An optional element which specifies the component with which the menu item is associated. Components can be turned on or off using Configuration Manager. A menu item associated with a component which is disabled does not display.
    url A required element which specifies the target URL for the menuitem. When this URL is called, the tool displays in the content frame.
    users A required attribute that defines the access control for the menu. Unauthorized users will not see the menu or node when they log on. The value must be a space delimited list of the roles that are permitted to perform the action associated with the menuitem. These names are defined in the roles.xml file, and match the ID column in the MBRGRP table. For example, 
    users="makMgr merMgr merchant siteAdmin"

    The roles are predefined in the ROLE table and the roles.xml file.

    type An optional attribute that specifies the type of the menuitem, help is the only value supported.
    display - optional An optional attribute that specifies whether this menuitem is visible or not. The default value is true.

  2. Create a resource bundle.

  3. Update the resource bundle for the menu and node name. For example, the resource bundle file for WebSphere Commerce Accelerator is:

    • WC_installdir/properties/com/ibm/commerce/tools/properties/mccNLS_locale.properties

    • WCDE_installdir/properties/com/ibm/commerce/tools/properties/mccNLS_locale.properties

    If you are customizing a different Tools User Interface Center, find the reference to the resource bundle file name at the top of the XML file, in a line similar to the following: 

     <menu resourceBundle="common.mccNLS">

Related concepts

Related tasks

Related reference