Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ControlRate/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ControlRate/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ControlRate/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ControlRate/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ControlRate</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Controls the rate at which data is transferred to follow-on processors. If you configure a very small Time Duration, then the accuracy of the throttle gets worse. You can improve this accuracy by decreasing the Yield Duration, at the expense of more Tasks given to the processor.</p><h3>Tags: </h3><p>rate control, throttle, rate, throughput</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>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Rate Control Criteria</strong></td><td id="default-value">data rate</td><td id="allo wable-values"><ul><li>data rate <img src="../../html/images/iconInfo.png" alt="Rate is controlled by counting bytes transferred per time duration." title="Rate is controlled by counting bytes transferred per time duration."></img></li><li>flowfile count <img src="../../html/images/iconInfo.png" alt="Rate is controlled by counting flowfiles transferred per time duration" title="Rate is controlled by counting flowfiles transferred per time duration"></img></li><li>attribute value <img src="../../html/images/iconInfo.png" alt="Rate is controlled by accumulating the value of a specified attribute that is transferred per time duration" title="Rate is controlled by accumulating the value of a specified attribute that is transferred per time duration"></img></li></ul></td><td id="description">Indicates the criteria that is used to control the throughput rate. Changing this value resets the rate counters.</td></tr><tr><td id="name"><strong>Maximum Rate</strong></td><td id="default-value"></ td><td id="allowable-values"></td><td id="description">The maximum rate at which data should pass through this processor. The format of this property is expected to be a positive integer, or a Data Size (such as '1 MB') if Rate Control Criteria is set to 'data rate'.</td></tr><tr><td id="name">Rate Controlled Attribute</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of an attribute whose values build toward the rate limit if Rate Control Criteria is set to 'attribute value'. The value of the attribute referenced by this property must be a positive long, or the FlowFile will be routed to failure. This value is ignored if Rate Control Criteria is not set to 'attribute value'. Changing this value resets the rate counters.</td></tr><tr><td id="name"><strong>Time Duration</strong></td><td id="default-value">1 min</td><td id="allowable-values"></td><td id="description">The amount of time to which the Maximum Rate pertains. Changing this value r esets the rate counters.</td></tr><tr><td id="name">Grouping Attribute</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">By default, a single "throttle" is used for all FlowFiles. If this value is specified, a separate throttle is used for each value specified by the attribute with this name. Changing this value resets the rate counters.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>FlowFiles are transferred to this relationship under normal conditions</td></tr><tr><td>failure</td><td>FlowFiles will be routed to this relationship if they are missing a necessary Rate Controlled Attribute or the attribute is not in the expected format</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.</body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ControlRate</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Controls the rate at which data is transferred to follow-on processors. If you configure a very small Time Duration, then the accuracy of the throttle gets worse. You can improve this accuracy by decreasing the Yield Duration, at the expense of more Tasks given to the processor.</p><h3>Tags: </h3><p>rate control, throttle, rate, throughput</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>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Rate Control Criteria</strong></td><td id="default-value">data rate</td><td id="allo wable-values"><ul><li>data rate <img src="../../html/images/iconInfo.png" alt="Rate is controlled by counting bytes transferred per time duration." title="Rate is controlled by counting bytes transferred per time duration."></img></li><li>flowfile count <img src="../../html/images/iconInfo.png" alt="Rate is controlled by counting flowfiles transferred per time duration" title="Rate is controlled by counting flowfiles transferred per time duration"></img></li><li>attribute value <img src="../../html/images/iconInfo.png" alt="Rate is controlled by accumulating the value of a specified attribute that is transferred per time duration" title="Rate is controlled by accumulating the value of a specified attribute that is transferred per time duration"></img></li></ul></td><td id="description">Indicates the criteria that is used to control the throughput rate. Changing this value resets the rate counters.</td></tr><tr><td id="name"><strong>Maximum Rate</strong></td><td id="default-value"></ td><td id="allowable-values"></td><td id="description">The maximum rate at which data should pass through this processor. The format of this property is expected to be a positive integer, or a Data Size (such as '1 MB') if Rate Control Criteria is set to 'data rate'.</td></tr><tr><td id="name">Rate Controlled Attribute</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of an attribute whose values build toward the rate limit if Rate Control Criteria is set to 'attribute value'. The value of the attribute referenced by this property must be a positive long, or the FlowFile will be routed to failure. This value is ignored if Rate Control Criteria is not set to 'attribute value'. Changing this value resets the rate counters.</td></tr><tr><td id="name"><strong>Time Duration</strong></td><td id="default-value">1 min</td><td id="allowable-values"></td><td id="description">The amount of time to which the Maximum Rate pertains. Changing this value r esets the rate counters.</td></tr><tr><td id="name">Grouping Attribute</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">By default, a single "throttle" is used for all FlowFiles. If this value is specified, a separate throttle is used for each value specified by the attribute with this name. Changing this value resets the rate counters.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>FlowFiles are transferred to this relationship under normal conditions</td></tr><tr><td>failure</td><td>FlowFiles will be routed to this relationship if they are missing a necessary Rate Controlled Attribute or the attribute is not in the expected format</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>State management: </h3>This processor has no state management.<h3>Restricted: </h3></body></html> \ No newline at end of file
Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ConvertCharacterSet/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ConvertCharacterSet/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ConvertCharacterSet/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ConvertCharacterSet/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ConvertCharacterSet</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Converts a FlowFile's content from one character set to another</p><h3>Tags: </h3><p>text, convert, characterset, character set</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, and whether a property supports the <a href="../../html/expression-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Input Character Set</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the CharacterSet to expect for Input<br/><stron g>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Output Character Set</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the CharacterSet to convert to<br/><strong>Supports Expression Language: true</strong></td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td></td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.</body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ConvertCharacterSet</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Converts a FlowFile's content from one character set to another</p><h3>Tags: </h3><p>text, convert, characterset, character set</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, and whether a property supports the <a href="../../html/expression-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Input Character Set</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the CharacterSet to expect for Input<br/><stron g>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Output Character Set</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the CharacterSet to convert to<br/><strong>Supports Expression Language: true</strong></td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td></td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>State management: </h3>This processor has no state management.<h3>Restricted: </h3></body></html> \ No newline at end of file Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ConvertJSONToSQL/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ConvertJSONToSQL/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ConvertJSONToSQL/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ConvertJSONToSQL/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ConvertJSONToSQL</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Converts a JSON-formatted FlowFile into an UPDATE or INSERT SQL statement. The incoming FlowFile is expected to be "flat" JSON message, meaning that it consists of a single JSON element and each field maps to a simple type. If a field maps to a JSON object, that JSON object will be interpreted as Text. If the input is an array of JSON elements, each element in the array is output as a separate FlowFile to the 'sql' relationship. Upon successful conversion, the original FlowFile is routed to the 'original' relationship and the SQL is routed to the 'sql' relationship.</p><h3>Tags: </h3><p>json, sql, database, rdbms, insert, update, relational, flat</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other pr operties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the <a href="../../html/expression-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>JDBC Connection Pool</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>DBCPService<br/><strong>Implementations: </strong><br/><a href="../org.apache.nifi.dbcp.DBCPConnectionPool/index.html">DBCPConnectionPool</a><br/><a href="../org.apache.nifi.dbcp.hive.HiveConnectionPool/index.html">HiveConnectionPool</a></td><td id="description">Specifies the JDBC Connection Pool to use in order to convert the JSON message to a SQL statement. The Connection Pool is necessary in order to determine the appropriate database column types.</td></tr><tr><td id="name"><strong>Statement Type</stro ng></td><td id="default-value"></td><td id="allowable-values"><ul><li>UPDATE</li><li>INSERT</li></ul></td><td id="description">Specifies the type of SQL Statement to generate</td></tr><tr><td id="name"><strong>Table Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the table that the statement should update<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Catalog Name</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the catalog that the statement should update. This may not apply for the database that you are updating. In this case, leave the field empty<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Schema Name</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the schema that the table belongs to. This may not apply for the database that you are updating. In this case, leave the field empty<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Translate Field Names</td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">If true, the Processor will attempt to translate JSON field names into the appropriate column names for the table specified. If false, the JSON field names must match the column names exactly, or the column will not be updated</td></tr><tr><td id="name">Unmatched Field Behavior</td><td id="default-value">Ignore Unmatched Fields</td><td id="allowable-values"><ul><li>Ignore Unmatched Fields <img src="../../html/images/iconInfo.png" alt="Any field in the JSON document that cannot be mapped to a column in the database is ignored" title="Any field in the JSON document that cannot be mapped to a column in the database is ignored"></img></li><li>Fail <img src="../../html/images/iconInfo.png" alt="If the JSON document has any field that cannot be mapped to a column in the database, the FlowFile will be routed to the failure relationship" title="If the JSON document has any field that cannot be mapped to a column in the database, the FlowFile will be routed to the failure relationship"></img></li></ul></td><td id="description">If an incoming JSON element has a field that does not map to any of the database table's columns, this property specifies how to handle the situation</td></tr><tr><td id="name">Unmatched Column Behavior</td><td id="default-value">Fail on Unmatched Columns</td><td id="allowable-values"><ul><li>Ignore Unmatched Columns <img src="../../html/images/iconInfo.png" alt="Any column in the database that does not have a field in the JSON document will be assumed to not be required. No notification will be logged" title="Any column in the database that does not have a field in the JSON document will be assumed to not be required. No notification will be logged"></img></li><li>Warn on Unmatched Columns <img src="../../html/images/iconInfo.png" alt="Any column in the database that does not have a field in the JSON document will be assumed to not be required. A warning will be logged" title="Any column in the database that does not have a field in the JSON document will be assumed to not be required. A warning will be logged"></img></li><li>Fail on Unmatched Columns <img src="../../html/images/iconInfo.png" alt="A flow will fail if any column in the database that does not have a field in the JSON document. An error will be logged" title="A flow will fail if any column in the database that does not have a field in the JSON document. An error will be logged"></img></li></ul></td><td id="description">If an incoming JSON element does not have a field mapping for all of the database table's columns, this property specifies how to handle the situation</td></tr><tr><td id="name">Update Keys</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A comma-sepa rated list of column names that uniquely identifies a row in the database for UPDATE statements. If the Statement Type is UPDATE and this property is not set, the table's Primary Keys are used. In this case, if no Primary Key exists, the conversion to SQL will fail if Unmatched Column Behaviour is set to FAIL. This property is ignored if the Statement Type is INSERT<br/><strong>Supports Expression Language: true</strong></td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>sql</td><td>A FlowFile is routed to this relationship when its contents have successfully been converted into a SQL statement</td></tr><tr><td>failure</td><td>A FlowFile is routed to this relationship if it cannot be converted into a SQL statement. Common causes include invalid JSON content or the JSON content missing a required field (if using an INSERT statement type).</td></tr><tr><td>original</td><td>When a FlowFile is converted to SQL, the origin al JSON FlowFile is routed to this relationship</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>mime.type</td><td>Sets mime.type of FlowFile that is routed to 'sql' to 'text/plain'.</td></tr><tr><td>sql.table</td><td>Sets the sql.table attribute of FlowFile that is routed to 'sql' to the name of the table that is updated by the SQL statement.</td></tr><tr><td>sql.catalog</td><td>If the Catalog name is set for this database, specifies the name of the catalog that the SQL statement will update. If no catalog is used, this attribute will not be added.</td></tr><tr><td>fragment.identifier</td><td>All FlowFiles routed to the 'sql' relationship for the same incoming FlowFile (multiple will be output for the same incoming FlowFile if the incoming FlowFile is a JSON Array) will have the same value for the fragment.identifier attribute. This can then be used to correlate the results.</td></tr><tr><td>fragment.count</td><td>The number of SQL FlowFiles that were produced for same incoming FlowFile. This can be used in conjunction with the fragment.identifier attribute in order to know how many FlowFiles belonged to the same incoming FlowFile.</td></tr><tr><td>fragment.index</td><td>The position of this FlowFile in the list of outgoing FlowFiles that were all derived from the same incoming FlowFile. This can be used in conjunction with the fragment.identifier and fragment.count attributes to know which FlowFiles originated from the same incoming FlowFile and in what order the SQL FlowFiles were produced</td></tr><tr><td>sql.args.N.type</td><td>The output SQL statements are parameterized in order to avoid SQL Injection Attacks. The types of the Parameters to use are stored in attributes named sql.args.1.type, sql.args.2.type, sql.args.3.type, and so on. The type is a number representing a JDBC Type constant. Generally, this is useful only for software to r ead and interpret but is added so that a processor such as PutSQL can understand how to interpret the values.</td></tr><tr><td>sql.args.N.value</td><td>The output SQL statements are parameterized in order to avoid SQL Injection Attacks. The values of the Parameters to use are stored in the attributes named sql.args.1.value, sql.args.2.value, sql.args.3.value, and so on. Each of these attributes has a corresponding sql.args.N.type attribute that indicates how the value should be interpreted when inserting it into the database.</td></tr></table><h3>See Also:</h3><p><a href="../org.apache.nifi.processors.standard.PutSQL/index.html">PutSQL</a></p></body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ConvertJSONToSQL</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Converts a JSON-formatted FlowFile into an UPDATE or INSERT SQL statement. The incoming FlowFile is expected to be "flat" JSON message, meaning that it consists of a single JSON element and each field maps to a simple type. If a field maps to a JSON object, that JSON object will be interpreted as Text. If the input is an array of JSON elements, each element in the array is output as a separate FlowFile to the 'sql' relationship. Upon successful conversion, the original FlowFile is routed to the 'original' relationship and the SQL is routed to the 'sql' relationship.</p><h3>Tags: </h3><p>json, sql, database, rdbms, insert, update, relational, flat</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other pr operties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the <a href="../../html/expression-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>JDBC Connection Pool</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>DBCPService<br/><strong>Implementation:</strong><br/><a href="../org.apache.nifi.dbcp.DBCPConnectionPool/index.html">DBCPConnectionPool</a></td><td id="description">Specifies the JDBC Connection Pool to use in order to convert the JSON message to a SQL statement. The Connection Pool is necessary in order to determine the appropriate database column types.</td></tr><tr><td id="name"><strong>Statement Type</strong></td><td id="default-value"></td><td id="allowable-values"><ul><li>UPDATE</li><li>INSERT</li></ ul></td><td id="description">Specifies the type of SQL Statement to generate</td></tr><tr><td id="name"><strong>Table Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the table that the statement should update<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Catalog Name</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the catalog that the statement should update. This may not apply for the database that you are updating. In this case, leave the field empty<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Schema Name</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the schema that the table belongs to. This may not apply for the database that you are updating. In this case, leave the field empty<br/><strong>Supports Expression Language: true</strong></td></tr><tr> <td id="name">Translate Field Names</td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">If true, the Processor will attempt to translate JSON field names into the appropriate column names for the table specified. If false, the JSON field names must match the column names exactly, or the column will not be updated</td></tr><tr><td id="name">Unmatched Field Behavior</td><td id="default-value">Ignore Unmatched Fields</td><td id="allowable-values"><ul><li>Ignore Unmatched Fields <img src="../../html/images/iconInfo.png" alt="Any field in the JSON document that cannot be mapped to a column in the database is ignored" title="Any field in the JSON document that cannot be mapped to a column in the database is ignored"></img></li><li>Fail <img src="../../html/images/iconInfo.png" alt="If the JSON document has any field that cannot be mapped to a column in the database, the FlowFile will be routed to the failure relations hip" title="If the JSON document has any field that cannot be mapped to a column in the database, the FlowFile will be routed to the failure relationship"></img></li></ul></td><td id="description">If an incoming JSON element has a field that does not map to any of the database table's columns, this property specifies how to handle the situation</td></tr><tr><td id="name">Unmatched Column Behavior</td><td id="default-value">Fail on Unmatched Columns</td><td id="allowable-values"><ul><li>Ignore Unmatched Columns <img src="../../html/images/iconInfo.png" alt="Any column in the database that does not have a field in the JSON document will be assumed to not be required. No notification will be logged" title="Any column in the database that does not have a field in the JSON document will be assumed to not be required. No notification will be logged"></img></li><li>Warn on Unmatched Columns <img src="../../html/images/iconInfo.png" alt="Any column in the database that does not have a fie ld in the JSON document will be assumed to not be required. A warning will be logged" title="Any column in the database that does not have a field in the JSON document will be assumed to not be required. A warning will be logged"></img></li><li>Fail on Unmatched Columns <img src="../../html/images/iconInfo.png" alt="A flow will fail if any column in the database that does not have a field in the JSON document. An error will be logged" title="A flow will fail if any column in the database that does not have a field in the JSON document. An error will be logged"></img></li></ul></td><td id="description">If an incoming JSON element does not have a field mapping for all of the database table's columns, this property specifies how to handle the situation</td></tr><tr><td id="name">Update Keys</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A comma-separated list of column names that uniquely identifies a row in the database for UPDATE statements. I f the Statement Type is UPDATE and this property is not set, the table's Primary Keys are used. In this case, if no Primary Key exists, the conversion to SQL will fail if Unmatched Column Behaviour is set to FAIL. This property is ignored if the Statement Type is INSERT<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Quote Identifiers</td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Enabling this option will cause all column names to be quoted, allowing you to use reserved words as column names in your tables.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>sql</td><td>A FlowFile is routed to this relationship when its contents have successfully been converted into a SQL statement</td></tr><tr><td>failure</td><td>A FlowFile is routed to this relationship if it cannot be converted into a SQL statement. Comm on causes include invalid JSON content or the JSON content missing a required field (if using an INSERT statement type).</td></tr><tr><td>original</td><td>When a FlowFile is converted to SQL, the original JSON FlowFile is routed to this relationship</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>mime.type</td><td>Sets mime.type of FlowFile that is routed to 'sql' to 'text/plain'.</td></tr><tr><td>sql.table</td><td>Sets the sql.table attribute of FlowFile that is routed to 'sql' to the name of the table that is updated by the SQL statement.</td></tr><tr><td>sql.catalog</td><td>If the Catalog name is set for this database, specifies the name of the catalog that the SQL statement will update. If no catalog is used, this attribute will not be added.</td></tr><tr><td>fragment.identifier</td><td>All FlowFiles routed to the 'sql' relationship for the same incoming FlowFil e (multiple will be output for the same incoming FlowFile if the incoming FlowFile is a JSON Array) will have the same value for the fragment.identifier attribute. This can then be used to correlate the results.</td></tr><tr><td>fragment.count</td><td>The number of SQL FlowFiles that were produced for same incoming FlowFile. This can be used in conjunction with the fragment.identifier attribute in order to know how many FlowFiles belonged to the same incoming FlowFile.</td></tr><tr><td>fragment.index</td><td>The position of this FlowFile in the list of outgoing FlowFiles that were all derived from the same incoming FlowFile. This can be used in conjunction with the fragment.identifier and fragment.count attributes to know which FlowFiles originated from the same incoming FlowFile and in what order the SQL FlowFiles were produced</td></tr><tr><td>sql.args.N.type</td><td>The output SQL statements are parametrized in order to avoid SQL Injection Attacks. The types of the Parameters to use are stored in attributes named sql.args.1.type, sql.args.2.type, sql.args.3.type, and so on. The type is a number representing a JDBC Type constant. Generally, this is useful only for software to read and interpret but is added so that a processor such as PutSQL can understand how to interpret the values.</td></tr><tr><td>sql.args.N.value</td><td>The output SQL statements are parametrized in order to avoid SQL Injection Attacks. The values of the Parameters to use are stored in the attributes named sql.args.1.value, sql.args.2.value, sql.args.3.value, and so on. Each of these attributes has a corresponding sql.args.N.type attribute that indicates how the value should be interpreted when inserting it into the database.</td></tr></table><h3>State management: </h3>This processor has no state management.<h3>Restricted: </h3><h3>See Also:</h3><p><a href="../org.apache.nifi.processors.standard.PutSQL/index.html">PutSQL</a></p></body></html> \ No newline at end of file Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.DebugFlow/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.DebugFlow/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.DebugFlow/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.DebugFlow/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>DebugFlow</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>The DebugFlow processor aids testing and debugging the FlowFile framework by allowing various responses to be explicitly triggered in response to the receipt of a FlowFile or a timer event without a FlowFile if using timer or cron based scheduling. It can force responses needed to exercise or test various failure modes that can occur when a processor runs.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>test, debug, processor, utility, flow, FlowFile</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>Name</th><th>Default Value</th><th>Allowa ble Values</th><th>Description</th></tr><tr><td id="name"><strong>FlowFile Success Iterations</strong></td><td id="default-value">1</td><td id="allowable-values"></td><td id="description">Number of FlowFiles to forward to success relationship.</td></tr><tr><td id="name"><strong>FlowFile Failure Iterations</strong></td><td id="default-value">0</td><td id="allowable-values"></td><td id="description">Number of FlowFiles to forward to failure relationship.</td></tr><tr><td id="name"><strong>FlowFile Rollback Iterations</strong></td><td id="default-value">0</td><td id="allowable-values"></td><td id="description">Number of FlowFiles to roll back (without penalty).</td></tr><tr><td id="name"><strong>FlowFile Rollback Yield Iterations</strong></td><td id="default-value">0</td><td id="allowable-values"></td><td id="description">Number of FlowFiles to roll back and yield.</td></tr><tr><td id="name"><strong>FlowFile Rollback Penalty Iterations</strong></td><td id="default-value">0</td><td id=" allowable-values"></td><td id="description">Number of FlowFiles to roll back with penalty.</td></tr><tr><td id="name"><strong>FlowFile Exception Iterations</strong></td><td id="default-value">0</td><td id="allowable-values"></td><td id="description">Number of FlowFiles to throw exception.</td></tr><tr><td id="name"><strong>FlowFile Exception Class</strong></td><td id="default-value">java.lang.RuntimeException</td><td id="allowable-values"></td><td id="description">Exception class to be thrown (must extend java.lang.RuntimeException).</td></tr><tr><td id="name"><strong>No FlowFile Skip Iterations</strong></td><td id="default-value">1</td><td id="allowable-values"></td><td id="description">Number of times to skip onTrigger if no FlowFile.</td></tr><tr><td id="name"><strong>No FlowFile Exception Iterations</strong></td><td id="default-value">0</td><td id="allowable-values"></td><td id="description">Number of times to throw NPE exception if no FlowFile.</td></tr><tr><td id="name"><stron g>No FlowFile Yield Iterations</strong></td><td id="default-value">0</td><td id="allowable-values"></td><td id="description">Number of times to yield if no FlowFile.</td></tr><tr><td id="name"><strong>No FlowFile Exception Class</strong></td><td id="default-value">java.lang.RuntimeException</td><td id="allowable-values"></td><td id="description">Exception class to be thrown if no FlowFile (must extend java.lang.RuntimeException).</td></tr><tr><td id="name"><strong>Write Iterations</strong></td><td id="default-value">0</td><td id="allowable-values"></td><td id="description">Number of times to write to the FlowFile</td></tr><tr><td id="name"><strong>Content Size</strong></td><td id="default-value">1 KB</td><td id="allowable-values"></td><td id="description">The number of bytes to write each time that the FlowFile is written to</td></tr><tr><td id="name"><strong>@OnScheduled Pause Time</strong></td><td id="default-value">0 sec</td><td id="allowable-values"></td><td id="description">Spe cifies how long the processor should sleep in the @OnScheduled method, so that the processor can be forced to take a long time to start up</td></tr><tr><td id="name"><strong>Fail When @OnScheduled called</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Specifies whether or not the Processor should throw an Exception when the methods annotated with @OnScheduled are called</td></tr><tr><td id="name"><strong>@OnUnscheduled Pause Time</strong></td><td id="default-value">0 sec</td><td id="allowable-values"></td><td id="description">Specifies how long the processor should sleep in the @OnUnscheduled method, so that the processor can be forced to take a long time to respond when user clicks stop</td></tr><tr><td id="name"><strong>Fail When @OnUnscheduled called</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Specifies whe ther or not the Processor should throw an Exception when the methods annotated with @OnUnscheduled are called</td></tr><tr><td id="name"><strong>@OnStopped Pause Time</strong></td><td id="default-value">0 sec</td><td id="allowable-values"></td><td id="description">Specifies how long the processor should sleep in the @OnStopped method, so that the processor can be forced to take a long time to shutdown</td></tr><tr><td id="name"><strong>Fail When @OnStopped called</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Specifies whether or not the Processor should throw an Exception when the methods annotated with @OnStopped are called</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>FlowFiles processed successfully.</td></tr><tr><td>failure</td><td>FlowFiles that failed to process.</td></tr></table><h3>Reads Attributes: </h 3>None specified.<h3>Writes Attributes: </h3>None specified.</body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>DebugFlow</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>The DebugFlow processor aids testing and debugging the FlowFile framework by allowing various responses to be explicitly triggered in response to the receipt of a FlowFile or a timer event without a FlowFile if using timer or cron based scheduling. It can force responses needed to exercise or test various failure modes that can occur when a processor runs.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>test, debug, processor, utility, flow, FlowFile</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>Name</th><th>Default Value</th><th>Allowa ble Values</th><th>Description</th></tr><tr><td id="name"><strong>FlowFile Success Iterations</strong></td><td id="default-value">1</td><td id="allowable-values"></td><td id="description">Number of FlowFiles to forward to success relationship.</td></tr><tr><td id="name"><strong>FlowFile Failure Iterations</strong></td><td id="default-value">0</td><td id="allowable-values"></td><td id="description">Number of FlowFiles to forward to failure relationship.</td></tr><tr><td id="name"><strong>FlowFile Rollback Iterations</strong></td><td id="default-value">0</td><td id="allowable-values"></td><td id="description">Number of FlowFiles to roll back (without penalty).</td></tr><tr><td id="name"><strong>FlowFile Rollback Yield Iterations</strong></td><td id="default-value">0</td><td id="allowable-values"></td><td id="description">Number of FlowFiles to roll back and yield.</td></tr><tr><td id="name"><strong>FlowFile Rollback Penalty Iterations</strong></td><td id="default-value">0</td><td id=" allowable-values"></td><td id="description">Number of FlowFiles to roll back with penalty.</td></tr><tr><td id="name"><strong>FlowFile Exception Iterations</strong></td><td id="default-value">0</td><td id="allowable-values"></td><td id="description">Number of FlowFiles to throw exception.</td></tr><tr><td id="name"><strong>FlowFile Exception Class</strong></td><td id="default-value">java.lang.RuntimeException</td><td id="allowable-values"></td><td id="description">Exception class to be thrown (must extend java.lang.RuntimeException).</td></tr><tr><td id="name"><strong>No FlowFile Skip Iterations</strong></td><td id="default-value">1</td><td id="allowable-values"></td><td id="description">Number of times to skip onTrigger if no FlowFile.</td></tr><tr><td id="name"><strong>No FlowFile Exception Iterations</strong></td><td id="default-value">0</td><td id="allowable-values"></td><td id="description">Number of times to throw NPE exception if no FlowFile.</td></tr><tr><td id="name"><stron g>No FlowFile Yield Iterations</strong></td><td id="default-value">0</td><td id="allowable-values"></td><td id="description">Number of times to yield if no FlowFile.</td></tr><tr><td id="name"><strong>No FlowFile Exception Class</strong></td><td id="default-value">java.lang.RuntimeException</td><td id="allowable-values"></td><td id="description">Exception class to be thrown if no FlowFile (must extend java.lang.RuntimeException).</td></tr><tr><td id="name"><strong>Write Iterations</strong></td><td id="default-value">0</td><td id="allowable-values"></td><td id="description">Number of times to write to the FlowFile</td></tr><tr><td id="name"><strong>Content Size</strong></td><td id="default-value">1 KB</td><td id="allowable-values"></td><td id="description">The number of bytes to write each time that the FlowFile is written to</td></tr><tr><td id="name"><strong>@OnScheduled Pause Time</strong></td><td id="default-value">0 sec</td><td id="allowable-values"></td><td id="description">Spe cifies how long the processor should sleep in the @OnScheduled method, so that the processor can be forced to take a long time to start up</td></tr><tr><td id="name"><strong>Fail When @OnScheduled called</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Specifies whether or not the Processor should throw an Exception when the methods annotated with @OnScheduled are called</td></tr><tr><td id="name"><strong>@OnUnscheduled Pause Time</strong></td><td id="default-value">0 sec</td><td id="allowable-values"></td><td id="description">Specifies how long the processor should sleep in the @OnUnscheduled method, so that the processor can be forced to take a long time to respond when user clicks stop</td></tr><tr><td id="name"><strong>Fail When @OnUnscheduled called</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Specifies whe ther or not the Processor should throw an Exception when the methods annotated with @OnUnscheduled are called</td></tr><tr><td id="name"><strong>@OnStopped Pause Time</strong></td><td id="default-value">0 sec</td><td id="allowable-values"></td><td id="description">Specifies how long the processor should sleep in the @OnStopped method, so that the processor can be forced to take a long time to shutdown</td></tr><tr><td id="name"><strong>Fail When @OnStopped called</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Specifies whether or not the Processor should throw an Exception when the methods annotated with @OnStopped are called</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>FlowFiles processed successfully.</td></tr><tr><td>failure</td><td>FlowFiles that failed to process.</td></tr></table><h3>Reads Attributes: </h 3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>State management: </h3>This processor has no state management.<h3>Restricted: </h3></body></html> \ No newline at end of file Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.DetectDuplicate/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.DetectDuplicate/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.DetectDuplicate/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.DetectDuplicate/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>DetectDuplicate</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Caches a value, computed from FlowFile attributes, for each incoming FlowFile and determines if the cached value has already been seen. If so, routes the FlowFile to 'duplicate' with an attribute named 'original.identifier' that specifies the original FlowFile's "description", which is specified in the <FlowFile Description> property. If the FlowFile is not determined to be a duplicate, the Processor routes the FlowFile to 'non-duplicate'</p><h3>Tags: </h3><p>hash, dupe, duplicate, dedupe</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, and whether a property supports the <a href="../../html/express ion-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Cache Entry Identifier</strong></td><td id="default-value">${hash.value}</td><td id="allowable-values"></td><td id="description">A FlowFile attribute, or the results of an Attribute Expression Language statement, which will be evaluated against a FlowFile in order to determine the value used to identify duplicates; it is this value that is cached<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>FlowFile Description</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">When a FlowFile is added to the cache, this value is stored along with it so that if a duplicate is found, this description of the original FlowFile will be added to the duplicate's "original.flowfile.description" attribute<br/><strong>Supports Ex pression Language: true</strong></td></tr><tr><td id="name">Age Off Duration</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Time interval to age off cached FlowFiles</td></tr><tr><td id="name"><strong>Distributed Cache Service</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>DistributedMapCacheClient<br/><strong>Implementation:</strong><br/><a href="../org.apache.nifi.distributed.cache.client.DistributedMapCacheClientService/index.html">DistributedMapCacheClientService</a></td><td id="description">The Controller Service that is used to cache unique identifiers, used to determine duplicates</td></tr><tr><td id="name">Cache The Entry Identifier</td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">When true this cause the processor to check for duplicates and cache the Entry Identifier. When false, the processor woul d only check for duplicates and not cache the Entry Identifier, requiring another processor to add identifiers to the distributed cache.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>duplicate</td><td>If a FlowFile has been detected to be a duplicate, it will be routed to this relationship</td></tr><tr><td>non-duplicate</td><td>If a FlowFile's Cache Entry Identifier was not found in the cache, it will be routed to this relationship</td></tr><tr><td>failure</td><td>If unable to communicate with the cache, the FlowFile will be penalized and routed to this relationship</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>original.flowfile.description</td><td>All FlowFiles routed to the duplicate relationship will have an attribute added named original.flowfile.description. The value of this attribute is determined by the attributes of the original copy of the data and by the FlowFile Description property.</td></tr></table><h3>See Also:</h3><p><a href="../org.apache.nifi.distributed.cache.client.DistributedMapCacheClientService/index.html">DistributedMapCacheClientService</a>, <a href="../org.apache.nifi.distributed.cache.server.map.DistributedMapCacheServer/index.html">DistributedMapCacheServer</a></p></body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>DetectDuplicate</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Caches a value, computed from FlowFile attributes, for each incoming FlowFile and determines if the cached value has already been seen. If so, routes the FlowFile to 'duplicate' with an attribute named 'original.identifier' that specifies the original FlowFile's "description", which is specified in the <FlowFile Description> property. If the FlowFile is not determined to be a duplicate, the Processor routes the FlowFile to 'non-duplicate'</p><h3>Tags: </h3><p>hash, dupe, duplicate, dedupe</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, and whether a property supports the <a href="../../html/express ion-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Cache Entry Identifier</strong></td><td id="default-value">${hash.value}</td><td id="allowable-values"></td><td id="description">A FlowFile attribute, or the results of an Attribute Expression Language statement, which will be evaluated against a FlowFile in order to determine the value used to identify duplicates; it is this value that is cached<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>FlowFile Description</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">When a FlowFile is added to the cache, this value is stored along with it so that if a duplicate is found, this description of the original FlowFile will be added to the duplicate's "original.flowfile.description" attribute<br/><strong>Supports Ex pression Language: true</strong></td></tr><tr><td id="name">Age Off Duration</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Time interval to age off cached FlowFiles</td></tr><tr><td id="name"><strong>Distributed Cache Service</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>DistributedMapCacheClient<br/><strong>Implementation:</strong><br/><a href="../org.apache.nifi.distributed.cache.client.DistributedMapCacheClientService/index.html">DistributedMapCacheClientService</a></td><td id="description">The Controller Service that is used to cache unique identifiers, used to determine duplicates</td></tr><tr><td id="name">Cache The Entry Identifier</td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">When true this cause the processor to check for duplicates and cache the Entry Identifier. When false, the processor woul d only check for duplicates and not cache the Entry Identifier, requiring another processor to add identifiers to the distributed cache.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>duplicate</td><td>If a FlowFile has been detected to be a duplicate, it will be routed to this relationship</td></tr><tr><td>non-duplicate</td><td>If a FlowFile's Cache Entry Identifier was not found in the cache, it will be routed to this relationship</td></tr><tr><td>failure</td><td>If unable to communicate with the cache, the FlowFile will be penalized and routed to this relationship</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>original.flowfile.description</td><td>All FlowFiles routed to the duplicate relationship will have an attribute added named original.flowfile.description. The value of this attribute is determined by the attributes of the original copy of the data and by the FlowFile Description property.</td></tr></table><h3>State management: </h3>This processor has no state management.<h3>Restricted: </h3><h3>See Also:</h3><p><a href="../org.apache.nifi.distributed.cache.client.DistributedMapCacheClientService/index.html">DistributedMapCacheClientService</a>, <a href="../org.apache.nifi.distributed.cache.server.map.DistributedMapCacheServer/index.html">DistributedMapCacheServer</a></p></body></html> \ No newline at end of file Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.DistributeLoad/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.DistributeLoad/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.DistributeLoad/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.DistributeLoad/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!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><body><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>Name</th><th>Default Value</th><th>Allowab le Values</th><th>Description</th></tr><tr><td id="name"><strong>Number of Relationships</strong></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 id="default-value">round robin</td><td id="allowable-values"><ul><li>round robin</li><li>next available</li><li>load distribution service</li></ul></td><td id="description">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.</td></tr></table><h3>Dynamic Properties: </h3><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="n ame">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 be receive 10 FlowFiles in each iteration instead of 1.</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>None specified.</body></html> \ No newline at end of file +<!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><body><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>Name</th><th>Default Value</th><th>Allowab le Values</th><th>Description</th></tr><tr><td id="name"><strong>Number of Relationships</strong></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 id="default-value">round robin</td><td id="allowable-values"><ul><li>round robin</li><li>next available</li><li>load distribution service</li></ul></td><td id="description">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.</td></tr></table><h3>Dynamic Properties: </h3><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="n ame">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 be receive 10 FlowFiles in each iteration instead of 1.</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>None specified.<h3>State management: </h3>This processor has no state management.<h3>Restricted: </h3></b ody></html> \ No newline at end of file Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.DuplicateFlowFile/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.DuplicateFlowFile/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.DuplicateFlowFile/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.DuplicateFlowFile/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>DuplicateFlowFile</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Intended for load testing, this processor will create the configured number of copies of each incoming FlowFile</p><h3>Tags: </h3><p>test, load, duplicate</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>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Number of Copies</strong></td><td id="default-value">100</td><td id="allowable-values"></td><td id="description">Specifies how many copies of each incoming FlowFile will be made</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th >Description</th></tr><tr><td>success</td><td>The original FlowFile and all >copies will be sent to this relationship</td></tr></table><h3>Reads >Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None >specified.</body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>DuplicateFlowFile</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Intended for load testing, this processor will create the configured number of copies of each incoming FlowFile</p><h3>Tags: </h3><p>test, load, duplicate</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>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Number of Copies</strong></td><td id="default-value">100</td><td id="allowable-values"></td><td id="description">Specifies how many copies of each incoming FlowFile will be made</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th >Description</th></tr><tr><td>success</td><td>The original FlowFile and all >copies will be sent to this relationship</td></tr></table><h3>Reads >Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None >specified.<h3>State management: </h3>This processor has no state >management.<h3>Restricted: </h3></body></html> \ No newline at end of file
