Directory Search builder

 

 

In this topic ...

How Do I?

Specifying Inputs

 

Related Topics ...

Overview: Creating Pages

How to Use the Page Builder

The Directory Search builder provides a way for users to search for and select people or groups. The builder is included in the Portal Integration category. Depending on how you set up the builder, it may allow users to search for groups or individuals and to select one or more names. After users click OK in the Search window, the selected names are placed in a list or an input box, where the names can be used for other tasks.

This builder only works on applications running WebSphere Portal server. In other environments, the builder displays a text field or a list, but does not provide any Search or Remove capabilities.

 

How Do I...?

The following examples show how to add a Directory Search builder to a page.

 

Search for one name

Follow these steps to add a Directory Search builder that allows users to select one name.

  1. Add a Directory Search builder to your model.

  2. In the Page Location section of the builder's editor, specify the Page and Tag that is associated with the search.

  3. To display an initial value in the field, type a value, such as "Enter user name," in the Initial Value field.

  4. Leave the other inputs with their default values.

  5. Click OK.

 

Search for multiple names

Follow these steps to add a Directory Search builder that allows users to select multiple names.

  1. Add a Directory Search builder to your model.

  2. In the Page Location section of the builder's editor, specify the Page and Tag.

  3. Select "Allow Multiple Selection."

  4. Select "Text Field" as the Control type.

  5. To display an initial value in the field, type a value, such as "Enter user name," in the Initial Value field.

  6. Leave the other inputs with their default values.

  7. Click OK.

 

Specifying Inputs

Input Name Description
Name Required. Enter a name for this builder call, for example, "DirectorySearch." The Designer tool displays this name in the builder call list.
Page Location Required. Use the Page Location input to specify the page or pages on which this builder call will act. See Locating control builders on pages for detailed documentation about the Page Location input and page location syntax.
Image for Search Required. The image file used for the Search button. The default is /factory/images/peoplepicker/Search.gif.
Alternate text for Search Optional. Provide text that appears when the user moves the mouse pointer over the Search image.
Image for Remove Required. The image file used for the Remove button. The default is /factory/images/peoplepicker/Delete.gif.
Alternate text for Remove Optional. Provide text that appears when the user moves the mouse pointer over the Remove image.
Require Email Optional. When checked, this option indicates that only users who have e-mail can be selected. The default setting is checked.
Allow Multiple Selection Optional. When checked, this option allows users to select more than one name in the Search window. The default setting is unchecked.
Control Type
(for multiple selections)
Optional. Specify what kind of control is used for multiple values: Text field or List. This option is available when "Allow Multiple Selection" is checked. The default control is List.
Initial Value Optional. This option allows you to provide default text for the input box. This option is available when either:

  • "Allow Multiple Selection" is not checked.
  • "Allow Multiple Selection" is checked, and the Control Type field is "Text field."

Enter a text value in the field or use the Reference Chooser to display the results of a service call or method, or the contents of a variable.

Examples:
Enter user name

${Variables/People}

Delimiter
(for multiple selections)
Optional. Specify the delimiter for multiple name selections. This option is available when "Allow Multiple Selection" is checked and the Control Type field is "Text field." The default is a comma.
List Size
(for multiple selections)
Required. The display size for the List control. This field is displayed when the Control Type is "List." The default is 10.
Lookup Table Used
(for multiple selections)
Optional. Use this input if you want to translate a text input through a Lookup table. For example, you might identify a value in a lookup table and display the label associated with that value as text. The value to be translated is identified in the Initial Value input above.

This field requires that you already have one or more Lookup Table builders in this model. See Lookup table builder for more information about creating a Lookup Table builder call.

Select the Lookup Table in the model that is to be used for translation. This field is displayed when "Allow Multiple Selection" is checked. The default selection is None.

Initial Members
(for multiple selections)
Optional. Specify an XML structure or a comma-separated list of values, for example, ${Variables/PeopleXml}. This option is available when "Allow Multiple Selection" is checked and the Lookup Table Used is "None."
Search Options
Search Scope Required. Select whether users can search for Users, Groups, or All (both users and groups). The default setting is All.
Returned Value Type Required. Select the type of value that users see: Name - User Name, DN - WP Distinguished Name, or WMMID - WebSphere Member Manager ID. The default is Name - User Name.
Directories Required. Click the ellipses (...) to select which directories appear in the Search window. If more than one directory is specified, a drop-down list box appears. The default is WMM. Multiple directories are delimited by commas.

The directories you select must already be configured to work with WebSphere Portal. For more information, see the WebSphere Portal Information Center or the Workplace Collaboration Services Information Center.

The directory choices are:

  • WMM
    Select WMM (WebSphere Member Manager) to search the organization directory that comes with WebSphere Portal server.

  • PAB
    Select PAB to search the personal address book used by Workplace Collaboration Services clients.

  • IM
    Select IM to search the Instant Messaging Contacts List used by Workplace Collaboration Services.

  • CMTY
    Select CMTY to search the list of the current community, such as a team space, Web conference, or application. This list is used by Workplace Collaboration Services.

  • LDAP
    Select LDAP to search an LDAP directory configured for Messaging.

  • DPAB
    Select DPAB to search the dynamic personal address book used by Workplace Collaboration Services clients when working offline.