| Oracle® Secure Enterprise Search Administration API Guide 11g Release 2 (11.2.2) Part Number E23428-01 |
|
|
PDF · Mobi · ePub |
| Oracle® Secure Enterprise Search Administration API Guide 11g Release 2 (11.2.2) Part Number E23428-01 |
|
|
PDF · Mobi · ePub |
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:lastCrawlDatesMergeRange> <search:searchTimeout> <search:enableWildcardQueries> <search:displayUrls> <search:tableDisplayUrl> <search:fileDisplayUrl> <search:mailingListDisplayUrl> <search:emailDisplayUrl> <search:relevancyBoosting> <search:spellingCorrection> <search:useLanguageDictionary> <search:useIndexedDocsAndQueryLog> <search:hitCount> <search:countMethod> <search:maxExactHitCount> <search:queryStatistics> <search:loggingPeriod> <search:urlSubmission> <search:sourceName> <search:checkUrlBoundaryRules> <search:federation> <search:timeout> <search:minNumThreads> <search:maxNumThreads> <search:queryTimeAuthorization> <search:timeout> <search:minNumThreads> <search:maxNumThreads> <search:logFilteredDocs> <search:secureSearch> <search:loginRequirement> <search:securityFilterLifespan> <search:securityFilterRefreshWaitTimeout> <search:authenticationTimeout> <search:authorizationTimeout> <search:minNumThreads> <search:maxNumThreads> <search:preserveStaleSecurityFilterOnError>
Element Descriptions
Describes query configuration parameters. It contains these elements:
<search:maxNumResults> <search:lastCrawlDatesMergeRange> <search:timeout> <sesarch:enableWildcardQueries <search:displayUrls> <search:relevancyBoosting> <search:parallelQuery> <search:spellingCorrection> <search:hitCount> <search:queryStatistics> <search:urlSubmission> <search:federation> <search:queryTimeauthorization> <search:secureSearch>
Maximum number of search results returned by a query.
Threshold for merging last crawl dates from different data sources. The default value is 86,400,000.
Number of milliseconds allowed for processing each parallel query phase. The default value is 1,200,000.
Controls whether question marks (?) and asterisks (*) in queries are used as wildcards or literal characters for matching documents.
| Attribute | Value |
|---|---|
enabled |
Set to true to enable wildcards, or set to false otherwise. True is the default for Oracle Fusion Applications. Required. |
Describes the display URLs. It contains these elements:
<search:tableDisplayUrl> <search:fileDisplayUrl> <search:mailingListDisplayUrl> <search:emailDisplayUrl>
URL used to display the retrieved data for a table source.
URL used to display the retrieved data for a file source.
URL used to display the retrieved data for a mailing list source.
URL used to display the retrieved data for an e-mail source.
Controls relevancy boosting.
| Attribute | Value |
|---|---|
enabled |
Set to true to enable relevancy boosting, or set to false otherwise. Required. |
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. |
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.
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.
Contains a <search:countMethod> element.
A hit count method:
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.
The maximum number of exact results. An estimated number is returned for a higher number of results.
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. |
Number of days the data is saved. Statistics are compiled for this number of days.
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. |
A Web source to which user-suggested URLs are added.
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.
Describes the querying parameters of federated sources. It contains these child elements:
<search:timeout> <search:minNumThreads> <search:maxNumThreads>
Contains the number of milliseconds for search results to be returned.
Contains the minimum number of processes to use for searching when demand is low.
Contains the maximum number of processes to use for searching when demand is high.
Describes authorization. It contains these optional child elements:
<search:timeout> <search:minNumThreads> <search:maxNumThreads> <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.
Describes secure search. It contains these child elements:
<search:loginRequirement> <search:securityFilterLifespan> <search:authenticationTimeout> <search:authorizationTimeout> <search:minNumThreads> <search:maxNumThreads> <search:preserveStaleSecurityFilterOnError>
A log-in method:
ALL_CONTENT: Users must log in to view any content, whether public or secure.
SECURE_CONTENT: Users must log in to view secure content.
Number of minutes a stored security filter is retained. Set to a value between 0 (no cache) and 526500 (one-year cache retention).
Number of milliseconds to block a query for a security filter refresh before returning no results or using an expired security filter, depending on the value of <search:preserveStaleSecurityFilterOnError>. The default value is 1000 ms.
Number of milliseconds for authentication.
Number of milliseconds for authorization.
Controls the response to queries when an expired security filter is being refreshed. Set to true to use the expired security filter, or set to false to return no results. The default value is false.
When the security filter is expired, Oracle SES triggers a security filter refresh. During the refresh, if there is any error from any data source, then the user's existing security filter is preserved or overwritten, depending on this setting.
Example
This XML document describes the query parameters:
<?xml version="1.0" encoding="UTF-8"?>
<search:config xmlns:search="http://xmlns.oracle.com/search" productVersion="11.2.1.0.0">
<search:queryConfig>
<search:maxNumResults>200</search:maxNumResults>
<search:lastCrawlDatesMergeRange>8640000</search:lastCrawlDatesMergeRange>
<search:searchTimeout>120000</search:searchTimeout>
<search:enableWildcardQueries enabled="false"/>
<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>7</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:securityFilterRefreshWaitTimeout>
1000</search:securityFilterRefreshWaitTimeout>
<search:preserveStaleSecurityFilterOnError>
false</search:preserveStaleSecurityFilterOnError>
</search:secureSearch>
</search:queryConfig>
</search:config>
|
 Copyright © 2009, 2012, Oracle and/or its affiliates. All rights reserved. Legal Notices |
|