APIs, SDKs, and Services

Back Next

Rollbacks

A rollback undoes the changes made to objects when a guide user navigates back to the step that made the change. For example, if the first step changes the name field of an object, the object is updated as soon as the user navigates to the second step. If the user goes back to the first screen, a rollback reverses the name change.

The operations that support rollbacks are those that mutate objects: create, update, and delete. The rollback segment of rollback response messages allows a custom user-defined service to be named to undo work already done.

The Process Designer framework does not automatically handle rollback segment creation. This means that it does not call a delete on your data server to undo a create operation.

Code Example: Rollback

Items in bold text are discussed in the paragraph following this example.

<aetgt:createResponseWrapper 
      xmlns:aetgt="http://schemas.active-endpoints.com/
         appmodules/screenflow/2011/06/avosHostEnvironment.xsd" 
      xmlns:types1="http://schemas.active-endpoints.com/
         appmodules/screenflow/2011/06/avosHostEnvironment.xsd" 
      xmlns:xsd1="http://schemas.active-endpoints.com/
         appmodules/screenflow/2010/10/avosScreenflow.xsd">
   <types1:createResponse 
         id="24db9f6f-2f66-4a19-915e-c9002faf0a11"
         objectType="account_tasks">
      <xsd1:onRollback deleteCount="1">
         <xsd1:serviceName>dbDeleteAnyEntityService 
                </xsd1:serviceName>
         <xsd1:avosServiceName>dbDeleteAnyEntityService
                </xsd1:avosServiceName>
         <xsd1:runAsUser/>
         <aesf:hostContext 
            xmlns:aesf="http://schemas.active-endpoints.com/
               appmodules/screenflow/2010/10/avosScreenflow.xsd"
            xmlns:aetgt="http://schemas.active-endpoints.com/
               appmodules/screenflow/2010/10/avosScreenflow.xsd"
            xmlns:sf="http://schemas.active-endpoints.com/
               appmodules/screenflow/2010/10/avosScreenflow.xsd">
            <aesf:arg name="ObjectType">contacts</aesf:arg>
            <aesf:arg name="ObjectId">
               925cdc8b-f8e5-467e-ad1b-9270afb97b8f</aesf:arg>
         </aesf:hostContext>
         <xsd1:parameters>
            <xsd1:parameter 
               name="ObjectType">account_tasks</xsd1:parameter>
         <xsd1:parameter 
            name="ObjectId">24db9f6f-2f66-4a19-915e-c9002faf0a11
           </xsd1:parameter>
         </xsd1:parameters>
      </xsd1:onRollback>
   </types1:createResponse>
</aetgt:createResponseWrapper>

This example declares that the Process Designer framework will execute the

dbDeleteAnyEntityService

service provided in the sample, and delete the

account_tasks

ObjectType where the

account_task

object has an

ObjectId

of "24db9f6f-2f66-4a19-915e-c9002faf0a11". The host context arguments and the

runAsUser

element is additional metadata that can be used by your service when executing the delete.

Rename Saved Search

Table of Contents

APIs, SDKs, and Services

APIs, SDKs, and Services

Rollbacks

Rollbacks