Using the Operations Editor

You can perform import operations using the operations editor.

Import Operations

Note 

In this release, preconfigured operations are automatically imported when the CMI Protocol is activated. You need to verify that the protocol is activated.

Properties of these preconfigured operations are read only and you cannot update or delete them.

Display the Imported Operations

To view the available operations for CMI Protocol, start the Operations Editor:

1. Select BusinessConnect > Operations Editor.
2. Click on the CMI link.
3. Click on the “+” sign in the upper left corner to display all available transactions that come predefined with CMI Protocol.

All available operations, grouped by their corresponding categories, is displayed as shown in the table below.

Detail schemas for each of the operations is provided in BC_HOME\protocols\cmi\examples\SampleDocs\cmipayload.xsd.

The following table explains the fields of CMI Protocol Transactions. For more information, see Operation Categories.

 

CMI Protocol Transactions

Field

Explanation

Version

 

1.0

Version number. In this release, you cannot add new versions.

Category: Batch

cancelBatch

Cancel a batch.

executeBatch

Execute a batch.

Category: Read

getManyAuditLog

Get a set of audit logs.

getManyBusinessAgreement

Get a set of business agreements.

getManyParticipant

Get a set of participants.

getManyProtocolOperation

Get a set of operations for a particular protocol.

getOneAuditLog

Get one audit log.

getOneBusinessAgreement

Get one business agreement.

getOneEnabledProtocol

Get one protocol that has been enabled.

getOneOperationBinding

Get one operation binding.

getOneOperationTree

Get one operation tree.

getOneParticipant

Get one participant.

Category: Session

login

Login and create a new session.

logout

Logout and destroy session.

Category: Write

deleteBusinessAgreement

Delete the business agreement.

deleteParticipant

Delete the participant.

insertBusinessAgreement

Insert a new business agreement.

insertParticipant

Insert a new participant.

updateBusinessAgreement

Update the existing business agreement.

updateEnabledProtocol

Update the existing enabled protocol.

updateOperationBinding

Update the existing operation binding.

updateOperationTree

Update the existing operation tree.

updateParticipant

Update the existing participant.

upsertBusinessAgreement

Update or insert a business agreement.

upsertParticipant

Update or insert a participant. Unlike in the GUI, creating a new Participant of Host type would result in all the protocols being disabled, unless they are explicitly enabled from the CMI Protocol requests.