8 Customizing Menus

Menu items are displayed as links in the left panel of the Administrative and User Console. This chapter describes how to customize the menus in the Administrative and User Console.

To customize the menus in the Administrative and User Console:

1. Identify the menu group or item that you want to customize and obtain the class name of the menu group or item by using the Form Information form in the Oracle Identity Manager Design Console.

   For example, the class name for the Request New Resources item on the My Resources menu is My Resources.Request New Resources. This name is stored in the database WIN table. The corresponding menu item shows that the menu group code is My Resources and the menu item code is Request New Resources.

2. Open the xlWebAdmin.properties or xlDefaultAdmin.properties files. Table 8-1 identifies the locations of the files for each supported application server.

   Table 8-1 Location of xlWebAdmin Properties and xlDefaultAdmin.properties Files

   Application Server	Location
   Oracle Application Server	In a nonclustered environment, the files are available in OAS_HOME\product\10.1.3.1\OracleAS_1\j2ee\home\applications\Xellerate\xlWebApp\WEB-INF\classes\. In a clustered environment, the files are available in OAS_HOME\product\10.1.3.1\OracleAS_1\j2ee\member\applications\Xellerate\xlWebApp\WEB-INF\classes\.
   JBoss Application Server	In a nonclustered environment: Extract xlWebApp.war from the EAR file located in JBOSS_HOME\server\default\deploy\XellerateFull.ear. Extract xlWebApp.war\WEB-INF\classes\xlWebAdmin.properties and xlWebApp.war\WEB-INF\classes\xlDefaultAdmin.properties from the WAR file. Edit the xlWebAdmin.properties file or xlDefaultAdmin.properties file. Repackage the WAR file. Repackage the EAR file. In a clustered environment, extract xlWebApp.war from the EAR file located in JBOSS_HOME\server\all\deploy\XellerateFull.ear, and then perform steps 2 through 6.
   IBM WebSphere Application Server	Files are available in WAS_HOME\AppServer\profiles\profile_name\installedApps\node_name\XellerateFull.ear\xlWebApp.war\WEB-INF\classes.
   Oracle WebLogic Server	In a nonclustered environment, the files are available in BEA_HOME\user_projects\domains\domain_name\XLApplications\WLXellerateFull.ear\xlWebApp.war. In a clustered environment: Admin Server: The files are available in BEA_HOME\user_projects\domains\xldomain\XLApplications\WLXellerateFull.ear\xlWebApp.war\WEB-INF\classes. Managed Server: The files are available in WL_HOME\wlserver_10.3\common\nodemanager\MANAGED_SERVER_NAME\stage\Xellerate\xlWebApp.war\WEB-INF\classes\. For the manager server, the files must be modified on all the nodes.

   
   

3. To modify a menu group, locate in the xlWebAdmin.properties file the property name for the menu group that you want to customize. Each menu group has a single property associated with it, which represents the display label.

   The property name for the menu group display label has the form menuGroup.menu group code with the spaces replaced by hyphens ( - ). For example, for a menu group with code My Resources, the property name is menuGroup.My-Resources. Modify the value assigned to the property to the label you want to display.

   Each menu item has two properties associated with it: the menu item display label property and the menu item link property, which identifies the target page that is displayed when a menu item is selected. The menu item display label property is defined in the xlWebAdmin.properties file and the menu item link property is defined in the xlDefaultAdmin.properties file.

   The property name for a menu item display label has the form menuItem.menu group code.menu item code with the spaces replaced by hyphens. This means that a menu item with the code Request-New-Resources under a menu group with the code My-Resources has a property name of menuItem.My-Resources.Request-New-Resources. The menu item link property is in the form menuItem.menu group code.menu item code.link.

4. To create new menu items or groups, you first create the correct entries in the system by using the Form Information form in the Oracle Identity Manager Design Console. Next, you add the corresponding new properties mentioned in step 3. For each new menu group, one new property is required, and for each new menu item, two new properties are needed.

   For instance, you want to add a new menu group with the code My Links and two new menu items under it, with codes Favorites and Non-Work Links. You must create two new entries in the system by using the Form Information form in the Design Console with the class names My Links.Favorites and My Links.Non-Work Links.

   Note:

   You can specify any class names you want, and the labels that are displayed do not depend on these names.

5. Add the following properties to the xlWebAdmin.properties file by using the class names specified in step 7:

   menuGroup.My-Links=My Links
   menuGroup.My-Links.Favorites=Favorites
   menuGroup.My-Links.Non-Work-Links=Non-Work Links
   

6. Add the following properties to the xlDefaultAdmin.properties file by using the class names specified in step 7:

   menuGroup.My-Links.Favorites.link=favorites.do?myfavorites
   menuGroup.My-Links Non-Work-Links.link=nonworklinks.do?nonworklinks
   

Note:

To change the menu group or item names, only the xlWebAdmin.properties and xlDefaultAdmin.properties files must be changed. No change is required in the database or code.