IBM BJ0NJML - Service And Asset Management Integration Manual page 86

Object Structure Element
Update actions
Change action
Replace action
72
object. If the parent object does not exist in the database, no error is reported to
the sending system.
The change and replace actions indicate that the existing database records are
updated. The AddChange action can result in an update when the record that is
to be processed exists in the receiving system.
The change and replace actions are interchangeable in the case of updates to
single-level standard object structures. For hierarchical object structures, the two
actions have different XML content and require different processing by the
receiving system.
A change action on the primary object in an XML message indicates that the
message contains one or more parent or child records that are added, changed, or
deleted. It always contains the parent of any child record to be updated, even if
the parent is unchanged.
When the primary object in an inbound or outbound XML message contains a
change action, each child object in the message can contain one of the following
action codes.
Action Code of
Child object
Add
Delete
Change
Null or no action
specified
If an action code is not listed in the preceding table, an error occurs in the
processing of the XML document.
A replace action on the primary object in an XML message indicates that the
message contains a complete set of objects that represent the net result of
additions, changes, and deletions to the object structure. These objects replace the
existing database records, and any database record that is not referenced in the
XML message is deleted.
For outbound processing, the system always uses the replace action, not the
change action.
In inbound processing, the system deletes any existing child record that is not
explicitly mentioned in the message. External systems must process replace
actions in the same manner; that is, delete any child records that are not part of
the XML document.
The replace action can appear only on the primary object in an XML message. If a
child record in an inbound XML message contains a replace action when the
primary object contains a change action, the integration framework does not
process the message. If a child level record contains a replace action when the
parent contains any action other than change, the system ignores the action on the
child record.
Processing Action
Add the child record; if it exists, an error results.
Delete the child record; if it does not exist, an error
results.
Update the child record; if it does not exist, an error
results.
If the child record exists, update it; if child record does
not exist, add it.
Integration Guide