Copyright © TIBCO Software Inc. All Rights Reserved
Copyright © TIBCO Software Inc. All Rights Reserved


Chapter 4 Transactions : Operation Overview

Operation Overview
CMI Protocol manages trading partners data in TIBCO BusinessConnect using operations that consist of a Request.Response pair.
Operation Categories
CMI Protocol operations can be categorized in different ways:
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.
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.
Command Rules for the Parent/Child Element
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.
Example 5 Command Rule Example for the Parent/Child Element

 
<UPDATEParticipantREQ>
  <Participant name=”partner1” type=”Partner”>
    <Locations>
      <Location name=”loc1” addr1=”newaddr” />
        <Contacts>
          <Contact name=”Mark” command=”INSERT” />
          <Contact name=”Mary” command=”DELETE” />
        <Contact name=”John” />
       </Contacts>
      </Location>
    <Locations>
  </Participant>
</UPDATEParticipantREQ>

 
Rules that follow the commands performed on the Parent and Child elements are described in Table 3.
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
Read Operations
Read operations follow the rules explained in Table 4.
Search criteria to retrieve only one exact result when the required parameters protocolName, startDate, and endDate are provided. Rules are:
Search is always accurate and returns one GETONEParticipantRESP response.
Search criteria to retrieve one or more results when the required parameters protocolName, startDate, and endDate are provided. Rules are:
Wildcard search is allowed and based on partner names; for example, Company* will return all business agreements containing this string, such as Company1-Company2 businessagreement, where Company1 is the Host and Company2 is the Partner.
Wildcard search is allowed; for example, the string *y* would return all participants containing *y*, such as Company1.
Write Operations
This operations category defines any operations that store or delete participants or business agreements in the configuration database.
The WRITE operations will perform the following:
Write operations follow the rules explained in Table 5.

Copyright © TIBCO Software Inc. All Rights Reserved
Copyright © TIBCO Software Inc. All Rights Reserved