Building PeopleSoft Search Indexes

This section provides an overview of:

  • Search definitions.

  • Search categories.

  • Search index schedule and search indexes.

Search Definitions

Search definitions are business objects that are made available for text search. Each search definition is associated with a query to capture the business context data needed for the search. The search definition provides the information required by the search framework to enable the system to create search results (search documents).

ePerformance delivers these search definitions that are used when users search for development tips and results writer through the writing tool function:

  • HC_EP_DEV_TIP

    Used for development tips which are not connected to a competency or sub-competency.

  • HC_EP_DEVSUB_TIP

    Used for development tips for competencies.

  • HC_EP_DEVCOMP_TIP

    Used for development tips for sub-competencies.

  • HC_EP_WRITER_COMP

    Used for results writer for competencies.

  • HC_EP_WRITER_SUBCOMP

    Used for results writer for sub-competencies.

Search Categories

Search categories allow for the logical groupings of search definitions. Technically, end users run searches against search categories and not individual search definitions, therefore, each search definition has to belong to at least one search category.

ePerformance delivers a search category for each delivered search definition with the same name:

  • HC_EP_DEV_TIP

  • HC_EP_DEVSUB_TIP

  • HC_EP_DEVCOMP_TIP

  • HC_EP_WRITER_COMP

  • HC_EP_WRITER_SUBCOMP

Search Index Schedule and Search Indexes

A search index schedule specifies a search definition that needs to be crawled. When the search index schedule process is run, it generates an XML feed and creates a schedule in the search engine which in turn crawls XML feed and builds the search index.

When you either add or remove Results Writer or Development Tips text items, you must rebuild the corresponding search indexes to accurately reference these items in the database. If you do not rebuild the index, the system user will not see the added content when using the writing tools.

Use the PTSF_SCHEDULE run control component provided in the PeopleSoft Search Framework to handle the launching of the PTSF_GENFEED process, which builds or rebuilds these indexes as necessary:

  • HC_EP_DEV_TIP

  • HC_EP_DEVCOMP_TIP

  • HC_EP_DEVSUB_TIP

  • HC_EP_WRITER_COMP

  • HC_EP_WRITER_SUBCOMP

The Index Build process must be run separately for each of the search definitions after they have been deployed.

Global Search for ePerformance Documents

ePerformance performance documents and development documents are searchable through Global Search (a PeopleSoft Search Framework feature). In addition to accessing the corresponding components using the classic menu navigations, users can go to these documents directly by initiating keyword search against the Performance Documents search category in the Global Search bar, which appears in the header of the application if enabled (right below the menu navigation path).

See Using Global Search Definitions for HCM.

PeopleSoft Global Search - HCM

Follow the PeopleTools installation document and the PeopleSoft Search Framework documentation for the complete setup of the functionality.

To ensure that users can search for results writer comments and development tips in ePerformance documents:

  1. Deploy search definitions delivered in ePerformance.

    For more information about search definitions, see PeopleTools: Search Technology.

  2. Deploy ePerformance search categories delivered in ePerformance.

    Note: When you deploy a search definition, the search category of the same name is automatically deployed.

    For more information about search categories, see PeopleTools: Search Technology.

  3. Build search indexes for search definitions.

    If the index is going to be created for the for the first time, create a full index. For subsequent runs, use the incremental index option.

    For more information about search indexes, see PeopleTools: Search Technology.

  4. Test the search functionality.

    If the index build process is completed successfully, test the search functionality by:

    • Using the Search Test page provided in PeopleTools.

      For more information about the Search Test page, see PeopleTools: Search Technology.

    • Performing a search on development tips or results writer text in a performance or development document.