To enable keyword searches in the form handler, you set the following properties:

You configure keyword searching with these properties:

Property

Description

dokeywordSearch

If true, enables this component for keyword searches.

excludedStringPropertyNames

An array of string properties to exclude from a keyword search, specified in this format:

item-type.property-name

For example, the following setting specifies to exclude properties someDescription and someString in items of type descriptor1 from keyword searches:

excludedStringPropertyNames=\
  descriptor1.someDescription,\
  descriptor1.someString

keywordInput

One or more keyword values, typically supplied by the search form user. Multiple keyword values are joined through the Logical Operators AND, NOT, and OR.

keywords

List of keywords that are always used in a search. If no keywords are specified for this property, the keywords must be supplied by the user.

keywordSearchPropertyNames

The properties that are scanned during a keyword search, specified in this format:

item-type.property-name

If this property is empty, the keyword search looks at all string properties in the item types that are specified by the itemTypes property.

If you specify multiple properties, the keyword search generates a query for each property, then ORs these queries together. If any query matches an item, the item is returned by the search operation.

toLowerCaseKeywords

If set to true, converts user-entered keyword to lowercase. If toLowerCaseKeywords and toUpperCaseKeywords properties are both set to true, toLowerCaseKeywords takes precedence. The default value is false.

toUpperCaseKeywords

If set to true, converts user-entered keyword to uppercase. The default value is false.

 
loading table of contents...