CallableFlowAsyncResponse node
Use the CallableFlowAsyncResponse node in conjunction with a paired CallableFlowAsyncInvoke node to split message flow processing asynchronously. The CallableFlowAsyncResponse node receives data input from the CallableReply node of a called message flow that was invoked by a CallableFlowAsyncInvoke node. The CallableFlowAsyncResponse node is paired with a CallableFlowAsyncInvoke node through the unique identifier value that is set on the CallableFlowAsyncInvoke node.
- Developer
- Application Integration Suite
- Standard
- Advanced
- Express
- Scale
- Adapter
Purpose
You can split message flows asynchronously so that you do processing in different locations by using the CallableFlowAsyncInvoke and CallableFlowAsyncResponse nodes. For information about splitting message flows synchronously, see CallableFlowInvoke node.
You can split your processing between different locations in IBM® Integration Bus, or between IBM Integration Bus and IBM App Connect on IBM Cloud. You can split flows between different applications in an integration server or between different integration servers, which can be on different integration nodes. A calling flow processes information in one location, then calls another flow in a different location. A separate response flow is also running in the same location as the calling flow. The response from the callable flow is received by a CallableFlowAsyncResponse node.
When the callable flow invoked by a CallableFlowAsyncInvoke node has completed processing, the CallableReply node sends the information back to the to the paired CallableFlowAsyncResponse node in a separate response flow that is in the same location as the calling flow that contains the CallableFlowAsyncInvoke node.
You can share data between the flow that contains the CallableFlowAsyncInvoke node and the flow that contains the CallableFlowAsyncResponse node, by storing and retrieving data in the UserContext folder in the Environment. For more information, see Sharing data between a calling flow and a response flow.
Terminals and properties
When you have put an instance of the CallableFlowAsyncResponse node into a message flow, you can configure it; see Configuring a message flow node. The properties of the node are displayed in the Properties view. All mandatory properties for which you must enter a value (those that do not have a default value defined) are marked with an asterisk.
| Terminal | Description |
|---|---|
| Failure | The output terminal to which the message is routed if a failure is detected during processing. |
| Out | The output terminal, if connected, will have the input message propagated when the input message data has been sent to the callable flow. |
| Catch | The output terminal to which the message is routed if an exception is thrown downstream and caught by this node. |
The following tables describe the node properties. The column headed M indicates whether the property is mandatory (marked with an asterisk if you must enter a value when no default is defined); the column headed C indicates whether the property is configurable (you can change the value when you add the message flow to the BAR file to deploy it).
| Property | M | C | Default | Description |
|---|---|---|---|---|
| Node name | No | No | The node type (CallableFlowAsyncResponse) | The name of the node. |
| Short Description | No | No | A brief description of the node. | |
| Long Description | No | No | Text that describes the purpose of the node in the message flow. |
| Property | M | C | Default | Description | mqsiapplybaroverride command property |
|---|---|---|---|---|---|
| Unique identifier | Yes | Yes | The unique identifier value is used to pair this node with a CallableFlowAsyncInvoke node, from which the called flow’s CallableInput node received a message. | asyncResponseCorrelator |
| Property | M | C | Default | Description |
|---|---|---|---|---|
| Events | No | No | None | Events that you have defined for the node are
displayed on this tab. By default, no monitoring events are defined
on any node in a message flow. Use Add, Edit,
and Delete to create, change or delete monitoring
events for the node; see Configuring monitoring event sources by using monitoring properties for details. You can enable and disable events that are shown here by selecting or clearing the Enabled check box. |
Sharing user context data
You can share data between the flow that contains the CallableFlowAsyncInvoke node and the flow that contains the CallableFlowAsyncResponse node, by storing and retrieving data in the UserContext folder in the Environment. For more information, see Sharing data between a calling flow and a response flow.