menu.xml file

The menu.xml file can be used to override default behavior for displaying the various menu options and Add links within Unanet.  

Note: this functionality is enabled by creating the necessary entries in the menu.xml file, which resides in your system's config directory.  You cannot manage this functionality via the user interface.

The following items can be accomplished via menu.xml entries:

• Remove Menu Items -- If you simply want to remove a menu item all together (for all users), this can be done via menu.xml entries.
   

• Remove Access by Role -- If your objective is to remove access to menu items for users with specific roles, this also can be accomplished via menu.xml entries.  This can be accomplished by including a list of 'role' tags separated by a |  (pipe) symbol, which operates as a logical "OR".  The possible roles that could be referenced include the following (you can also include a ~ symbol after a particular role to indicate the alternate of a particular role -- ie   projectManager~ ):

• System

  • administrator

  Project

  • prAdministrator

  • projectManager

  • projectLead         (will be ignored if included on person import)

  • projectApprover   (will be ignored if included on person import)

  • projectViewer

  • customer

  • billingManager

  • billingViewer

  • resourcePlanner

  • resourceAssigner

  • resourceRequestor

  People

  • HRAdministrator

  • manager

  • viewer

  Financial

  • arAdmin

  • arPoster

  • arUser

  • arViewer

  • apAdmin

  • apPoster

  • apUser

  • apViewer

  • glAdmin

  • glPoster

  • glUser

  • glViewer

  • glBudgetManager

  End User - Roles & Permissions

  • timesheetUser

  • expenseUser

  • unaSourceUser

  • costRateManager

  • costBudgetManager

  • costBudgetViewer

  • billRateManager

  • billBudgetManager

  • billBudgetViewer

   

   

Note that you cannot add access to menu options for roles that do not already have access.

• Remove Add Options -- There are a number of  "add" icons that can be removed from the system as well via menu.xml entries, including:

• • -- available on the Project >> List and Project Dashboard  

  • -- available on various Project Lists  

  • -- available on the Person >> List and Person Dashboard

  • -- available on the Expense >> List and Expense and Home Dashboards   (an example file to accomplish this is shown below)

  • -- available on the Expense >> List and Expense and Home Dashboards

  • -- available on the Time >> List and Time and Home Dashboards

  • -- available on the Project Profile >> People Assignments >> List screen

  • -- available on the Project Profile >> People Assignments >> List screen

  • -- available on the Project Profile >> People Plans >> List screen

  • -- available on the Project Profile >> People Plans >> List screen

  • -- available on the Project Profile >> Expense Budget >> List screen

  • -- available on the Project Profile >> Expense Plan >> List screen

  • -- available on the Admin >> Organization screen
    

• Adding New Menu Options -- You cannot currently add your own / new menu items to the Unanet menu structure.  (see link.xml for adding custom links to the various dashboards)

This file can be viewed/edited by your Unanet Administrator with any standard text editor.   This file is not required.

WARNING - All changes to the menu.xml file should take place in the file located in your config directory.  DO NOT attempt to modify the copy of the menu.xml file packaged within the unanet.war file (this can result in unpredictable system behavior).  

You may also be interested in:

• link.xml -- this file can be used to add a custom link (to an internal or external destination) onto a dashboard as well as to suppress the display of other left and right dashboard column entries.

In order to create these entries, you will need to understand the xml definition in the unanet.dtd and the internal refids, roles values, etc.,  which you may be able to determine by viewing the page source in your browser, however, you should probably contact Unanet Support for assistance with creating appropriate entries for your menu.xml file.

Example menu.xml file

Note that a sample menu.xml file is included in your config directory by default with a number of common entries commented out.

Note: all lines beginning with    <!--    and ending with    -->      are comments.  In order to activate the commented out example entries in the default file above, you would need to remove the comment symbols from before and after the desired rows.  

The following example file would hide the Expense Requests add icon, but the removal of the copy project menu is still commented out.