Skip Headers
Oracle® Secure Enterprise Search Administration API Guide
11g Release 1 (11.1.2.0.0)

E14133-02
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

queryConfig

Query configuration enables you to customize the query results and tune the search engine.

Object Type

Universal

State Properties

None

Supported Operations

export
update

Administration GUI Page

Global Settings - Query Configuration

XML Description

The <search:queryConfig> element sets the query configuration parameters:

<search:queryConfig>
  <search:maxNumResults>
  <search:displayUrls>
     <search:tableDisplayUrl>
     <search:fileDisplayUrl>
     <search:mailingListDisplayUrl>
     <search:emailDisplayUrl>

  <<search:relevancyBoosting>

<!-- Provide spelling suggestions -->
  <search:spellingCorrection>
     <search:useLanguageDictionary>
     <search:useIndexedDocsAndQueryLog>

  <search:hitCount>
     <search:countMethod>
<!-- For exact count methods -->
       <search:maxExactHitCount>
  <search:queryStatistics>
     <search:loggingPeriod>

  <search:urlSubmission>
<!-- For URL Submission --> 
     <search:sourceName>
     <search:checkUrlBoundaryRules>

  <search:federation>
     <search:timeout>
     <search:minNumThreads>

  <search:queryTimeAuthorization>
     <search:timeout>
     <search:minNumThreads>
     <search:maxNumThreads>
     <search:logFilteredDocs>

  <search:secureSearch>
     <search:loginRequirement>
     <search:securityFilterLifespan>
     <search:authenticationTimeout>
     <search:authorizationTimeout>
     <search:minNumThreads>
     <search:maxNumThreads>

Element Descriptions 

<search:queryConfig>

Describes query configuration parameters. It contains these elements:

<search:maxNumResults>
<search:displayUrls>
<search:relevancyBoosting>
<search:spellingCorrection>
<search:hitCount>
<search:queryStatistics>
<search:urlSubmission>
<search:federation>
<search:queryTimeauthorization>
<search:secureSearch>
<search:maxNumResults>

Maximum number of search results returned by a query.

<search:displayUrls>

Describes the display URLs. It contains these elements:

<search:tableDisplayUrl>
<search:fileDisplayUrl>
<search:mailingListDisplayUrl>
<search:emailDisplayUrl>
<search:tableDisplayUrl>

URL used to display the retrieved data for a table source.

<search:fileDisplayUrl>

URL used to display the retrieved data for a file source.

<search:mailingListDisplayUrl>

URL used to display the retrieved data for a mailing list source.

<search:emailDisplayUrl>

URL used to display the retrieved data for an e-mail source.

<search:relevancyBoosting>

Controls relevancy boosting.

Attribute Value
enabled Set to true to enable relevancy boosting, or set to false otherwise. Required.

<search:spellingCorrection>

Controls spelling correction. When enabled, this element contains these child elements:

<search:useLanguageDictionary>
<search:useIndexedDocsAndQueryLog>
Attribute Value
enabled Set to true to enable spelling correction, or set to false otherwise. Required.

<search:useLanguageDictionary>

Controls use of an English dictionary for spelling suggestions. Set to true to use an English dictionary, or set to false to derive spelling suggestions only from terms in indexed documents and the query log. Consider false if users typically search for non-English terms.

<search:useIndexedDocsAndQueryLog>

Contains a value of true or false to control use of terms from indexed documents and the query log for spelling suggestions. Terms that occur frequently are extracted to the Oracle SES dictionary. Set to true to use terms from these sources, or set to false to use only the English dictionary for suggestions. Consider false if suggestions from crawled documents to all search users may breach security.

<search:hitCount>

Contains a <search:countMethod> element.

<search:countMethod>

One of these hit count methods:

  • APPROX_COUNT: Displays an estimated number of matching documents. This method supports better performance than EXACT_COUNT. (Default)

  • EXACT_COUNT: Displays the exact number of matching documents.

  • EXACT_COUNT_QTA: Displays the exact number of matching documents adjusted for query-time filtering.

<search:maxExactHitCount>

The maximum number of exact results. An estimated number is returned for a higher number of results.

<search:queryStatistics>

Controls the collection of search statistics. SEt to true to collect statistics, or set to false otherwise. This operation degrades search performance, so you should disable it during peak hours.

Attribute Value
enabled Set to true to enable collection or set to false otherwise. Required.

<search:loggingPeriod>

Number of days the data is saved. Statistics are compiled for this number of days.

<search:urlSubmission>

Controls the submission of URLs. When enabled, this element contains these child elements:

<search:sourceName>
<search:checkUrlBoundaryRules>
Attribute Value
enabled Set to true to enable URL submission, or set to false otherwise. Required.

<search:sourceName>

A Web source to which user-suggested URLs are added.

<search:checkUrlBoundaryRules>

Controls the enforcement of boundary rules for URLs submitted by users. Set to true to accept only URLs that match the rules, or set to false to ignore the boundary rules.

<search:federation>

Describes the querying parameters of federated sources. It contains these child elements:

<search:timeout>
<search:minNumThreads>
<search:maxNumThreads>
<search:timeout>

Contains the number of milliseconds for search results to be returned.

<search:minNumThreads>

Contains the minimum number of processes to use for searching when demand is low.

<search:maxNumThreads>

Contains the maximum number of processes to use for searching when demand is high.

<search:queryTimeAuthorization>

Describes authorization. It contains these optional child elements:

<search:timeout>
<search:minNumThreads>
<search:maxNumThreads>
<search:logFilteredDocs>
<search:logFilteredDocs>

Controls document logging. Set to true to record all filtered documents in the query application log file, or set to false otherwise

Query-time filtering errors are always logged.

<search:secureSearch>

Describes secure search. It contains these child elements:

<search:loginRequirement>
<search:securityFilterLifespan>
<search:authenticationTimeout>
<search:authorizationTimeout>
<search:minNumThreads>
<search:maxNumThreads>
<search:loginRequirement>

One of these log-in methods:

  • ALL_CONTENT: Users must log in to view any content, whether public or secure.

  • SECURE_CONTENT: Users must log in to view secure content.

<search:securityFilterLifespan>

Number of minutes a stored security filter is retained. Set to a value between 0 (no cache) and 526500 (one-year cache retention).

<search:authenticationTimeout>

Number of milliseconds for authentication.

<search:authorizationTimeout>

Number of milliseconds for authorization.

Example

This XML document defines the query parameters:

<?xml version="1.0" encoding="UTF-8"?>
<search:config productVersion="11.1.2.0.0" xmlns:search="http://xmlns.oracle.com/search">
<search:queryConfig>
  <search:maxNumResults>200</search:maxNumResults>
  <search:displayUrls>
     <search:tableDisplayUrl>
        /search/query/display.jsp?type=table
     </search:tableDisplayUrl>
     <search:fileDisplayUrl>
        /search/query/display.jsp?type=file
     </search:fileDisplayUrl>
     <search:mailingListDisplayUrl>
        /search/query/mail.jsp
     </search:mailingListDisplayUrl>
     <search:emailDisplayUrl>
        /search/query/pmail.jsp
     </search:emailDisplayUrl>
  </search:displayUrls>
  <search:relevancyBoosting enabled="true"/>
  <search:spellingCorrection enabled="false"/>
  <search:hitCount>
     <search:countMethod>APPROX_COUNT</search:countMethod>
  </search:hitCount>
  <search:queryStatistics enabled="true">
     <search:loggingPeriod>0</search:loggingPeriod>
  </search:queryStatistics>
  <search:urlSubmission enabled="false"/>
  <search:federation>
     <search:timeout>30000</search:timeout>
     <search:minNumThreads>5</search:minNumThreads>
     <search:maxNumThreads>20</search:maxNumThreads>
  </search:federation>
  <search:queryTimeAuthorization>
     <search:timeout>30000</search:timeout>
     <search:minNumThreads>5</search:minNumThreads>
     <search:maxNumThreads>20</search:maxNumThreads>
     <search:logFilteredDocs>false</search:logFilteredDocs>
  </search:queryTimeAuthorization>
  <search:secureSearch>
     <search:loginRequirement>SECURE_CONTENT</search:loginRequirement>
     <search:securityFilterLifespan>60</search:securityFilterLifespan>
     <search:authenticationTimeout>10000</search:authenticationTimeout>
     <search:authorizationTimeout>10000</search:authorizationTimeout>
     <search:minNumThreads>5</search:minNumThreads>
     <search:maxNumThreads>20</search:maxNumThreads>
  </search:secureSearch>
</search:queryConfig>