IBM FileNet P8, Version 5.1.+            

Customize Workplace XT search options

You can customize the Workplace XT search option check boxes that appear on the simple or advanced search pages. The search options are displayed in the Options and Documents types lists. You can customize the lists in the following ways:
  • Add options
  • Remove options
  • Rename options
Before a search is performed, Workplace XT transforms the search conditions into a SQL query. Each search option check box represents one condition added to the WHERE clause in the SQL statement. The check boxes are defined in the <WPXT_deploy_path>/FileNet/Config/WC/SimpleSearch.xml file. As shown in the XML snippet, each check box is described in a searchOption object element.
<object key="searchOptionGroup">
 <setting key="id">options</setting>
 <list key="searchOptions">
 <object key="searchOption">
 <label key="label" localizationKey="server.SimpleSearch.createdByMe">
 <resource>Added by me</resource>
 </label>
 <setting key="symname">Creator</setting>
 <setting key="value">{CURRENT_USER}</setting>
 <setting key="type">typestring</setting>
 <setting key="operator">eq</setting>
 <setting key="join">and</setting>
 <array key="objectTypes">
 <value>document</value>
 <value>folder</value>
 </array>
 <array key="objectStores"></array>
 <array key="roles"></array>
 </object>
...
Notes:
  • When editing the XML file, make sure that you work with the deployed file on your application server, which can be different from the XML file in the default installation location.
  • Back up SimpleSearch.xml before modifying it.
  • If you modify the file to include extended characters, save the file in UTF-8 format.
  • After modifying SimpleSearch.xml, you can reload it from Workplace XT to avoid restarting the application server.
The following table describes the elements in SimpleSearch.xml, using the Added by me check box as an example. An element is identified by its key attribute. Unless otherwise specified, the following elements are required.
Table 1. This table describes the elements in SimpleSearch.xml, using the Added by me check box as an example.
Setting Value
<object key="searchOptionGroup">
 <setting key="id">options</setting>
The searchOptionGroup element organizes search options into the Options and Document types lists on the simple and advanced search pages. The id element specifies the list: elements with a value of options are displayed in the Options list; elements with a value of docTypes are displayed in the Document types list.
<object key="searchOption">
 <label key="label"
 localizationKey=
 "server.SimpleSearch.createdByMe">
 <resource>
 Added by me
 </resource>
 <resource locale=fr_FR" >
 Créé par moi
 </resource>
 </label>
The searchOption element defines a search option. The label element defines various attributes of the text used to describe the check box.

The label element requires a localizationKey attribute. To specify the value for the localizationKey attribute when creating a new search option, use the string server.SimpleSearch. and append a descriptive name. The localizationKey must be unique within SimpleSearch.xml. Use the resource element to specify the text used to describe the check box.

The label element supports localized strings. You can optionally have one or more resource elements with a locale attribute. The value of this attribute must use the standard ISO language and country codes as supported by browsers.
<setting key="symname"> 
 Creator
</setting>
The symname element specifies the symbolic name (programmatic identifier) of the property associated with the check box. You can get the symbolic name of a property using Enterprise Manager.
<setting key="value">
 {CURRENT_USER}
</setting>
The value element specifies the value of the property specified in the SQL query. Where applicable, the following macros are supported:
  • {CURRENT_USER} is the short version name of the currently logged in user.
  • {DATE}[ + | - ][days] is the current date +/- the number of days specified. For example, " {DATE}-7" means the current day minus 7 days. No spaces are allowed.
<setting key="type">
 typestring
</setting>
The type element specifies the property's data type. Valid data types are: typestring, typeboolean, and typedate. You can determine a property's data type by using Enterprise Manager.
<setting key="operator">
 eq
</setting>
The operator element specifies the relational operator used in the SQL query. The valid values are as follows: eq, lt, gt, lte, gte, neq, in, isnull, isnotnull, like.
<setting key="join">
  and
</setting>
The join element specifies how this search option is combined with other search options. This option defaults to or for Document type check boxes and to and for all others. For example, if a user selects Word, Excel, and PDF document types, the search returns any document that matches the Word or Excel or PDF type. Alternatively, if a user selects the Created by me and Checked out check boxes, search returns documents that are created by the user and are checked out.

When Workplace XT transforms the search options into a SQL query, it groups all and conditions together, followed by all or conditions. For example using the default settings, if a user selects Word, PDF, Created by me and Checked out, search submits a query similar to "created by me and checked out and (Word or PDF)."

<array key="objectTypes">
 <value>document</value>
 <value>folder</value>
</array>
The objectTypes element specifies the list of object types for which this search option is valid. Supported values are document and folder.
<array key="objectStores">
 <value>Claims</value>
</array>
The objectStores element specifies the list of object stores in which this property is valid. If the user is searching in an object store in which the property is not valid, the associated search option is not displayed. To display the search option for all object stores, leave out the value object element.
<array key="roles">
 <value>Adjustor</value>
</array>
The roles element specifies the list of roles that have access to this search option. If the user is not a member of a specified role, the associated search option is not displayed. To display the search option for all users, leave out the value object element.


Feedback

Last updated: July 2011


© Copyright IBM Corporation 2011.
This information center is powered by Eclipse technology. (http://www.eclipse.org)