8.4 Configuring Virtual Search Servers

After you have created a virtual search server, you can fine-tune it by modifying many of its default settings. This section describes how to configure an individual virtual search server.

HINT:When you create a new virtual search server, all of its default settings are inherited from the Global Settings pages of QuickFinder. If you are the global administrator, you can modify these settings so that when you create a new virtual search server, its default settings reflect your preferences. (See Section 7.1, Differences between Default and Services Settings.)

8.4.1 Configuring General Settings

The General Settings page of QuickFinder Server Manager lets you configure the way that the virtual search server handles requests from clients for search services. You can modify general search query, search response, error log, and e-mail settings (if the global administrator has enabled the e-mail feature).

Modifying General Search Query Settings

  1. On the Global Settings page of QuickFinder Server Manager, click Manage in the row of the virtual search server that you want to work with.

  2. Click General under Settings.

  3. From the Default query encoding drop-down list, select an encoding that represents the character set encoding that the users of your search services are most likely to use.

    For more information about character sets, see Section B.0, Combined Character Sets for Use with QuickFinder.

  4. In the Maximum query duration field, specify the maximum number of seconds before QuickFinder should end a query, regardless of whether a search has been completed.

    This option is one of several methods for letting you protect your server’s resources from processing potential rogue searches, which are sometimes intended to harm your service by consuming server resources.

  5. (Optional) Click Yes next to Enable stop-words processing if you want QuickFinder to ignore insignificant words, such as adverbs, conjunctions, or prepositions, in a user’s search query.

    For information about how to modify the list of stop-words used by QuickFinder, see Editing the Stop-Words List.

  6. (Optional) Click Yes next to Enable synonym enhanced search results if you want QuickFinder to expand search queries by looking for synonyms of the original search terms.

    Synonym enhancement is not performed within the FileFilter section of a search. For more information about synonym enhanced searches, see Using Synonyms to Broaden Search Results.

  7. Click Apply Settings.

Modifying Query Logging Settings

When query logging is enabled, it captures many details about user queries, including total number of searches performed (for the current logging period), top 100 search terms, load statistics, and the number of print jobs performed. It also provides information about queries that resulted in a “not found” error message. This information can be used to improve the performance of your search services, or to identify areas of your site that could be improved.

Query logging is enabled by default. However, it is optional and can be turned off.

  1. On the Global Settings page of QuickFinder Server Manager, click Manage in the row of the virtual search server that you want to work with.

  2. Click General under Settings.

  3. Click Yes next to Enable query logging.

    or

    If Query Logging has been enabled, click No to turn it off.

  4. In the Exclude these IP addresses field, specify one or more IP addresses of the computers that you want excluded from the query log, separating each additional address by a space or hard return.

    This feature enables you to eliminate query logging for searches originating within your organization. Keeping query log information gathered from customer queries separate from log information related to employees of your own company can help you identify issues that directly affect your customers.

  5. From the Log period drop-down list, select a log period of either Monthly or Weekly.

    QuickFinder records search requests in the current log file until the end of the specified period. When QuickFinder switches to a new log file, a report for the old log file is automatically generated.

  6. In the E-mail log reports field, specify one or more e-mail addresses where you want copies of each new log report sent, separating each additional address by a space or hard return.

    If this field does not appear, it is because you have disabled e-mail services on your QuickFinder Server. To re-enable e-mail services, go to the QuickFinder Global Settings page and click Services Settings > General > E-Mail Settings.

  7. To view an existing log report, select one from the Available log reports field, then click View Report.

    If there are no logs listed, you have not yet generated a log report. Click Generate Current to create a report of the current (not yet completed) log period. Depending on the amount of information in the logs, this process could take anywhere from a few seconds up to several hours to complete. After a new report is generated, it appears in this field.

  8. (Optional) If you want to specify a different logging template, specify the name of the template in the Template to use when generating reports field.

  9. Click Apply Settings.

Modifying General Response Settings

  1. On the Global Settings page of QuickFinder Server Manager, click Manage in the row of the virtual search server that you want to work with.

  2. Click General under Settings.

  3. Under Response Settings, select an output encoding from the Default encoding for response pages drop-down list.

    This setting specifies the encoding QuickFinder should use when responding to user queries using the search and print results templates, and the error and response messages templates.

  4. Specify the maximum number of queries in the Refuse queries if potential hits exceed field to cancel the processing of search results that might take a long time to complete.

  5. Click Apply Settings.

Modifying Error Log Settings

  1. On the Global Settings page of QuickFinder Server Manager, click Manage in the row of the virtual search server that you want to work with.

  2. Click General under Settings.

  3. In the Maximum log size field, specify the maximum size (in bytes) that QuickFinder should allow the log file to grow to.

    Depending on the number of visitors that your virtual search server hosts, log files can become large. This setting protects your system’s hard drive resources.

    The number you specify here is divided evenly between two log files. For example, if you specify 30000, each log file allows up to 15000 bytes of logged data. This ensures that you always have at least 15000 bytes of logged synchronization data.

  4. Click Apply Settings.

Modifying E-Mail Settings

If this section of the General Settings page is not visible, it is because the global administrator has disabled it. If you are the global administrator, you can enable this feature from the Global Settings > Services Settings > General page. In the E-Mail Settings section, enable e-mail services, then specify an outgoing SMTP hostname, port number, user ID, and password. This makes the E-Mail Settings section appear on the General Settings page for a virtual search server. Follow the instructions below to enable or disable e-mail services and to specify recipients.

  1. On the Global Settings page of QuickFinder Server Manager, click Manage in the row of the virtual search server that you want to work with.

  2. Click General under Settings.

  3. (Optional) Click Yes next to Enable e-mail services if you want QuickFinder to generate an e-mail message when errors occur during the generation (or regeneration) of your virtual search server’s indexes, or when your indexes are being synchronized with other QuickFinder servers.

  4. (Optional) If you enabled e-mail services, type one or more e-mail addresses indicating where error messages should be sent.

    If the global administrator has specified default e-mail recipients, they appear here. You can remove them, or simply add additional addresses. Separate addresses by using a space, comma, semicolon, or carriage return.

  5. Click Apply Settings.

Editing the Stop-Words List

Sometimes users include irrelevant words in their search strings, such as the conjunctions and, to, and of. These are referred to as stop words. The Stop Words feature of QuickFinder removes all occurrences of stop words from the search string before performing a search, except in the following situations:

  • Stop words processing has been turned off.

  • You prepend the word with a plus (+) sign (for example, +the).

  • They are the only words in the query.

  • They occur within a phrase.

You can add or remove words from the Stop-Words list. QuickFinder Server uses this list to determine which words it ignores in a user’s search string. QuickFinder includes a predefined list of stop words, but you can edit or change these at any time.

  1. On the Global Settings page of QuickFinder Server Manager, click Manage in the row of the virtual search server that you want to work with.

  2. Click General under Settings.

  3. Click Apply Settings > Back to General Settings to save any changes you have made.

    Clicking Edit List causes any unsaved changes to be lost.

  4. Under Query Settings, click Edit List next to Enable stop-words processing.

  5. (Optional) To add a new word to the Stop-Words list, type a new word directly into the list.

    Separate each new word with a space or a carriage return. When you click Apply, the word is added to the list in alphabetical order, regardless of where you entered it in the list.

  6. (Optional) To remove an existing stop word from the Stop-Words list, select it and press the Delete key.

    To removing a stop word from the Global Stop Words list, delete it from the global area.

  7. Click Apply.

For information about enabling and editing the synonym enhanced search settings, see Using Synonyms to Broaden Search Results.

8.4.2 Configuring Search Settings

The Search Settings page lets you configure the way that the virtual search server handles end user’s search queries. You can modify search query, search response, and template settings.

Modifying Search Query Settings

  1. On the Global Settings page of QuickFinder Server Manager, click Manage in the row of the virtual search server that you want to work with.

  2. Under Settings, click Search.

  3. Under Query Settings, click Edit next to Default indexes to search.

  4. Select the indexes to be searched by default when a user does not select any indexes on the search form when performing a search, then click Apply.

  5. (Optional) Click Yes next to Enable search expansion if you want QuickFinder to automatically perform a second search using additional indexes when a first search query fails to find results.

    For more information, see Section 10.6, Helping Users Avoid Failed Searches.

  6. (Optional) If you enabled search expansion, click Edit next to the Default search expansion indexes field to select the indexes to be used during an expanded search, then click Apply.

  7. (Optional) Click Yes next to Enable search term redirection if you want QuickFinder to redirect common search terms to a specific URL.

    For more information, see Redirecting Searches.

  8. Click Apply Settings > Back to Search Settings to save any changes you have made.

    Clicking Edit List causes any unsaved changes to be lost.

  9. (Optional) If you enabled search term redirection, click Edit List to add common terms and their associated URLs, then click Apply.

    For more information, see Creating or Editing the Redirection URLs List.

  10. (Optional) Click Yes next to Enable Best Bets search results if you want QuickFinder to insert a secondary results list at the top of the search results page.

    For more information, see Using Best Bets to Help Users Find the Right Information.

  11. (Optional) Click Edit next to the Default Best Bets indexes to search field and select the indexes for use with best bets.

  12. (Optional) If you want the best bets results to always appear on the search results page, select Yes next to Show Best Bets searches By default.

    Select No if you want users to request the best bets results list at the time of their search request.

  13. (Optional) In the Maximum number of Best Bets results field, type the maximum number of best bets results to be returned on each search results page.

  14. (Optional) In the Minimum Best Bets relevance field, type the number of low relevance documents you want removed from the best bets display list.

  15. Click Apply Settings.

Modifying Search Response Settings

  1. On the Global Settings page of QuickFinder Server Manager, click Manage in the row of the virtual search server that you want to work with.

  2. Under Settings, click Search.

  3. Under Response Settings, specify the number of search results in the Default number of results to display field that you want displayed on each search results page.

    For example, if you set this option to 25 (which is the default setting) and the number of hits in a return was 200, QuickFinder only returns 25 hits per search results page at a time.

  4. Set a limit on the number of results allowed at one time on the results page by specifying a number in the Maximum number of results per page field.

  5. Specify the highest number of search results that can be returned to a user query in the Highest allowed result number field.

  6. (Optional) Click Yes next to Enable speller to have QuickFinder provide alternate spelling suggestions for search terms.

  7. Click Apply Settings > Back to Search Settings to save any changes you have made.

    Clicking Edit List causes any unsaved changes to be lost.

  8. (Optional) Click Edit List to define your own words to ignore or misspelled words to replace.

  9. (Optional) Use the Spell check if total hits is below option to have QuickFinder spell-check search terms if the number of search results is lower than the number specified.

  10. (Optional) Click Yes next to Enable search terms Highlighter if you want users’ search terms to be highlighted in the documents returned in a search.

  11. Click Apply Settings > Back to Search Settings to save any changes you have made.

    Clicking Edit Colors causes any unsaved changes to be lost.

  12. Click Edit Colors to modify the colors used by the Highlighter.

    For information, see Selecting Highlighter Colors.

  13. Click Apply Settings.

Modifying Template Settings

  1. On the Global Settings page of QuickFinder Server Manager, click Manage in the row of the virtual search server that you want to work with.

  2. Under Settings, click Search.

  3. Under Template Settings, specify a path to where your QuickFinder templates are stored in the Templates directory field.

    The default path is /var/lib/qfsearch/Templates. If you have created custom templates, or if you want to keep your templates elsewhere, specify the path here so that QuickFinder knows where the templates are.

  4. From the Default encoding for templates drop-down list, select the character set that your templates are written in.

    This value is used even with templates that do not specify an encoding. Encodings found in templates that do not match the encoding you specify here override this encoding.

  5. In the Default search page template field, specify the filename of the search page template you want to use.

    If you have created a custom template and want QuickFinder to use it as your search page, specify its name in this field.

  6. In the Default search results template field, specify the filename of the search results template you want to use.

    If you have created a custom search results template and want QuickFinder to use it as your default search results page, specify its name in this field.

  7. In the Default highlighter template field, specify the filename of the highlighter template you want to use.

    If you have created a custom highlighter template and want QuickFinder to use it as your default search results page, specify its name in this field.

  8. In the Template to use if no results returned field, specify the filename of the template that QuickFinder should return if no results are found.

  9. In the Template to use if error occurs field, specify the filename of the template that QuickFinder should return if there are errors while processing a user’s query.

  10. Click Apply Settings.

Selecting Highlighter Colors

Because a user can search for more than one search term at a time, you can define multiple colors so that each search term appears in a different color. For example, if a user searched for “HTTP AND Apache,” the terms appear highlighted in the documents where they originated.

The colors are used in the order in which they are defined. If only two highlight colors are defined but a user searches for three search terms, the first color is repeated.

  1. On the Global Settings page of QuickFinder Server Manager, click Manage in the row of the virtual search server that you want to work with.

  2. Under Settings, click Search.

  3. On the Search Settings page, click Edit Colors under Response Settings.

  4. To define a new highlight color, click the Color button in the Foreground and Background columns to select a color.

    You can also specify the color value (such as #RRGGBB) or color names.

  5. To define additional color sets, click Add More Colors.

  6. To remove a defined color set, click Delete in the row of the color set you want removed.

  7. Click Apply.

8.4.3 Configuring Print Settings

The Print Settings page lets you configure the way that the current virtual search server handles end user’s print queries. You can modify print result and template settings.

Modifying Default Print Settings

  1. On the Global Settings page of QuickFinder Server Manager, click Manage in the row of the virtual search server that you want to work with.

  2. Click Print under Settings.

  3. Under Print Results Settings, specify the number of print results in the Default number of results to print field that you want displayed on each print results page.

    For example, if you set this to 25 (which is the default setting) and the number of hits in a return was 200, QuickFinder only returns 25 hits per print results page at a time.

  4. Set a limit on the number of results allowed at one time on the results page by specifying a number in the Maximum number of results to print field.

  5. Specify the highest number of search results that can be returned to a user query in the Highest allowed result number field.

  6. To limit the size of a print job, specify the largest print job size that QuickFinder will allow in the Maximum print job size field.

    Users requesting a print job larger than this value receive a message informing them that the request was too large.

    This is a useful feature for administrators who want to keep down the size of print jobs in their own companies, departments, or organizations.

  7. To be notified when a print job exceeds a certain size, specify the print job size in the Print job size warning field.

    By default, this message is sent by using the ResponseMessageTemplate.html file and is intended as a warning to users that they are exceeding the allowed print job size. It then prompts the user to confirm the print job before continuing.

  8. Click Apply Settings.

Modifying Default Print Template Settings

  1. On the Global Settings page of QuickFinder Server Manager, click Manage in the row of the virtual search server that you want to work with.

  2. Click Print under Settings.

  3. Under Template Settings, specify a path in the Templates directory field to where your QuickFinder templates are stored.

    The default path is /var/lib/qfsearch/Templates. If you have created custom templates, or want to keep your templates elsewhere, specify the path here so that QuickFinder knows where the templates are.

  4. From the Default encoding for templates drop-down list, select the character set that your templates are written in.

    This value is used even with templates that do not specify an encoding. Encodings found in templates that do not match the encoding you specify here override this encoding.

  5. In the Default print results template field, specify the filename of the print results template you want to use.

    If you have created a custom print results template and want QuickFinder to use it when returning print results, specify its name in this field.

  6. In the Template to use if no results returned field, specify the filename of the template that QuickFinder should return if no print results match a user’s query.

  7. In the Template to use if more information needed field, specify the filename of the template to be sent back to users whose print jobs exceed the size you specify in the Print Job Size field. (See Step 6.)

  8. In the Template to use if error occurs field, specify the filename of the template that QuickFinder should return if there are errors while processing a user’s print query.

  9. Click Apply Settings.

8.4.4 Configuring Index Settings

These settings are intended to make the process of creating indexes even easier by letting you configure common settings as default settings. This saves you time by not making you make the same selections each time you create a new index.

Modifying Default Index Settings

  1. On the Global Settings page of QuickFinder Server Manager, click Manage in the row of the virtual search server that you want to work with.

  2. Click Index under Settings.

  3. Select the type of index that you want as the default index type on the Index Settings page.

    Each time you create a new index, the index type you select here is automatically selected. You can change the default index type when you create an index.

  4. Click Yes next to Obey Robots.txt exclusions when crawling to instruct QuickFinder to obey the instructions in the Robots.txt file as it indexes Web sites.

    For more information about Robots.txt, see Using the Robots Meta Tag.

  5. Click Yes next to Crawl dynamic URLs (URLs containing ‘?’) if you want QuickFinder to index dynamic content, in addition to static content.

    Some search engines do not crawl Web pages that are created dynamically, such as pages generated from forms submitted by a Web browser. The URLs of dynamic content typically contain a question mark (?) followed by additional parameters. (See Section 8.7, Indexing Dynamic Web Content.)

    Because dynamic content can change at any time, you might want to schedule more frequent regeneration events for your indexes when enabling this feature. For information about scheduling automatic updates to your indexes, see Section 8.9, Automating Index and Server Maintenance.

  6. Click Yes next to Allow URLs with multiple question marks if you want QuickFinder to crawl URLs with multiple query strings (parameters).

  7. Select the URLs are case sensitive option if you want QuickFinder to recognize URLs that are different only in character case, but are otherwise identical (for example, www.digitalairlines.com verses www.DigitalAirlines.com).

    IMPORTANT:Setting this option to No can help QuickFinder avoid indexing duplicate information, which can come from indexing URLs that are presented using different cases but actually point to the same information. However, if a Web server being indexed is configured to differentiate between cases, QuickFinder might leave out content that you want indexed.

  8. In the Maximum index depth field, specify the maximum number of hypertext links from the starting URL that QuickFinder should follow before it stops indexing.

  9. In the Maximum depth of off-site URLs field, specify the maximum number of hypertext links off-site from the starting URL that QuickFinder should follow before it stops indexing.

  10. Specify a number (in bytes) in the Maximum file size to index field to keep QuickFinder from indexing files larger than the number you specify.

  11. In the Maximum time to download a URL field, specify a number (in seconds) before QuickFinder automatically skips the indexing of the specified URL.

  12. Type a number (in milliseconds) in the Delay between URL requests field that QuickFinder should pause between requests for URLs that it is trying to index.

  13. From the Encoding (if not in META tags) drop-down list, select the encoding to be used when indexing files that do not contain an encoding specification.

    For example, HTML files can specify their encoding with a Content-Type meta tag.

  14. In the Field names to display on Search Results pages field, list any field names that you want to be included on the search results page (for example, author date_created product dc.copyright).

    To display the field on the search results pages, add the corresponding $$Variable to the template (for example, $$author $$date_created $$product $$copyright).

    The field data is stored in the index and causes the index size to increase.

  15. Click Apply Settings.

Allowing Indexes to Be Used With QuickFinder Synchronization

  1. On the Global Settings page of QuickFinder Server Manager, click Manage in the row of the virtual search server that you want to work with.

  2. Click Index under Settings.

  3. Under Synchronization Settings, click Yes next to Index may be copied to other clustered servers.

    For more information about QuickFinder Synchronization, see Section 9.0, Synchronizing Data Across Multiple QuickFinder Servers.

  4. Click Apply Settings.

Enabling or Disabling User Authentication When Accessing Indexes

  1. On the Global Settings page of QuickFinder Server Manager, click Manage in the row of the virtual search server that you want to work with.

  2. Click Index under Settings.

  3. (Optional) Under Rights-based Search Results, click Off to allow anyone to access the indexes.

    No user authentication is required to search the indexes of the current virtual search server.

  4. (Optional) Under Rights-based Search Results, click by Index to restrict access to the indexes only to those who have access rights to the filename you specify in the by Index field.

  5. In the by Index field, specify the full path to a file on your server that already has rights protection assigned to it.

    For example, if you are using Apache 2, you might type /usr/local/apache2/htdocs/index.html.

  6. Select either Search Engine or Templates from the Unauthorized hits filtered by drop-down list to specify how QuickFinder should handle attempts to access indexes without authorization.

    Select Search Engine if you don’t want any search results displayed when users attempt to search the index without first logging in. A No Results Found message is returned instead.

    Select Template to have QuickFinder return search results to users who have not logged in. When they attempt to click a search result, they are then prompted for a username and password.

    HINT:You can use the $$BeginUnAuthorized and $$EndUnAuthorized template variables to control how the template should display unauthorized hits. For more information about template variables, see Section 12.0, Working with Template Variables and Search Parameters.

  7. Click Apply Settings.

8.4.5 Configuring Security Settings

Security settings let you manage access to indexed content by requiring users to authenticate to a server before seeing rights-protected search results. The Security Settings page lets you configure rights-based search results and specify secure connection settings, including enabling the HTTPS protocol for securing usernames and passwords as they are sent over the network.

Modifying Default Rights-Based Search Results

  1. On the Global Settings page of QuickFinder Server Manager, click Manage in the row of the virtual search server that you want to work with.

  2. Under Settings, click Security.

  3. In the Default search contexts box, type the NetIQ eDirectory context where user objects are stored.

    If you provide a context here, users won’t need to supply their fully qualified user IDs when logging in to QuickFinder. For example, if your user objects are all kept in a container named employees, type employees.marketing.digitalairlines in the Default Search Contexts box so that QuickFinder knows where to look when a user attempts to log in. A user whose fully qualified name is sjones.employees.marketing.digitalairlines only needs to enter sjones.

  4. Click Yes next to Check authorization by directory if you want QuickFinder to validate user rights to files in a directory (search results) based on whether or not users have rights to any one file in the same directory.

    If a larger number of results are from the same directory, this can help to speed up the search.

  5. (Optional) If you are using basic authentication (as apposed to using form-based authentication), then in the Authentication realm string field, specify the correct authentication realm string, which is typically shown in your Web browser’s login dialog box.

    Specifying the Apache Web server’s authentication realm string in this field means that after users authenticate to the Web server, they won’t need to authenticate again when using QuickFinder to search and access protected information.

    If Apache is your Web server, refer to http://httpd.apache.org/docs-2.0/howto/auth.html for more information about authentication.

  6. Click Apply Settings.

Modifying Default Connection Settings

  1. On the Global Settings page of QuickFinder Server Manager, click Manage in the row of the virtual search server that you want to work with.

  2. Under Settings, click Security.

  3. Under Connection Settings, click Yes next to Require https if you want to protect usernames and passwords as they are sent across the network or Internet.

  4. Specify a number (in minutes) in the Auto-logout time field to direct QuickFinder to log users out who have been idle for the specified period of time.

  5. Click Apply Settings.

8.4.6 Configuring Synchronization Settings

QuickFinder Synchronization lets you designate one QuickFinder server as the search master from which updated indexes, templates, and configuration settings are systematically sent out to all other QuickFinder servers defined as part of a QuickFinder Synchronization cluster.

For more information about setting up and configuring QuickFinder Synchronization, see Section 9.0, Synchronizing Data Across Multiple QuickFinder Servers.

  1. On the Global Settings page of QuickFinder Server Manager, click Manage in the row of the virtual search server that you want to work with.

  2. Under Settings, click Synchronization.

  3. Select Yes next to Let Virtual Search Server receive cluster data.

  4. Click Apply Settings.