Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.kite.ConvertAvroSchema/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.kite.ConvertAvroSchema/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.kite.ConvertAvroSchema/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.kite.ConvertAvroSchema/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ConvertAvroSchema</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Convert records from one Avro schema to another, including support for flattening and simple type conversions</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>avro, convert, kite</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 Schema</strong></td><td id="default-value"></td><td id="allowable-values"></td>< td id="description">Avro Schema of Input Flowfiles. This can be a URI (dataset, view, or resource) or literal JSON schema.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Output Schema</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Avro Schema of Output Flowfiles. This can be a URI (dataset, view, or resource) or literal JSON schema.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Locale</td><td id="default-value">default</td><td id="allowable-values"></td><td id="description">Locale to use for scanning data (see https://docs.oracle.com/javase/7/docs/api/java/util/Locale.html)or " default" for JVM default</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="name">Field name from input schema</td><td id="value">Field name for output schema</td><td>Explicit mappings from input schema to output schema, which supports renaming fields and stepping into nested records on the input schema using notation like parent.id</td></tr></table></p><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>Avro content that converted successfully</td></tr><tr><td>failure</td><td>Avro content that failed to convert</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>ConvertAvroSchema</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Convert records from one Avro schema to another, including support for flattening and simple type conversions</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>avro, convert, kite</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 Schema</strong></td><td id="default-value"></td><td id="allowable-values"></td>< td id="description">Avro Schema of Input Flowfiles. This can be a URI (dataset, view, or resource) or literal JSON schema.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Output Schema</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Avro Schema of Output Flowfiles. This can be a URI (dataset, view, or resource) or literal JSON schema.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Locale</td><td id="default-value">default</td><td id="allowable-values"></td><td id="description">Locale to use for scanning data (see https://docs.oracle.com/javase/7/docs/api/java/util/Locale.html)or " default" for JVM default</td></tr><tr><td id="name">Compression type</td><td id="default-value">SNAPPY</td><td id="allowable-values"><ul><li>BZIP2</li><li>DEFLATE</li><li>NONE</li><li>SNAPPY</li><li>LZO</li></ul></td><td id="description">Compression type to use when writting Avro fi les. Default is Snappy.</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="name">Field name from input schema</td><td id="value">Field name for output schema</td><td>Explicit mappings from input schema to output schema, which supports renaming fields and stepping into nested records on the input schema using notation like parent.id</td></tr></table></p><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>Avro content that converted successfully</td></tr><tr><td>failure</td><td>Avro content that failed to convert</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.kite.ConvertCSVToAvro/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.kite.ConvertCSVToAvro/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.kite.ConvertCSVToAvro/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.kite.ConvertCSVToAvro/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ConvertCSVToAvro</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Converts CSV files to Avro according to an Avro Schema</p><h3>Tags: </h3><p>kite, csv, avro</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">Hadoop configuration files</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A comma-separated list of Hadoop configuration files</td></tr><tr><td id="name"><strong>Record schema</stron g></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Outgoing Avro schema for each record created from a CSV row<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">CSV charset</td><td id="default-value">utf8</td><td id="allowable-values"></td><td id="description">Character set for CSV files</td></tr><tr><td id="name">CSV delimiter</td><td id="default-value">,</td><td id="allowable-values"></td><td id="description">Delimiter character for CSV records</td></tr><tr><td id="name">CSV quote character</td><td id="default-value">"</td><td id="allowable-values"></td><td id="description">Quote character for CSV values</td></tr><tr><td id="name">CSV escape character</td><td id="default-value">\</td><td id="allowable-values"></td><td id="description">Escape character for CSV values</td></tr><tr><td id="name">Use CSV header line</td><td id="default-value">false</td><td id="allowable-values"></td><td id="description">Whether to us e the first line as a header</td></tr><tr><td id="name">Lines to skip</td><td id="default-value">0</td><td id="allowable-values"></td><td id="description">Number of lines to skip before reading header or data</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>Avro content that was converted successfully from CSV</td></tr><tr><td>failure</td><td>CSV content that could not be processed</td></tr><tr><td>incompatible</td><td>CSV content that could not be converted</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>ConvertCSVToAvro</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Converts CSV files to Avro according to an Avro Schema</p><h3>Tags: </h3><p>kite, csv, avro</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">Hadoop configuration files</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A comma-separated list of Hadoop configuration files</td></tr><tr><td id="name"><strong>Record schema</stron g></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Outgoing Avro schema for each record created from a CSV row<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">CSV charset</td><td id="default-value">utf8</td><td id="allowable-values"></td><td id="description">Character set for CSV files</td></tr><tr><td id="name">CSV delimiter</td><td id="default-value">,</td><td id="allowable-values"></td><td id="description">Delimiter character for CSV records</td></tr><tr><td id="name">CSV quote character</td><td id="default-value">"</td><td id="allowable-values"></td><td id="description">Quote character for CSV values</td></tr><tr><td id="name">CSV escape character</td><td id="default-value">\</td><td id="allowable-values"></td><td id="description">Escape character for CSV values</td></tr><tr><td id="name">Use CSV header line</td><td id="default-value">false</td><td id="allowable-values"></td><td id="description">Whether to us e the first line as a header</td></tr><tr><td id="name">Lines to skip</td><td id="default-value">0</td><td id="allowable-values"></td><td id="description">Number of lines to skip before reading header or data</td></tr><tr><td id="name">Compression type</td><td id="default-value">SNAPPY</td><td id="allowable-values"><ul><li>BZIP2</li><li>DEFLATE</li><li>NONE</li><li>SNAPPY</li><li>LZO</li></ul></td><td id="description">Compression type to use when writting Avro files. Default is Snappy.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>Avro content that was converted successfully from CSV</td></tr><tr><td>failure</td><td>CSV content that could not be processed</td></tr><tr><td>incompatible</td><td>CSV content that could not be converted</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.kite.ConvertJSONToAvro/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.kite.ConvertJSONToAvro/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.kite.ConvertJSONToAvro/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.kite.ConvertJSONToAvro/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ConvertJSONToAvro</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Converts JSON files to Avro according to an Avro Schema</p><h3>Tags: </h3><p>kite, json, avro</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">Hadoop configuration files</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A comma-separated list of Hadoop configuration files</td></tr><tr><td id="name"><strong>Record schema</st rong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Outgoing Avro schema for each record created from a JSON object<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>Avro content that was converted successfully from JSON</td></tr><tr><td>failure</td><td>JSON content that could not be processed</td></tr><tr><td>incompatible</td><td>JSON content that could not be converted</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>ConvertJSONToAvro</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Converts JSON files to Avro according to an Avro Schema</p><h3>Tags: </h3><p>kite, json, avro</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">Hadoop configuration files</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A comma-separated list of Hadoop configuration files</td></tr><tr><td id="name"><strong>Record schema</st rong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Outgoing Avro schema for each record created from a JSON object<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Compression type</td><td id="default-value">SNAPPY</td><td id="allowable-values"><ul><li>BZIP2</li><li>DEFLATE</li><li>NONE</li><li>SNAPPY</li><li>LZO</li></ul></td><td id="description">Compression type to use when writting Avro files. Default is Snappy.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>Avro content that was converted successfully from JSON</td></tr><tr><td>failure</td><td>JSON content that could not be processed</td></tr><tr><td>incompatible</td><td>JSON content that could not be converted</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>State management: </h3>This processor has no state managem ent.<h3>Restricted: </h3></body></html> \ No newline at end of file Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.kite.InferAvroSchema/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.kite.InferAvroSchema/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.kite.InferAvroSchema/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.kite.InferAvroSchema/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>InferAvroSchema</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Examines the contents of the incoming FlowFile to infer an Avro schema. The processor will use the Kite SDK to make an attempt to automatically generate an Avro schema from the incoming content. When inferring the schema from JSON data the key names will be used in the resulting Avro schema definition. When inferring from CSV data a "header definition" must be present either as the first line of the incoming data or the "header definition" must be explicitly set in the property "CSV Header Definition". A "header definition" is simply a single comma separated line defining the names of each column. The "header definition" is required in order to determine the names that should be given to each field in the resulting Avro definition. When inferring data types the higher o rder data type is always used if there is ambiguity. For example when examining numerical values the type may be set to "long" instead of "integer" since a long can safely hold the value of any "integer". Only CSV and JSON content is currently supported for automatically inferring an Avro schema. The type of content present in the incoming FlowFile is set by using the property "Input Content Type". The property can either be explicitly set to CSV, JSON, or "use mime.type value" which will examine the value of the mime.type attribute on the incoming FlowFile to determine the type of content present.</p><h3>Tags: </h3><p>kite, avro, infer, schema, csv, json</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>Schema Output Destination</strong></td><td id="default-value">flowfile-content</td><td id="allowable-values"><ul><li>flowfile-attribute</li><li>flowfile-content</li></ul></td><td id="description">Control if Avro schema is written as a new flowfile attribute 'inferred.avro.schema' or written in the flowfile content. Writing to flowfile content will overwrite any existing flowfile content.</td></tr><tr><td id="name"><strong>Input Content Type</strong></td><td id="default-value">use mime.type value</td><td id="allowable-values"><ul><li>use mime.type value</li><li>json</li><li>csv</li></ul></td><td id="description">Content Type of data present in the incoming FlowFile's content. Only "json" or "csv" are supported. If this value is set to "use mime.type value" the incoming Flowfile's attribute "MIME_TYPE" will be used to determine the Content Type .</td></tr><tr><td id="name">CSV Header Definition</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">This property only applies to CSV content type. Comma separated string defining the column names expected in the CSV data. EX: "fname,lname,zip,address". The elements present in this string should be in the same order as the underlying data. Setting this property will cause the value of "Get CSV Header Definition From Data" to be ignored instead using this value.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Get CSV Header Definition From Data</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">This property only applies to CSV content type. If "true" the processor will attempt to read the CSV header definition from the first line of the input data.</td></tr><tr><td id="name"><strong>CSV Header Line Skip Count</strong></td><td id="default-value">0</td><td id="allowable-values"></td><td id="description">This property only applies to CSV content type. Specifies the number of lines that should be skipped when reading the CSV data. Setting this value to 0 is equivalent to saying "the entire contents of the file should be read". If the property "Get CSV Header Definition From Data" is set then the first line of the CSV file will be read in and treated as the CSV header definition. Since this will remove the header line from the data care should be taken to make sure the value of "CSV header Line Skip Count" is set to 0 to ensure no data is skipped.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">CSV delimiter</td><td id="default-value">,</td><td id="allowable-values"></td><td id="description">Delimiter character for CSV records<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>CSV Escape String</strong></td><td id="default-value">\</ td><td id="allowable-values"></td><td id="description">This property only applies to CSV content type. String that represents an escape sequence in the CSV FlowFile content data.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>CSV Quote String</strong></td><td id="default-value">'</td><td id="allowable-values"></td><td id="description">This property only applies to CSV content type. String that represents a literal quote character in the CSV FlowFile content data.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Pretty Avro Output</strong></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 Avro output will be formatted.</td></tr><tr><td id="name"><strong>Avro Record Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Value to be placed in the Avro record schema "name" fi eld.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Number Of Records To Analyze</strong></td><td id="default-value">10</td><td id="allowable-values"></td><td id="description">This property only applies to JSON content type. The number of JSON records that should be examined to determine the Avro schema. The higher the value the better chance kite has of detecting the appropriate type. However the default value of 10 is almost always enough.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Charset</strong></td><td id="default-value">UTF-8</td><td id="allowable-values"></td><td id="description">Character encoding of CSV data.<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>unsupported content</td><td>The content found in the flowfile content is not of the required format.</td> </tr><tr><td>success</td><td>Successfully created Avro schema from data.</td></tr><tr><td>failure</td><td>Failed to create Avro schema from data.</td></tr><tr><td>original</td><td>Original incoming FlowFile data</td></tr></table><h3>Reads Attributes: </h3><table id="reads-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>mime.type</td><td>If configured by property "Input Content Type" will use this value to determine what sort of content should be inferred from the incoming FlowFile content.</td></tr></table><h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>inferred.avro.schema</td><td>If configured by "Schema output destination" to write to an attribute this will hold the resulting Avro schema from inferring the incoming FlowFile content.</td></tr></table></body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>InferAvroSchema</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Examines the contents of the incoming FlowFile to infer an Avro schema. The processor will use the Kite SDK to make an attempt to automatically generate an Avro schema from the incoming content. When inferring the schema from JSON data the key names will be used in the resulting Avro schema definition. When inferring from CSV data a "header definition" must be present either as the first line of the incoming data or the "header definition" must be explicitly set in the property "CSV Header Definition". A "header definition" is simply a single comma separated line defining the names of each column. The "header definition" is required in order to determine the names that should be given to each field in the resulting Avro definition. When inferring data types the higher o rder data type is always used if there is ambiguity. For example when examining numerical values the type may be set to "long" instead of "integer" since a long can safely hold the value of any "integer". Only CSV and JSON content is currently supported for automatically inferring an Avro schema. The type of content present in the incoming FlowFile is set by using the property "Input Content Type". The property can either be explicitly set to CSV, JSON, or "use mime.type value" which will examine the value of the mime.type attribute on the incoming FlowFile to determine the type of content present.</p><h3>Tags: </h3><p>kite, avro, infer, schema, csv, json</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>Schema Output Destination</strong></td><td id="default-value">flowfile-content</td><td id="allowable-values"><ul><li>flowfile-attribute</li><li>flowfile-content</li></ul></td><td id="description">Control if Avro schema is written as a new flowfile attribute 'inferred.avro.schema' or written in the flowfile content. Writing to flowfile content will overwrite any existing flowfile content.</td></tr><tr><td id="name"><strong>Input Content Type</strong></td><td id="default-value">use mime.type value</td><td id="allowable-values"><ul><li>use mime.type value</li><li>json</li><li>csv</li></ul></td><td id="description">Content Type of data present in the incoming FlowFile's content. Only "json" or "csv" are supported. If this value is set to "use mime.type value" the incoming Flowfile's attribute "MIME_TYPE" will be used to determine the Content Type .</td></tr><tr><td id="name">CSV Header Definition</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">This property only applies to CSV content type. Comma separated string defining the column names expected in the CSV data. EX: "fname,lname,zip,address". The elements present in this string should be in the same order as the underlying data. Setting this property will cause the value of "Get CSV Header Definition From Data" to be ignored instead using this value.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Get CSV Header Definition From Data</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">This property only applies to CSV content type. If "true" the processor will attempt to read the CSV header definition from the first line of the input data.</td></tr><tr><td id="name"><strong>CSV Header Line Skip Count</strong></td><td id="default-value">0</td><td id="allowable-values"></td><td id="description">This property only applies to CSV content type. Specifies the number of lines that should be skipped when reading the CSV data. Setting this value to 0 is equivalent to saying "the entire contents of the file should be read". If the property "Get CSV Header Definition From Data" is set then the first line of the CSV file will be read in and treated as the CSV header definition. Since this will remove the header line from the data care should be taken to make sure the value of "CSV header Line Skip Count" is set to 0 to ensure no data is skipped.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">CSV delimiter</td><td id="default-value">,</td><td id="allowable-values"></td><td id="description">Delimiter character for CSV records<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>CSV Escape String</strong></td><td id="default-value">\</ td><td id="allowable-values"></td><td id="description">This property only applies to CSV content type. String that represents an escape sequence in the CSV FlowFile content data.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>CSV Quote String</strong></td><td id="default-value">'</td><td id="allowable-values"></td><td id="description">This property only applies to CSV content type. String that represents a literal quote character in the CSV FlowFile content data.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Pretty Avro Output</strong></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 Avro output will be formatted.</td></tr><tr><td id="name"><strong>Avro Record Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Value to be placed in the Avro record schema "name" fi eld. The value must adhere to the Avro naming rules for fullname. If Expression Language is present then the evaluated value must adhere to the Avro naming rules.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Number Of Records To Analyze</strong></td><td id="default-value">10</td><td id="allowable-values"></td><td id="description">This property only applies to JSON content type. The number of JSON records that should be examined to determine the Avro schema. The higher the value the better chance kite has of detecting the appropriate type. However the default value of 10 is almost always enough.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Charset</strong></td><td id="default-value">UTF-8</td><td id="allowable-values"></td><td id="description">Character encoding of CSV data.<br/><strong>Supports Expression Language: true</strong></td></tr></table><h3>Relationships: </h3><table id="relationship s"><tr><th>Name</th><th>Description</th></tr><tr><td>unsupported content</td><td>The content found in the flowfile content is not of the required format.</td></tr><tr><td>success</td><td>Successfully created Avro schema from data.</td></tr><tr><td>failure</td><td>Failed to create Avro schema from data.</td></tr><tr><td>original</td><td>Original incoming FlowFile data</td></tr></table><h3>Reads Attributes: </h3><table id="reads-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>mime.type</td><td>If configured by property "Input Content Type" will use this value to determine what sort of content should be inferred from the incoming FlowFile content.</td></tr></table><h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>inferred.avro.schema</td><td>If configured by "Schema output destination" to write to an attribute this will hold the resulting Avro schema from inferring the incoming FlowFile content.</td></tr></table><h 3>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.kite.StoreInKiteDataset/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.kite.StoreInKiteDataset/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.kite.StoreInKiteDataset/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.kite.StoreInKiteDataset/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>StoreInKiteDataset</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Stores Avro records in a Kite dataset</p><h3>Tags: </h3><p>kite, avro, parquet, hadoop, hive, hdfs, hbase</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">Hadoop configuration files</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A comma-separated list of Hadoop configuration files</td></tr><tr><td id="name"><strong>Targ et dataset URI</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">URI that identifies a Kite dataset where data will be stored<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>FlowFile content has been successfully saved</td></tr><tr><td>incompatible</td><td>FlowFile content is not compatible with the target dataset</td></tr><tr><td>failure</td><td>FlowFile content could not be processed</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>StoreInKiteDataset</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Stores Avro records in a Kite dataset</p><h3>Tags: </h3><p>kite, avro, parquet, hadoop, hive, hdfs, hbase</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">Hadoop configuration files</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A comma-separated list of Hadoop configuration files</td></tr><tr><td id="name"><strong>Targ et dataset URI</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">URI that identifies a Kite dataset where data will be stored<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>FlowFile content has been successfully saved</td></tr><tr><td>incompatible</td><td>FlowFile content is not compatible with the target dataset</td></tr><tr><td>failure</td><td>FlowFile content could not be processed</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.lumberjack.ListenLumberjack/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.lumberjack.ListenLumberjack/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.lumberjack.ListenLumberjack/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.lumberjack.ListenLumberjack/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ListenLumberjack</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Listens for Lumberjack messages being sent to a given port over TCP. Each message will be acknowledged after successfully writing the message to a FlowFile. Each FlowFile will contain data portion of one or more Lumberjack frames. In the case where the Lumberjack frames contain syslog messages, the output of this processor can be sent to a ParseSyslog processor for further processing.</p><h3>Tags: </h3><p>listen, lumberjack, tcp, logs</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><t able id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name">Local Network Interface</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of a local network interface to be used to restrict listening to a specific LAN.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Port</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The port to listen on for communication.</td></tr><tr><td id="name"><strong>Receive Buffer Size</strong></td><td id="default-value">65507 B</td><td id="allowable-values"></td><td id="description">The size of each buffer used to receive messages. Adjust this value appropriately based on the expected size of the incoming messages.</td></tr><tr><td id="name"><strong>Max Size of Message Queue</strong></td><td id="default-value">10000</td><td id="allowable-values"></td><td id="descr iption">The maximum size of the internal queue used to buffer messages being transferred from the underlying channel to the processor. Setting this value higher allows more messages to be buffered in memory during surges of incoming messages, but increases the total memory used by the processor.</td></tr><tr><td id="name"><strong>Max Size of Socket Buffer</strong></td><td id="default-value">1 MB</td><td id="allowable-values"></td><td id="description">The maximum size of the socket buffer that should be used. This is a suggestion to the Operating System to indicate how big the socket buffer should be. If this value is set too low, the buffer may fill up before the data can be read, and incoming data will be dropped.</td></tr><tr><td id="name"><strong>Character Set</strong></td><td id="default-value">UTF-8</td><td id="allowable-values"></td><td id="description">Specifies the character set of the received data.</td></tr><tr><td id="name"><strong>Max Batch Size</strong></td><td id="defa ult-value">1</td><td id="allowable-values"></td><td id="description">The maximum number of messages to add to a single FlowFile. If multiple messages are available, they will be concatenated along with the <Message Delimiter> up to this configured maximum number of messages</td></tr><tr><td id="name"><strong>Batching Message Delimiter</strong></td><td id="default-value">\n</td><td id="allowable-values"></td><td id="description">Specifies the delimiter to place between messages when multiple messages are bundled together (see <Max Batch Size> property).</td></tr><tr><td id="name"><strong>Max Number of TCP Connections</strong></td><td id="default-value">2</td><td id="allowable-values"></td><td id="description">The maximum number of concurrent TCP connections to accept.</td></tr><tr><td id="name"><strong>SSL Context Service</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>SSLContextService<br/><strong>Implement ation:</strong><br/><a href="../org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></td><td id="description">The Controller Service to use in order to obtain an SSL Context. If this property is set, messages will be received over a secure connection. Note that as Lumberjack client requirestwo-way SSL authentication, the controller MUST have a truststore and a keystore to workproperly.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>Messages received successfully will be sent out 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>lumberjack.sender</td><td>The sending host of the messages.</td></tr><tr><td>lumberjack.port</td><td>The sending port the messages were received over.</td></tr><tr><td>lumberjack.sequencenumber</td><td>The sequence number of the message. Only included if <Batch Size> is 1.</td></tr><tr><td>lumberjack.*</td><td>The keys and respective values as sent by the lumberjack producer. Only included if <Batch Size> is 1.</td></tr><tr><td>mime.type</td><td>The mime.type of the content which is text/plain</td></tr></table><h3>See Also:</h3><p><a href="../org.apache.nifi.processors.standard.ParseSyslog/index.html">ParseSyslog</a></p></body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ListenLumberjack</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Listens for Lumberjack messages being sent to a given port over TCP. Each message will be acknowledged after successfully writing the message to a FlowFile. Each FlowFile will contain data portion of one or more Lumberjack frames. In the case where the Lumberjack frames contain syslog messages, the output of this processor can be sent to a ParseSyslog processor for further processing.</p><h3>Tags: </h3><p>listen, lumberjack, tcp, logs</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><t able id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name">Local Network Interface</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of a local network interface to be used to restrict listening to a specific LAN.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Port</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The port to listen on for communication.</td></tr><tr><td id="name"><strong>Receive Buffer Size</strong></td><td id="default-value">65507 B</td><td id="allowable-values"></td><td id="description">The size of each buffer used to receive messages. Adjust this value appropriately based on the expected size of the incoming messages.</td></tr><tr><td id="name"><strong>Max Size of Message Queue</strong></td><td id="default-value">10000</td><td id="allowable-values"></td><td id="descr iption">The maximum size of the internal queue used to buffer messages being transferred from the underlying channel to the processor. Setting this value higher allows more messages to be buffered in memory during surges of incoming messages, but increases the total memory used by the processor.</td></tr><tr><td id="name"><strong>Max Size of Socket Buffer</strong></td><td id="default-value">1 MB</td><td id="allowable-values"></td><td id="description">The maximum size of the socket buffer that should be used. This is a suggestion to the Operating System to indicate how big the socket buffer should be. If this value is set too low, the buffer may fill up before the data can be read, and incoming data will be dropped.</td></tr><tr><td id="name"><strong>Character Set</strong></td><td id="default-value">UTF-8</td><td id="allowable-values"></td><td id="description">Specifies the character set of the received data.</td></tr><tr><td id="name"><strong>Max Batch Size</strong></td><td id="defa ult-value">1</td><td id="allowable-values"></td><td id="description">The maximum number of messages to add to a single FlowFile. If multiple messages are available, they will be concatenated along with the <Message Delimiter> up to this configured maximum number of messages</td></tr><tr><td id="name"><strong>Batching Message Delimiter</strong></td><td id="default-value">\n</td><td id="allowable-values"></td><td id="description">Specifies the delimiter to place between messages when multiple messages are bundled together (see <Max Batch Size> property).</td></tr><tr><td id="name"><strong>Max Number of TCP Connections</strong></td><td id="default-value">2</td><td id="allowable-values"></td><td id="description">The maximum number of concurrent TCP connections to accept.</td></tr><tr><td id="name"><strong>SSL Context Service</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>SSLContextService<br/><strong>Implement ation:</strong><br/><a href="../org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></td><td id="description">The Controller Service to use in order to obtain an SSL Context. If this property is set, messages will be received over a secure connection. Note that as Lumberjack client requirestwo-way SSL authentication, the controller MUST have a truststore and a keystore to workproperly.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>Messages received successfully will be sent out 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>lumberjack.sender</td><td>The sending host of the messages.</td></tr><tr><td>lumberjack.port</td><td>The sending port the messages were received over.</td></tr><tr><td>lumberjack.sequencenumber</td><td>The sequence number of the message. Only included if <Batch Size> is 1.</td></tr><tr><td>lumberjack.*</td><td>The keys and respective values as sent by the lumberjack producer. Only included if <Batch Size> is 1.</td></tr><tr><td>mime.type</td><td>The mime.type of the content which is text/plain</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.ParseSyslog/index.html">ParseSyslog</a></p></body></html> \ No newline at end of file Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.media.ExtractMediaMetadata/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.media.ExtractMediaMetadata/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.media.ExtractMediaMetadata/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.media.ExtractMediaMetadata/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ExtractMediaMetadata</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Extract the content metadata from flowfiles containing audio, video, image, and other file types. This processor relies on the Apache Tika project for file format detection and parsing. It extracts a long list of metadata types for media files including audio, video, and print media formats.NOTE: the attribute names and content extracted may vary across upgrades because parsing is performed by the external Tika tools which in turn depend on other projects for metadata extraction. For the more details and the list of supported file types, visit the library's website at http://tika.apache.org/.</p><h3>Tags: </h3><p>media, file, format, metadata, audio, video, image, document, pdf</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">Max Number of Attributes</td><td id="default-value">100</td><td id="allowable-values"></td><td id="description">Specify the max number of attributes to add to the flowfile. There is no guarantee in what order the tags will be processed. By default it will process all of them.</td></tr><tr><td id="name"><strong>Max Attribute Length</strong></td><td id="default-value">100</td><td id="allowable-values"></td><td id="description">Specifies the maximum length of a single attribute value. When a metadata item has multiple values, they will be merged until this length is reached and then ", ..." will be added as a n indicator that additional values where dropped. If a single value is longer than this, it will be truncated and "(truncated)" appended to indicate that truncation occurred.</td></tr><tr><td id="name">Metadata Key Filter</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A regular expression identifying which metadata keys received from the parser should be added to the flowfile attributes. If left blank, all metadata keys parsed will be added to the flowfile attributes.</td></tr><tr><td id="name">Metadata Key Prefix</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Text to be prefixed to metadata keys as the are added to the flowfile attributes. It is recommended to end with with a separator character like '.' or '-', this is not automatically added by the processor.<br/><strong>Supports Expression Language: true</strong></td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>De scription</th></tr><tr><td>success</td><td>Any FlowFile that successfully has media metadata extracted will be routed to success</td></tr><tr><td>failure</td><td>Any FlowFile that fails to have media metadata extracted will be routed to failure</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><Metadata Key Prefix><attribute></td><td>The extracted content metadata will be inserted with the attribute name "<Metadata Key Prefix><attribute>", or "<attribute>" if "Metadata Key Prefix" is not provided.</td></tr></table></body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ExtractMediaMetadata</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Extract the content metadata from flowfiles containing audio, video, image, and other file types. This processor relies on the Apache Tika project for file format detection and parsing. It extracts a long list of metadata types for media files including audio, video, and print media formats.NOTE: the attribute names and content extracted may vary across upgrades because parsing is performed by the external Tika tools which in turn depend on other projects for metadata extraction. For the more details and the list of supported file types, visit the library's website at http://tika.apache.org/.</p><h3>Tags: </h3><p>media, file, format, metadata, audio, video, image, document, pdf</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">Max Number of Attributes</td><td id="default-value">100</td><td id="allowable-values"></td><td id="description">Specify the max number of attributes to add to the flowfile. There is no guarantee in what order the tags will be processed. By default it will process all of them.</td></tr><tr><td id="name"><strong>Max Attribute Length</strong></td><td id="default-value">100</td><td id="allowable-values"></td><td id="description">Specifies the maximum length of a single attribute value. When a metadata item has multiple values, they will be merged until this length is reached and then ", ..." will be added as a n indicator that additional values where dropped. If a single value is longer than this, it will be truncated and "(truncated)" appended to indicate that truncation occurred.</td></tr><tr><td id="name">Metadata Key Filter</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A regular expression identifying which metadata keys received from the parser should be added to the flowfile attributes. If left blank, all metadata keys parsed will be added to the flowfile attributes.</td></tr><tr><td id="name">Metadata Key Prefix</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Text to be prefixed to metadata keys as the are added to the flowfile attributes. It is recommended to end with with a separator character like '.' or '-', this is not automatically added by the processor.<br/><strong>Supports Expression Language: true</strong></td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>De scription</th></tr><tr><td>success</td><td>Any FlowFile that successfully has media metadata extracted will be routed to success</td></tr><tr><td>failure</td><td>Any FlowFile that fails to have media metadata extracted will be routed to failure</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><Metadata Key Prefix><attribute></td><td>The extracted content metadata will be inserted with the attribute name "<Metadata Key Prefix><attribute>", or "<attribute>" if "Metadata Key Prefix" is not provided.</td></tr></table><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.mongodb.GetMongo/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.mongodb.GetMongo/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.mongodb.GetMongo/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.mongodb.GetMongo/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>GetMongo</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Creates FlowFiles from documents in MongoDB</p><h3>Tags: </h3><p>mongodb, read, get</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>Mongo URI</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">MongoURI, typically of the form: mongodb://host1[:port1][,host2[:port2],...]</td></tr><tr><td id="name"><strong>Mongo Database Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the d atabase to use</td></tr><tr><td id="name"><strong>Mongo Collection Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the collection to use</td></tr><tr><td id="name">SSL Context Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>SSLContextService<br/><strong>Implementation:</strong><br/><a href="../org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></td><td id="description">The SSL Context Service used to provide client certificate information for TLS/SSL connections.</td></tr><tr><td id="name">Client Auth</td><td id="default-value">REQUIRED</td><td id="allowable-values"><ul><li>WANT</li><li>REQUIRED</li><li>NONE</li></ul></td><td id="description">Client authentication policy when connecting to secure (TLS/SSL) cluster. Possible values are REQUIRED, WANT, NONE. This property is only used when an SSL Context has been defined and enabled.</td></tr><tr><td id="name">Query</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The selection criteria; must be a valid MongoDB Extended JSON format; if omitted the entire collection will be queried</td></tr><tr><td id="name">Projection</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The fields to be returned from the documents in the result set; must be a valid BSON document</td></tr><tr><td id="name">Sort</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The fields by which to sort; must be a valid BSON document</td></tr><tr><td id="name">Limit</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The maximum number of elements to return</td></tr><tr><td id="name">Batch Size</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The number of elements returned from the server in one batch</td></tr><tr><td id= "name">SSL Context Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>SSLContextService<br/><strong>Implementation:</strong><br/><a href="../org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></td><td id="description">The SSL Context Service used to provide client certificate information for TLS/SSL connections.</td></tr><tr><td id="name">Client Auth</td><td id="default-value">REQUIRED</td><td id="allowable-values"><ul><li>WANT</li><li>REQUIRED</li><li>NONE</li></ul></td><td id="description">Client authentication policy when connecting to secure (TLS/SSL) cluster. Possible values are REQUIRED, WANT, NONE. This property is only used when an SSL Context has been defined and enabled.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>All files are routed to success</td></tr></table><h3>Reads Attributes: </h3>N one 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>GetMongo</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Creates FlowFiles from documents in MongoDB</p><h3>Tags: </h3><p>mongodb, read, get</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>Mongo URI</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">MongoURI, typically of the form: mongodb://host1[:port1][,host2[:port2],...]</td></tr><tr><td id="name"><strong>Mongo Database Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the d atabase to use</td></tr><tr><td id="name"><strong>Mongo Collection Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the collection to use</td></tr><tr><td id="name">SSL Context Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>SSLContextService<br/><strong>Implementation:</strong><br/><a href="../org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></td><td id="description">The SSL Context Service used to provide client certificate information for TLS/SSL connections.</td></tr><tr><td id="name">Client Auth</td><td id="default-value">REQUIRED</td><td id="allowable-values"><ul><li>WANT</li><li>REQUIRED</li><li>NONE</li></ul></td><td id="description">Client authentication policy when connecting to secure (TLS/SSL) cluster. Possible values are REQUIRED, WANT, NONE. This property is only used when an SSL Context has been defined and enabled.</td></tr><tr><td id="name">Query</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The selection criteria; must be a valid MongoDB Extended JSON format; if omitted the entire collection will be queried</td></tr><tr><td id="name">Projection</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The fields to be returned from the documents in the result set; must be a valid BSON document</td></tr><tr><td id="name">Sort</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The fields by which to sort; must be a valid BSON document</td></tr><tr><td id="name">Limit</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The maximum number of elements to return</td></tr><tr><td id="name">Batch Size</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The number of elements returned from the server in one batch</td></tr><tr><td id= "name">SSL Context Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>SSLContextService<br/><strong>Implementation:</strong><br/><a href="../org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></td><td id="description">The SSL Context Service used to provide client certificate information for TLS/SSL connections.</td></tr><tr><td id="name">Client Auth</td><td id="default-value">REQUIRED</td><td id="allowable-values"><ul><li>WANT</li><li>REQUIRED</li><li>NONE</li></ul></td><td id="description">Client authentication policy when connecting to secure (TLS/SSL) cluster. Possible values are REQUIRED, WANT, NONE. This property is only used when an SSL Context has been defined and enabled.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>All files are routed to success</td></tr></table><h3>Reads Attributes: </h3>N one 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.mongodb.PutMongo/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.mongodb.PutMongo/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.mongodb.PutMongo/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.mongodb.PutMongo/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutMongo</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Writes the contents of a FlowFile to MongoDB</p><h3>Tags: </h3><p>mongodb, insert, update, write, put</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>Mongo URI</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">MongoURI, typically of the form: mongodb://host1[:port1][,host2[:port2],...]</td></tr><tr><td id="name"><strong>Mongo Database Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description" >The name of the database to use</td></tr><tr><td id="name"><strong>Mongo >Collection Name</strong></td><td id="default-value"></td><td >id="allowable-values"></td><td id="description">The name of the collection to >use</td></tr><tr><td id="name">SSL Context Service</td><td >id="default-value"></td><td id="allowable-values"><strong>Controller Service >API: ></strong><br/>SSLContextService<br/><strong>Implementation:</strong><br/><a >href="../org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></td><td > id="description">The SSL Context Service used to provide client certificate >information for TLS/SSL connections.</td></tr><tr><td id="name">Client >Auth</td><td id="default-value">REQUIRED</td><td >id="allowable-values"><ul><li>WANT</li><li>REQUIRED</li><li>NONE</li></ul></td><td > id="description">Client authentication policy when connecting to secure >(TLS/SSL) cluster. Possible values are REQUIRED, WANT, NONE. This property is >only used when an SSL Context has been defined and enabled.</td></tr><tr><td id="name"><strong>Mode</strong></td><td id="default-value">insert</td><td id="allowable-values"><ul><li>insert</li><li>update</li></ul></td><td id="description">Indicates whether the processor should insert or update content</td></tr><tr><td id="name"><strong>Upsert</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">When true, inserts a document if no document matches the update query criteria; this property is valid only when using update mode, otherwise it is ignored</td></tr><tr><td id="name"><strong>Update Query Key</strong></td><td id="default-value">_id</td><td id="allowable-values"></td><td id="description">Key name used to build the update query criteria; this property is valid only when using update mode, otherwise it is ignored</td></tr><tr><td id="name"><strong>Write Concern</strong></td><td id="default-value">ACKNOWLEDGED</td><td id="allowable-va lues"><ul><li>ACKNOWLEDGED</li><li>UNACKNOWLEDGED</li><li>FSYNCED</li><li>JOURNALED</li><li>REPLICA_ACKNOWLEDGED</li><li>MAJORITY</li></ul></td><td id="description">The write concern to use</td></tr><tr><td id="name"><strong>Character Set</strong></td><td id="default-value">UTF-8</td><td id="allowable-values"></td><td id="description">The Character Set in which the data is encoded</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>All FlowFiles that are written to MongoDB are routed to this relationship</td></tr><tr><td>failure</td><td>All FlowFiles that cannot be written to MongoDB are routed 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>PutMongo</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Writes the contents of a FlowFile to MongoDB</p><h3>Tags: </h3><p>mongodb, insert, update, write, put</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>Mongo URI</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">MongoURI, typically of the form: mongodb://host1[:port1][,host2[:port2],...]</td></tr><tr><td id="name"><strong>Mongo Database Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description" >The name of the database to use</td></tr><tr><td id="name"><strong>Mongo >Collection Name</strong></td><td id="default-value"></td><td >id="allowable-values"></td><td id="description">The name of the collection to >use</td></tr><tr><td id="name">SSL Context Service</td><td >id="default-value"></td><td id="allowable-values"><strong>Controller Service >API: ></strong><br/>SSLContextService<br/><strong>Implementation:</strong><br/><a >href="../org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></td><td > id="description">The SSL Context Service used to provide client certificate >information for TLS/SSL connections.</td></tr><tr><td id="name">Client >Auth</td><td id="default-value">REQUIRED</td><td >id="allowable-values"><ul><li>WANT</li><li>REQUIRED</li><li>NONE</li></ul></td><td > id="description">Client authentication policy when connecting to secure >(TLS/SSL) cluster. Possible values are REQUIRED, WANT, NONE. This property is >only used when an SSL Context has been defined and enabled.</td></tr><tr><td id="name"><strong>Mode</strong></td><td id="default-value">insert</td><td id="allowable-values"><ul><li>insert</li><li>update</li></ul></td><td id="description">Indicates whether the processor should insert or update content</td></tr><tr><td id="name"><strong>Upsert</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">When true, inserts a document if no document matches the update query criteria; this property is valid only when using update mode, otherwise it is ignored</td></tr><tr><td id="name"><strong>Update Query Key</strong></td><td id="default-value">_id</td><td id="allowable-values"></td><td id="description">Key name used to build the update query criteria; this property is valid only when using update mode, otherwise it is ignored</td></tr><tr><td id="name"><strong>Write Concern</strong></td><td id="default-value">ACKNOWLEDGED</td><td id="allowable-va lues"><ul><li>ACKNOWLEDGED</li><li>UNACKNOWLEDGED</li><li>FSYNCED</li><li>JOURNALED</li><li>REPLICA_ACKNOWLEDGED</li><li>MAJORITY</li></ul></td><td id="description">The write concern to use</td></tr><tr><td id="name"><strong>Character Set</strong></td><td id="default-value">UTF-8</td><td id="allowable-values"></td><td id="description">The Character Set in which the data is encoded</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>All FlowFiles that are written to MongoDB are routed to this relationship</td></tr><tr><td>failure</td><td>All FlowFiles that cannot be written to MongoDB are routed 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
