Set an image for ConcourseSuite Community Edition

Sign In or Register

ConcourseSuite Community Edition

Core Team
PostgreSQL Java
PUBLIC PROFILE

Renaming Modules and Menu Items

Modules and Menu Items can be renamed through the system.xml in the fileLibrary. This allows a user to rename modules to better reflect the terminology used by their business.

How It Works

The system.xml file can have values specified for modules and and sub-container menu items that override those specified in the default configuration. This default configuration is set in the "cfs-config.xml" file in "WEB-INF" directory, to override an existing module or menu name the entry in system.xml must use the same value in the name attribute of the cfs-config.xml file.

Procedure

The following procedure outlines the steps involved, and includes snippets of an example scenario of renaming the "Help Desk" module to "Bug Tracking" and renaming the "Export" sub-menu item to "Download Ticket Details".

  • Search through the cfs-config.xml file for "Help Desk" and "Export" and collect the correct names

For Help Desk we find the following snippet:

    <page title="Help Desk"/>
    <permission value="tickets-view"/>
    <long_html value="Help Desk"/>
    <short_html value="Help Desk"/>

Note: Modules names are always in <page /> tags with their name specified in the "title" attribute
Looking a little farther down we find Export in the following snippet:

    <submenu name="Reports">
      <permission value="tickets-reports-view"/>
      <long_html value="Export"/>
      <short_html value="Export"/>
      <link value="TroubleTickets.do?command=Reports"/>
    </submenu>

We need to collect the submenu name which in this case is "Reports". It doesn't match "Export", but the <long_html /> <short_html /> values are what is seen on the webpage, so we know we're using the right submenu element.

  • Update system.xml with the corresponding entries

If you've never modified the system.xml file before you should find the following, if you don't see it you just need to add a "<config name="system.modules.label" enabled="true"> </config>" to the document. This is where the "Help Desk" module will be renamed.

  <!-- The following are the menu names that are renamed -->
	<config name="system.modules.label" enabled="false">
    <param name="Employees">
			<page_title>Users</page_title>
			<menu_title>Users</menu_title>
		</param>
		<param name="Accounts">
			<page_title>Prospects</page_title>
			<menu_title>Prospects</menu_title>
		</param>
		<param name="Documents">
			<page_title>Document Library</page_title>
			<menu_title>![CDATA[Document
Library]]</menu_title> </param> </config>

The enabled attribute has initially been set to false so anything inside is ignored. We'll need to update it to true, and then either delete or comment out the <param /> elements not being changed.
After adding in the param to rename "Help Desk" to "Bug Tracking" the snippet now looks like:

  <!-- The following are the menu names that are renamed -->
	<config name="system.modules.label" enabled="false">
                 <param name="Help Desk">
			<page_title>Bug Tracking</page_title>
			<menu_title>Bug Tracking</menu_title>
		</param>               
               <!--
                <param name="Employees">
			<page_title>Users</page_title>
			<menu_title>Users</menu_title>
		</param>
		<param name="Accounts">
			<page_title>Prospects</page_title>
			<menu_title>Prospects</menu_title>
		</param>
		<param name="Documents">
			<page_title>Document Library</page_title>
			<menu_title>![CDATA[Document
Library]]</menu_title> </param> --> </config>

For renaming the "Export" sub-menu item we'll update another snippet:

  <!-- The following are the container names that are relabeled -->
  <config name="system.container.menu.label" enabled="false">
    <param name="accounts.tickets.long_html">
      <value>Actions</value>
    </param>
    <param name="accounts.folders.long_html">
      <value>Application</value>
    </param>
  </config>

This <config /> element also needs it's enabled status updated to "true", and the extra params deleted or commented out.
After updating the element with the rename the snippet now looks like the following:

  <!-- The following are the container names that are relabeled -->
  <config name="system.container.menu.label" enabled="true">
    <param name="helpdesk.reports.long_html">
      <value>Download Ticket Details</value>
    </param>
   <!--
    <param name="accounts.tickets.long_html">
      <value>Actions</value>
    </param>
    <param name="accounts.folders.long_html">
      <value>Application</value>
    </param>
    -->
  </config>

Sign in to add your comment.