IBM App Connect Enterprise, Version 11.0.0.2 Operating Systems: Windows, Linux


Aggregation policy

Attach an Aggregation policy to one or more Aggregation nodes in a message flow to control timeout values or event storage at run time.

You use aggregation nodes in a message flow to control the fan-out of related requests from one input message, and the aggregation of corresponding replies to one reply message. You can use an Aggregation policy to control, at run time, the storage queues that are generated for the aggregation nodes to use, and how timed-out aggregation messages are processed.

To attach an Aggregation policy to an Aggregation node, set the Aggregation name property of the AggregateControl or AggregateReply node to the name of the policy in the format {policyProjectName}:policyName. You must deploy this policy before the associated message flow is started.

The properties of this policy are described in the following table.
Table 1. Properties of the Aggregation policy
Property Property name in .policyxml file Value
Queue prefix queuePrefix This property contains the queue prefix that specifies the storage queues that are generated for use by the aggregation nodes. This property is optional, but if you set it, you must specify the following five queues:
  • SYSTEM.BROKER.AGGR.QueuePrefix.CONTROL
  • SYSTEM.BROKER.AGGR.QueuePrefix.REPLY
  • SYSTEM.BROKER.AGGR.QueuePrefix.REQUEST
  • SYSTEM.BROKER.AGGR.QueuePrefix.UNKNOWN
  • SYSTEM.BROKER.AGGR.QueuePrefix.TIMEOUT

The prefix can contain any characters that are valid in a WebSphere® MQ queue name, but must be no longer than eight characters and must not begin or end with a period (.). For example, SET.1 is valid, but .SET1 and SET1. are invalid. Multiple Aggregation policy instances can use the same queue prefix.

If no queue prefix is specified, the aggregation nodes use the following default queues that are generated when the integration server is created:
  • SYSTEM.BROKER.AGGR.CONTROL
  • SYSTEM.BROKER.AGGR.REPLY
  • SYSTEM.BROKER.AGGR.REQUEST
  • SYSTEM.BROKER.AGGR.UNKNOWN
  • SYSTEM.BROKER.AGGR.TIMEOUT

Value type: String

Timeout (seconds) timeoutInterval This mandatory property defines the value that is used by the AggregateControl node to set the expiry time (in seconds) of an aggregation. The value can be any positive integer.

This property is optional; if it is not set, the value that is set on the node is used.

The value of this property overrides the value that is set on the node, but this property can be overridden by a value in the local environment.

Value type: Integer

Number of timeout threads timeoutThreads This property specifies the number of threads that are used by the AggregateReply node to process expired messages. The value can be any positive integer.

This property has a default value of one, which means that a single thread is used to process expired messages. When you set this property, you must also set a unique Queue prefix property in this policy, and this Aggregation policy must be used only in a single integration server.

Value type: Integer


py00108_.htm | Last updated 2018-11-02 14:46:46