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.
| Name | Default Value | Allowable Values | Description |
| Number of Relationships | 1 | Determines the number of Relationships to which the load should be distributed | |
| Distribution Strategy | round robin | * round robin</br> * next available</br> * load distribution service</br> | 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.
| Name | Value | Description |
| 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:
| Name | Description |
| 1 | Where to route flowfiles for this relationship index |
Dynamic Relationships:
A Dynamic Relationship may be created based on how the user configures the Processor.
| Name | Description |
| A number 1..<Number Of Relationships> | FlowFiles are sent to this relationship per the <Distribution Strategy> |
Reads Attributes:
None specified.
Writes Attributes:
None specified.