The following table lists the XML and properties files used to configure Workplace XT. Some files must be modified manually, whereas others can be changed through the Workplace XT user interface.
NOTE A modified Workplace XT configuration file must be reloaded for the new settings to take affect. In most cases, you can simply reload the file from Workplace XT. However, for some modified files, you must restart the web server on which the Workplace XT application is deployed.
Configuration file | Description |
---|---|
Actions.xml | Defines the actions that are displayed in the selected object's Information page. In some cases, a secondary Workplace XT page may display a list view control; in these cases, the context menu is controlled by this file. The actions displayed on the Workplace XT primary pages are not controlled by this file. See MenuActions.xml. |
bootstrap.properties | Defines Bootstrap values for Workplace XT. These can be updated through the Bootstrap page in Site Preferences. See Bootstrap Preferences. |
ClassFilter.xml | Excludes classes from displaying in the Workplace XT Add and Checkin wizards. Exclusions are defined on a per object store basis for each object type (document, folder, custom object and so on). See Excluding Classes from User Selection. |
ConfigurableLabels.xml | Configures common Workplace XT UI labels, including system property names. An administrator can customize the default FileNet-provided labels on a per-locale basis, eliminating the need to update resource bundles. See Customizing UI Labels. |
containericons.properties | For container types, associates mime types with icons displayed in Workplace XT. Container icons are mainly displayed on the navigation page in front of the folder path, in the folder list, or any other list that contains a folder icon. See Customizing Icons. |
content_redir.properties | Configures redirections to custom or third-party applications based on content object types when the user attempts to open a file from inside Workplace XT. See content_redir.properties File. |
customobjecticons.properties | Associates Workplace XT UI images to different types of custom objects. By default, there is one image associated with custom objects. An administrator can create any number of custom object types and associate a distinctive image for each type. See Mapping Images to Custom Object Types. |
download_redir.properties | Configures redirections for downloads. See download_redir.properties File. |
icons.properties | For content types, associates mime types with icons displayed in Workplace XT. See Customizing Icons. |
InfoPages.xml | Registers custom Information pages. See Plugging In an Information Page or Properties View. |
MenuActions.xml | Contains the definitions of actions displayed in the context menu and multi-select menu for browse and search mode. An administrator can modify existing menu actions. See Customize Workplace XT Actions. |
PagingConfiguration.xml | Configures several paging-related options that appear in the tree view control and in list view presentations. See Configuring Paging. |
PolicyProcessors.xml | Registers form processors (document or workflow). To override the default behavior of the out-of-the-box form processors, a developer would implement a new custom processor and register it in PolicyProcessors.xml. See Customizing FileNet P8 eForms Processor Components. |
PrimaryViews.xml | Registers primary views in Workplace XT. Primary views are the links such as Browse, Search, and so on that appear to the left, at the top, and/or bottom of Workplace XT. An administrator can change the order of the views, hide or show views, and restrict access to views. See Primary Views Preferences. |
PropertiesPage.xml | Registers custom Property views in Information pages. See Plugging In an Information Page or Properties View. |
SimpleSearch.xml | Configures the search option check boxes in the Simple Search page. See Customizing Workplace Search Options. |
SystemPropertiesView.xml | Defines the system properties per object store that will be exposed in the application UI. For various object types, an administrator can select the properties to show in the UI. This file is modified by the application through the "Object Stores" view of the Site Preferences page. See System Properties View Settings. |
Workplace XT looks up UI strings in property resource bundles based on the client locale passed in the request. The purpose of the label element in Workplace XT XML configuration files is to override UI strings in the resource bundles. As shown in the following XML snippet, this element allows you to set resource strings for multiple locales. The capability to set multilingual strings in the XML spares you the effort of modifying strings in the resource bundles.
<object key="searchOptionGroup">
<label key="label" localizationKey="server.SimpleSearch_xml.useTheseSearchOptions">
<resource>Use these search options:</resource>
<resource locale="en_US">Use these search options:</resource>
<resource locale="fr_FR">employez ces options pour faire une recherche:</resource>
</label>
...
NOTE FileNet P8 4.0 introduces the use of XLIFF flies to augment existing resource bundle files. XLIFF files support the display of localized user-authored names in Workplace and other Toolkit-based applications, and Workplace XT. The application indirectly uses XLIFF files by exposing the “Preferred Locale” user preference and passing the browser locale to the web application to ensure that the correct language-specific XLIFF file is loaded. If available, localized user-defined name strings are retrieved from the XLIFF file by the Process Engine server and are employed by rosters, queues, milestones, steps, workflows, and various other fields. Conversely, the application directly uses resource bundle files, while Process Engine does not.
Given a particular client locale(s) in the request, the application uses the following order of precedence to look up a resource string:
If a resource bundle does not exist for one or more of the locales in the header, the application attempts to find a locale match in the XML, again in the order specified by the browser locale header. If there is no match, the application defaults to the English string that is set in the resource element for which no locale is specified. In the above XML, the application would use the string "Use these search options:".
If no match is found, the application uses the value of the localizationKey attribute to retrieve the label from the resource bundle. Given the XML above, if the client locale were "es-us" (Spanish American), then the application would use the "server.SimpleSearch_xml.useTheseSearchOptions" value to look up the label in a Spanish American resource bundle.
<object key="configurableLabels" version="4.0.0">
<label key="objectStore" localizationKey="server.ConfigurableLabels_xml.ObjectStore">
<resource>Object Store</resource>
<resource locale="en_US">Library</resource>
<resource locale="fr_FR">Bibliothèque</resource>
</label>
NOTE Full multilingual support requires resource bundles for all of the languages of your users. Do not rely solely on the application's XML locale support; otherwise, the application's UI will display a mixture of different language strings.
<object key="configurableLabels" version="4.0.0">
<label key="objectStore" localizationKey="server.ConfigurableLabels_xml.ObjectStore">
<resource>Object Store</resource>
<resource locale="en_US">Library</resource>
<resource locale="fr_FR">Bibliothèque</resource>
</label>
<object key="configurableLabels" version="4.0.0">
<label key="objectStore" localizationKey="server.ConfigurableLabels_xml.ObjectStore">
<resource>Object Store</resource>
<resource locale="en_US">Library</resource>
</label>
<object key="configurableLabels" version="4.0.0">
<label key="objectStore" localizationKey="server.ConfigurableLabels_xml.ObjectStore">
<resource>Object Store</resource>
<resource locale="en_US">Library</resource>
</label>
For the following configuration files, you can reload modified settings from Workplace XT (as opposed to restarting the web server):
To reload settings:
NOTE Changes to the content_redir.properties and download_redir.properties configuration files require that you restart the web server on which Workplace XT is deployed. For behavior related to changing access role settings, see Access Roles Preferences.
The following table describes the high-level directory structure of Workplace XT.
Directory | Contents |
---|---|
Authentication | Cryptography key files. |
Config/AE | User-configurable files. |
lib2 | Third-party .jar files. |
Router | Batch file that launches Process Task Manager. |
WorkplaceXT | Core event Java™Server Pages. |