SOAP Add Body Element

This SOAP tool adds an entry to the body of the SOAP envelope. Use the XML tools on the returned ‘Element’ node to add rich contents to the element (not just a string).

Note: If the ‘Name’ argument has no namespace prefix and a ‘Namespace’ different than "" (default namespace) is specified, a prefix will be synthesized, unless the local name starts with a ‘:’ (which is illegal in XML, and thus signals to this tool not to add a synthesized namespace prefix). Adding a prefix can greatly reduce the size of the message if child elements are in no namespace, as otherwise each child element would get an xmlns="" attribute.

Inputs

Envelope

Envelope node of the SOAP payload. Can be a document node whose document element is <SOAP-ENV:Envelope> or the node is the element itself.

Name

Fully qualified name of the element to create and add to the body. Please see remarks above for details.

Namespace

Optional string containing the namespace URI of the element. If the parameter is omitted and the name has a namespace prefix, the tool will search in the parent elements for the namespace with the same prefix and make the element a member of this namespace.

Encoding Style

Optional string containing the value of the ‘encodingStyle’ attribute. Attribute is omitted if not specified or “NONE.” Specify “STANDARD” for standard namespace ("http://schemas.xmlsoap.org/soap/encoding/”).

Value

Optional string value to set as content of the element.

Replace Existing Body Element

Checking this box will replace the first element in the body that has the same (local) name and namespace. If the body contains multiple elements with the same name and namespace, the remaining ones are not modified.

By default, this box is not checked and the element is added as the last child of the body.

Delete All Existing Body Elements

If this box is checked, all existing elements will be removed from the body prior to adding the new element. By default, this box is not checked and the new element is appended to the child list of the body.

Outputs

Body Element

Node of the element that has just been added.

Exit Paths

Success

This path is taken if the element is successfully added.

Failure

This path is taken if the operation fails.