| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>DistributeLoad</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">DistributeLoad</h1><h2>Description: </h2><p>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.</p><h3>Tags: </h3><p>distribute, load balance, route, round robin, weighted</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values.</p><table id="properties"><tr><th>Display Name</th><th>API Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Number of Relationships</strong></td><td>Number of Relationships</td><td id="default-value">1</td><td id="allowable-values"></td><td id="description">Determines the number of Relationships to which the load should be distributed</td></tr><tr><td id="name"><strong>Distribution Strategy</strong></td><td>Distribution Strategy</td><td id="default-value">round robin</td><td id="allowable-values"><ul><li>round robin <img src="../../../../../html/images/iconInfo.png" alt="Relationship selection is evenly distributed in a round robin fashion; all relationships must be available." title="Relationship selection is evenly distributed in a round robin fashion; all relationships must be available."></img></li><li>next available <img src="../../../../../html/images/iconInfo.png" alt="Relationship selection is distributed across all available relationships in order of their weight; at least one relationship must be available." title="Relationship selection is distributed across all available relationships in order of their weight; at least one relationship must be available."></img></li><li>load distribution service <img src="../../../../../html/images/iconInfo.png" alt="Relationship selection is distributed by supplied LoadDistributionService Controller Service; at least one relationship must be available." title="Relationship selection is distributed by supplied LoadDistributionService Controller Service; at least one relationship must be available."></img></li><li>overflow <img src="../../../../../html/images/iconInfo.png" alt="Relationship selection is the first available relationship without further distribution among all relationships; at least one relationship must be available." title="Relationship selection is the first available relationship without further distribution among all relationships; at least one relationship must be available."></img></li></ul></td><td id="description">Determines how the load will be distributed. Relationship weight is in numeric order where '1' has the greatest weight.</td></tr></table><h3>Dynamic Properties: </h3><p>Supports Sensitive Dynamic Properties: <strong>No</strong></p><p>Dynamic Properties allow the user to specify both the name and value of a property.<table id="dynamic-properties"><tr><th>Name</th><th>Value</th><th>Description</th></tr><tr><td id="name">The relationship name (positive number)</td><td id="value">The relationship Weight (positive number)</td><td>Adding a property with the name '5' and value '10' means that the relationship with name '5' will receive 10 FlowFiles in each iteration instead of 1.<br/><strong>Supports Expression Language: false</strong></td></tr></table></p><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>1</td><td>Where to route flowfiles for this relationship index</td></tr></table><h3>Dynamic Relationships: </h3><p>A Dynamic Relationship may be created based on how the user configures the Processor.<table id="dynamic-relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>A number 1..<Number Of Relationships></td><td>FlowFiles are sent to this relationship per the <Distribution Strategy></td></tr></table></p><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>distribute.load.relationship</td><td>The name of the specific relationship the FlowFile has been routed through</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.<h3>System Resource Considerations:</h3>None specified.</body></html> |