Portal, Express Beta Version 6.1 Operating systems: i5/OS, Linux,Windows

Configuration parameters for the Search and Browse portlet

This topic lists the parameters and possible values for the Search and Browse end user portlet.

1. You configure the Search and Browse portlet for search on a single search collection and its search service. Some configuration parameters are shared between that search service and the copy of the Search and Browse portlet that you configure. When you configure this copy of the Search and Browse portlet, you need to set the same values for these shared parameters as you did when you configured the search service. For details about this refer to search services. This includes creating a new search service or editing an existing search service.">Managing search services and Search service configuration parameters.
2. The parameter list in the following table show several parameters that end with the suffix _EXAMPLE. These are not used by the portal. They serve as an example for the same parameter without the suffix _EXAMPLE. They give an example value that you might use. Deleting these parameters or modifying their value has no effect.
3. If you want to set a parameter that is listed here, but not in the portlet, just add it. To do this, type the parameter and the value in the entry fields New parameter: and New value: and click the Add button.
4. In the following list the abbreviation pse in parameters or values stands for Portal Search Engine.
5. The following list is arranged in alphabetical order. Parameters might be listed in a different order in the portlet.

BuildAllTaxonomy

This parameter defines whether the complete taxonomy is built when a user selects the Search and Browse portlet. The default value is false. In this case the taxonomy is built level by level, depending on the user action: the sub-taxonomies for child categories are only build as the user selects the categories. If you set the value for this parameter to true , the complete taxonomy is built when a user selects the Search and Browse portlet.

CollectionLocation

Use this parameter to specify the full directory path location of the search collection which this Search and Browse portlet searches. This parameter is mandatory. It has no default value. You determine this location in the Manage Search portlet under Search Collections. Click the search collection. The search collection location is shown under the Search collection status information.

EJB

If you set up a remote search service by using EJB, use this parameter to specify the EJB name in JNDI. An example value is ejb/com/ibm/hrl/portlets/WsPse/WebScannerLiteEJBHome .

Use the same value for this parameter as you did for the same parameter in the search service for which you are configuring this Search and Browse portlet.

If you set this parameter, you also need to set the IIOP_URL parameter.

EJB_Example

This is an example that gives an example value for the parameter EJB . The example value is ejb/com/ibm/hrl/portlets/WsPse/WebScannerLiteEJBHome .

EnableBrowse

Use this parameter to specify whether users can or cannot use the browse feature of the Search and Browse portlet. The default value is true. If you set this value to false, the feature for browsing documents is not available to users.

helpjsp

This parameter defines the directory location and file name for the Search and Browse portlet help file. The help file and its location is WEB-INF/jsp/html/SindexWebHelp.jsp. The default value for this parameter is WEB-INF/jsp/html/SindexWebHelp.jsp . If you want to modify or replace the Search and Browse portlet help for users, do one of the following:

• Modify the existing help file according to your requirements.
• Create your own help file and replace the existing help file with your custom help file.
• If you want to use a help file in a different directory location, specify that location as the value for this parameter.

Note: Depending on your configuration, you might have to ensure availability of the help file appropriately. For example, if you have a cluster configuration, replicate the help file to each node or repackage and redeploy the portlet.

IIOP_URL

If you set up a remote search service by using EJB, use this parameter to specify the IIOP URL. An example value is iiop://localhost:2811 .

Use the same value for this parameter as you did for the same parameter in the search service for which you are configuring this Search and Browse portlet.

IIOP_URL_Example

This is an example that gives an example value for the parameter IIOP_URL . The example value is iiop://localhost:2811 .

OPEN_WCM_WINDOW

This parameter defines whether IBM^® Lotus Web Content Management™ search results are opened in a Web Content Management Web content viewer portlet. You can specify a URL Mapping to a portal page as follows: portal_context_path/portal_URL_mapping_to_portal_page?WCM_GLOBAL_CONTEXT= . This URL mapping can be to a portal page that contains a Web Content Management viewer portlet. The default value is portal_server_root/myportal/wcmContent?WCM_GLOBAL_CONTEXT= .

OpenResultMode

Use this parameter to specify how results are displayed when you use the Search and Browse feature of the Manage Search portlet. Possible values are:

• new - This opens search results in a new window. This is the default. Use this setting for searching documents on a Web site.
• same - This opens search results in the same window. Use this setting for searching a portal site.
• wcm - This opens search results in an IBM Lotus Web Content Management window. Use this setting for searching a Web Content Management site. In this case you might consider to have both the Manage Search portlet and the Web Content Management portlet placed on the same page.

The default setting is new . Notes:

1. The value for this parameter does not need to match the parameter value for the search service to which you configure this Search and Browse portlet. Each search service or portlet can have its own value.
2. As the Search and Browse portlet relates to only one document collection, you can install and configure separate Search and Browse portlets for each of the content sources mentioned above.

PSE_TYPE

Use this parameter to specify the type of search service. Possible values are localhost , ejb , and soap. The default value is localhost for local search service.

If you use Portal Search locally, this parameter is optional.

If you set up a remote search, this parameter is mandatory. In this case specify the type of remote service that you use, EJB or SOAP. If you specify ejb here, you also need to specify the values for the parameters EJB and IIOP_URL . If you specify soap here, you also need to specify the values for the parameter SOAP_URL .

Use the same value for this parameter as you did for the same parameter in the search service for which you are configuring this Search and Browse portlet.

RefreshTaxonomy

This parameter defines whether the subtree shown for a taxonomy category is refreshed when the user selects the category. The default value is false , and the subtree is not refreshed. If you set the value for this parameter to true , the category subtree and the number of documents are refreshed when the category is selected.

ShowSearchableList

Use this parameter to determine whether users can change between different collections when searching by the Search and Browse portlet. The default value is off . If you set this parameter to on, a pull-down list on the portlet title bar shows the collections to which the user has access permission. The user can switch between the available collections.

SOAP_URL

If you set up a remote search service by using SOAP, use this parameter to specify the SOAP URL. An example value is http://localhost:10000/WebScannerSOAP/servlet/rpcrouter .

Use the same value for this parameter as you did for the same parameter in the search service for which you are configuring this Search and Browse portlet.

SOAP_URL_Example

This is an example that gives an example value for the parameter SOAP_URL . The example value is http://localhost:10000/WebScannerSOAP/servlet/rpcrouter .

The following parameters are reserved for internal use only. Do not change their values.

ApplicationInfoId_EXAMPLE

This parameter is reserved for internal use only. Do not change its value. The default value is application info .

ApplicationInfoPassword

This parameter is reserved for internal use only. Do not change its value. The default value is password .

BrowseFactoryImp

This parameter is reserved for internal use only. Do not change its value. The default value is com.ibm.hrl.wp.siapi.pseAdapter.search.BrowseAdapterImp .

IMPLEMENT

This parameter defines the type of search implementation. The default setting is PSE (Portal Search Engine). Change this value only if you use a different search implementation than the portal search engine.

IsAdmin

This parameter is reserved for internal use only. Do not change its value. The default value is false .

portlet_icon_name

This parameter is reserved for internal use only. Do not change its value. The default value is search.gif .

portlet_icon_path

This parameter is reserved for internal use only. Do not change its value. The default value is images/palette/portlets .

SearchFactoryImp

This parameter is reserved for internal use only. Do not change its value. The default value is com.ibm.hrl.wp.siapi.pseAdapter.search.SearchAdapterImp .

TaxonomyID

This parameter is reserved for internal use only. Do not change its value. The default value is Default .