Aggregate Mediator

The Aggregate mediator implements the Message Aggregator enterprise integration pattern and aggregates the response messages for messages that were split by the Clone or Iterate mediator and sent using the Send mediator. At the same time, it can aggregate messages in the presence of matching elements specified by the correlateOn XPath expression. The Aggregate mediator collects the incoming messages until the completion condition is satisfied. The completion condition can specify a minimum or maximum number of messages to be collected, or a timeout value in seconds, after which the aggregation terminates. Note that when the Iterate mediator is used to split the requests and produces only an n number of fragmented messages, the Aggregate mediator will terminate as soon as it receives n responses, even if you have specified a higher minimum limit.

On completion of the aggregation, the Aggregate mediator will merge all collected messages and invoke the onComplete sequence on it. The merged message will be created using the XPath expression specified by the attribute expression on the onCompleteelement. Note that the responses will not necessarily be aggregated in the same order that the requests were sent, even if you set the sequential attribute to true on the Iterate mediator.

Syntax

<aggregate>
   <correlateOn expression="xpath"/>?
   <completeCondition [timeout="time-in-seconds"]>
     <messageCount min="int-min" max="int-max"/>?
   </completeCondition>?
   <onComplete expression="xpath" [sequence="sequence-ref"]>
     (mediator +)?
   </onComplete>
</aggregate>

UI Configuration

The Aggregate Mediator field descriptions:

Aggregate ID - This optional attribute can be used to aggregate only responses for split messages that are created by a specific clone/iterate mediator. Aggregate ID should be the same as the ID of the corresponding clone/iterate mediator that creates split messages. This is particularly useful when aggregating responses for messages that are created using nested clone/iterate mediators.
Aggregation Expression - An XPath expression specifying which elements to aggregate. A set of messages that is taken for aggregation is determined through Correlation Expression.
Completion Timeout - Time that the aggregator waits for messages.
Completion Max-messages - Maximum number of messages that can exist in an aggregation.
Completion Min-messages - Minimum number of messages required for the aggregation to complete.
Correlation Expression - An XPath expression specifying the pattern messages collected for aggregation. A specific aggregation condition is set through the Aggregation Expression.

Tip

You can click the "NameSpaces" link to add namespaces if you are providing an expression. You will be provided another panel named "Namespace Editor", where you can provide any number of namespace prefixes and URLs used in the XPath expression.

On Complete - The sequence to run when the aggregation is complete. You can specify the sequence as follows:
- Anonymous - Select this option when you will define the On Complete sequence by adding child mediators to the Aggregate mediator instead of calling an existing sequence. For example, if you just want to call the Send mediator when the aggregation is complete, you can select Anonymous and add the Send mediator as a child mediator.
- Pick From Registry - Select this option when you want to use an existing defined sequence. You can select the sequence from the Configuration Registry or Governance Registry. For more information, see Working with the Registry.

Note

You can configure the Mediator using XML. Click on "switch to source view" in the "Mediator" window.

Example

<outSequence>
    <aggregate>
        <onComplete expression="//m0:getQuoteResponse"
                xmlns:m0="http://services.samples">
            <send/>
        </onComplete>
    </aggregate>
</outSequence>

In this example, the mediator aggregates the responses coming into the ESB, and on completion it sends the aggregated message through the Send mediator.

For more examples, see: