Scheduled job for indexing

This topic describes the indexing scheduled job in an integration of Episerver Find with EPiServer 7/7.5 CMS.

How it works

The EPiServer.Find.Cms assembly ships with a scheduled job plug-in, which lets administrators re-index an entire site from the Episerver CMS admin mode. The job, Episerver Find CMS indexing, can be started manually or via Episerver CMS's job scheduling feature.

Note: You only need to schedule the indexing job for specific circumstances described below. Episerver instantly indexes any content changes. If you run the indexing job when it is not necessary, you are unduly adding to the system load.

Using the scheduled job

There are two legitimate scenarios for using the scheduled indexing job to index all pages:

• After installing Episerver Find CMS integration for the first time. Existing pages are not otherwise indexed unless manually re-published.
• The automatic indexing failed, or pages should be re-indexed for another reason. One reason may be ACL changes (access rights settings), as this activity doss not trigger automatic indexing.

When started manually, the job runs within the IIS server application pool and is interrupted by IIS when the Idle Time-out passes. By default, the timeout is set to 20 minutes. Indexing a large site may take more than 20 minutes, and it is not advisable to increase the timeout. Therefore, it is recommended to schedule the job, as the Episerver scheduled job process is not affected by the timeout.

Log of indexing activity

At the completion of an indexing job, a report prints to the history log displaying execution time and number of pages indexed.

Indexing job: Reindexing completed.
ExecutionTime: 0minutes 18seconds
Number of pages indexed: 180

Error notifications

If an error occurs, the report notifies you where it occurred and gives the error message. Two types of errors are counted:

• Page errors, relating to filtering or loading page.
• Batch errors, relating to transmitting and indexing files to Episerver Find.

Example of error notification:

Indexing job: Reindexing completed.
ExecutionTime: 0minutes 16seconds
Number of pages indexed: 169
Number of page errors: 11
Number of batch errors: 0
An error occured while filtering Page: 113. 
The 'ShouldIndex' function could not be evaluated for Page: 113. 
ShouldIndex-exception. (see log for more information)

To see the stack trace, activate the logging functionality and trace it in your log file.