Developer

Transaction Server Update Step

A step definition reference for updating the back-end system during transaction processing.

A transaction server update step references a step definition within the same module that is run during transmit to update the back-end system with the data captured by the transaction. This step has access to all of the properties of the transaction using the SDML or mechanisms available using the Agentry Java API. The value of these properties can be used by the steps to update the back-end system. An update step can be defined to run or not run based on a data state being set for the transaction. An update step can also define a response to be sent to the Client to perform some additional action in relation to the object instance targeted by the transaction.

Using the data state functionality, update steps may be defined for a single transaction that process the data captured in the transaction normally, and other steps that run only when data states are set to provide data collision handling. Each server update step can contain its own list of selected data states, that is, the data states it is aware of. It can then be defined to run or not when one of its selected data states is set.

Server update steps can send a client response after they have been processed by the Agentry Server. This response will only be sent if the step that defines it is run. Only one response is sent for a transaction. There are different responses possible, and which one is ultimately sent to the Client is based on the type of response.

Server Update Step Attributes

Following is a list of the attributes for a server update step definition:
  • Step: This attribute references the step definition within the same module to be run by the Agentry Server as a server update step for the transaction.
  • Run for which States: This attribute defines when the step is run in relation to the transaction’s data states. This can be “All Data States”, “Data States except selected”, “Only selected data states”, and “Do Not run Step”. This last option is normally only set for testing purposes, as the step will never be run if this option is selected. When set to one of the two data state options, a second tab is available in the Properties view of the Agentry Editor. This second tab lists all selected data states for the update step and allows for additional data states to be added.
  • Response to Client: This attribute specifies what response is sent to the Agentry Client after the Update Step has been processed. The response defined here will only be sent if the update step is run. The responses that may be sent are “Delete Client Object”, “Replace Client Object”, “Update Client Key Property”, and “No Action Required”. If “Update Client Key Property” is set, the step being run by the server update step is expected to return a value identified as the transaction’s target object’s key property. This value will replace the current value of this property on the Client for that object instance.