Show TOC

 Search OptionsLocate this document in the navigation structure

Use

You can make the following settings for the search in the configuration.

  • You can specify which search options users can use for a search.
  • You can make presettings for search criteria.
  • You can select functions to be displayed in the search results list.

These settings are initially valid for all users. They remain valid unless users change the options manually during a search.

Integration

You can also select a set of search options in the iView properties of the KM search iView. For more information, see KM Search iView .

Features

Configuration

You can set the following parameters for a set of search options:

Parameter Required Description

Name

Yes

Name of search option set.

Description

No

Description of search option set.

Initial Display of Search Options

No

Specifies whether the search options are displayed in the search dialog box at the start of a search.

Enable Large Search Field

No

If activated, you can use a large input field for the search.

Close Options After Search

No

Specifies whether the search options are hidden in the search results list after a search.

Enable Search Options

No

If activated, you can call up the search options using a link.

Enable Further Search After Quick Search

No

Specifies whether or not an additional search can be started from the search results list.

Enable Search Scope Selection

No

Specifies whether or not the search scope can be selected in the search options.

Default Search Scope

Yes

Default search scope.

Indexes: Search in indexes and index groups.

Folder: Search in a prescribed folder (see the Root Folder for Searchparameter).

Search Index IDs

No

Comma-separated list of search index IDs to be used by default for a search.

Index Groups

No

Comma-separated list of index groups to be used by default for a search. For more information, see Index Groups .

Use the IDXG_BLANK ID for the Miscellaneous index group.

Example: News,IDXG_Blank

Root Folders for Search

No

Folder or folders from which the search is to be started.

This parameter can only be used in combination with the Default Search Scope = Folder parameter.

Enable Selection of Search Method

No

Specifies whether or not the search method can be selected in the search options. For more information, see Search Methods .

Default Search Method

Yes

Specifies the search method to be used for the search by default.

Possible values: Exact, Linguistic, or Fuzzy

Enable Standard Properties

No

Specifies whether or not standard properties can be selected in the search options.

Enable Result Parameters

No

Specifies whether or not parameters for modifying the search results list are to be displayed in the search options parameters.

Enable Cascading Search

No

If this parameter is activated the cascading search is used.

Enable Sorting of Search Results

No

If this parameter is activated you can sort the search results.

Default Sorting Mode

Yes

Sort order for the search result list.

Ascending

Descending

Default Property for Sorting

No

Specifies the default sort property for the search result list.

Allowed Sort Properties

No

Specifies properties by which the search results can be sorted.

Enable Item Selection

No

If activated, you can filter the search results list by item type (see the Default Item Selectionparameter).

Default Item Selection

No

Default item type for filtering the search results list.

ALL: All item types are displayed.

ONLY FOLDERS: Only folders are displayed.

ONLY DOCS: Only documents are displayed.

Enable Language Selection

No

If activated, you can filter by language in the header of the search results list.

If you implement the search_language component, you must deactivate this parameter.

More information: Defining the Search Languages

Default Search Language Selection

Yes

Specifies which language is taken into by default when searching for documents.

If the entry ALL is selected, the search results list displays documents in all languages.

More information: Defining the Search Languages

When TREX indexes a document, it checks the language of the document. Depending on the result, the document is assigned to the appropriate language index. If you now select a specific language in the search options, the system searches only the associated language index.

Note that only those languages that were selected and installed during the installation of TREX are available. In general, the value set for the parameter contains a larger selection of languages than TREX actually determines.

More information: Language Recognition and Processing with TREX

Additional Search Properties

No

Properties that are considered for a search in addition to the standard properties (description, title, and content).

More information: Predefined Properties

Users cannot change this setting.

Example: Color

The search finds all documents that match the search term and to which the property Color is assigned.

However, only properties that could be indexed by TREX are evaluated.

Show Related Terms

No

If this checkbox is activated, you can use the Related Terms function.

Max. No. of Related Terms

Yes

Maximum number of terms that can be displayed by the Related Terms function in the search results list.

Max. No. of Words in Snippet

Yes

Maximum number of words in a text snippet.

Max. No. of Search Results per Page

Yes

Maximum number of search results per page.

Max. No. of Categories

Yes

Maximum number of categories to be displayed in the search result list.

Enable Predefined Properties

No

Specifies whether or not predefined properties can be selected in the search options.

Predefined Properties

No

Comma-separated list of predefined properties (and corresponding values) that can be displayed and evaluated by default in the search options when searching.

Users can change the properties and values in the search options. The Enable Predefined Properties parameter must be activated for these properties to appear in the search options.

You can use modifiers in the specification (see the section below the table).

Example 1: Color(value=Blue),Shape(value=Circle)

Example 2: cm_modifiedby(/default)

Example 3: cm_modified(/comparator=GT)

 

In the case of a property with multiple values, you can restrict the available values in the search options using the following syntax:

NamespaceAlias:PropertyName(value= Value_1|Value_2|..Value_n|)

Example: Color(value=Blue|Red|Green|)

Fixed No. of Rows for Predef. Properties

Yes

Specifies the number of rows in which predefined properties are to be displayed in the search options.

Choose a value that corresponds to the number of properties under Predefined Properties, or choose 0. Rows are then added dynamically.

Meta Data for Predefined Properties

No

This parameter is reserved for internal purposes.

Allowed Predefined Properties

No

Selection of predefined properties that are displayed in the search options in a dropdown list and that you can use to filter the search results.

Note: These properties must have been configured as indexable (Indexable parameter) and indexed with values once.

Enable Custom Properties

No

Specifies whether or not custom properties can be selected in the search dialog box.

(Custom properties for a document are entered in the details dialog box for the document in question.)

Custom Properties

No

Comma-separated list of custom properties to be evaluated by default for a search.

To use this parameter you must activate Enable Custom Parameters.

You can use modifiers in the specification (see the section below the table).

Example:

Color(value=Blue/default),Shape

Fixed No. of Rows for Custom Properties

No

Specifies the number of rows in which custom properties are to be displayed in the search options.

Show No. of Hits

No

Number of hits to be displayed in the search result list.

Permissions are not taken into account here.

Enable Web Repository Access for Properties

No

If activated, queries for non-indexable properties can be sent to Web repositories to display these in the search results.

The system uses the search result collection renderer to display the search results. You can enter non-indexable properties in the Displayed Properties parameter. If the Enable Web Repository Access for Properties parameter is deactivated, these properties are not queried in the Web repository and are therefore not displayed in the search results.

Note that activating this parameter affects the performance of the search because the Web repositories must answer the queries. You should therefore deactivate this parameter if possible.

Modifiers

You can use modifiers in the value specifications for the Custom Properties and Predefined Properties parameters.

Prescribed Properties

You can use the default modifier to control whether prescribed properties in the search options can be changed by the user or not.

Use the following syntax:

<property>(/default)

If you specify this modifier, the user can use a selection list to change the property in question in the search options.

You can also prescribe a value for this property as follows:

<property>(value=<value of property>/default)

If you do not specify the modifier default, the user cannot change the property in the search options.

Prescribed Comparators

The specification of comparators is possible for properties of the type date, time, timestamp, and integer. The property in question is then displayed with the selected comparator in the search options.

Use the following syntax:

<property>(/comparator=<key for comparator>)

Comparators and keys

Comparator ID

is equal to

EQ

is not equal to

NT

is greater than

GT

is equal to or greater than

GE

is less than

LT

is equal to or less than

LE

Tip

cm_modified(/comparator=GT)

This specification allows you to search for documents whose change date is after the date specified in the search options.

If you do not specify a comparator, the comparator '=' is displayed by default for the described types. Users can change this in the search options using a selection list.

Activities

To change the search options or create a new set of search options, choose System Administration → System Configuration → Knowledge Management → Content Management → User Interface → Search → Search Options Set in the portal.