Managing search indexes

You can manage your search indexes.

About this task

To manage search indexes, navigate to System > Index Management. The Index Management screen appears.

Note: The Index Management Menu will appear only if the Sterling Search Index feature is enabled. Refer to the yfs.ssi.enabled property for information about enabling the Sterling Search Index.

Table 1. Index management window
Field Description
Index Management
Index Name From the drop-down list, select the name of the index that you want to manage. The drop-down options are Order and Shipment.
Index Status - This panel displays the status of the specified index name.
Index Version The version number associated with the current index configuration. Every change in the index configuration made by following the steps in the "Customizing the Sterling Search Index" topic will result in the version of that index being incremented by 1. The current index version for each index is tracked in the PLT_INDEX_CONFIG configuration table.
Update Required Shows the current state of the PLT_INDEX_CONFIG.INDEX_UPDATE_REQUIRED column. No action needs to be taken based on this flag.
View Index Template Click this button to view the indexable attributes for the specified index name and index version. A pop-up window appears and displays the attributes in XML format.
Note: The attribute IsXMLGroup appears if the parent xml node is an XMLGroup. This is not an indexable attribute.
Indexing Working Indicates the current status of the indexing operations. It is displayed as a drop-down list.
  • Yes - Indicates that indexing-related operations, such as adding a record to the index or modifying/deleting an existing record in the index, are working.
  • No - Indicates that indexing-related operations are currently disabled.

In case indexing operations are continuously failing, the system will set Indexing Working to No. This is done automatically so that no further indexing attempt is made until the issue is resolved. Generally, these kinds of issues require manual intervention to fix the problem. For more details about this feature, refer to the "Continuous Index/Search Failure Considerations" topic.

After the issue is fixed, you need to set Indexing Working to Yes (by selecting Yes from the drop-down list) so that indexing operations can resume.

Note: This flag will appear only when ’fail fast’ logic is enabled for the Sterling Search Index. Refer to the yfs.ssi.fail.fast property for information about enabling fail fast logic.
Search Working Indicates the current status of the search operations. It is displayed as a drop-down list.
  • Yes - Indicates that the search operations on the index are working.
  • No - Indicates that the search operations on the index are currently disabled.

In case search operations are continuously failing, the system will reset Search Working to No. This is done automatically so that no further search attempt is made until the issue is resolved. Generally, these kinds of issues require manual intervention to fix the problem. For more details about this feature, refer to the "Continuous Index/Search Failure Considerations" topic.

After the issue is fixed, you need to set Search Working to Yes so that search operations on the index can resume.

Note: This flag will appear only when ’fail fast’ logic is enabled for the Sterling Search Index. Refer to the yfs.ssi.fail.fast property for information about enabling fail fast logic.
Save Click this button to save the Index Status selections.
Reset Click this button to clear the Index Status selections.
Index Synchronization Status - This panel displays the synchronization status of the specified index name for an enterprise. Refer to the "Index Synchronization Concepts" topic for details about this section.
EnterpriseCode The EnterpriseCode of the enterprise organization.
Synchronized Indicates whether the data for this enterprise is synchronized with the index.
Mark As Synchronized Select the enterprise from the panel, and click this button to mark the index as synchronized for the enterprise.
Note: This button will be enabled only if the Synchronized flag displays No.
Mark All As Synchronized This is similar to the Mark As Synchronized button, but clicking this button will set Synchronized to Yes for all the enterprises in the list.
Mark As Not Synchronized Select the enterprise from the panel and click the Mark As Not Synchronized button. This will set Synchronized to No for the enterprise, and search operations on the index will be disabled. Refer to the "Index Synchronization Concepts" topic for scenarios where this might be useful.
Mark All As Not Synchronized This is similar to the Mark As Not Synchronized button, but clicking this button will set Synchronized to No for all the enterprises in this list.