This site contains the documentation that is relevant to older WSO2 product versions and offerings.
For the latest WSO2 documentation, visit https://wso2.com/documentation/.

Adding Menu Item

Owned by Former user (Deleted)
Last updated: Oct 16, 2012Version comment
2 min read

Described below is how to add a menu item by adding a menu element to the registry extension file.

<menu>
        <id>governance_list_processes_menu</id>
        <i18n-key>List</i18n-key>
        <i18n-bundle>org.wso2.carbon.event.mgt.ui.i18n.Resources</i18n-bundle>
        <parent-menu>governance_processes_menu</parent-menu>
        <link>../generic/list.jsp
        <url-params>key=process</url-params>
        <region>region3</region>
        <order>1</order>
        <style-class>manage</style-class>
        <icon>../images/list.gif</icon>
        <require-permission>/permission/admin/manage/resources/govern/processes/list</require-permission>
    </menu>

The menu definitions are standard to the Carbon Platform, and you can copy any generic menu configuration into this block. Below are simple descriptions of the above elements.

  • id - Menu identifier
  • i18n-key - Name for the new menu item appearing in the list. The key is borrowed from the Resource.properties file.
  • i18n-bundle - Place where you put the Resource.properties file
  • parent-menu - Parent menu
  • link - On-click
  • url-params - Parameters parse on URL
  • region - Which region it belongs to
  • order - Order of appearance in the list
  • style-class - CSS
  • icon - Icon
  • require-permission - User permissions required to see the menu

However, if there is a specifying menu of items to point to JSPs that have been specifically created for representing Governance Artifacts, you need to be mindful of some parameters.

1. ../generic/add_edit.jsp requires the following parameters:

  • key - Must be equal to artifactkey defined above
  • lifecycleAttribute - The attribute used to define the lifecycle
  • breadcrumb - The title of the breadcrumb link for the add_edit.jsp page

2. ../generic/list.jsp requires key, which has to be equal to artifactkey defined in the registry extension file.

3. ../generic/configure.jsp requires the following parameters:

  • key - Must be equal to artifactkey defined in the registry extension file
  • lifecycleAttribute - The attribute used to define the lifecycle
  • breadcrumb - The title of the breadcrumb link for the configure.jsp page
  • add_edit_region - The value of the region parameter of the add_edit.jsp page (same as the region specified in the menu definition that you would use to create a link to the add_edit.jsp page)
  • add_edit_item - The value of the item parameter of the add_edit.jsp }}page (same as the menu ID specified in the menu definition that you would use to create a link to the {{add_edit.jsp page)
  • add_edit_breadcrumb - The title of the breadcrumb link for the add_edit.jsp page