Show TOC

Procedure documentationRecommendations on Call Sequence Locate this document in the navigation structure

 

In this section you will find our recommendations on the call sequence for common usage cases.

Procedure

Recommended Sequence for Creating Objects

If you do not explicitly specify a change list ID when you create an object then a new change list will be generated. If you would like to create many objects then this can cause an unmanageable number of change lists to be generated quickly.

To keep all newly created objects in a single change list, the following call sequence is recommended (the example here is for creating communication profile objects):

  1. Create change list (ChangeList.create).

    The operation displays a change list ID.

  2. Create the communication party (Party.create).

    Use the change list ID displayed in step 1.

  3. Create the business component (BusinessComponent.create).

    Use the change list ID displayed in step 1.

  4. Create the communication channel (CommunicationChannel.create)

    Use the change list ID displayed in step 1, the communication party created in step 2, and the business service created in step 3.

    If you do not enter any further attributes then this will be displayed in the message.

  5. Change the communication channel (CommunicationChannel.change)

    In this step enter the missing obligatory attributes of the communication channel (error message from step 4).

    Use the change list ID displayed in step 1.

  6. Activate change list (ChangeList.activate).

    Use the change list ID displayed in step 1.

Recommended Sequence for Changing Objects
  1. Open the object to edit (<CommunicationObject>.openForEdit)

    When you call it, enter the object key. The Web Service generates a change list and displays the change list ID. The object is locked in the change list.

  2. Change the object (<CommunicationObject>.change)

    Change the object.

  3. Activate change list (ChangeList.activate).

    Use the change list ID displayed in step 1.