This topic describes the AggregateRequest node.
This topic contains the following sections:
Use the AggregateRequest node to record the fact that request messages have been sent. This node also collects information that helps the AggregateReply node to construct the compound response message.
Aggregation is an extension of the request/reply application model. It combines the generation and fan-out of a number of related requests with the fan-in of the corresponding replies, and compiles those replies into a single aggregated reply message.
The AggregateRequest node is contained in the Routing drawer of the palette, and is represented in the workbench by the following icon:
When you have put an instance of the AggregateRequest 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.
Configure the AggregateRequest node as follows:
The AggregateRequest node terminals are described in the following table.
Terminal | Description |
---|---|
In | The input terminal that accepts messages sent as part of an aggregate request. |
Out | The output terminal to which the input message is routed when processing completes successfully. |
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).
The AggregateRequest node Description properties are described in the following table.
Property | M | C | Default | Description |
---|---|---|---|---|
Node name | No | No | The node type | 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. |
The AggregateRequest node Basic property is described in the following table.
Property | M | C | Default | Description |
---|---|---|---|---|
Folder Name | Yes | No | The name that is used as a folder in the AggregateReply node's compound message. This property is mandatory. |