Overview
Portal Administrators
have control over how search results are presented on the portal, using the Search
Results section of the Portal-configuration file. The following
parameters can be set as search results options:
-
Results per Page
-
Maximum results
-
Sort Order
-
Summary
-
Results Meta-Data
-
Solution finder
The following
sections describe the steps to configure these search options.
Configuring Search
Results Options
- Login to Portal Administration.
- Click Edit in a portal's row in the Available Portals
list.
- Click Configuration.
Set Number of Results per Page and Maximum results
- Scroll to the lines:
<search>
<resultsPerPage>
<maxResults>
- Make changes as described in the table "Search Results Per Page and Maximum Search Results"
- Click Save
Note: Use the find shortcut CtrlF to scroll to the file location to complete the steps described in the table.
|
XML Section
|
Description
|
Example
|
|
<resultsPerPage>
</resultsPerPage>
|
Specify a number between 1 and 200 to display search
results per page.
|
<resultsPerPage<10>/resultsPerPage>
|
|
<maxResults>
</maxResults>
|
Specify a number between 1 and 200 to indicate the
maximum number of search results to be displayed per page.
|
<maxResults>200</maxResults>
If <resultsPerPage> is set to 10 <maxResults> is set to 200,
Users can view
a maximum of 20 pages with 10 results on each page.
|
Table : Search Results Per Page and Maximum Search Results.
Sort Order
A primary, secondary and
tertiary sort order can be defined in the configuration file. By default the
articles are sorted by "relevance", then "modified date" and then "article
title".
- Scroll to the line:
<defaultSort >
|
XML Section
|
Description
|
Example
|
|
<defaultSort>
</defaultSort>
|
Specify the default
Sort method for the search results.
Set the order as 1-3 for the primary, secondary, and tertiary sort.
|
<defaultSort>
<relevance order="1" />
<modifiedDate order="2" />
<articleTitle order="3" />
</defaultSort>
|
Table : Sort Search Results in the Preferred Sort Order
Article Summary
If enabled, a summary of
each article will be displayed in the search results. The configuration file
can be edited to specify the maximum length of the summary (between 50-200
words) and the "type" of summary that is used. The following types are
available:
-
Context: to display the most relevant content within the
Article, as determined by the
search engine.
-
Quick: to display the first "n" number of characters in
the Article content as the synopsis on the Portal.
n would be the "maximum number of characters" configured to be displayed in the article summary.
-
Manual: to display a user specified synopsis for the
article.
If the Manual option is selected for a Portal but a manual
summary does not exist for articles, search displays an automatically
generated summary.
- Scroll to the line:
< autoSummarization >
|
XML Section
|
Description
|
Example
|
|
<autoSummarization>
</autoSummarization>
|
Enable auto summarization by setting enabled=
"true".
Disable it by setting enabled="false".
Specify a value between 50 and 250 to set the maximum
length of the summary
Enable display by setting enabled= "true".
Disable it by setting enabled="false".
Enable Display Summary by setting
"selected=true" for one of the display types
Set "selected=false" for the rest. If
"selected=true" is set for more than one type, only the first one will be
used.
|
<autoSummarization enabled="true">
<maxLength>250</maxLength> <displaySummary>
<context selected="true" />
<quick selected="false" />
<manual selected="false" />
</displaySummary>
</autoSummarization>
|
Table : Search Result Article Summary
Articles Meta-Data
The article's ID,
attributes, modified date, KB name, and file type (for non-html articles) can
be displayed in the results.
Additionally, the user's search term can be highlighted in the summary. To
enable or disable the meta-data that you would like displayed in the summary
set "enabled" to "true" or "false".
- Scroll to the line:
< resultsDisplay >
|
XML Section
|
Description
|
Example
|
|
<resultsDisplay>
</resultsDisplay>
|
The Results Display setting determines what meta-data is
displayed for each search result.
0 to 6 meta-data elements can be defined for this display.
Set Article ID "enabled=true" to display or
"enabled=false" to disable.
For Article Attributes, specify "enabled=true"
to display or "enabled=false" to disable display.
For Date Modified, specify "enabled=true" to
display or "enabled=false" to disable display.
For KB Name, specify "enabled=true" to display
or "enabled=false" to disable display.
For Article File Type, specify "enabled=true" to
display or "enabled=false" to disable display.
For Highlight Term, specify "enabled=true" to
highlight the search query or "enabled=false" to disable display.
|
<resultsDisplay enabled="true">
<articleID enabled="false" />
<articleAttributes enabled="false" />
<dateModified enabled="true" />
<kbName enabled="false" />
<articleFileType enabled="true" />
<highlightTerm enabled="true" />
</resultsDisplay>
|
Table : Search Result Article Metadata
Solution Finders
Search results can include Solution Finders.
- Scroll to the line:
<solutionFinders >
|
XML Section
|
Description
|
Example
|
|
<solutionFinders>
</solutionFinders>
|
Specify "enabled=true" to display or
"enabled=false" to disable display.
Specify the ID of each solution finder that should be
included in the search results.
To index more than 1
solution finder, specify multiple IDs separated by a comma ,.
If no ID is specified, no Solution Finder will be included in the search
results
|
<solutionFinders>
<id>1</id>
</solutionFinders>
Or
<solutionFinders>
<id>1,18,33</id>
</solutionFinders>
|
Table : Search Result Solution Finders
