iWay Service Manager Component Reference Guide > Available Services > Save/Restore Document Value Service (com.ibi.agents.XDSREGDocAgent)

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

Syntax:

com.ibi.agents.XDSREGDocAgent

iIT Service Object:

Description:

This service stores a document value in a special register (SREG), or reloads the document from a SREG.

A document is the unit of information that passes through a process flow. There can be only a single document on any line of the process flow at any time. Documents include payload and state information. State information in the document is automatically managed by the server and can be modified in a process flow using the Set Document State service (com.ibi.agents.XDDocAgent). For more information, see Set Document State (com.ibi.agents.XDDocAgent).

The logic of some process flows requires that the current document be stored so that it can be recovered later on a process flow line. The Save/Restore Document Value Service accomplishes this by storing the document (or its payload) in a SREG, and later recovering the document or its payload. The SREG is a user register of local scope.

Parameters:

Parameter

Description

Register name *

The name of the register that is used as a storage location for the document.

Action to take *

Determines the type of action that is taken by the service. Select one of the following values from the drop-down list:

  • Store to register {store} (default)

    The requested document or its payload is stored in the SREG.

  • Load from register {load}

    The current document is replaced by the one that is loaded in the SREG.

Level *

Determines the level of information to be saved. Select one of the following values from the drop-down list:

  • Full document {doc} (default)

    The entire document.

  • Payload {payload}

    Only the information stored in the document. The state is not affected.

Note: This operand applies only to store actions. The load action restores the document based on what was stored.

Clear *

Used only for load actions, this parameter determines if the contents of the register should be cleared when the load is completed. This parameter is set to true by default.

No Activity Log *

If set, this register will not be logged in an activity log. Some drivers will not respect this setting.

True (default): activity will not be logged.

False: activity will be logged.

No Marshal *

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

True (default): will not be marshalled.

False: will be marshalled.

The edges returned are listed in the following table.

Edge

Description

success

The operation completed successfully.

fail_notfound

On a load operation, the register was not found or did not have the appropriate type of information loaded.