Delete Sync Invoking Enterprise Business Services

Constructing the ABCS 12-29 Content Payload The payload of an operation that uses an Update verb is typically the entire EBO and in general every business object has only two messages with an Update operation single and list. Situations may occur in which subsets of an EBO must be updated, in which case multiple update messages may possibly exist, each with a distinct payload. An example is a possible UpdateSalesOrderLineEBM message with a payload that contains only SalesOrderLine. Verb Attributes The Update verb has an optional ResponseCode attribute that is intended to communicate the payload that is expected in the response message to the Update request. The possible values for the ResponseCode are restricted to either ID response payload is expected to be the Identifier of the object that was created or OBJECT response payload is expected to be the entire object that was created. Corresponding Response Verb The Update verb has a paired UpdateResponse verb that is used in the response message for each Update EBM. The response is expected to be provided by the target application only if the original request message explicitly requests a response by setting the ResponseCode attribute in the Update message. The payload of the response is either the ID or the entire object that was updated, depending on the ResponseCode specified in the Update request. Response Content Payload The payload type of the response verb is always based on the payload type of the Update Request operation. It is implemented as a different type to support user customization if needed.

12.8.3 Delete

The Delete verb is a request to a service provider to delete the business object identified using the object Identification provided in the payload of the Delete message. When to Use the Delete Verb The Delete verb is used for operations that are intended to delete a business object. Operations that use the Delete verb must delete content and should not be an orchestration of other operations. Content Payload The payload of the Delete verb must be only an identification element that uniquely identifies the business object to be deleted. Verb Attributes The Delete verb has an optional ResponseCode attribute that is intended to communicate the payload that is expected in the response message to the Update Note: Currently, AIA does not support using Delete for components of a business object, that is, Delete Purchase Order Line is allowed 12-30 Developers Guide for Oracle Application Integration Architecture Foundation Pack request. The only possible value for the ResponseCode for Delete is ID response payload is expected to be the Identifier of the object that was created. Corresponding Response Verb The Delete verb has a paired DeleteResponse verb that is used in the response message for each Delete EBM. The Response is expected to be provided by the target application only if the original request message explicitly requests a response by setting the ResponseCode attribute in the Delete message. The only allowed value for the ResponseCode is ID.

12.8.4 Sync

The Sync verb indicates a request to a service provider to synchronize information about an object using the payload provided in the Sync message. When to Use the Sync Verb The Sync verb is used in situations in which applications provide operations that can accept the payload of the operation and create or update business objects as necessary. Operations that use the Sync verb must create or update content and should not be an orchestration of other operations. The primary usage scenario for Sync is generally batch transactions in which the current state of an object is known, but what has changed between the previous sync and the current sync is not known. Sync can also be used to synchronize individual instances of objects. The initiator of Sync is generally the system that owns the data to be synchronized. Using the Sync operation implies that the object exists in both the source and the target system, and the result of Sync is that both the source and target have the same content. Sync is different from the other verbs in that it assumes a dual processing instruction-Sync can both create and update existing content. The content of the Sync reflects the current state of the object in the system generating the message. In this mode, a single Sync message can contain multiple instances of nouns, with none of them having any specific change indicator. The source system generates the message, and all systems that subscribe to the message are expected to synchronize their data to reflect the message content. Sync is probably the most practical approach for master data management scenarios in which change is not frequent, and it may not be practical or necessary from an operational point of view to synchronize data on a real-time basis. The Sync verb has an optional syncActionCode attribute that can be used to further instruct the recipient of a Sync message about the expected processing behavior. The possible values for the syncActionCode are: ■ CREATE_REPLACE: This is the default behavior of Sync when no syncActionCode is specified. The target system that receives a Sync message with no syncActionCode attribute, or with a syncActionCode attribute value of NULL or CREATE_REPLACE, is expected to create the object if it does not exist in the target system, or if it does exist, the entire object is to be replaced with the definition that has been provided in the Sync message. ■ CREATE_UPDATE: A Sync message with the value of syncActionCode as CREATE_UPDATE is expected to be processed as follows: create the object if it does not exist in the target system, or if it does exist, update the object with the content that has been provided in the Sync message. Constructing the ABCS 12-31 Content Payload Generally speaking, there is only one Sync message per EBO with a single and list implementation and the payload of the message is the entire EBO. Sync should always be used to synchronize the entire business object. Multiple Sync messages may exist in cases in which different named views of the business object exist, but never for synchronizing a specific component of a business object. Verb Attributes The Sync verb has an optional ResponseCode attribute that is intended to communicate the payload that is expected in the response message to the Sync request. The possible values for the ResponseCode for Sync is restricted to OBJECT response payload is expected to be the entire object that was created or updated and ID response is only the ID of the object that was created or updated Corresponding Response Verb The Sync verb has a paired SyncResponse verb that is used in the response message for each Sync EBM. The response is expected to be provided by the target application only if the original request message explicitly requests a response by setting the ResponseCode attribute in the Sync message. Response Verb Content Payload The payload type of the response verb is always based on the payload type of the Sync Request operation. It is implemented as a different type to support user customization if needed.

12.8.5 Validate