Create global search index batch job

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.

Note: There is no need to frequently rebuild the index, meaning you do not need to run this 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.

Note: 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. From the Administration menu, select System tools > Batch engine.

  2. Select New.

  3. Complete the batch job fields as described below.

    Field Action
    Name (Required) Enter "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,regardless if 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 Communication manager.
    Job type (Required) Select job type System from this menu.
    Service category

    Select Global search rebuild index.

    Note: This field displays after you select a job type
  4. Select Submit.

  5. Select the Job schedule tab.

  6. Complete the following fields:

    Field name Action
    Start time

    Determine the time of day at which the batch job begins running by selecting hour, minute, and am/pm from menus.

    Note: If you set a batch job Schedule status to Active but do not specify a Start Time, an error message displays when you try to save the batch job.
    Schedule status Use this menu to turn a batch job on and off. Select Active to activate the batch job. Select On hold to deactivate the batch job and save its information.
    Start date

    Enter the date on which the batch job starts or select a date by selecting the data picker beside the field.

    Note: If you set a batch job Schedule status to Active but do not specify a Start date, an error message displays when you try to save the batch job.
    Time out (seconds) Enter the number of seconds a batch job attempts to run before timing out.
    End date This field is active only if you select a value other than Once in the Frequency field. Enter the date on which the batch job stops running or select a date by selecting the data picker beside the field.
    Frequency Select the frequency with which the batch job runs from this menu. The options are Once, Daily, Weekly, Monthly, or Yearly.
    PM generate

    (Required) This field enables you to specify how far in advance the batch job generates work orders.

    Note: This field only displays if you selected PM schedule as the Service category during the creation of the batch job.

    Enter a number in the first field, then select Days, Weeks, Months, or Years from the menu in the second field.

    Example: To generate work orders two weeks in advance of the PM Schedule batch job, enter 2 in the numeric field and select Weeks from the menu. Or, enter 15 in the numeric field and select Days from the menu.
  7. Select Save.

Note: You can review a batch job's history from the Log tab. For more information, see View the batch job log.