SSI mass sync agent

As explained in the "Index Synchronization Concepts" topic, the SSI_MASS_SYNC agent is to be used to bring the index ‘in sync’ with the database. This agent is used when there are mass inconsistencies between these two systems. Some examples of mass inconsistencies include:

Each indexable entity (order/shipment) has a column called INDEX_VERSION. This column is used to track if the entity record is indexed or not, and if so, which index-definition version the index record corresponds to. For example, if INDEX_VERSION is null for a particular order, that order is not indexed at all. If, on the other hand, its version is 3, the document indexed corresponds to the index-definition version 3. For more details about index version, refer to the "Managing Search Indexes" topic.

The agent works in three modes:

Notes:

Attributes

Table 1. SSI mass sync agent attributes
Attribute Value
Base Transaction ID SSI_MASS_SYNC
Base Process Type General

Criteria Parameters

In addition to the index mode criteria, SSI Mass Sync Agent takes the following criteria parameters.
Table 2. SSI mass sync agent criteria parameters
Parameter Name Description
Action Required. This parameter triggers the transaction. The default value is "Get".
BatchSize Number of records to process in a single executeJob . The default is 1000.
NumBatchesToBuffer Number of records to return in one iteration of getJobs. The default is 5000.
Enterprise Code Enterprise Code of the enterprise to run this agent for.

This agent will run for the enterprise colony and all the Seller colonies for this enterprise.

Mode Mode of operation (unindexed, versionsync, full). The default value is unindexed.
IndexName Name of the index. For example: Order
Colony Id Colony Id.

When Colony Id is passed and Enterprise Code is not passed, the agent will be triggered for all enterprises that are configured in that colony. Also, for each of these enterprises, the agent will run for the enterprise colony and all the Seller colonies for this enterprise.

Collect Pending Jobs This agent does not provide the pending jobs count for monitoring it in the System Management Console; hence, this parameter is set to N and is not modifiable.

Events Raised

None

Statistics Tracked

None

Pending Job Count

None