Property | Description | |
Comments | Optional. Specifies a descriptive comment for the step. | |
Label | Optional. (Required if you are using this EXIT step as a target for a BRANCH step.) Specifies a name for this specific step, or a null, unmatched, or empty string ($null, $default, blank). | |
Exit from | Required. Specifies the flow step or service from which you want to exit. | |
Specify this value… | To exit the… | |
$parent | Parent flow step, regardless of the type of step. This is the default. | |
$loop | Nearest parent LOOP or REPEAT step. | |
$flow | Entire flow. | |
$iteration | An iteration of the nearest ancestor LOOP or REPEAT flow step. | |
label | Nearest ancestor step that has a label that matches this value. Note: If the label you specify does not match the label of an ancestor flow step, the flow will exit with an exception. | |
<blank> | Nearest ancestor LOOP or REPEAT flow step. This is the same as specifying a value of $loop. | |
Signal | Required. Specifies whether the exit is considered a success or a failure. A SUCCESS condition exits the flow service or step. A FAILURE condition exits the flow service or step and throws an exception. The text of the exception message is contained in the Failure message property. | |
Failure name | The fully qualified Java Class name of the Pending Exception that will be created for this Failure. For example: java.lang.Exception com.wm.app.b2b.server.ServiceException com.wm.lang.flow.FlowException com.costomerCo.CustomException Valid class names must be available to the current class loader and must extend java.lang.Exception. If the class name is not valid, Integration Server throws the default Exception with the following message appended to the Failure message value: -- class for specified failure not found or invalid The default value depends on the Exit from value.  If Exit from is set to $flow, then the default is com.wm.lang.flow.FlowException.For all other Exit from values, the default is com.wm.lang.FlowFailure.If you want to use the value of a pipeline variable for this property, type the variable name between % symbols (for example, %failure%). The variable you specify must be a String. When you want the EXIT step to throw an exception, you specify a value for either Failure name or Failure instance properties. If you specify both, Integration Server uses the Failure instance value. This property is used only when Signal is set to FAILURE. | |
Failure instance | The name of the pipeline variable that contains an existing Exception instance that you want the EXIT step to identify as the failure. This instance is most likely the failure output parameter of the pub.flow:getLastFailureCaught service. The specified pipeline variable must be of type Object. The object variable in the pipeline must extend java.lang.Exception. If it does not, Integration Server throws a FlowException. If you specify a pipeline variable that exists but does not contain an exception at run time or if you specify a variable that does not exist, Integration Server throws a FlowException and exits the flow service. This property is used only when Signal is set to FAILURE. | |
Failure message | Optional. Specifies the text of the exception message that is displayed when Signal is set to FAILURE. If you want to use the value of a pipeline variable for this property, type the variable name between % symbols. For example, %mymessage%. The variable you specify must be a String. This property is used only when Signal is set to FAILURE. | |