Service SAP form - Completing the Faults tab
Use the Faults tab to specify data returned to the client application when the service encounters a fatal processing error and must return a SOAP fault message. You can also use the Faults tab for other conditions that you want to cause SOAP fault messages to be returned.
A fault is a fatal processing error in the service, such that valid data cannot be returned by the normal output parameter process. In addition to the fault message, the Pega Platform returns an HTTP Code 500 Internal Server Error.
You can also have the system return other, non-fatal activity status information to the client as the value of a response parameter set on the Response tab.
Select the condition that causes the system to return the data you specify:
|When key||Optional. If the Condition value is When or Queue When, specify the key of the when condition rule to be evaluated. Otherwise, leave this blank.|
Specify the source of the SOAP fault reason value:The SOAP fault reason is also known as the SOAP faultstring in SOAP 1.1.
|Map from key||Specify the key of the property or rule from which to map the SOAP fault reason
If you selected XML Literal as the data type, the property value must contain text that is formatted as well-formed XML.
|Fault detail key||If you intend to return a value for the SOAP fault detail element, enter the
Stream Name (second key part) of the XML Stream rule that is used to generate the
data. The system assumes that the XML Type key (second key part) of the XML Stream
rule is the constant value
For an example of this facility, see Pega Community article How to customize SOAP fault messages.