Web Services Guide

10.2.1

Back Next

Fault Handling

When an error occurs in a web service, the Data Integration Service generates an error message and returns the message in a fault to the web service client.

If a SOAP 1.1 request is sent to an operation with SOAP 1.2 binding, the web service will generate a fault using SOAP 1.1. If a SOAP 1.2 request is sent to an operation with a SOAP 1.1 binding, the web service will generate a fault using SOAP 1.2. A web service can generate system defined faults and user-defined faults.

The Data Integration Service returns an error message to a web service client when a user-defined error occurs. A user-defined fault can be one of the following types:

Predefined

Generic

When the operation mapping contains an Output transformation, the web service returns data from the Output transformation or it returns a fault. If a fault occurs after the operation mapping has committed data to target transformations or external applications, the Data Integration Service cannot roll back the data. The mapping stops and the Data Integration Service discards the data that the web service Output transformation received.

SOAP 1.1 Fault

For SOAP 1.1, a fault is a SOAP message with the following structure:


   Fault (FaultName)         
   Key_Fault (FaultName)
   faultcode            xs:QName
   faultstring          xs:string
   faultactor           xs:anyURI
   detail

The fault contains the following elements:

Fault code: A fault identification code such as an error message number.
Fault string: An explanation of the error.
Fault actor: Optional information about the object that caused the fault to occur.

Detail: Optional information that varies based on the fault.

SOAP 1.2 Fault

For SOAP 1.2, a fault is a SOAP message with the following structure:


   Fault (FaultName)         
   Key_Fault (FaultName)
   Code                tns:faultcodeEnum
   Reason              tns:reasontext
   Node                xs:anyURI
   Role                xs:anyURI
   detail

The fault contains the following elements:

Code: A fault identification.
The Value element of Code must be one of the following values:
infasoapns:DataEncodingUnknown
infasoapns:MustUnderstand
infasoapns:Receiver
infasoapns:Sender
infasoapns:VersionMismatch
You can expand the Code fault element to extract the SubCode fault element up to one level. The schema type for SubCode is xsd:QName. You can use the SubCode fault element to define an error message number.
Reason: An explanation of the error.
Node: Contains the URI of the SOAP node that generated the fault.
Role: Optional information about the object that caused the fault to occur.