Catalog index building

The Lucene searchable index file contains denormalized item data that has been extracted from the IBM® Sterling Order Management System database. The index file stores all the item data that is required for performing fast, scalable searches.

Additionally, the index file is stored on the server, further enhancing the performance of the search. For example, if a customer searches for red shirts, the Lucene search engine uses the index file to quickly locate all the item information pertaining to shirts with the attribute value of red.

The Create Catalog Index time-triggered transaction builds an index file for each supported locale. The transaction can be configured to perform the following tasks:

  • Build a full or incremental index file for each locale
  • Run scheduled index builds or enable user-initiated index builds
  • Activate the index

The transaction refers to an XML configuration file for instructions about building the index file. The default index file configuration includes item data about attributes, categories, pricing information, and assets (Sterling Order Management System provides only the HTML format for asset type by default.)

Note: You can customize catalog search by extending the corresponding XML configuration file. For example, Sterling Order Management System provides only the US-English locale by default. However, you can add a locale, such as Canada-French, by extending the XML configuration file. Data from external sources can be added to the index file by extending the XML configuration file and by providing a custom implementation of the appropriate user exit. You can also add asset types.

If any changes are made in the database to the attributes of entities that are defined in the catalog search XML configuration file, the catalog index must be rebuilt, either incrementally or fully. For example, you must rebuild the index after adding or deleting individual items in entitlement rules, or when an item is added or removed from a category. The same is true when the price on an item is modified or added. Additionally, the index must be fully rebuilt when there is a pricelist assignment for anonymous or all customers removed.

Note: If more than a third of the items in the catalog have changed, it is recommended that you perform a full index build.