Setting the maximum rate for a message flow

Allows system administrators to restrict the maximum rate at which a message flow can run at by setting the maximum rate property.

About this task

The system administrator is able to restrict the rate that an individual message flow can run at by setting the maximum rate property. The maximum rate is specified as the total number of input messages processed every second by all the threads that are running in the message flow.

To calculate the number of threads within a specific message flow:

Count the number of input nodes within the flow.
Add on the number of additional instances that are specified for each input node.

There are two ways the maximum rate can be set for a message flow:

Directly within a BAR file.
As one of the attributes within a workload management policy that is defined within Integration Registry.

BAR file

The maximum rate is set within the BAR file under a property called maximumRateMsgsPerSec.

The property can be set in the following ways:

Within the BAR file through the IBM® Integration Toolkit editor.
Note: You must refresh the content of a migrated BAR file before you can see and configure the maximumRateMsgsPerSec property. For more information, see Refreshing the contents of a BAR file.
Within the BAR file through the mqsiapplybaroverride command line.
Note: For example, to set the maximumRateMsgsPerSec property for a message flow included in an application, you can use the following sample code:
```
mqsiapplybaroverride -b BARfile -k applicationName -m sampleFlow#maximumRateMsgsPerSec=100 
```
For more information, see mqsiapplybaroverride command.

Additionally, once the BAR file is deployed, the property can be set dynamically within the flow through the IBM Integration API. Any change to the property is picked up immediately and does not require the flow to be restarted.

Workload management policy

Create and configure a workload management policy. For more information about workload management, see Workload management.

A maximum rate value of zero, or not set, causes the message flow maximum rate to be turned off. The default state is off.

Within the same integration server, a mixture of message flows can run along side each other, some with the maximum rate set, others with the maximum rate turned off.