![]() |
Copyright © TIBCO Software Inc. All Rights Reserved |
CMI Protocol manages trading partners data in TIBCO BusinessConnect using operations that consist of a Request.Response pair.
• By type: Operations are categorized into four types:
• By target: Except for Session and Batch type, each operation has a “target” attribute, which is a particular type that the operation works on, such as Participant, Business Agreement, and so on.
• By command: Each operation falls into one of the pre-defined commands, as explained in Table 2.
Table 2 CMI Protocol Commands Delete data. If the data does not exist, an Error message is returned. Used only for the Read operation. Used only for the Read operation.
• If the given batchId does not exist (may be already executed or cancelled), an error message is returned.
• If the given batchId does exist, CMI Protocol will always try to execute the requests of the batch and return a success response, even if all requests fail.
• If the given batchId does not exist (may be already executed or cancelled), an error message is returned.
• If the given batchId does exist, CMI Protocol will try to delete all stored data and return a success response.One example of the operation ParticipantRequest is described in the Example 5, where the Parent element UPDATEParticipantREQ is highlighted in Italic, and the children (or grand children) are highlighted in Bold.
<Contact name=”Mark” command=”INSERT” /><Contact name=”Mary” command=”DELETE” />
Not allowed for children when the parent executes the insert command. Not allowed for children when the parent executes the insert command. Not allowed for children when the parent executes the insert command. Allowed. UPSERT on a child element with the UPSERT command on the parent either inserts the child (if not present) or updates the child details appropriately. Allowed. UPDATE on a child element with the UPSERT command on the parent updates only the child details appropriately. If the child details are not present, an Error is thrown. Allowed. DELETE on a child element with the UPSERT command on the parent deletes the child data appropriately. Allowed. UPSERT on a child element with the UPDATE command on the parent either inserts the child (if not present), or updates the child details appropriately. Allowed. UPDATE on the child element with the UPDATE command on the parent updates only the child details appropriately. If the child details are not present, an Error is thrown. Allowed. DELETE on a child element with the UPDATE command on the parent deletes the child data appropriately Not recommended for children when the parent does the delete command. The WRITE operations will perform the following:
Table 5 Write Operation Rules
![]() |
Copyright © TIBCO Software Inc. All Rights Reserved |