Search service configuration parameters

Overview

The parameter list in both the search services panel of the Manage Search portlet and 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. Deleting these parameters or modifying their value has no effect.

To set a parameter that is listed here, but not in the portlet, just add it.

The abbreviation pse stands for Portal Search Engine.
CLEAN_UP_TIME_OF_DAY_HOURS

Time of day at which the portal performs the maintenance process for search collections to remove outdated files and broken links. Possible values are positive integers from 0 to 24 for the full hours of the day. The default value is 0 , which runs the cleanup at midnight. If you modify the value for this parameter, the new value is applied only to newly created collections of the search service. You cannot update this parameter for existing search collections.

DefaultCollectionsDirectory

Default directory for search collections. If you use Portal Search locally, this parameter is optional. If you specify no value for this parameter, the default collection directory is WP_PROFILE/PortalServer/collections. If you set up a remote search service, this parameter is mandatory. For details about setting this parameter refer to Configure the default location for search collections.

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 .

If you configure a copy of the Search and Browse portlet for this search service, use the same value for this parameter for both the search service and the 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 .

HTTP_MAX_BODY_SIZE_MB

Use this parameter to limit how much content is fetched during a crawl from application files, such as PDF, MicroSoft Word etc. The specified unit is MB. The default value is 20 MB. If a file exceeds the specified limit, the document is truncated, and Portal Search indexes the fetched portion as is possible. However, indexing might fail on truncated documents; in this case the document will not be listed under search results at all.
Notes:

1. If you modify the value for this parameter, the new value is applied only to newly created collections of the search service. You cannot update this parameter for existing search collections.

2. Document Conversion Services might not be able to convert the content of truncated application files. If Document Conversion Services fails to convert a truncated application file, it logs an error to the SystemErr.log file. If tracing is enabled for the portal, Portal Search logs a warning message to the portal log file.

HTTP_MAX_SEEDLIST_SIZE_MB

This parameter limits how much portal content is fetched during a crawl from own portal site. It determines the amount of space that is reserved for listing portal site resources or managed Web content resources. The specified unit is MB. The default value is 4 MB. If a crawl exceeds the limit set for this parameter, the crawl fails, and Portal Search logs an error message. In this case, or if returned search results do not represent to complete extent of portal site resources, increase this value. If you modify the value for this parameter, the new value is applied only to newly created collections of the search service. You cannot update this parameter for existing search collections.

HTTP_NON_APPL_MAX_BODY_SIZE_MB

Use this parameter to limit how much content of each HTML page is fetched from Web sites of collections that belong to this search service. The specified unit is MB. The default value is 0.2 MB. This means that the amount of content sent for indexing is always the first 0.2 MB of text. If you modify the value for this parameter, the new value is applied only to newly created collections of the search service. You cannot update this parameter for existing search collections.

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 .

If you configure a copy of the Search and Browse portlet for this search service, use the same value for this parameter for both the search service and the 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 .

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. 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 value is only supported for use with the Search and Browse portlet. Do not use this value when you configure the search service.

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 .

If you configure a copy of the Search and Browse portlet for this search service, use the same value for this parameter for both the search service and the Search and Browse portlet.

SEARCH_SECURITY_MODE

This parameter defines access control enforcement during search. Three filter modes are supported. Specify one of the following values, depending on the filter mode to use:
SECURITY_MODE_PREFILTER
Use pre-filtering mode. Pre-filtering provides the fastest filtering, as it is performed in the search index level. An additional advantage of this filtering mode is that remote secured content sources can be searched from portal. However, as it is based on search index only, the search result list can be temporarily inconsistent with user access rights if these access rights were changed after the last crawl:

• If users who had their access rights restricted after the last crawl, they might get search results listed to which they had access before, but to which they no longer have access. When these users click such a link in the search result list, they cannot access the document.

• If a user was given access rights on documents after the last crawl, the user will not get these documents listed among the search results until after the next crawl.

If the search service contains Portal content (a collection that contains a content source of type Portal site) then this security mode is invalid and must not be used.


SECURITY_MODE_POSTFILTER
Post-filtering

Use post-filtering mode. Default. Post-filtering provides the safest but costly filtering approach. It checks access permission in real time for each returned search result against Portal Access Control. As a result you can use it only for local content sources. This was the only filtering mode available before portal V 7.0.


SECURITY_MODE_PRE_POST_FILTER
Pre-post-filtering

Use pre-post-filtering mode. Pre-post-filtering combines the two filter modes mentioned above. It provides a balanced method for enforce access control. It filters most irrelevant documents at the pre-filtering phase based on the search index. This results in fewer rejections in the post-filtering phase. As it still uses post-filtering, you can apply it only for local content sources. As it uses pre-filtering, search result lists might be temporarily inconsistent with users' access rights until after the next crawl.

SEEDLIST_PAGE_TIMEOUT

Use this parameter to increase the timeout for fetching the seedlist page. The specified unit for the value is seconds. The default value is 150 sec. This means that the portal search attempts to fetch the seedlist main URL for 150 seconds. If you modify the value for this parameter, the new value is applied only to newly created collections of the search service. You cannot update this parameter for existing search 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 .

If you configure a copy of the Search and Browse portlet for this search service, use the same value for this parameter for both the search service and the 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.
CONTENT_SOURCE_TYPE_FEATURE_NAME

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

CONTENT_SOURCE_TYPE_FEATURE_VAL_PORTAL

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

CONTENT_SOURCE_TYPE_FEATURE_VAL_UPLOAD

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

CONTENT_SOURCE_TYPE_FEATURE_VAL_WEB

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

Recovery_backup_location

Optional for local search service but is required for remote search services. Specify the full directory path where you want files to be stored for automatic backup and recovery of search collection configuration, such as, C:/portal_search/collections_config_backup on a Windows computer.

Recovery_backup_location
SecurityResolverId

This parameter is reserved for internal use only. Do not change its value. The default value is com.ibm.lotus.search.plugins.provider.core.PortalSecurityResolverFactory.

SetProperties

This parameter is reserved for internal use only. Do not change its value. Possible values are on or off . The default value is on .

startup

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

VALIDATE_COOKIE

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

WORK_MANAGER

You can use this parameter to specify the work manager. This parameter is reserved for internal use only. Do not change its value. The default value is wps/searchIndexWM .

WORK_MANAGER_DEPLOY

This is an example of the deployed WORK_MANAGER parameter. The example value is wps/searchIndexWM .

WORK_MANAGER_NATIVE

This is an example of the parameter WORK_MANAGER for native threads for debug purposes only. The example value is force.hrl.work.manager.use.native.threads .

Parent

Administer Portal Search

Related tasks

Manage search services
Configure the Search and Browse portlet for end users
Configure the default location for search collections
Configuration parameters for the Search and Browse portlet

 

+

Search Tips   |   Advanced Search