Skip to Main Content
Return to Navigation

Administering Verity Search Indexes

After you design and build your search indexes, the Search Administration interface enables you to schedule when and how frequently the indexes must be rebuilt. An important aspect of maintaining the collections involves scheduling PeopleSoft Process Scheduler jobs that, on a regular basis, rebuild the collection completely or incrementally update the index. Search index administration also includes deleting old indexes and building indexes to support additional languages.

This section discusses how to:

Specifying the Verity Index Location

By default, search index files are located in:

PS_CFG_HOME/data/search/indexname/db_name/language_code

You can store indexes in different locations, but you need to specify the custom location in the CFG file for an application server, Process Scheduler, or search server. Use the [Search Indexes] section in the PSAPPSRV.CFG, PSPRCS.CFG, or PSSRCHSRV.CFG files to specify alternate search index locations and multiple locations, if necessary.

Note: This procedure assumes that you've already used the Search Index Designer to define, build, and store the search indexes that you will specify in the CFG file.

Note: You must edit the CFG file manually to include the locations. You do not add search index locations through PSADMIN.

To add a search index location:

  1. Open the CFG file.

  2. Locate the Search Indexes configuration section.

    For example:

    [Search Indexes]
    ;=========================================================================
    ; Search index settings
    ;=========================================================================
    : Search indexes can be given alternate locations if there is an entry here.
    ; Entries look like: IndexName=fs location (ie EMPLOYEE=c:\temp)
  3. Add an entry for each search index location that you want to specify by using the following syntax:

    index_name=location

    For example, to specify the location for search INDEX_A and INDEX_B, your entries would look similar to the following:

    [Search Indexes]
    ;=========================================================================
    ; Search index settings
    ;=========================================================================
    : Search indexes can be given alternate locations if there is an entry here.
    ; Entries look like: IndexName=fs location (ie EMPLOYEE=c:\temp)
    INDEX_A=c:\temp
    INDEX_B=n:\search

    Note: Make sure that your entries are not commented out with a semicolon (;) appearing before them.

    Note: For the Process Scheduler configuration file, PSPRCS.CFG, include the same location as specified in the application server configuration file.

    Note: When specifying the index to be generated in a custom location, the directory structure the system builds within the custom location will be slightly different from that built in the default location. The directory structure within custom index locations will not have a directory for the database name.

  4. Save the CFG file.

Administering the Verity Search Index

Select select PeopleTools, then select Search Engine, then select Administration to access the Search Index Admin page.

Image: Search Index Admin page

This example illustrates the fields and controls on the Search Index Admin page. You can find definitions for the fields and controls later on this page.

Search Index Admin page
Index

Displays the name of the index so that you can identify specific indexes. To select an index, select the check box to the left of the index name.

Index Location

Displays the current location of the index.

Edit Properties

Click to access the interface for changing the index location and to build indexes to support additional languages.

Schedule

Click to access the interface for scheduling the program that maintains your collection.

Delete checked Indexes

If you have selected indexes to be deleted, click this button to remove them from the system. The deletion process deletes the index definition and the collections that are stored in the file system.

Note: If you attempt to delete a scheduled index, you may see SQL errors on IBM DB2 UDB or Sybase database platforms.

Editing Properties

Select select PeopleTools, then select Search Engine, then select Administration, then select Edit Properties.

Index Location

Displays the current location of the index.

Language Code

Select the language for which you want to build an index.

Language to Map

Currently disabled.

Build

After you add the additional indexes, click to create the indexes.

Note: Style files are located in the style subdirectory of the index. To make style changes, apply them to the files in this directory.

Scheduling Administration

Select select PeopleTools, then select Search Engine, then select Administration, then select Schedule.

Image: Scheduling search builds

This example illustrates the fields and controls on the Scheduling search builds. You can find definitions for the fields and controls later on this page.

Scheduling search builds
Add a new Recurrence Definition

In PeopleSoft Process Scheduler, you define run recurrence definitions that enable you to schedule jobs to run at regular intervals, such as monthly, weekly, daily, and so on. The more current you keep the collections, the more accurate your search results will be.

Type of Build

Rebuild: Select to drop the existing collection and rebuild a new collection. This applies to all types of collections.

Increment: Use only for the spider indexes. For record-based indexes, only theRebuild option is available.

Run Recurrence Name

Select the appropriate run recurrence definition for the collection maintenance requirements.

Server Name

Specify the PeopleSoft Process Scheduler server on which you want the build program to run. The PeopleSoft Process Scheduler system must be installed and configured before you can schedule the collection build program to run as a job.

Sharing Indexes Between Application Servers and PeopleSoft Process Scheduler

The index files reside on a file system at the home location and must be accessible to all application servers and process schedulers that will manipulate the index. An application server uses the index for searching while the process scheduler invokes an Application Engine program that builds the indexes. Therefore, if you are running a process scheduler on a different machine than the application server, ensure that the index files are accessible to both. You can do this three ways:

  • Make a Microsoft Windows shared drive or NFS file system available for the index.

    Specify the index location in both the application server and the process scheduler to point to the shared directory.

  • Run an instance of the process scheduler on the application server host and schedule only the building of indexes on this process scheduler.

    Because the process scheduler and the application servers are running on the same host, they create and read files from the same location.

  • Use an external program such as FTP or Secure Copy (SCP) to copy all of the files and directories in the index home location from the process scheduler host (after the index has been built) to the application server host so that they are available for searching.