DistributeLoad

Description:

Distributes FlowFiles to downstream processors based on a Distribution Strategy. If using the Round Robin strategy, the default is to assign each destination a weighting of 1 (evenly distributed). However, optional propertiescan be added to the change this; adding a property with the name '5' and value '10' means that the relationship with name '5' will be receive 10 FlowFiles in each iteration instead of 1.

Tags:

distribute, load balance, route, round robin, weighted

Properties:

In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values.

NameDefault ValueAllowable ValuesDescription
Number of Relationships1Determines the number of Relationships to which the load should be distributed
Distribution Strategyround robin
  • round robin
  • next available
  • load distribution service
Determines how the load will be distributed. If using Round Robin, will not distribute any FlowFiles unless all destinations can accept FlowFiles; when using Next Available, will distribute FlowFiles as long as at least 1 destination can accept FlowFiles.

Dynamic Properties:

Dynamic Properties allow the user to specify both the name and value of a property.

NameValueDescription
The relationship name(positive number)The relationship Weight(positive number)adding a property with the name '5' and value '10' means that the relationship with name '5' will be receive 10 FlowFiles in each iteration instead of 1.

Relationships:

NameDescription
1Where to route flowfiles for this relationship index

Dynamic Relationships:

A Dynamic Relationship may be created based on how the user configures the Processor.

NameDescription
A number 1..<Number Of Relationships>FlowFiles are sent to this relationship per the <Distribution Strategy>

Reads Attributes:

None specified.

Writes Attributes:

None specified.

State management:

This component does not store state.

Restricted:

This component is not restricted.

Input requirement:

This component requires an incoming relationship.