Sun Java System Web Server 6.1 SP10 Administrator's Configuration File Reference

Search Elements

Search elements are as follows:

SEARCH

Defines search related configuration parameters for a given VS.

Subelements

The following table describes subelements for the SEARCH element.

Table 2–23 SEARCH Subelements

Element  

Required  

Description  

WEBAPP

zero or one 

The default search web application for this virtual server 

SEARCHCOLLECTION

zero or more 

Specifies a searchable index of documents called a collection. 

PROPERTY

zero or more 

Specifies name-value pairs to pass extra configuration information to the search engine. 

Attributes

The following table describes attributes for the SEARCH element.

Table 2–24 SEARCH Attributes

Attribute  

Default  

Description  

maxhits

none 

The maximum number of results that will be retrieved by the search engine in a single search. 

SEARCHCOLLECTION

Specifies a searchable index of documents called a search collection.

Subelements

The following table describes subelements for the SEARCHCOLLECTION element.

Table 2–25 SEARCHCOLLECTION Subelements

Element  

Required  

Description  

DISPLAYNAME

zero or one 

Optional display name that can be used while displaying searchable collections to the end user. 

DESCRIPTION

zero or one 

Contains a text description of the collection. 

PROPERTY

zero or more 

Contains name-value pairs to pass extra configuration information to the search engine. 

Attributes

The following table describes attributes for the SEARCHCOLLECTION element.

Table 2–26 SEARCHCOLLECTION Attributes

Attribute  

Default  

Description  

name

none 

Specifies unique identifier for this collection. Should be a legal XML ID type. 

path

none 

Specifies a file system location for storing search collection meta data. 

uri

none 

Specifies a URI for the indexable collection of documents. 

docroot

none 

Specifies a file system path for the collection of documents. 

enabled

true

Specifies whether a collection can be searched. Legal values are yes, no, true, false, on, off, 1, and 0.

DISPLAYNAME

Specifies a human-readable name for the collection to be used while displaying the collection to the end user. Example:

<DISPLAYNAME>  Omega Manual </DISPLAYNAME>

Subelements

none

Attributes

none