iWay Service Manager Component Reference Guide > Available Services > Save/Restore XML Tree Service (com.ibi.agents.XDSREGTreeAgent)

Save/Restore XML Tree Service (com.ibi.agents.XDSREGTreeAgent)

Syntax:

com.ibi.agents.XDSREGTreeAgent

iIT Service Object:

Description:

This service stores XML to a special register (SREG), or reloads the XML tree from an SREG. Usually this agent is used to build an XML segment that is then added to the document on the edge at this moment.

Parameters:

Parameter

Description

Target

The name of the node of the desired subtree.

Type*

The target type of the node. Select one of the following target types from the drop-down list:

  • parent
  • root (default)

Special Reg*

Name of the SREG to be assigned.

Note: Register names must conform to the requirements used for XML element names.

Store or load

Select one of the following target types from the drop-down list:

  • Store to register {store} (default)

    Saves the tree into the SREG.

  • Load from register {load}

    Sets the outbound document to the value of the SREG.

Edges:

The edges returned are listed in the following table.

Edge

Description

success

Operation completed successfully.

duplicate

The node was found, but has siblings.

notfound

The node to assign was not found.