Configuration parameters for the Search and Browse portlet

Configuration parameters for the Search and Browse portlet

+

Search Tips | Advanced Search

You configure the Search and Browse portlet on a single search collection and its search service.
Some configuration parameters are shared between the search service and the copy of the Search and Browse portlet that you configure.
Search and Browse portlet shared parameters need to match those configured in the search service.
Note that pse stands for Portal Search Engine.

BuildAllTaxonomy

Whether the complete taxonomy is built when a user selects the Search and Browse portlet.
The default value is false, where the taxonomy is built level by level, depending on the user action. The sub-taxonomies for child categories are only built as the user selects the categories.
If set to true, the complete taxonomy is built when a user selects the Search and Browse portlet.

CollectionLocation

Full directory path location of the search collection which this Search and Browse portlet searches.
This parameter is mandatory and has no default value.
To determine location click...
Search Collections | Manage Search portlet | 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

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

Directory location and file name for the Search and Browse portlet help file. The default value for this parameter is...
WEB-INF/jsp/html/SindexWebHelp.jsp

To modify or replace the Search and Browse portlet help for users, do one of the following:

Modify the existing help file according to the requirements.

Create your own help file and replace the existing help file with your custom help file.

To use a help file in a different directory location, specify that location as the value for this parameter.

Depending on the 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

Whether search results are opened in a WCM Web content viewer portlet.
We 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 WCM viewer portlet. The default value is...
portal_server_root/myportal/wcmContent?WCM_GLOBAL_CONTEXT=

OpenResultMode

Specify how results are displayed when you use the Search and Browse feature of the Manage Search portlet. Possible values are:

new Open search results in a new window. Default. Use this setting for searching documents on a Web site.
same Open search results in the same window. Use this setting for searching a portal site.
wcm Open search results in a IWWCM window. Use this setting for searching a WCM site. In this case you might consider to have both the Manage Search portlet and the WCM portlet placed on the same page.

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.
As the Search and Browse portlet relates to only one document collection, we can install and configure separate Search and Browse portlets for each of the content sources mentioned above.

PSE_TYPE

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

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

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

Reserved for internal use only. Do not change its value. The default value is application info.

ApplicationInfoPassword

Reserved for internal use only. Do not change its value. The default value is password.

BrowseFactoryImp

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

Reserved for internal use only. Do not change its value. The default value is false.

portlet_icon_name

Reserved for internal use only. Do not change its value. The default value is search.gif.

portlet_icon_path

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

SearchFactoryImp

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

TaxonomyID

Reserved for internal use only. Do not change its value. The default value is Default.

Parent topic:
Configure the Search and Browse portlet for end users

new	Open search results in a new window. Default. Use this setting for searching documents on a Web site.
same	Open search results in the same window. Use this setting for searching a portal site.
wcm	Open search results in a IWWCM window. Use this setting for searching a WCM site. In this case you might consider to have both the Manage Search portlet and the WCM portlet placed on the same page.