Creating a Global Search Index Batch Job

The underlying engine for Civic Platform global search is the Apache Lucene full-text search engine. You must create and execute a batch job to build the initial index files on the index server with the current database data. It is best practice to execute batch jobs after you finish running all data conversion loading jobs. After you build the initial index, the index server automatically updates the index with the transaction data that users enter into the database through Civic Platform. There is no need to frequently rebuild the index, for example, no need to run the batch job daily or weekly.

You can define the batch job to support the global search for one or more objects including records, addresses, licensed professionals, assets, parcels, documents, and contacts. By default, the batch job supports all the mentioned objects. You can modify the supporting scope by configuring the Standard Choice GLOBAL_SEARCH_BUILD_INDEX_ENTITIES.

To create a global search index batch job

  1. Access the Batch Jobs portlet (Accessing the Batch Jobs Portlet).

  2. Click New and complete the Batch Job fields as described below.

    Name Rebuild Index
    Description Add the description for the batch job.
    Email Enter the email address where you want Civic Platform to send emails after job completion, no matter whether the job is successful or not. You can configure the email template named NOTICE_OF_BATCH_JOB_COMPLETED to customize the notification. For information about how to edit an email notification template, see Working with Communication Manager.
    Job Server Select the server for running the batch job.
    Job Type Select job type “System” from this drop‑down menu.
    Service Category Global Search Rebuild Index.

  3. Click Submit.

    Civic Platform saves the batch job details.

  4. Click the Job Schedule tab.

  5. Define the batch job schedule, including the start time, the start date, and the frequency. Refer to Table 1 for a list of field definitions.

    Note:

    There are only two options, “Once” and “Monthly,” of the frequency with which the Global Search Index batch job runs.

  6. Click Save.

  7. If at any time you want to review the batch job history, click the Log tab. See Viewing the Batch Job Log.

    Civic Platform displays the list of completed Rebuild Index batch jobs.