SREG: Save/Restore Document Value Service (com.ibi.agents.XDSREGDocAgent)

Syntax:

com.ibi.agents.XDSREGDocAgent

iIT Service Object:

format: SREG: Save/Restore Document Value

Description: Stores the document value in a special register, or reloads the document from a special register.

Parameters:

Parameter

Description

Register name *

The name of the special register holding the document

Action to take *

  • Store to register saves the value of the current document in the named register.
  • Load from register restores it.

Level *

  • Payload addresses only the message information.
  • Full document includes all state information such as addresses, error status, etc.

Clear *

Determines on load whether the register should be cleared after loading.

No Activity Log *

If set, this register will not be logged in an activity log (some drivers may not respect this setting).

No Marshal *

If set, this register will not be marshalled for transfer via, for example, gateway, pending storage, or AFTI.

Edges:

The following table lists the available Line Edges for the SREG: Save/Restore Document Value Service (com.ibi.agents.XDSREGDocAgent).

Line Edge

Description

OnError

An exception occurred during execution.

OnSuccess

The operation was successful.

OnFailure

A fail condition occurred during execution.

OnNotFound

The resource was not found and this is considered an error.