Collector policy

Attach a Collector policy to one or more Collector nodes in a message flow to control how events are stored at run time.

You use the Collector node in a message flow to create message collections based on rules that you define. You can use a Collector policy to control, at run time, the storage queues that the Collector node uses, and for how long a collection is retained.

To attach a Collector policy to a Collector node, set the Policy property of the Collector node to the name of the policy in the format {policyProjectName}:policyName. You must deploy this policy before the associated message flow is started.

If you redeploy a Collector policy, all message flows that are using the policy will be stopped and restarted.

The properties of this policy are described in the following table.
Table 1. Properties of the Collector policy
Property Property name in .policyxml file Value
Queue prefix queuePrefix This property specifies the queue prefix that identifies the storage queues that are generated for use by the Collector node. This property is optional, but if you set it, you must define the following queues:
  • SYSTEM.BROKER.EDA.QueuePrefix.EVENTS
  • SYSTEM.BROKER.EDA.QueuePrefix.COLLECTIONS

The prefix can contain any characters that are valid in an IBM® 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 policies can use the same queue prefix.

If no queue prefix is specified, the Collector node uses the following default queues that are generated when the integration server is created:
  • SYSTEM.BROKER.EDA.EVENTS
  • SYSTEM.BROKER.EDA.COLLECTIONS
These default queues are also used by the Resequence node.

Value type: String
Collection expiry (seconds) collectionExpiry This mandatory property specifies the value that is used by the Collector node to set the expiry time (in seconds) of a collection. The value can be any positive integer. This property has a default value of zero, which indicates that the collection does not expire.

Value type: Integer