Directory Search V5.1

The Directory Search portlet is a common embedded component that allows users to select names of people and groups. Directory Search is different from People Finder in two ways:

  • Users use Directory Search as part of a task, such as sending a document link to other people with access to the same document library. Users can select the name(s) Directory Search finds and use that selection in the next step of their task.
  • Users can search for groups as well as people.

Directory Search Help is available from all calling applications.

 

Using the Directory Search portlet

Directory Search opens in a window set to use the "no skin" skin so that it appears without a title bar. The portlet provides common controls for searching for people and groups.

Control Description
Search for
The field where users enter all or part of a name for retrieval from the directory. Users can search for person names only, group names only, or person names and group names.
Search results
The list of names (persons and groups) that match the search text. By default, the application context and the type of directory determine the information that is displayed in the columns of the search results list.

To modify the information that appears, see Set attributes for results columns.You can configure the search results to show information in three columns. Users can use the third column to distinguish between people whose name information in the first and second columns is identical.

 

Test assumptions

The Directory Search portlet has been tested on and is compatible with all supported WebSphere Portal platforms, as listed in Supported hardware and software.

 

Set up Directory Search

For Directory Search, make sure your portal environment meets the following client and server requirements.

 

Client requirements

This portlet supports browsers capable of rendering HTML markup. The following table provides detailed information.

Minimum requirements for HTML
Markup level
HTML 4.01 Transitional
Java applet
No
JavaScript
Yes
<iframe>
No
Style sheets
Portal styles only
Software
This portlet has been tested on the following browsers:
Internet Explorer V5.5 and 6.0
Mozilla V1.0
Accessibility
Yes

 

Server requirements

There are no special server requirements for the Directory Search portlet.

 

Deployment/Installation

This portlet is installed automatically as part of WebSphere Portal installation.

Note: This portlet is not supported as a remote WSRP service.

 

Configure Directory Search

Directory Search uses the directory configured in WebSphere Portal. The directory is comprised of both of the following sets of user information:

  • the WebSphere Application Server User Registry
  • either the Lookaside database of WebSphere Portal membership information, or a DB2 database.

Both sets of information are controlled by the WebSphere Member Manager service -- usually an LDAP directory -- that is installed and configured to work with WebSphere Portal.

The directory applies the byName query defined in WebSphere Member Manager when retrieving person or group names The byName query uses cn when retrieving a group name, and at least one of the following attributes when retrieving a person name:

  • cn
  • givenName
  • sn
  • DisplayName

For detailed information. refer to the attribute definition and mapping files and the configuration property files described in IBM WebSphere Member Manager documentation.

 

Set attributes for results columns

By modifying the pickersettings.properties file, you can specify the Member Manager attributes to use when displaying search results for either people or group names in the Directory Search window. You can specify Member Manager attributes to determine the items of information in up to three columns.

Perform these actions to specify attributes:

  1. Edit the pickersettings.properties file in the following location: 
    PORTAL_ROOT\shared\app\config\pickersettings.properties file.
  2. Enter up to three lines using the workplace.people.picker.wmm.adapter.peopleDisplayAttribute setting to specify attributes to display for each person name. For example, these three lines would display the common name, e-mail address, and telephone number for each person. 
    WMM1.peopleDisplayAttribute.1=cn

    WMM2.peopleDisplayAttribute.2=ibmprimaryEmail

    WMM3.peopleDisplayAttribute.3=telephoneNumber
  3. Enter up to three lines using the workplace.people.picker.wmm.adapter.groupDisplayAttribute setting to specify attributes to display for each group name. For example, these three lines could display the common name, department number, and meeting room number for a group. 
    WMM1.groupDisplayAttribute.1=cn

    WMM2.groupDisplayAttribute.2=departmentNumber

    WMM3.groupDisplayAttribute.3=roomNumber
  4. Save the properties file.

 

Improving response time

To improve performance of the Directory Search portlet, add it to the JSP batch compiler in the portal by specifying additional directories for the compiler.

Follow the procedure under Improving JSP response time in the topic Performance improvements (see See also), and append the following two directories at step 1: 

\shared\ext

\shared\app\lotusworkplacelib

For example, on Windows, use the following command: 

SET WAS_EXT_DIRS=%JAVA_HOME%/lib;%WAS_HOME%/classes; ... C:\WebSphere\PortalServer\shared\app;C:\WebSphere\PortalServer\shared\ext;C:\WebSphere\PortalServer\shared\app\lotusworkplacelib;

 

Configuration parameters

There are no configuration parameters available in this portlet

 

See also

Home | Support | Terms of use | Feedback

 

WebSphere is a trademark of the IBM Corporation in the United States, other countries, or both.

 

IBM is a trademark of the IBM Corporation in the United States, other countries, or both.