Search Components
The KM search iView can comprise various modular components. A component can have one or more search functions.
You specify a component set in the configuration of the default search dialog box (see Default Search Dialog Box ).
Mapping
Search components are based on JAVA classes. An alias is assigned to each JAVA class in the configuration. You can find the available assignments in the portal at System Administration → System Configuration → Knowledge Management → Content Management → User Interface → Mapping → Search Dialog Box Component.
Search Components
In the standard configuration the following component, comprising several functions, is used:
- standard_search
It includes a search input field, the function Related Terms, and the configured search options.
If you use this component you do not need to specify any other components in the configuration parameters.
You can replace these components with other components delivered by SAP or with your own components. The table below lists the components of the standard delivery and gives a recommendation about which parameters to specify them in (see below).
- You must not configure the standard_search component and the search_input_indexes component together for a component set. The reason is that both components have their own index configuration which cannot be synchronized by the system. Thus, if both components are configured to work with different indexes and despite that are used in one component set, the system has inconsistent behavior in the search result lists.
- Hiding the field for specifying the relevant search indexes of the standard_search component does not disable the usage of the specified search indexes. This means that all the selected indexes remain active in the background and therefore all search queries are performed according to them.
Search Components
| Alias of the component. | Description | Recommended parameter for specification |
|---|---|---|
|
standard_search_input |
Includes a search input field and the function Related Terms. |
Component for Basic Search Function |
|
search_input_indexes |
Includes a search input field with the option of selecting a particular index, and the function Related Terms. |
Component for Basic Search Function |
|
standard_search_resultparams |
Includes options for influencing the display of the search results list, such as the sorting order for the search results, number of hits on a page, and maximum number of categories. |
Last entry under Component for Basic Search Function or first entry under Component for Search Options |
|
standard_search_options |
Provides various search options. |
Component for Search Options |
|
search_touched_documents |
Provides search options with reduced scope. |
Component for Search Options |
|
search_predefined_props |
Search options that provide filter functions to restrict the scope of the search results using predefined properties and values (see also Predefined Properties ). |
Component for Search Options |
|
standard_search_properties |
Search options that provide filter functions to restrict the scope of the search results using standard properties. |
Component for Search Options |
|
search_custom_props |
Search options that provide filter functions to restrict the scope of the search results using custom properties. |
Component for Search Options |
|
standard_search_scope |
Search options that allow the search to be restricted to a certain index, index group, or folder. |
Component for Search Options |
|
related_terms |
Provides the function Related Terms. |
Component below Search Options or Component below Search Result |
|
search_language |
Part of the search options that allows users to limit the search results to certain languages (see Defining the Search Languages ). |
Component for Search Options or Component below Search Options |
Configuration
The configuration of a component set includes the parameters in the table below.
Parameters for a Search Component Set
| Parameter | Required | Description |
|---|---|---|
|
Name |
Yes |
Name of the search component set. |
|
Description |
No |
Description of the search component set. |
|
Component for Basic Search Function |
Yes |
Component that provides the basic search functions. |
|
Component for Search Options |
No |
Components that provide the search options. For information on the configuration of these options, see Search Options . |
|
Component below Search Options |
No |
Components to be displayed beneath the search options. |
|
Component below Search Result |
No |
Components to be displayed beneath the search results. |
To create a new set of search components, choose System Administration → System Configuration → Knowledge Management → Content Management → User Interface → Search → Search Component Set in the portal.
If you want to use a component you developed yourself, you have to carry out mapping first (see above).
Then select the set in the configuration of the standard search dialog box.
You can use the following set to display the search instead of the standard configuration.
Name = mySearchComponents
Description = My own set of components
Component for basic search function = search_input_indexes, standard_search_resultparams
Component for search options dialog = search_predefined_props, standard_search_scope
Component below search result = related_terms