Examples: Changing displayed text in the user interface

You can modify the text shown in the user interface to change labels, tabs, or other strings. Strings that you can change are defined in a single resource file, cwexml.strings.<locale>.prb. To change a string, locate the resource key for the string in the configuration file, then find that key in the resource file. Edit the resource file to assign your new text to the key.

Detailed examples follow.

Example 1: Changing "Tasks" to "Action Items"

For this example, assume that you want to change "Tasks" to "Action Items" in your customized version of the TCM application. To do this, you do the following:

  1. Open the TCMConfig.xml file for editing. The TCMConfig.xml file is located by default in the C:\Program Files\FileNet\Collaboration\TCM\WEB-INF\Config folder on the Collaboration Engine.
  2. Find the Tasks object type in the file. Specifically, you should see the following:
     <object-type id="tasks">
  3. Locate the resource key for the label related to the Tasks page and make a note of it:
     <label localKey="cwexml.TCMConfig_xml.taskOverviewLabel">Tasks Overview</label>
  4. Open the resource file cwexml.strings.<locale>.prb for editing. This file is located by default in the C:\Program Files\FileNet\Collaboration\TCM\WEB-INF\resources folder on the Collaboration Engine. (The <locale> identifies the language and locale. You may have different versions of the resource string file for different localized versions.)
  5. Search the file for the string identified above. In practice, you should search for all occurrences of "task" and evaluate whether to change each one. Change the string "Tasks" to your new label, "Action Items."
  6. You also must make similar changes to any entries controlled within the appConfig.xml file. (The appConfig.xml file is located in the C:\Program Files\FileNet\Collaboration\TCM\WEB-INF\Config folder on the Collaboration Engine.)
  7. Find the Tasks object type in the file, as you did for the TCMConfig.xml file. Make a note of the resource key:
            <object-type id="tasks">
    <label localKey="cwexml.appConfig_xml.typeTasks">Tasks</label>
    <image>Tasks16</image>
    </object-type>
  8. Open the resource file cwexml.strings.<locale>.prb for editing. Search the file for the string identified above. Change the string "Tasks" to your new label, "Action Items."
  9. Save and close all files. Recycle the Application Server (Tomcat, Weblogic, etc.) to eliminate any cached copies of the configuration files, then restart the Collaboration Engine.

Example 2: Renaming the "Home" tab to "Start Here"

  1. Open the TCMConfig.xml file for editing. The TCMConfig.xml file is located by default in the C:\Program Files\FileNet\Collaboration\TCM\WEB-INF\Config folder on the Collaboration Engine.
  2. Find the Home view in the file and locate the resource keys for the label and the tooltip. Specifically, you should see the following:
       <!-- views -->
    <view id="Home">
    <help-topic>home</help-topic>
    <label localKey="cwexml.TCMConfig_xml.homeLabel">Home</label>
    <tooltip localKey="cwexml.TCMConfig_xml.homeTooltip">Home</tooltip>
  3. Open the resource file cwexml.strings.<locale>.prb for editing. This file is located by default in the C:\Program Files\FileNet\Collaboration\TCM\WEB-INF\resources folder on the Collaboration Engine. (The <locale> identifies the language and locale. You may have different versions of the resource string file for different localized versions.)
  4. Search the file for the strings identified above. In practice, you should search for all occurrences of "Home" and evaluate whether to change each one. Change the string "Home" to your new label, "Start Here."
  5. In this specific example, there are no strings controlled by the appConfig.xml file that you need to change. However, when you are changing a string in the user interface, you should also check appConfig.xml file for other strings.
  6. Save and close all files. Recycle the Application Server (Tomcat, Weblogic, etc.) to eliminate any cached copies of the configuration files, then restart the Collaboration Engine.