Previous Contents
Sun ONE Web Server 6.1 Administrator's Guide

> ## The Search Tab

> The Search tab allows you to search the contents and attributes of documents on the server. The Search tab contains the following pages:

> - The Search Configuration Page
> - The Create Collection Page
> - The Configure Collection Page
> - The Update Collection Page
> - The Maintain Collection Page
> - The Add Scheduled Maintenance Page
> - The Edit Scheduled Maintenance Page
> - The Remove Scheduled Maintenance Page

> ##

> The Search Configuration Page

> The Search Parameters page allows you to set the default parameters that govern what users see when they get search results, and also allows you to specify the default search web application details. For more information, see Enabling the Search Application for a Virtual Server.

> The following elements are displayed:

> Maximum Hits. Specify the maximum results retrieved in a search query.

> URI. If you plan to use a custom search application, enter the URI. If you are using the default search application, you don’t need to specify a value here.

> Path. If you plan to use a custom search application, enter the path. If you are using the default search application, you don’t need to specify a value here.

> Enabled. Select this box to enable the default search application.

> OK. Saves your entries.

> Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

> Help. Displays online help.

> ##

> The Create Collection Page

> The Create Collection page allows you to create a collection that indexes the content of all or some of the files in a directory. You can define collections that contain only one kind of file, or you can create a collection of documents in multiple formats. When you add a new collection, by default, it is created with the specified name in the following location:

> instance_root/collections/vs_id/collection_name

> An appropriate SEARCHCOLLECTION entry is also created in the server.xml file.

> For more information, see Creating a Collection.

> The following elements are displayed:

> Directory to Index. Use the drop-down list to select the directory from which documents will be indexed into the collection. Only the directories visible from this virtual server will be listed.

> To add a directory to the list of indexable directories, you must first create an additional document directory. For more information, see Setting Additional Document Directories.

> View. Click this button to view the contents of the directory. If the selected directory has subdirectories, these are listed in the “View directory_name” page. To select a directory to index, click the index link on this page. To view a directory, click the folder. Click Back to return to the previous page.

> Collection Name. Enter a name for the collection. Make sure the name does not contain white space.

> Display Name. The collection name as displayed in the search query page. This is what users see when they use the text search interface. Display names should be as descriptive and relevant as possible. You can use any character except single or double quotation marks, up to a maximum of 128 characters. If you don’t specify a display name, the collection name serves as the display name.

> Description. Enter text that describes the new collection.

> Pattern. Specify a wildcard to select the files to be indexed. For more information about wildcards, see Wildcards Used in the Resource Picker.

> Caution | While adding documents, use the wildcard pattern judiciously to ensure that only specific files are indexed. For example, specifying *.* might cause even executables and perl scripts to be indexed.

> Include Subdirectories. This box is selected by default. If the box is not selected, documents within the subdirectories of the selected directory will not be indexed.

> Default Encoding. Use the drop-down list to specify the character encoding for the documents to be indexed. The default is ISO-8859-1. The indexing engine tries to determine the encoding of HTML documents from the embedded meta tag. If this is not specified, the default encoding is used.

> Documents in collections are not restricted to a single language/encoding. Every time documents are added, only a single encoding can be specified. However, the next time you add documents to the collection, you can select a different encoding.

> OK. Saves your entries.

> Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

> Help. Displays online help.

> ##

> The Configure Collection Page

> Once you have created a collection, you can use the Configure Collection information page to configure the collection by:

> - Changing its display name
> - Modifying its description
> - Defining a different URL for its documents
> - Enabling or disabling search for the collection

> For more information, see Configuring a Collection.

> The following elements are displayed:

> Collection Name. Use the drop-down list to specify the collection you want to update, and then click Go.

> Go. Click this button after selecting a collection.

> Document Root. Displays the primary document directory of the collection.

> Display Name. The collection name as displayed in the search query page. This is what users see when they use the text search interface. Display names should be as descriptive and relevant as possible. You can use any character except single or double quotation marks, up to a maximum of 128 characters.

> Description. The text description of the collection.

> Document URI. Specify the new URI for the document root against which search queries will be resolved. For example, if you originally indexed the directory of files that corresponded to those defined by the URL mapping /publisher/help, and you have changed that mapping to the simpler /helpFiles, you would replace the URL of /publisher/help with /helpFiles in this field.

> Note | Do not change the Document URI unless you have changed the URI mapping for the document root from the Additional Document Directories page. For more information, see Setting Additional Document Directories.

> Enabled. Select this box to enable search for the collection. If the box is not selected, search is disabled for the collection. The collection will not appear on the search query page. This box is selected by default.

> OK. Saves your entries.

> Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

> Help. Displays online help.

> ##

> The Update Collection Page

> Once you have created a collection, you can use the Update Collection page to add or remove files from the collection. Documents can be added only from under the directory that was specified during collection creation. For more information, see Updating a Collection.

> The following elements are displayed:

> Collection Name. Use the drop-down list to specify the collection you want to update, and then click Go.

> Go. Click this button after selecting a collection.

> Document Root. Displays the primary document directory of the collection.

> Display Name. Displays the collection name as displayed in the search query page.

> Documents Currently in the Collection. Lists up to 100 documents with index entries in the currently selected collection.

> Previous and Next. Use the Previous and Next buttons to view the previous or next set of 100 files for collections that have more than 100 files in them.

> Pattern. Specify a wildcard to select the files to be indexed or removed from the collection. For more information about wildcards, see Wildcards Used in the Resource Picker.

> Caution | While adding documents, use the wildcard pattern judiciously to ensure that only specific files are indexed. For example, specifying *.* might cause even executables and perl scripts to be indexed.

> Include Subdirectories. Specify whether the server should index and add all matching documents in the subdirectories of the document directory that was originally defined for the collection. This box is selected by default.

> Default Encoding. Use the drop-down list to specify the character encoding for the documents to be indexed. The default is ISO-8859-1. The indexing engine tries to determine the encoding of HTML documents from the embedded meta tag. If this is not specified, the default encoding is used.

> Documents in collections are not restricted to a single language/encoding. Every time documents are added, only a single encoding can be specified. However, the next time you add documents to the collection, you can select a different encoding.

> Add documents. Adds the indicated files and subdirectories to the server. You can add documents only if they are located under the directory specified during content creation.

> Remove documents. Removes the entries for the files and their metadata from the collection. The actual files themselves are not removed from the file system.

> Help. Displays online help.

> ##

> The Maintain Collection Page

> Once you have created a collection, you can use the Maintain Collection page to reindex or remove the collection. For more information, see Maintaining a Collection.

> The following elements are displayed:

> Collection Name. Use the drop-down list to specify the collection you want to maintain, and then click Go.

> Go. Click this button after selecting a collection.

> Document Root. Displays the primary document directory of the collection.

> Display Name. Displays the collection name as displayed in the search query page.

> Reindex. Locates each file that already has an entry in the collection and reindexes its attributes and contents. Selecting Reindex does not index any new content into the collection, but rather updates its existing contents. This option also removes collection entries if the source documents are no longer present in the server file system.

> Remove Collection. Removes the collection, not the original source documents. When a collection is deleted, it is no longer visible to users on the search query page, and all configuration and index files associated with the collection are deleted. The actual documents that formed the collection are not deleted from the file system, only their index entries in the collection.

> Note | Do not use your local file manager to remove collections. The corresponding configuration files will not be updated.

> Help. Displays online help.

> ##

> The Add Scheduled Maintenance Page

> The Add Scheduled Maintenance page is used to reindex or update the collection at a designated time. After adding scheduled maintenance, UNIX/Linux users need to restart the schedulerd cron controller for the changes to take effect.

> For more information on cron control, see Using schedulerd Control-based Log Rotation (UNIX/Linux). For more information on adding scheduled maintenance, see Adding Scheduled Collection Maintenance.

> The following elements are displayed:

> Collection Name. Use the drop-down list to specify the collection for which scheduled maintenance will be performed.

> Task. Use the drop-down list to choose one of these actions:

> - Reindex. Locates each file that already has an entry in the collection and reindexes its attributes and contents. Selecting Reindex does not index any new content into the collection, but rather updates its existing contents. This option also removes collection entries if the source documents are no longer present in the server file system.

> If you select Reindex, and click Go, the following elements are displayed:

> - Time. Specify the time of day the scheduled maintenance will take place. The time must be in military format (HH:MM). HH must be less than 24 and MM must be less than 60. This field must contain a value for scheduled maintenance to take place.
> - Day(s) of Week. Select which days of the week to perform maintenance. You can select all of the days, but must select at least one day.
> - Update. Updates the files in a collection. If you are adding documents, the files’ contents are indexed (and converted if necessary) when their entries are added to the collection. If you are removing documents, the entries for the files are removed from the collection along with their metadata. This function does not affect the original documents, only their entries in the collection.

> If you select Update, and click Go, the following elements are displayed:

> - Pattern. Specify a wildcard to select the files to be indexed or removed from the collection. For more information about wildcards, see Wildcards Used in the Resource Picker.

> Caution | While adding documents, use the wildcard pattern judiciously to ensure that only specific files are indexed. For example, specifying *.* might cause even executables and perl scripts to be indexed.

> - Include Subdirectories. Specify whether the server should index and add all matching documents in the subdirectories of the document directory that was originally defined for the collection.
> - Default Encoding. Specify the character encoding type. The default is ISO-8859-1.
> - Time. Specify the time of day the scheduled maintenance will take place. The time must be in military format (HH:MM). HH must be less than 24 and MM must be less than 60. This field must contain a value for scheduled maintenance to take place.
> - Day(s) of Week. Select which days of the week to perform maintenance. You can select all of the days, but must select at least one day.

> OK. Saves your entries. For your changes to take effect, you need to restart the cron server.

> Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

> Help. Displays online help.

> ##

> The Edit Scheduled Maintenance Page

> The Edit Scheduled Maintenance page allows you to reconfigure scheduled maintenance to suit changing requirements. After editing scheduled maintenance, UNIX/Linux users need to restart the schedulerd cron controller for the changes to take effect.

> For more information on cron control, see Using schedulerd Control-based Log Rotation (UNIX/Linux). For more information on editing scheduled maintenance, see Editing Scheduled Collection Maintenance.

> The following elements are displayed:

> Collection Name. Use the drop-down list to specify the collection for which scheduled maintenance will be reconfigured, and then click Go.

> Go. Click this button after specifying a collection to view tasks for that collection.

> Task. Lists the task type for this collection (Reindex or Update).

> Pattern (Encoding). Lists the file types that will be indexed.

> Time. Lists the time of day the scheduled maintenance will take place.

> Days. Lists the day(s) the maintenance will take place.

> Edit. Click the edit link to edit the time and day settings. Make your changes and then click OK.

> OK. Saves your entries. For your changes to take effect, you need to restart the cron server.

> Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

> Help. Displays online help.

> ##

> The Remove Scheduled Maintenance Page

> The Remove Scheduled Maintenance page is used to remove scheduled maintenance for a collection. Scheduled maintenance includes reindexing or updating a collection at a designated time. After removing scheduled maintenance, UNIX/Linux users need to restart the schedulerd cron controller for the changes to take effect.

> For more information on cron control, see Using schedulerd Control-based Log Rotation (UNIX/Linux). For more information about removing scheduled maintenance, see Removing Scheduled Collection Maintenance.

> The following elements are displayed:

> Collection Name. Use the drop-down list to specify the collection for which you want to remove scheduled maintenance, and then click Go.

> Go. Click this button after specifying a collection.

> Delete. Select the box to remove a scheduled maintenance task, and then click OK.

> Task. Lists the task type for this collection (Reindex or Update).

> Pattern (Encoding). Lists the file types to be indexed.

> Time. Lists the time of day for the scheduled maintenance.

> Days. Lists the day(s) for the scheduled maintenance.

> OK. Saves your entries.

> Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

> Help. Displays online help.

> Previous Contents

> Copyright 2004 Sun Microsystems, Inc. All rights reserved.