CloudStreams 10.5 | webMethods CloudStreams | Administering webMethods CloudStreams | Virtual Services | Creating a New Virtual Service (SOAP) | The Error Sequence Step (SOAP) | The Fault Handler Variables
 
The Fault Handler Variables
The following fault handler variables are used in fault response messages. You can define fault response messages either in a virtual service's Error Sequence step or in the global Service Fault Configuration page in Integration Server Administrator.
Error Handler Variable
Description
$ERROR_MESSAGE
When a fault is returned by the native service provider, this variable will contain the message produced by the provider's exception that caused the error. This is equivalent to the getMessage call on the Java Exception. This maps to the faultString element for SOAP 1.1 or the Reason element for SOAP 1.2 catch. For REST service calls, the message is returned inside an </Exception> tag. If the response is XML, the message is returned inside <Exception>'custom message'</Exception>. If the response is JSON, it will be returned inside {"Exception":"Invalid response"}.
When a fault is returned by internal CloudStreams exceptions (policy violation errors, cloud connection errors and cloud connector service errors), this variable will contain the error messages generated by CloudStreams.
$OPERATION
The operation that was invoked when this error occurred.
$SERVICE
The service that was invoked when this error occurred.
Note:
Deprecated, but still a valid alias. Alternatively, use $SERVICE_NAME (see The Predefined Context Variables).
$TIME
The time (as determined on the Container side) at which the error occurred.
$DATE
The date (as determined on the Container side) at which the error occurred.
$CLIENT_IP
The IP address of the client invoking the service. This might be available for only certain invoking protocols, such as HTTP(S).
Note:
Deprecated, but still a valid alias. Alternatively, use $INBOUND_IP (see The Predefined Context Variables).
$USER
The currently authenticated user. The user will be present only if the Transport/SOAP Message have user credentials.
$CONSUMER_APPLICATION
The currently identified consumer application. If the service's policy does not contain the Identify Consumer action, $CONSUMER_APPLICATION will return null.