The Fail object generates an exception, which triggers the process flow to handle onCatchExceptions events. This object is located in the iWay Integration Tools (iIT) Palette, under the Exceptions group, as shown in the following image.

Fail Object in Palette

When you add the Fail object to your process flow using iIT, configuration properties for this object are available in the Properties tab, as shown in the following image.

Fail Object Configuration Parameters

Default action: throw a fail exception

This action causes a deliberate fail of the message in the process flow. The process flow begins error processing. If the error is not resolved, then the process flow terminates in an error state, accordingly.

Note: For applications migrated from iWay Release 7 to the iWay Release 8 framework, you may see an error generated during the process flow compilation for the process flows which have used Fail Agent followed by other execution objects as part of the implementation. The reason is that in iWay Release 7, you were allowed to have execution nodes after the Fail Agent, even though they did not execute due to the agent termination process. To work around the issue during migration, remove the use of Fail Agent, and replace it with the applicable FAIL node.

Parameter Groups

Parameter Description
Message The exception message that will be issued to the user.
Terminate Flow If set to true, the process flow terminates immediately with an uncatchable error, bypassing error processing.

By default, this parameter is set to true.
Parameter Description
Bypass Logging If set to true, the exception will not be traced at the error level. This is useful for cases where the trace log is being monitored by an external program for errors. The exception will be traced at the debug level.

By default, this parameter is set to false.
XA Log If set to true, a transaction log entry (XALOG) is written with its message. This causes a message to appear in the transaction log.

By default, this parameter is set to false.