Sun logo      Previous      Contents      Index      Next     

Sun ONE Portal Server 6.2 Administrator's Guide

Chapter 8
Administering the Search Engine Service

This chapter describes how to configure and administer the Sun™ ONE Portal Server Search Engine service.

This chapter contains these sections:


Overview of the Search Engine Service

The Sun ONE Portal Server Search Engine is a taxonomy and database service designed to support search and browse interfaces similar to popular internet search engines such as Google, Alta Vista, and so on. Search Engine includes a robot to discover, convert, and summarize document resources. In Sun ONE Portal Server 6.2, the interface is provided by the Desktop exclusively, using JSP™ providers. Search Engine includes administration tools for configuration editing and command-line tools for system management. Configuration settings can be defined and stored as iPlanet™ Directory Server Access Management Edition service attribute values through the Sun ONE Identity Server administration console.


Note

Although the administration console permits an administrator to configure a majority of the Search Engine options, the administration console does not perform all the administrative functions available through the command line.


Search Database

Search users search through a database to locate particular resources or kinds of resources. The individual entries in the database are called resource descriptions (RDs). An Resource Description is a specific set of information about a single resource. The fields of each Resource Description are determined by the database schema.

To get RDs into the database, you can use two approaches:

The RDs in the Sun ONE Portal Server Search Engine are based on open Internet standards, such as the Summary Object Interchange Format (SOIF) and resource description messages (RDM). This ensures that the Search Engine can operate in a cross-platform enterprise environment.

Search Robots

One method of filling the database is via robots. The Search Engine uses robots to find and report on the resources in their domains. A robot is a small program that does two things:

As the system administrator, you control every aspect of these processes in a number of ways, including the following:

The Search Engine also provides utilities to ensure that the robot has done what you wanted.

Database Taxonomy Categories

Users interact with the Search system in two distinct ways: they can type direct queries to search the database, or they can browse through the database contents using a set of categories you design. A hierarchy of categories is sometimes called a taxonomy. Categorizing resources is like creating a table of contents for the database.

Browsing is an optional feature in a Search system. That is, you can have a perfectly useful Search system that does not include browsing by categories. You need to decide whether adding browsable categories will be useful to the users of your index, and then what kind of categories you want to create.

The resources in a Search database are assigned to categories to clarify complexity. If there is a large number of items in the database, it is helpful to group related items together. This allows users to quickly locate specific kinds of items, compare similar items, and choose which ones they want.

Such categorizing is common in the product and service indexes. Clothing catalogs divide men’s, women’s, and children’s clothing, with each of those further subdivided for coats, shirts, shoes, and so on. An office products catalog could separate furniture from stationery, computers, and software. And advertising directories are arranged by categories of products and services.

The principles of categorical groupings in a printed index also apply to online indexes. The idea is to make it easy for users to locate resources of a certain type, so that they can choose the ones they want. No matter what the scope of the index you design, the primary concern in setting up your categories should be usability. That is, you need to know how users will use the categories. For example, if you were designing an index for a company that has three offices in different locations, you might make your top-level categories correspond to each of the three offices. But if users are more interested in, say, functional divisions that cut across the geographical boundaries, it might make more sense to categorize resources by corporate divisions.

Once the categories are defined, you must set up rules to assign resources to categories. These rules are called classification rules. If you do not define your classification rules properly, users will not be able to locate resources by browsing in categories. You need to avoid categorizing resources incorrectly, but you also should avoid failing to categorize documents at all.

Documents can be assigned to multiple categories, up to a maximum number defined in the settings. Classification rules are simpler than filter rules because they don’t involve any flow-control decisions. In classification rules you determine what criteria to use to assign specific categories to a resource as part of its Resource Description. A classification rule is a simple conditional statement, taking the form "if <some condition> is true, assign the resource to <a category>."


Configuring the Search Channel

This section describes how to initially configure the Search Engine service. Configuration settings can be defined and stored as Sun ONE Identity Server service attribute values through the Sun ONE Identity Server administration console.

The Search service is registered globally and its configuration applies to the entire Portal Server. By default, the organization you specify during the Sun ONE Portal Server installation will have the Search service registered. If you install the sample portal, the Search tab on the sample portal Desktop contains the search channel. This is configured for you during the Sun ONE Portal Server installation. However, for new organizations and for new instances you must define the Search URL.

The default behavior for a search provider user is that “No document matches” found will be displayed when the user enters a query.

You need to configure the Search server and create the document database to get search results.

To Initially Configure the Search Server

Use these steps to configure the Search provider. This is a sample way to fill in the database. You can also use the import function.

  1. Log in to the Sun ONE Identity Server administration console as administrator.
  2. By default, Identity Management is selected in the location pane and All created organizations are displayed in the navigation pane.

  3. Choose Service Configuration in the location pane.
  4. Click the properties arrow next to Search in the navigation pane.
  5. Create a new site.
    1. Click Robot.
    2. Click Sites.
    3. Click New under Manage Sites to define sites for the Robot to index.
    4. Specify the type of site (URL or domain), the site to index, and the depth for the robot to crawl.
    5. Click Create Site to use the default Search attributes or select Create and Edit Site to define the search site more completely.
    6. See Appendix F, "Search Attributes" for more information on the attributes that define the site.

  6. Create a taxonomy.
  7. You can create a taxonomy using the Category Editor under Categories or by copying a sample taxonomy SOIF file to config/taxonomy.rdm).

  8. Disable any of the default filters that you do not want to use.
  9. Click Robot and then Filters. Turn off any filters in the Filter Rule list you do not want to use.

  10. (Optional) Create robot classification rules if you need to get document results under categories.
  11. You can create a create robot classification rulesusing the Classification Rules Editor under Categories

  12. Start the robot.
  13. Click Robot, Overview, and then Start to start the robot.

  14. Reindex the categories
  15. Click Categories then Reindex to reindex.

To Define the Search URL

The searchServer property defines the Search URL. It is automatically configured for the default organization; however, this value is not defined when new organizations are created, when new SearchProvider instances are created, or when the sample dp-org.xml is loaded manually. If users search when value is not defined, the following error message is displayed on the user’s Desktop:

You got a com.sun.portal.search.providers.taglib.SearchTaglibException: SearchRequest Error: search server is not defined.

  1. Log in to the Sun ONE Identity Server administration console as administrator.
  2. By default, Identity Management is selected in the location pane and All created organizations are displayed in the navigation pane.

  3. Choose the organization for which you want to define the Search URL.
  4. Choose Services from the View menu
  5. Use the Show menu in the navigation pane and the Location path in the location pane.

  6. Click the properties arrow next to Desktop in the navigation pane.
  7. The Desktop attributes page appears in the data pane.

  8. In the Desktop page, click the Channel and Container Management link.
  9. The Channels page appears. At the top is the container path. The defined channels appear in a list.

  10. Click the Edit Properties link beside the Search channel to be modified.
  11. The Properties page appears.

  12. Specify the SearchURL in the Search Server property in the format:
  13. http://portal_server_name:port/portal/search

  14. Click Save.
  15. To verify the Search URL, do the following:
    1. Log in to the organization for which you configured the Search URL. For example, log in to an organization named B as follows:
    2. http://portal_server_name:port/amserver/ui/login?org=B

    3. Perform a search from the Search channel.


Administering the Search Engine

Once you have initially configured the Search Engine and generated a database, you can view and manage the Search Engine from the Sun ONE Identity Server administration console.

Viewing, Managing, and Monitoring Search Engine Operations

Search Engine operational attributes have two levels: basic and advanced.The basic settings page appears by default when the Search service is selected from the administration console. The basic settings displayed include the server root, the location of the temporary files, and the document level security. The advanced settings include the log locations for various Search Engine components and the configured log level.

In addition, the administration console allows administrators to view the log files or specific information extracted from the log files.

To View or Manage the Basic Settings

  1. Log in to the Sun ONE Identity Server administration console as administrator.
  2. By default, Identity Management is selected in the location pane and All created organizations are displayed in the navigation pane.

  3. Choose Service Configuration in the location pane.
  4. Click the properties arrow next to Search in the navigation pane.
  5. Click Server then Settings from the menu bar.
  6. View or specify the Server Root directory for the Search Engine.
  7. View or specify the Temporary Files directory for the Search Engine.
  8. View or specify the Document Level Security attribute.
  9. Off means all users have access to the RDs in the database. On indicates that the ReadACL field in the RD must be evaluated to determine if the user has permission to access the RD.

  10. Click Save to record any altered attributes.

To View or Manage the Advanced Settings

  1. Log in to the Sun ONE Identity Server administration console as administrator.
  2. By default, Identity Management is selected in the location pane and All created organizations are displayed in the navigation pane.

  3. Choose Service Configuration in the location pane.
  4. Click the properties arrow next to Search in the navigation pane.
  5. Click Server then Advanced from the menu bar.
  6. View or specify the Advanced attributes
  7. The attributes available are: Search (rdm), Disable Search Log, Index Maintenance, RD Manager, RDM Server, and Log Level.

  8. Click Save to record any altered settings.

To Monitor Search Engine Activity

The Search Engine provides a number of reports to allow you to monitor the search activity.

To view the various reports:

  1. Log in to the Sun ONE Identity Server administration console as administrator.
  2. By default, Identity Management is selected in the location pane and All created organizations are displayed in the navigation pane.

  3. Choose Service Configuration in the location pane.
  4. Click the properties arrow next to Search in the navigation pane.
  5. Click Reports.
  6. Click on a link in the menu bar to view a specific report.
  7. The following report options are available: Starting Points, Excluded URLs, Robot Advanced Reports, Log Files, and Popular Searches.


Administering the Robot

The following are some configuration and maintenance tasks you might need to do to administer the robot:

Defining Sites

The robot finds resources and determines if (and how) to add descriptions of those resources to the database. The determination of which servers to visit and what parts of those servers to index is called site definition.

Defining the sites for the Search Engine is one of the most important jobs of the server administrator. You need to be sure you send the robot to all the servers it needs to index, but you also need to exclude extraneous sites that can fill the database and make it hard to find the correct information.

To Define Sites for the Robot to Index

  1. Log in to the Sun ONE Identity Server administration console as administrator.
  2. By default, Identity Management is selected in the location pane and All created organizations are displayed in the navigation pane.

  3. Choose Service Configuration in the location pane.
  4. Click the properties arrow next to Search in the navigation pane.
  5. Click Robot then Sites from the menu bar.
  6. To create a site:
    1. Click New.
    2. Select the type of site (url or domain).
    3. Specify the site and depth.
    4. Click Save.
  7. To edit the site attributes, click the Edit link.
  8. This displays a form containing site attributes. See Appendix F, "Search Attributes",” for information on the Site attributes.

    1. Edit the attributes.
    2. Click Save.

Controlling Robot Crawling

The robot crawls to the various sites selected for indexing. Administrators can control how the robot searches sites by defining crawling operational parameters. Crawling parameters allow you to define the speed, completion actions, logging level, standards complaince, autentication parameters, proxy settings, maximum number of links to follow, and other settings. See Appendix F, "Search Attributes",” for desciptions of the robot crawling attributes.

To Control Robot Crawling

  1. Log in to the Sun ONE Identity Server administration console as administrator.
  2. By default, Identity Management is selected in the location pane and All created organizations are displayed in the navigation pane.

  3. Choose Service Configuration in the location pane.
  4. Click the properties arrow next to Search in the navigation pane.
  5. Click Robot and then Crawling from the menu bar.
  6. This displays a form containing attributes that define the Robot Crawling operational parameters and their settings. See Appendix F, "Search Attributes",” for information on the Robot Crawling attributes.

  7. Modify the Robot Crawling attributes as necessary.

    Note

    If the jvm12.conf file has a proxy set up (using the http.proxyHost= and http.proxyPort= options) you must check Accepts Commands from Any Host for the Robot to run.


  8. Click Save.

Filtering Robot Data

Filters allow an attribute of a resource to be compared against a filter definition to identify a resource so that it can be excluded or included by the Site definitions. The Robot comes with a number of predefined filters some of which are enabled by default. The following filters are predefined; files marked with an asterisk are enabled by default:

To manage the filtering process, you can create new filter definitions, modify a filter definition, or enable or disable filters.

To Create a New Filter Definition

  1. Log in to the Sun ONE Identity Server administration console as administrator.
  2. By default, Identity Management is selected in the location pane and All created organizations are displayed in the navigation pane.

  3. Choose Service Configuration in the location pane.
  4. Click the properties arrow next to Search in the navigation pane.
  5. Select Robot then Filters from the menu bar.
  6. Click New and specify a Nick Name for the new filter.
  7. In the Filter Definition, check the checkbox and specify the Filter Source, Filter by and Filter String values. You may specify as many Filter Definitions as necessary.
  8. Type a description of the filter.
  9. Check New Site if you would like this filter to be used when creating new sites.
  10. Click the button to indicate whether to include or exclude resources that match this filter.
  11. Click Save.

To Modify an Existing Filter Definition

  1. Log in to the Sun ONE Identity Server administration console as administrator.
  2. By default, Identity Management is selected in the location pane and All created organizations are displayed in the navigation pane.

  3. Choose Service Configuration in the location pane.
  4. Click the properties arrow next to Search in the navigation pane.
  5. Select Robot then Filters from the menu bar.
  6. Locate the Filter to modify from the Filter Rules list and click the Edit link.
  7. Modify the Filter as necessary.
  8. Type a description of the filter.
  9. Click Save.

To Enable or Disable a Filter

  1. Log in to the Sun ONE Identity Server administration console as administrator.
  2. By default, Identity Management is selected in the location pane and All created organizations are displayed in the navigation pane.

  3. Choose Service Configuration in the location pane.
  4. Click the properties arrow next to Search in the navigation pane.
  5. Select Robot then Filter from the menu bar.
  6. Locate the Filter to modify from the Filter Rules list.
  7. Select the button to indicate whether to turn the filter on or off.
  8. Click Save.

Defining the Indexing Attributes

For each resource that passes through the robot’s filters, the robot generates an RD that it places in the database. The choices you make in setting up the generation of RDs determine what users will see when they search the database. For example, you can choose to index the full text of each document or only some fixed portion of the beginning of the document.

To Define the Indexing Attributes:

  1. Log in to the Sun ONE Identity Server administration console as administrator.
  2. By default, Identity Management is selected in the location pane and All created organizations are displayed in the navigation pane.

  3. Choose Service Configuration in the location pane.
  4. Click the properties arrow next to Search in the navigation pane.
  5. Select Robot then Indexing from the menu bar.
  6. This displays a page containing attributes that define the Robot Indexing operational parameters and their settings. See Appendix F, "Search Attributes",” for information on the Robot Indexing attributes.

  7. Modify the Robot Indexing attributes as necessary.
  8. Click Save.

Using the Robot Utilities

The Robot includes two debugging tools or utilities:

To Run the Site Probe Utility

  1. Log in to the Sun ONE Identity Server administration console as administrator.
  2. By default, Identity Management is selected in the location pane and All created organizations are displayed in the navigation pane.

  3. Choose Service Configuration in the location pane.
  4. Click the properties arrow next to Search in the navigation pane.
  5. Select Robot then Site Probe from the menu bar.
  6. Type the URL of the site to probe.
  7. Click Show Advanced DNS information if you want the probe to return DNS information.
  8. Click OK to start the Site Probe.

To Run the Simulator

  1. Log in to the Sun ONE Identity Server administration console as administrator.
  2. By default, Identity Management is selected in the location pane and All created organizations are displayed in the navigation pane.

  3. Choose Service Configuration in the location pane.
  4. Click the properties arrow next to Search in the navigation pane.
  5. Select Robot then Simulator from the menu bar.
  6. Type in one or more URLs on which to perform the simulation.
  7. Select Check for DNS aliases if you would like the Simulator to check for aliases.
  8. Select Check for Server Redirects (302) if you would like the Simulator to check for redirects.
  9. Click OK to start the Simulator.

Scheduling the Robot

In order to keep the search data timely, the robot should search and index sites regularly. Because robot crawling and indexing can consume processing resources and network bandwidth. To avoid these resource constraints, you should schedule the robot to run during non-peak days and times. The administration console allows administrators to set up a cron job with the time and days to run the robot.

To Schedule the Robot

  1. Log in to the Sun ONE Identity Server administration console as administrator.
  2. By default, Identity Management is selected in the location pane and All created organizations are displayed in the navigation pane.

  3. Choose Service Configuration in the location pane.
  4. Click the properties arrow next to Search in the navigation pane.
  5. Select Robot then Schedule from the menu bar.
  6. Select the time (hour and minutes) and days to start the robot.
  7. Select the time and days to stop the robot.
  8. Click Save.


Administering the Database

The Search Engine stores its descriptions of resources in a database. The following are some configuration and maintenance tasks you may need to perform to administer the database:

Importing to the Database

Normally, the items in your Search database come from the robot. You tell the robot which sites to visit, and it locates and describes all the resources it finds there. But you can also import databases of existing items, either from other Sun ONE Portal Server Search Engines, from iPlanet Web Servers or Netscape™ Enterprise Servers or from databases generated from other sources. Import existing databases of RDs instead of sending the robot to create them anew helps reduce the amount of network traffic and also enables large indexing efforts to be completed more quickly by breaking the effort down into smaller parts. If the central database is physically distant from the servers being indexed, it can be helpful to generate the RDs locally, then have the central database import the various remote databases periodically.

The Search Engine uses an import agent to import RDs from another server or from a database. An import agent is a process that retrieves a number of RDs from an external source and merges that information into the local database. It contains parameters that tell it where to go to import RDs, what to ask for when it gets there, and some other information that fine-tunes the way it goes about the job.

Before you can import a database, you must create an import agent. Once an agent is created, you can start the import process immediately or schedule a time to run the import process.

To Create an Import Agent

  1. Log in to the Sun ONE Identity Server administration console as administrator.
  2. By default, Identity Management is selected in the location pane and All created organizations are displayed in the navigation pane.

  3. Choose Service Configuration in the location pane.
  4. Click the properties arrow next to Search in the navigation pane.
  5. Select Database then click the Import Agents link..
  6. Click New.
  7. The attributes page for the import agent appears.

  8. Specify the appropriate attributes for the import agent.
  9. See Appendix F, "Search Attributes",” for information on the Database Import attributes.

    1. Indicate whether the source is a local file or search server.
    2. If the source is a file, specify the local file path.
    3. If the source is another search server, specify the URL for the remote server, the instance name, and the search URI.
    4. Specify the name of the database to import.
    5. Specify the character set for the import agent.
  10. Click Save.

To Edit an Existing Import Agent

  1. Log in to the Sun ONE Identity Server administration console as administrator.
  2. By default, Identity Management is selected in the location pane and All created organizations are displayed in the navigation pane.

  3. Choose Service Configuration om the location pane.
  4. Click the properties arrow next to Search in the navigation pane.
  5. Select Database then click the Import Agents link.
  6. Click the Edit link to the right of the agent to edit.
  7. Specify the appropriate attributes for the import agent.
  8. See Appendix F, "Search Attributes",” for information on the Database Import attributes

  9. Click Save.

Editing Resource Descriptions

At times you will find it necessary to change the contents of one or more Resource Descriptions. For example, you might need to correct a typographical error copied into an Resource Description from an original document.

To Edit the Resource Descriptions

  1. Log in to the Sun ONE Identity Server administration console as administrator.
  2. By default, Identity Management is selected in the location pane and All created organizations are displayed in the navigation pane.

  3. Choose Service Configuration in the location pane.
  4. Click the properties arrow next to Search in the navigation pane.
  5. Select Database then Resource Descriptions from the menu bar.
  6. Select the type of Resource Description to search for to edit.
  7. The following types are available: All RDs, Uncategorized RDs, Categorized RDs, RDs by category, Specific RD by URL, RDs that contain.

  8. For Resource Descriptions that contain, specify a text string to search for in the Resource Description.
  9. Click Search.
  10. From the list of Resource Descriptions found, select the Resource Description to edit.
  11. Edit the appropriate Resource Description attribute.
  12. Click Save.

Editing the Database Schema

A schema determines what information your Search Engine maintains on each resource, and in what form. The design of your schema determines two factors that affect the usability of your index:

The schema is a master data structure for Resource Descriptions in the database. Depending on how you define and index the fields in that data structure, users will have varying degrees of access to the resources.

The schema is closely tied to the structure of the files used by the Search Engine and its robot. You should only make changes to the data structure by using the schema tools in administration console. You should never edit the schema file (schema.rdm) directly, even though it is a text file.

You can edit the database schema of the Search Engine to add a new schema attribute, edit a schema attribute, or delete attributes.

The schema includes the following attributes:

To Edit the Database Schema

  1. Log in to the Sun ONE Identity Server administration console as administrator.
  2. By default, Identity Management is selected in the location pane and All created organizations are displayed in the navigation pane.

  3. Choose Service Configuration in the location pane.
  4. Click the properties arrow next to Search in the navigation pane.
  5. Select Database then Schema from the menu bar.
  6. The Schema attributes page appears.

  7. To add a new attribute to the schema:
    1. Select New under Schema List.
    2. Type a name and description for the new attribute in the Name and Description fields.
    3. Check Editable to allow the attribute to be edited.
    4. Check Indexable to make the attribute indexed.
  8. To make an existing schema attribute editable or indexable:
    1. Click the Edit link next to an attribute from the schema list.
    2. The Schema attributes page appears.

    3. Check Editable to allow the attribute to be edited.
    4. Check Indexable to make the attribute indexed.
    5. Click Update
  9. To delete an attribute:
    1. Check an attribute from the schema list.
    2. Click Delete.

    3. Note

      Changes to the search engine schema may require that the entire database be reindexed and the server restarted. This is because the search engine highlighting functions are sensitive to the order and types of the schema fields. Adding or removing (or even removing and then adding backagain) a text field has a high likelihood of causing search result highlighting to be incorrect.

       


Defining Schema Aliases

There are several instances where you might encounter discrepancies between the names used for fields in database schemas. One is when you import Resource Descriptions from one server into another. You cannot always guarantee that the two servers use identical names for items in their schemas. Similarly, when the robot converts HTML META tags from a document into schema fields, the document controls the names.

The Search Engine allows you to define schema aliases for your schema attributes, to map these external schema names into valid names for fields in your database.

To Define Schema Aliases

  1. Log in to the Sun ONE Identity Server administration console as administrator.
  2. By default, Identity Management is selected in the location pane and All created organizations are displayed in the navigation pane.

  3. Choose Service Configuration in the location pane.
  4. Click the properties arrow next to Search in the navigation pane.
  5. Select Database then click the Schema link.
  6. The Schema attributes page appears.

  7. Click the attribute for which to define an alias.
  8. Specify the field name of the alias as it is used in the imported database.
  9. Click Update.
  10. Click Reindex.
  11. The reindexing process may take several hours for a large database.

Viewing Database Analysis

The Search Engine provides a report with information about the number of sites indexed and the number of resources from each in the database.

To View Database Analysis Information

  1. Log in to the Sun ONE Identity Server administration console as administrator.
  2. By default, Identity Management is selected in the location pane and All created organizations are displayed in the navigation pane.

  3. Choose Service Configuration in the location pane.
  4. Click the properties arrow next to Search in the navigation pane.
  5. Select Database then Analysis from the menu bar.
  6. A sorted list of all sites and the number of resources from that site currently in the search database.

  7. To generate a up-to-date list, click Save.

Reindexing the Database

In certain instances, you might need to reindex the Resource Description database for the Search Engine. One obvious instance is if you have edited the schema to add or remove an indexed field.

You might also need to reindex the database if a disk error corrupts the index file. It’s also a good idea to reindex after adding a large number of new Resource Descriptions.

Reindexing the database can take several hours.

The time required to reindex the database is proportional to the number of records in the database, so if you have a large database, you should perform reindexing at a time when the server is not in high demand.

To Reindex the Database

  1. Log in to the Sun ONE Identity Server administration console as administrator.
  2. By default, Identity Management is selected in the location pane and All created organizations are displayed in the navigation pane.

  3. Choose Service Configuration in the location pane.
  4. Click the properties arrow next to Search in the navigation pane.
  5. Select Database then Management.
  6. Click Reindex under Database List.
  7. Check the Reindex the database? checkbox and click OK.
  8. The Search Engine rebuilds the search collection and its index files.

Expiring the Database

Expiring the database will expire Resource Descriptions deemed out of date. Resource Descriptions will expire ONLY when you run the expiration. The expired Resource Descriptions will be deleted, however the database size will not decreased.

To Expire the Database:

  1. Log in to the Sun ONE Identity Server administration console as administrator.
  2. By default, Identity Management is selected in the location pane and All created organizations are displayed in the navigation pane.

  3. Choose Service Configuration in the location pane.
  4. Click the properties arrow next to Search in the navigation pane.
  5. Select Database then Management.
  6. Select Expire under Database List.
  7. Check the Expire RDs? checkbox and click OK.

Purging the Database

One attribute of an Resource Description is its expiration date. Your robots can set the expiration date from HTML META tags or from information provided by the resource’s server. By default, Resource Descriptions expire in three months from creation unless the resource specifies a different expiration date. Periodically your Search Engine should purge expired Resource Descriptions from its database.

Purging allows you to remove the contents of the database. Disk space used for indexes will be recovered, but disk space used by the main database will not be recovered, instead, it is reused as new data are added to the database.

To Purge Expired Resource Descriptions from a Server:

  1. Log in to the Sun ONE Identity Server administration console as administrator.
  2. By default, Identity Management is selected in the location pane and All created organizations are displayed in the navigation pane.

  3. Choose Service Configuration in the location pane.
  4. Click the properties arrow next to Search in the navigation pane.
  5. Select Database then Management.
  6. Select Purge under Database List.
  7. Check the Purge the database? checkbox and click OK.
  8. When the purge is complete, the system displays the message “The database contents were successfully purged.”

Partitioning the Database

The Search Engine allows you to split the physical files that contain the search database across multiple disks, file systems, directories, or partitions. By spreading the database across different physical or logical devices, you can create a larger database than would fit on a single device.

By default, the Search Engine sets up the database to use only one directory. The command-line interface allows you to perform two kinds of manipulations on the database partitions:

The Search Engine does not perform any checking to ensure that individual partitions have space remaining. It is your responsibility to maintain adequate free space for the database.

You can add new database partitions up to a maximum of 15 total partitions.


Note

Once you increase the number of partitions, you will need to delete the entire database if you later want to reduce the number again.


You can change the physical location of any of your database partitions by specifying the name of the new location. Similarly, you can rename an existing partition. Use the rdmgr command to manipulate the partitions. See Chapter 14, "Command-Line Utilities",” for information on the rdmgr command.


Administering the Database Taxonomy

The following are some configuration and maintenance tasks you may need to perform to administer the database taxonomy:

Configuring Categories

Using the Sun ONE Identity Server administration console you can perform the following procedures to configure the database taxonomy:

To Create a Child Category

  1. Log in to the Sun ONE Identity Server administration console as administrator.
  2. By default, Identity Management is selected in the location pane and All created organizations are displayed in the navigation pane.

  3. Choose Service Configuration in the location pane.
  4. Click the properties arrow next to Search in the navigation pane.
  5. Select Categories then Category Editor from the menu bar.
  6. Select a category in which to create a child category.
  7. If you have not previously defined any categories, only the root category titled “Search” is listed. Click the lower Search link to expand the root category.

  8. In the Name field, specify a name for the category.
  9. In the Description field, specify a description for the category (optional).
  10. Click Add as a Child to create the category.
  11. Click Save.

  12. Note

    The Category Editor has a go-to list that appears whenever the list of visible categories spans multiple pages. Use the the page-up and page-down buttons to scroll up or down one page from the current page. Use the go-to button to access more than one page.


To Create a Sibling Category

  1. Log in to the Sun ONE Identity Server administration console as administrator.
  2. By default, Identity Management is selected in the location pane and All created organizations are displayed in the navigation pane.

  3. Choose Service Configuration in the location pane.
  4. Click the properties arrow next to Search in the navigation pane.
  5. Select Categories then Category Editor from the menu bar.
  6. Select a category for which to create a sibling.
  7. In the Name field, specify a name for the category.
  8. In the Description field, specify a description for the category (optional).
  9. Click Add as a Sibling to create the category.
  10. Click Save.

  11. Note

    The Category Editor has a go-to list that appears whenever the list of visible categories spans multiple pages. Use the the page-up and page-down buttons to scroll up or down one page from the current page. Use the go-to button to access more than one page.


To Update a Category

  1. Log in to the Sun ONE Identity Server administration console as administrator.
  2. By default, Identity Management is selected in the location pane and All created organizations are displayed in the navigation pane.

  3. Choose Service Configuration in the location pane.
  4. Click the properties arrow next to Search in the navigation pane.
  5. Select Categories then Category Editor from the menu bar.
  6. Select a category to update.
  7. To change the name of the category, specify a new name for the category in the Name field.
  8. To change the description of the category, specify a description for the category In the Description field.
  9. Click Update.
  10. Click Save.

  11. Note

    The Category Editor has a go-to list that appears whenever the list of visible categories spans multiple pages. Use the the page-up and page-down buttons to scroll up or down one page from the current page. Use the go-to button to access more than one page.


To Delete a Category

  1. Log in to the Sun ONE Identity Server administration console as administrator.
  2. By default, Identity Management is selected in the location pane and All created organizations are displayed in the navigation pane.

  3. Choose Service Configuration in the location pane.
  4. Click the properties arrow next to Search in the navigation pane.
  5. Select Categories then Category Editor from the menu bar.
  6. Select the category to delete.
  7. When a category is deleted, all its child categories will also be deleted.

  8. Click Delete.
  9. Click Save.

  10. Note

    The Category Editor has a go-to list that appears whenever the list of visible categories spans multiple pages. Use the the page-up and page-down buttons to scroll up or down one page from the current page. Use the go-to button to access more than one page.


Defining Classification Rules

A classification rule is a simple conditional statement. Its form is "if <some condition> is true, assign the resource to <a category>".

To Define a Classification Rule

  1. Log in to the Sun ONE Identity Server administration console as administrator.
  2. By default, Identity Management is selected in the location pane and All created organizations are displayed in the navigation pane.

  3. Choose Service Configuration in the location pane.
  4. Click the properties arrow next to Search in the navigation pane.
  5. Select Categories then Classification Rules Editor from the menu bar.
  6. f you are creating a new rule, click New.
  7. If you are editing an existing rule, select the rule.
  8. Click the element type or attribute to use to classify the resource from the drop-down menu.
  9. Click the comparison test in the drop-down menu.
  10. Comparison tests available are is, contains, begins with, ends with, or regular expression.

  11. Define a text string to compare.
  12. Click the category in which to classify the resource if the comparison is true.
  13. Click save.


Previous      Contents      Index      Next     


Copyright 2003 Sun Microsystems, Inc. All rights reserved.