search
  1. Home

Search Widget

Overview

This widget displays a search box on the Portal Home page and enables users to search for Articles on the Portal.
You can configure the parameters on the Search Button of this widget in the portal configuration file.

Configuring the widget

  1. Login to Portal Administration.
  2. Click Edit in the selected portal's row in the Available Portals table.
  3. Click Configuration.
  4. Scroll to the lines:
    <search>
    <searchType>
  5. Make changes to the Widget as described in the table.
  6. Click Save.  
     

XML Section

Description

Example

<search>
.
.
.
<searchType>
</searchType>
.
.
.

 

 SearchType must be set as "true" to any one of the following per portal:

  • All selected Words          
  • Any selected Word  
  • Boolean          
  • Exact Match          
  • Natural Language 

This is mandatory.  All other search types should be set to "selected=false". If more than one search type, is specified, the first one will be used.

<searchType>
<allWords selected="true" />
<anyWords selected="false" />
<boolean selected="false" />
<exactMatch selected="false" />
<naturalLanguage selected="false" />
</searchType>

 

<enhancedNumericSearch/>

 

 Enable Enhanced Numeric Search by setting enabled= "true".  Disable it by setting enabled="false". 

<enhancedNumericSearch enabled="false" />

<spellCheck enabled/>

Enable Spell Check by setting enabled= "true".
Disable it by setting enabled="false".

<spellCheck enabled="true" />

<communityClues enabled/>

 

 Enable Community Clues by setting enabled= "true".  Disable it by setting enabled="false".   

<communityClues enabled="true" />

 

<synonyms enabled/>

 

 Enable Synonyms search by setting enabled= "true".  Disable it by setting enabled="false" 

<synonyms enabled="true" />

 

<suggestedSearches />

 

 Enable Suggested Searches by setting enabled= "true".  Disable it by setting enabled="false" 

<suggestedSearches enabled="true" />

 

<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>

 

<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>

<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

   context

   quick

   manual

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>

<filterDisplay>

</filterDisplay>

 

The Filter Display setting determines the filter groups that are displayed on the search results screen. 1 to 5 filter types can be enabled for this display.

 KB : Set "enabled=true" to display this filter group or set "enabled=false".   

Categories : Set enabled="true" to display this filter group or set enabled="false".    

Attributes : Set enabled="true" to display this filter group or set enabled="false".    

Content Types: Set enabled="true" to display this filter group or set enabled="false".    

Formats: Set "enabled=true" to display this filter group or set "enabled=false".  

<filterDisplay enabled="true">

<kb enabled="true" />

<categories enabled="true" />

<attributes enabled="true" />

<contentTypes enabled="true" />

<formats enabled="true" />

</filterDisplay>

<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>

<solutionFinders>

</solutionFinders>

Multiple instances of Solution Finders can be specified per portal.

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 : Configure Widget - Search