This is an administrator-level activity.
Workplace provides the capability to customize common terms and system properties in the UI. You may find this feature convenient if you prefer site-specific labels over the Workplace defaults, or if you've upgraded from an earlier FileNet product that used different labels than Workplace. For example, you may prefer "libraries" over the Workplace default of "object stores", as shown in the following screenshot.
You can substitute custom labels for system properties as well. For example, for the "Creator" system property, you may prefer that Workplace display the "Added by User" label rather than the default of "Added by", as shown in the following screenshot.
You customize UI labels with the <AE_install_path>/FileNet/Config/AE/ConfigurableLabels.xml file. As shown in the XML snippet below, there are two sets of label types that you can customize: common terms defined under the object element <object key="userInterfaceLabels">, and system properties defined under the object element <object key="systemPropertiesLabels">.
<object key="configurableLabels" version="4.0.0">
<object key="userInterfaceLabels">
<label key="objectStore" localizationKey="server.ConfigurableLabels_xml.ObjectStore">
<resource>Object Store</resource><!-- Default value. DO NOT MODIFY -->
<resource locale="en_US">Library</resource><!-- added by admin -->
<resource locale="fr_FR">Bibliothèque</resource><!-- added by admin -->
</label>
...
</object>
<object key="systemPropertiesLabels">
<label key="Creator">
<resource>Added By</resource>
</label>
...
</object>
</object>
ConfigurableLabels.xml follows the Workplace Preferences XML Schema, Preferences.xsd, located in <AE_install_path>/Workplace/WEB-INF/xml.
Workplace retrieves a custom label from ConfigurableLabels.xml based on the client locale passed in the request. If your Workplace application is supporting clients of various locales, you can set localized UI labels in ConfigurableLabels.xml. Note that the labels that you set in ConfigurableLabels.xml serve as overrides to the labels set in the property resource bundles, thereby sparing you the effort of modifying the UI labels in the resource bundles.
Using the XML example above, if the client locale were "en_US", then Workplace would substitute the term "Library" for the default of "Object Store"; if the client locale were "fr", then Workplace would substitute the term "Bibliothèque". On the other hand, if the client locale were "es-us" (Spanish American) -- for which there is no match in the XML -- then Workplace would use the value of the localizationKey attribute to look up the label in the Spanish American resource bundle.
For a detailed description of the resource lookup logic, see Lookup Precedence for Locale Resources.
NOTE Back up <AE_install_path>/FileNet/Config/AE/ConfigurableLabels.xml before modifying it.
To customize Workplace UI labels:
For example, let's say that you want to add a customized label for "Object Store" in English. First, you would identify the label element for "Object Store". The default label element would be similar to the following:
<label key="objectStore" localizationKey="server.ConfigurableLabels_xml.ObjectStore">
<resource>Object Store</resource><!-- Default value. DO NOT MODIFY -->
</label>
Next, you would would add a resource subelement that includes a locale attribute for English, as shown below. This label would function as an override to the "Object Store" string that is defined in the English/US resource bundle. For the locale attributes, use the standard ISO language and country codes as supported by browsers.
<label key="objectStore" localizationKey="server.ConfigurableLabels_xml.ObjectStore">
<resource>Object Store</resource><!-- Default value. DO NOT MODIFY -->
<resource locale="en_US">Library</resource><!-- Add resource with locale -->
</label>
If you added a new system property in the Workplace System Properties View preference, the property's display name will be used in the Workplace UI by default. You can, however, substitute a custom label for the system property in the Workplace UI, as described below.
To customize a system property label:
Note: Do not modify SystemPropertiesView.xml; use it only for reference.
Note the symbolic name under the object type for which you added the system property in Workplace. For example, if you added a system property called "Publications" for the document object in the Workplace System Properties View preference, you will find the new system property in the SystemPropertiesView.xml file. The system property will not be identified by the "Publications" display name in the file, but rather by its symbolic name, "DestinationDocuments", in the <value> element for "document", as shown below:
...
<array key="document">
...
<value>DestinationDocuments<value> <!-- use this symbolic name for the key attribute in ConfigurableLabels.xml -->
</array>
...
<label key="DestinationDocuments">
<resource>Publications List</resource>
<label>
If you want to include a label for a non-English locale, add a resource subelement that specifies the locale and the label string, for example:.
<label key="DestinationDocuments">
<resource>Publications List</resource>
<resource locale="it_IT">Lista delle Pubblicazioni</resource>
<label>