Send customer changes

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

When customer changes occur in Sterling Selling and Fulfillment Foundation, they need to be communicated to the external system.

The business process may require the synchronization of customers 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 customers that are consumers, have a user ID present, and are required to synchronize. This transaction can also be used to complete the initial synchronization of users between the two systems. For example, if an external system is already in place, and Sterling Selling and Fulfillment Foundation is then added, the SendCustomerChanges agent synchronizes the users from the external system.

The sendCustomerChanges agent also serves as a backup mechanism. If a customer synchronization event fails, the agent automatically retries the synchronization after a specified amount of time.

The MaxModifyTS of an customer is updated with the current timestamp whenever an customer is modified, whenever syncTS is less than MaxModifyTS, or when syncTS is null. The transaction then retrieves detailed information about those customers and raises the ON_SUCCESS event. This event should be configured to invoke the Send Customer 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 customer changes attributes
Attribute Value
Base Transaction ID SEND_CUSTOMER_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 customer 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 customers are synchronized. This field is blank by default.
ColonyID Required in a multischema 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 customers requiring synchronization. This is determined for customers that are consumers, have a user ID present, and are required to synchronize.

Events raised

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

Table 3. Events raised by the send customer changes transaction
Transaction/Event Key Data Data Published Template Support?

SEND_CUSTOMER_
CHANGES.ON_SUCCESS

None

YSC_SEND_CUSTOMER
_CHANGES.ON_
SUCCESS.XML

Yes