Send item changes

In integrated environments, this transaction publishes item data changes that are directed to an external system.

When item changes occur in Sterling Order Management System Software, they need to be communicated to the external system.

The business process may require the synchronization of items all at once in a batch. For example, at the end of each business day, the sendItemChanges agent can be configured to synchronize items based on the synchronization logic. This transaction retrieves all items that are not logical kit or dynamic physical kit items and whose SyncTS is null or MaxModifyTS is greater than the SyncTS.

The MaxModifyTS of an item is updated with the current timestamp whenever an item is modified. The transaction then retrieves detailed information about those items and raises the ON_SUCCESS event. This event should be configured to invoke the Send Item Changes action.

For more information about how this integration is implemented, see the Configuring integrations with other systems.

Attributes

The following are the attributes for this time-triggered transaction:

Table 1. Send item changes attributes
Attribute Value
Base Transaction ID SEND_ITEM_CHANGES
Base Document Type None
Base Process Type General
Abstract Transaction No
APIs Called None

Criteria parameters

The following are the criteria parameters for this transaction:

Table 2. Send item changes criteria parameters
Parameter Description
Action Required. Triggers the transaction. If left blank, it defaults to Get, the only valid value.
Number of Records To Buffer Optional. Number of records to retrieve and process at one time. If left blank or specified as 0 (zero), it defaults to 5000.
Organization Code Optional. The organization from which items are synchronized. This field is blank by default.
ColonyID Required in a sharded deployment where a table may exist in multiple schemas. Runs the agent for the colony.

Statistics tracked

None.

Pending job count

For this transaction the pending job count is the number of items requiring synchronization. This is determined for product items that are not logical kit or dynamic physical kit items and whose SyncTS is null or MaxModifyTS is greater than the SyncTS.

Events raised

The following events are raised by this time-triggered transaction:

Table 3. Events raised by the send item changes transaction
Transaction/Event Key Data Data Published Template Support?
ON_SUCCESS None
YCM_SEND_ITEM_
CHANGES_ON_
SUCCESS.XML
Yes