Copyright © Cloud Software Group, Inc. All Rights Reserved

SOAP Send Fault

Activity

The SOAP Send Fault activity sends a SOAP fault to the client if an error occurs during processing of a SOAP request.

This activity is used when the SOAP Event Source process starter handles incoming SOAP requests. The WSDL file for the request can have one or more fault messages defined for an operation (see Chapter 19, WSDL Palette for a description of creating fault schemas for operations). The SOAP Send Fault activity can use the fault schema to send application-specific data about the fault back to the client that made the SOAP request.

This activity cannot be used if the SOAP request is one way.

SOAP faults are required to send the fault code and the fault string. These values are required input items on the Input tab. For example, "Client" can be used for client faults and "Server" can be used for server faults. See the SOAP specification at www.w3.org/TR/SOAP for more information about the syntax of SOAP fault codes.

Configuration

The Configuration tab has the following fields.

Field	Global Var?	Description
Name	No	The name to appear as the label for the activity in the process definition.
Description	No	Short description of the activity.
Reply To	No	The SOAP Event Source process starter.
Fault Details	No	The name of the fault message to send. This field provides a drop down list of the fault messages defined in the WSDL file specified for the SOAP Event Source process starter. You must select one of the fault messages to return to the client, and that message becomes part of the input schema for this activity’s Input tab. The option <Default> is always available and can be used to send the default fault message.

Transport

The Transport tab has the following fields.

Field	Global Var?	Description
JMS Transport
JMS Delivery Mode	No	The delivery mode of the message. Can be one of the following: • PERSISTENT: signifies the messages are stored and forwarded. • NON-PERSISTENT: messages are not stored and may be lost due to failures in transmission. • TIBCO EMS Reliable: this mode is only available when using TIBCO Enterprise Message Service. See the TIBCO Enterprise Message Service documentation for more information about this mode.
JMS Application Properties	No	Any application-specific message properties that will be part of the message. This is specified by the JMS Application Properties shared configuration resource.

Input

See TIBCO ActiveMatrix BusinessWorks Process Design for more information about mapping and transforming input data.

TIBCO ActiveMatrix BusinessWorks uses the same schema for Fault messages regardless of the version of the SOAP protocol. See SOAP Specification Compliance for more information.

The input for the activity is the following.

Input Item	Datatype	Description
faultcode	string	The SOAP specification defines a specific syntax for faultcodes returned by a SOAP fault. See the SOAP specification for more information on how to specify a faultcode.
faultstring	string	The faultstring is a string message to pass back to the client describing the fault.
faultactor	string	The faultactor element is intended to provide information about who caused the fault to happen in the message path. It is similar to the SOAP actor attribute but instead of indicating the destination of the header entry, it indicates the source of the fault. The value of the faultactor attribute is a URI identifying the source of the fault. You may use the faultactor element to indicate explicitly that this TIBCO ActiveMatrix BusinessWorks process generated the fault.
detail	complex	The fault message specified by the Fault Details field on the Configuration tab. This message is used to pass application-specific data back to the client in the event of a fault.
_configData	complex	This element is available only for a JMS transport. Specifies the values to use to override transport-specific configuration values. The content of the _configData element depends upon the type of transport used.

Output

The activity has no output.

Error Output

The Error Output tab lists the possible exceptions that can be thrown by this activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information about error codes and corrective action to take.

Exception	Thrown When...
HTTP Transport
ServerException	An error occurred and the reply could not be sent to the client.
JMS Transport
JMSMessageCreateException	The JMS message could not be created.
JMSSessionCreateException	The JMS session could not be created.
JMSSendException	The JMS send operation failed.

Copyright © Cloud Software Group, Inc. All Rights Reserved