Configuring Incremental Indexing

Search Framework provides an automated way to schedule the incremental indexing, enabling it to process data where real-time indexing might miss a change. For example, when a future effective-dated row becomes current, the RTI trigger will not be activated, but a new effective-date row needs to be processed.

Use the following pages to configure and schedule the incremental indexing:

  1. Configure Incremental Indexing

  2. Configure Incremental Schedule

  3. View Incremental Schedules

Use the Configure Incremental Indexing page to configure incremental indexing for a specific search definition that has a date or datetime field and to specify any additional information required for incremental indexing of the search definition.

Access the Configure Incremental Indexing page by selecting PeopleTools > Search Framework > Incremental Indexing > Configure Incremental Indexing.

The search page displays search definitions with the source type as query and connected query from the default search instance.

The search page also provides a comprehensive view of the Incremental Active status retrieved from the Configure Incremental Schedule page, enabling you to take the necessary action on a search definition.

Select a search definition to view or modify the configured incremental indexing information.

This example illustrates the fields and controls on the Configure Incremental Indexing page. You can find definitions for the fields and controls later on this page.

Configure Incremental Indexing

Field or Control

Description

Record (Table) Name

Select the table where a change in data need to initiate incremental indexing.

Record Description

Displays the description of the selected record.

Field Name

Select the date or datetime field that needs to be monitored to identify the change in data in the table.

Audit Field

Select the date or datetime field that acts as an audit field in the table in case a current effective date data undergoes a change or any other specific use cases where only an audit field update happens.

This is an optional field.

Use the Configure Incremental Schedule page to activate or deactivate incremental indexing for a specific search definition and to specify any additional information required for scheduling incremental indexing of the search definition.

Access the Configure Incremental Schedule page by selecting PeopleTools > Search Framework > Incremental Indexing > Configure Incremental Schedule.

The search page displays search definitions as well as their schedule and last scheduled time status, enabling you to take necessary action on search definitions.

This example illustrates the fields and controls on the Configure Incremental Schedule page. You can find definitions for the fields and controls later on this page.

Configure Incremental Schedule

Field or Control

Description

Search Definition

Displays the search definition’s name.

Search Instance

Displays the search instance's name.

Incremental Active

Enable the Incremental Active button to schedule incremental indexing at the specified time.

Schedule Time

Specify the time for initiating incremental indexing.

Time Zone

Select the preferred execution time zone.

Run Control ID

By default the last run control from a successful indexing is displayed. However, you can provide a run control of your choice. If the given run control doesn't exist, the system automatically creates a new incremental run control.

Last Indexed Time

Displays the date and time when the index was scheduled successfully.

Index By Data Partition

Displays whether the Search Framework partitions the application data using the Index By Data Partition option.

This field is populated when data partition run control is available.

Number of Partitions

Displays the number of partitions.

This field is populated when data partition indexing is enabled in the search definition.

Use the View Incremental Schedules page to view the data related to incremental indexing. This page provides a comprehensive view of the information retrieved from the Configure Incremental Indexing and Configure Incremental Schedule pages.

Access the View Incremental Schedules page by selecting PeopleTools > Search Framework > Incremental Indexing > View Incremental Schedules.

This example illustrates the fields and controls on the View Incremental Schedules page.

View Incremental Schedules