This site contains the documentation that is relevant to older WSO2 product versions and offerings.
For the latest WSO2 documentation, visit https://wso2.com/documentation/.

Aggregate Mediator

Owned by Former user (Deleted)
Last updated: Apr 10, 2013 by Former user (Deleted)Version comment
3 min read

The Aggregate Mediator implements the Message Aggregator EIP and aggregates the response messages for messages spited using either the clone or iterate mediators and sent using send mediator. At the same time, it can aggregate messages in the presence of matching elements specified by the correlateOn XPATH expression. Aggregate collects the messages coming into it until the messages collected on the aggregation satisfy the completion condition. 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.

On completion of the aggregation, it 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 onComplete element.

Note

When the Iterate Mediator is used to split the requests and it 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.

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:
    • Anonymous
    • Pick From Registry - The Path can be chosen from Configuration Registry or Governance Registry. Refer to more information abut the Registry Browser in Namespace.

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 in to the ESB and on completion, it sends the aggregated message through the Send Mediator.

For more examples, see:

Â