Show TOC

 Commands Relating to the Search Dialog BoxLocate this document in the navigation structure

Configuration of commands that call the search dialog box

The standard search dialog box can be called using the search field in the header area of the portal or by using the following commands:

  • Search All (alias: goto_search)
  • Similar Documents (alias: see_also_extern)
  • Search from Here (alias: search_from_here)

 

Specification of Sets for Search Options and Search Components

You can define which sets are to be used for the search options and search components in the search dialog box. You do this in the configuration of the commands that you can use to call up the search, in the parameter Parameters. Use the following syntax:

Parameters = SearchCompsName=<name of a search component set>,SearchPluginName=<name of a search option set>

 

Specification of a Layout Set

You can reference a layout set to be used for displaying the search results. You do this in the configuration of the named commands. Use the following syntax in the parameter Parameters:

rndLayoutSet=<name of layout set>

 

Specification of a layout set (using resource list type)

The layout of the search results list can be controlled by specifying a resource list type in an OTH file. A layout set is assigned to the resource list type in the OTH file.

In the standard delivery, in the OTH file search.oth (located in the directory /etc/oth) the layout set SearchResultLayoutSet is assigned to the resource type com.sapportals.wcm.SearchResultList.

 

Below is an example of the OTH file search.oth, specifying a resource list type and layout set.

<?xml version="1.0"?>

<ObjectTypeHandler Name="scoutSearch" Class="com.sapportals.wcm.service.objecttypehandler.GenericObjectTypeHandler">

 <SelectionCriteria>

 <ResourceTypes>

 <ResourceType>com.sapportals.wcm.SearchResultList</ResourceType>

 </ResourceTypes>

 </SelectionCriteria>

 <Properties>

 <Property Key="rndLayoutSet" Value="SearchResultLayoutSet" />

 </Properties>

 <Actions />

</ObjectTypeHandler>

 

Note

This OTH file determines the layout of the search results list that is called using the input field in the portal header.

 

You can create your own OTH files with your own resource list types, and then assign your own layout sets to them.

Use the following syntax in the parameter Parameters in the configuration of the commands:

ResourceListType=com.sapportals.wcm.SearchResultList

 

Tip

You can combine the parameters mentioned as follows:

Parameters = SearchCompsName=<name of a search component set>,SearchPluginName=<name of a search option set>, rndLayoutSet=<name of a layout set>

However, there is no point in specifying a layout set and a resource list type at the same time, since this would mean that two layout sets are referenced.

 

For more information on the configuration of commands, see Commands and Command Groups .

 

Command for Generating HTML Versions of Documents

Another command used in relation to the search results list is the command with the alias html_version. This allows you to display HTML versions of indexed documents.