Contents

SOAP Set Fault

Adds a <Fault> element to the envelope or replaces an existing one. If one of the mandatory fields (Fault Code, Fault Actor) is empty, the Failure path is taken and XML Get Error Info may be used on the Envelope node to query for error reasons. If the envelope already has a <Fault> element, the tool will remove the existing <Fault> element and replace it with the new element.

Parameter	Dir	Type	Remarks
Envelope	IN	Node	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.
Fault Code	IN	String	String to set as value of the <faultcode> element. String must not be empty.
Fault String	IN	String	String to set as value of the <fautstring> element. Should be set to provide human readable information.
Fault Actor	IN	String	Optional. String to set as value of the <faultactor> element. If argument is not specified, no <faultactor> element is added.
Create Detail Element	IN	Boolean	Checkbox: False Don't create a <detail> element True Default. Create an empty <detail> element NOTE: According to the SOAP spec, a <detail> element must be present if the fault is because the <Body> could not be processed successfully.
Preserve Body Elements	IN	Boolean	Checkbox: False Default. Remove all existing body elements and replace with <Fault> element True Leave existing body elements and append <Fault> element as last child of <Body> NOTE: When sending a fault response to the client, only the <Fault> element is allowed in the body!
Detail Element	OUT	Node	Returns the node of the newly created <detail> element. If ‘Create Detail Element' is False, a NULL node is returned.

Exit Paths: Success, Failure