Data migration and index sync agents

You can review the information about data migration and sync agents.
Broadly speaking, data in the index can become inconsistent due to the following reasons:
  • Failures during the indexing operation or lost updates.
  • Index becoming out of sync because of mass data import, preexisting orders, index version change, and so on.
Correspondingly, there are two agents to ensure that the index stays in a consistent state:
  • SSI_DELAYED_SYNC agent is meant to up and triggered frequently to ensure that any records that exist in YFS_Awaiting_Index table are processed. Mostly, the updates are sent to Order Search from the agent, integration, or application server where the order state is modified. But, if there are any exceptions the SSI_DELAYED_SYNC agents attempts indexing again. Additionally, any indexing attempt for a large order and the index update requests from order purge transactions are always processed in a delayed fashion by the SSI_DELAYED_SYNC agent. Therefore, the SSI_DELAYED_SYNC agent is a critical component to support the search index capabilities in Sterling Order Management System Software and hence, this must be running all the time and ought to be configured to trigger with short interval, preferably less than 5 minutes. Any higher trigger interval simply delays the propagation to Order Search and impacts the visibility of order updates.
  • SSI_MASS_SYNC agent is to be used to migrate transactional orders and to fix out-of-sync issues. This agent must run once to migrate all the transactional orders in Sterling Order Management System Software to the Order Search. Subsequent runs are needed to fix the out-of-sync issues such as when the outline template is changed or to migrate the unindexed order updates. That is, orders that are created or modified when Sterling Search Index is temporarily disabled, during an upgrade process, Order Search is out of reach, or in exceptional cases such as the order index in Order Search appeared to be corrupted. This agent works different modes to meet these specific requirements.

The SSI_MASS_SYNC agent when run on 'Full' mode migrates the order data from transaction tables. But the history orders that are waiting to be archived in future are not migrated to Order Search by these agents. So, for Order Search to become a single source of truth for orders that are fulfilled through Sterling Order Management System Software and to provide a search facility for orders to be archived soon, you must migrate all the history orders to Order Search. The OSI_HISTORY_MASS_SYNC agent is provided solely for this purpose.

OSI_HISTORY_MASS_SYNC agent migrates history orders to Order Search and stage the orders for archival. The eventual goal of this agent is to facilitate archival of orders present in history tables and delete them from Sterling Order Management System Software. However, every order in history is not eligible to archive at a time, and hence this agent stages them for archival so that the OSI_ORDER_ARCHIVE agent that runs periodically can archive the eligible orders. Basically, this agent migrates the order outline data for history orders to Order Search and initiate the archival of history orders to Archive Service, which archives and removes the entire order data from Sterling Order Management System Software. This is required to run immediately after enabling the build-in integration with Order Search and enabling the Sterling Search Index feature. You can stop this agent after all the history orders are migrated to Order Search and staged for archival.

For more information about these agents, see Business process time-triggered transactions.