The BranchByException component directs the flow along a single branch according to the preceding component's Exception.
Branching is performed according to one of three possible exception evaluation operations: branch according to an Exception's string value, branch according to an Exception's error code, or branch according to an Exception's type.
If the branch evaluation is successful, the stream is directed to the right. If the branch evaluation is not successful, the stream is directed to the bottom.
| Input | Format | All |
|---|---|---|
| Number of Inputs | 1 | |
| Description | Accepts all Stream types. | |
| Output | Format | All |
| Description |
The input stream is copied to the output stream. |
| Name | Data Type | Mapping | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| BranchBy | choice | - |
Specifies the evaluation operation to be performed. The property used for branching evaluation is different for each value selected here.
|
|||||||||
| CaseSensitive | choice | - |
Used for branching evaluation if BranchBy is set to ByString. Specifies whether the MessagePattern regular expression distinguishes case differences. |
|||||||||
| MessagePattern | string | In & Out |
Used for branching evaluation if BranchBy is set to ByString. When the preceding component has several exception properties, specify the exception here. For details of error information, please refer to following topic "Error Information". |
|||||||||
| ExceptionType | propertyName | - |
Used for branching evaluation if BranchBy is set to ByType. When the preceding component has several exception properties, specify the exception here. |
|||||||||
| ExceptionCode | string | - |
Used for branching evaluation if BranchBy is set to ByCode. Specifies the Exception error code. |
| Commit | Do nothing |
|---|---|
| Rollback | Do nothing |
This component never causes any exceptions.
Normally, this component evaluates the component property of the component immediately preceding this component. However, if the component immediately preceding this component is a BranchByComponentProperty component or a BranchByException component, then the component preceding that component is evaluated. Furthermore, if there are several branching components preceding this component, this component evaluates the component immediately preceding the first branching component in the chain.
Error information varies by component's error handling.
If Exception property is set to "Ignore", error message is set to invisible ErrorMessage property. This error message is used for this component as error information.
If Exception flow handles exception, return value of Exeption flow is used for this component as error information.