ExceptionReturn - Return from an exception flow

This component is for returning to a caller flow from an exception flow.

Stream Information

Input	Format	All
	Number of Inputs	1
	Description	Accepts all stream types.
Output	Format	NONE
	Description	The input stream is copied to the output stream.

Component Properties

Name	Data Type	Mapping	Description
Transaction	choice	-	Specifies whether completed transactions are to be committed, or rolled back. If transactions are disabled, this property is ignored. Commit [true] - Commit transactions Rollback [Rollback] - Rollback transactions
ReturnValue	string	In & Out	The flow's return value.
ReturnStream	choice	-	Specifies whether multiple streams are to be packed in the case of looping. For details, please refer to following topic "Output format". PackRecords [true] - Pack streams Last [false] - Output only last stream PackStreams [PackStreams] - Output streams as a contaitner
ReturnType	choice	-	Specifies where to return. ExceptionComponent [true] - Return to an component where an exception has occurred, then processes to a next component EndOfParent [false] - Return to a caller flow and ends it

Loop

Ends looping. When this component completes execution, the flow execution returns control to the last loop initiator component executed prior to this End component.

Transaction

Commit	Do nothing
Rollback	Do nothing

Exceptions

Type	Parameter	Stream for error handling flow	Error Code	Description
Exception	None	This component's input stream	-	ReturnStream=PackRecords and the multiple input stream's field formats are different.

After handing of exception

After an exception flow ends with this component, returns to a flow which has called an exception flow. After that, it behaves according to ReturnType. An exception flow ends with another end component except for this, an exception flow and a request ends immediately.

When ReturnType is set to "ExceptionComponent"

Returns to a component which has called this exception flow, then, the next component is processed. The next component is processed as well as the case where the error doesn't occur by the previous component.
An output stream of a component, which is the one returned by an exception flow, should be a stream of the same type as the case for the component to be executed normally. For instance, when the error occurs by the FileGet component whose it is the main flow and output stream is CSV, the preparation for the CSV data of taking the place etc. is required to return an output stream of an exception flow.

Return value of exception flow

A return value of an exception flow, which is a value of ReturnValue, is set as a value of invisible ErrorMessage property. ErrorMessage can be referred only from Mapper component or BranchByException component. It can be used for directing a flow according to whether error has occurred or not. For example, if you put a BranchByException component next to a FileGet component, it's possible to direct a flow by evaluating error message of FileGet.

When ReturnType is set to "EndOfParent"

Ends a flow which includes a components where error occurred in.
When a caller flow is a main flow, a flow ends because a flow's end means a request's end.
When a caller flow is a sub-flow, processing is continued assuming that the sub-flow ends by the component where the error occurs. Exception flow should return the same type of output stream as that when the component is normally processed.す出力ストリームは、そのサブフローが正常に実行された場合と同じ型のストリームでなければなりません。

Return value of exception flow

When a flow which has called this exception flow is a sub-flow, a return value as an exception flow, which is a value of ReturnValue, can be referred as a return value property of SubFlow component.

Output fomat

By ReturnStream, specifies a format of output stream when the flow is looped. By this property, output streamm can be packed as one stream, or can be put in a stream container.

Only when all input stream, that are also output stream into this component, should have the same type and the same fields. Different streams by branching flow cannot be packed.

If there is no loop section and input stream is only one, the last stream becomes output stream. In the case of MIME, each part itself, not multipart, is output. In the case of XML, no error occurs when it has no field definitions.

Packing stream

When "Pack streams" is specified, input streams are packed according to the stream type.

Binary, Text	Streams are concatenated.
Record, CSV, FixedLength	All records in the streams are joined in one output stream.
ParameterList	The value of last stream is set except for String[] type. The values of String[] type field are joined.
XML	XML is re-constructed according to field definition. If field definition is not defined, error occurs.
MIME	Multipart MIME is generated.

Stream container

"Stream container" is used in the case to attach the multiple streams to a single mail.