Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-metrics-reporting-nar/1.5.0/org.apache.nifi.metrics.reporting.reporter.service.GraphiteMetricReporterService/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-metrics-reporting-nar/1.5.0/org.apache.nifi.metrics.reporting.reporter.service.GraphiteMetricReporterService/index.html?rev=1821033&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-metrics-reporting-nar/1.5.0/org.apache.nifi.metrics.reporting.reporter.service.GraphiteMetricReporterService/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-metrics-reporting-nar/1.5.0/org.apache.nifi.metrics.reporting.reporter.service.GraphiteMetricReporterService/index.html Fri Jan 12 21:00:14 2018 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>GraphiteMetricReporterService</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">GraphiteMetricReporterService</h1><h2>Description: </h2><p>A controller service that provides metric reporters for graphite. Used by MetricsReportingTask.</p><h3>Tags: </h3><p>metrics, reporting, graphite</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>Host</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The hostname of the carbon listener<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 on which carbon listens<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">The charset used by the graphite server</td></tr><tr><td id="name"><strong>Metric Name Prefix</strong></td><td id="default-value">nifi</td><td id="allowable-values"></td><td id="description">A prefix that will be used for all metric names sent by reporters provided by this service.<br/><strong>Supports Expression Language: true</strong></td ></tr></table><h3>State management: </h3>This component does not store >state.<h3>Restricted: </h3>This component is not restricted.</body></html> \ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-metrics-reporting-nar/1.5.0/org.apache.nifi.metrics.reporting.task.MetricsReportingTask/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-metrics-reporting-nar/1.5.0/org.apache.nifi.metrics.reporting.task.MetricsReportingTask/index.html?rev=1821033&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-metrics-reporting-nar/1.5.0/org.apache.nifi.metrics.reporting.task.MetricsReportingTask/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-metrics-reporting-nar/1.5.0/org.apache.nifi.metrics.reporting.task.MetricsReportingTask/index.html Fri Jan 12 21:00:14 2018 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>MetricsReportingTask</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">MetricsReportingTask</h1><h2>Description: </h2><p>This reporting task reports a set of metrics regarding the JVM and the NiFi instanceto a reporter. The reporter is provided by a MetricReporterService. It can be optionally used for a specificprocess group if a property with the group id is provided.</p><h3>Tags: </h3><p>metrics, reporting</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>Metric Reporter Service</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>MetricReporterService<br/><strong>Implementation: </strong><a href="../org.apache.nifi.metrics.reporting.reporter.service.GraphiteMetricReporterService/index.html">GraphiteMetricReporterService</a></td><td id="description">The service that provides a reporter for the gathered metrics</td></tr><tr><td id="name">Process Group ID</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The id of the process group to report. If not specified, metrics of the root process groupare reported.<br/><strong>Supports Expression Language: true</strong></td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mongodb-nar/1.5.0/org.apache.nifi.processors.mongodb.DeleteMongo/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mongodb-nar/1.5.0/org.apache.nifi.processors.mongodb.DeleteMongo/index.html?rev=1821033&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mongodb-nar/1.5.0/org.apache.nifi.processors.mongodb.DeleteMongo/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mongodb-nar/1.5.0/org.apache.nifi.processors.mongodb.DeleteMongo/index.html Fri Jan 12 21:00:14 2018 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>DeleteMongo</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">DeleteMongo</h1><h2>Description: </h2><p>Executes a delete query against a MongoDB collection. The query is provided in the body of the flowfile and the user can select whether it will delete one or many documents that match it.</p><h3>Tags: </h3><p>delete, mongo, mongodb</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 Lan guage</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>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],...]<br/><strong>Supports Expression Language: true</strong></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<br/><strong>Supports Expression Language: true</strong></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<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">SSL Context Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service A PI: </strong><br/>SSLContextService<br/><strong>Implementations: </strong><a href="../../../nifi-ssl-context-service-nar/1.5.0/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a><br/><a href="../../../nifi-ssl-context-service-nar/1.5.0/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</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">Delete Mode</td><td id="default-value">one</td><td id="allowable-values"><ul><li>Delete One < img src="../../../../../html/images/iconInfo.png" alt="Delete only the first document that matches the query." title="Delete only the first document that matches the query."></img></li><li>Delete Many <img src="../../../../../html/images/iconInfo.png" alt="Delete every document that matches the query." title="Delete every document that matches the query."></img></li><li>Use 'mongodb.delete.mode' attribute <img src="../../../../../html/images/iconInfo.png" alt="Read the 'mongodb.delete.mode attribute and use that mode. Acceptable values are 'many' and 'one.'" title="Read the 'mongodb.delete.mode attribute and use that mode. Acceptable values are 'many' and 'one.'"></img></li></ul></td><td id="description">Choose between deleting one document by query or many documents by query.</td></tr><tr><td id="name">Fail When Nothing Is Deleted</td><td id="default-value">true</td><td id="allowable-values"><ul><li>True <img src="../../../../../html/images/iconInfo.png" alt="Fail when no documents are deleted." title="Fail when no documents are deleted."></img></li><li>False <img src="../../../../../html/images/iconInfo.png" alt="Do not fail when nothing is deleted." title="Do not fail when nothing is deleted."></img></li></ul></td><td id="description">Determines whether to send the flowfile to the success or failure relationship if nothing is successfully deleted.</td></tr><tr><td id="name"><strong>Write Concern</strong></td><td id="default-value">ACKNOWLEDGED</td><td id="allowable-values"><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></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 re lationship</td></tr></table><h3>Reads Attributes: </h3><table id="reads-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>mongodb.delete.mode</td><td>Configurable parameter for controlling delete mode on a per-flowfile basis. The process must be configured to use this option. Acceptable values are 'one' and 'many.'</td></tr></table><h3>Writes Attributes: </h3>None specified.<h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mongodb-nar/1.5.0/org.apache.nifi.processors.mongodb.GetMongo/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mongodb-nar/1.5.0/org.apache.nifi.processors.mongodb.GetMongo/index.html?rev=1821033&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mongodb-nar/1.5.0/org.apache.nifi.processors.mongodb.GetMongo/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mongodb-nar/1.5.0/org.apache.nifi.processors.mongodb.GetMongo/index.html Fri Jan 12 21:00:14 2018 @@ -0,0 +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><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">GetMongo</h1><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, 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>Mo ngo 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],...]<br/><strong>Supports Expression Language: true</strong></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<br/><strong>Supports Expression Language: true</strong></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<br/><strong>Supports Expression Language: true</strong></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>Implementations: </strong><a href="../../../nifi-ssl-context-service-nar/1.5.0/org.apache.nifi.ssl.Standar dSSLContextService/index.html">StandardSSLContextService</a><br/><a href="../../../nifi-ssl-context-service-nar/1.5.0/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</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>JSON Type</strong></td><td id="default-value">Extended</td><td id="allowable-values"><ul><li>Extended JSON <img src="../../../../../html/images/iconInfo.png" alt="Use MongoDB's "extended JSON". This is the JSON generated with toJ son() on a MongoDB Document from the Java driver" title="Use MongoDB's "extended JSON". This is the JSON generated with toJson() on a MongoDB Document from the Java driver"></img></li><li>Standard JSON <img src="../../../../../html/images/iconInfo.png" alt="Generate a JSON document that conforms to typical JSON conventions instead of Mongo-specific conventions." title="Generate a JSON document that conforms to typical JSON conventions instead of Mongo-specific conventions."></img></li></ul></td><td id="description">By default, MongoDB's Java driver returns "extended JSON". Some of the features of this variant of JSON may cause problems for other JSON parsers that expect only standard JSON types and conventions. This configuration setting controls whether to use extended JSON or provide a clean view that conforms to standard JSON.</td></tr><tr><td id="name">Query</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The selection criteria; mus t be a valid MongoDB Extended JSON format; if omitted the entire collection will be queried<br/><strong>Supports Expression Language: true</strong></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<br/><strong>Supports Expression Language: true</strong></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<br/><strong>Supports Expression Language: true</strong></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<br/><strong>Supports Expression Language: true</strong></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<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Results Per FlowFile</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">How many results to put into a flowfile at once. The whole body will be treated as a JSON array of results.<br/><strong>Supports Expression Language: true</strong></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>Implementations: </strong><a href="../../../nifi-ssl-context-service-nar/1.5.0/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a><br/><a href="../../../nifi-ssl-context-service-nar/1.5.0/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</a></td><td id="description">The SSL Context Service used to provide client certifica te 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>None specified.<h3>Writes Attributes: </h3>None specified.<h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component does not allow an incoming relationship.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mongodb-nar/1.5.0/org.apache.nifi.processors.mongodb.PutMongo/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mongodb-nar/1.5.0/org.apache.nifi.processors.mongodb.PutMongo/index.html?rev=1821033&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mongodb-nar/1.5.0/org.apache.nifi.processors.mongodb.PutMongo/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mongodb-nar/1.5.0/org.apache.nifi.processors.mongodb.PutMongo/index.html Fri Jan 12 21:00:14 2018 @@ -0,0 +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><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">PutMongo</h1><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, 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>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],...]<br/><strong>Supports Expression Language: true</strong></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<br/><strong>Supports Expression Language: true</strong></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<br/><strong>Supports Expression Language: true</strong></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>Implementations: </strong><a href="../../../nifi-ssl-context-service-nar/1.5.0/org.apach e.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a><br/><a href="../../../nifi-ssl-context-service-nar/1.5.0/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</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>Update Mode</strong></td><td id="default-value">doc</td><td id="allowable-values"><ul><li>With whole document</li><li>With operators enabled</li></ul></td><td id="description">Choose an update mode. You can either supply a JSON document to use as a direct replacement or specify a document that contains update operators like $set and $unset</td></tr><tr><td id="name">< strong>Write Concern</strong></td><td id="default-value">ACKNOWLEDGED</td><td id="allowable-values"><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 component does not store state.<h3>Restricted: </h3>This componen t is not restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mongodb-nar/1.5.0/org.apache.nifi.processors.mongodb.PutMongoRecord/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mongodb-nar/1.5.0/org.apache.nifi.processors.mongodb.PutMongoRecord/index.html?rev=1821033&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mongodb-nar/1.5.0/org.apache.nifi.processors.mongodb.PutMongoRecord/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mongodb-nar/1.5.0/org.apache.nifi.processors.mongodb.PutMongoRecord/index.html Fri Jan 12 21:00:14 2018 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutMongoRecord</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">PutMongoRecord</h1><h2>Description: </h2><p>Bulk ingest documents into MongoDB using a configured record reader.</p><h3>Tags: </h3><p>mongodb, insert, record, 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, 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>De scription</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],...]<br/><strong>Supports Expression Language: true</strong></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<br/><strong>Supports Expression Language: true</strong></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<br/><strong>Supports Expression Language: true</strong></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>Implementations: </strong><a href="../../../nifi-ssl-contex t-service-nar/1.5.0/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a><br/><a href="../../../nifi-ssl-context-service-nar/1.5.0/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</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>Write Concern</strong></td><td id="default-value">ACKNOWLEDGED</td><td id="allowable-values"><ul><li>ACKNOWLEDGED</li><li>UNACKNOWLEDGED</li><li>FSYNCED</li><li>JOURNALED</li><li>REPLICA_ACKNO WLEDGED</li><li>MAJORITY</li></ul></td><td id="description">The write concern to use</td></tr><tr><td id="name"><strong>Record Reader</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>RecordReaderFactory<br/><strong>Implementations: </strong><a href="../../../nifi-record-serialization-services-nar/1.5.0/org.apache.nifi.csv.CSVReader/index.html">CSVReader</a><br/><a href="../../../nifi-scripting-nar/1.5.0/org.apache.nifi.record.script.ScriptedReader/index.html">ScriptedReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.5.0/org.apache.nifi.grok.GrokReader/index.html">GrokReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.5.0/org.apache.nifi.json.JsonTreeReader/index.html">JsonTreeReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.5.0/org.apache.nifi.avro.AvroReader/index.html">AvroReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.5 .0/org.apache.nifi.json.JsonPathReader/index.html">JsonPathReader</a></td><td id="description">Specifies the Controller Service to use for parsing incoming data and determining the data's schema</td></tr><tr><td id="name"><strong>Insert Batch Size</strong></td><td id="default-value">100</td><td id="allowable-values"></td><td id="description">The number of records to group together for one single insert operation against MongoDB.</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 component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </ h3>This component requires an incoming relationship.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mongodb-services-nar/1.5.0/org.apache.nifi.mongodb.MongoDBControllerService/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mongodb-services-nar/1.5.0/org.apache.nifi.mongodb.MongoDBControllerService/index.html?rev=1821033&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mongodb-services-nar/1.5.0/org.apache.nifi.mongodb.MongoDBControllerService/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mongodb-services-nar/1.5.0/org.apache.nifi.mongodb.MongoDBControllerService/index.html Fri Jan 12 21:00:14 2018 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>MongoDBControllerService</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">MongoDBControllerService</h1><h2>Description: </h2><p>Provides a controller service that wraps most of the functionality of the MongoDB driver.</p><h3>Tags: </h3><p>mongo, mongodb, service</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>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],...]<br/><strong>Supports Expression Language: true</strong></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<br/><strong>Supports Expression Language: true</strong></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<br/><strong>Supports Expression Language: true</strong></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>Implementations: </stro ng><a href="../../../nifi-ssl-context-service-nar/1.5.0/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a><br/><a href="../../../nifi-ssl-context-service-nar/1.5.0/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</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>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mongodb-services-nar/1.5.0/org.apache.nifi.mongodb.MongoDBLookupService/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mongodb-services-nar/1.5.0/org.apache.nifi.mongodb.MongoDBLookupService/index.html?rev=1821033&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mongodb-services-nar/1.5.0/org.apache.nifi.mongodb.MongoDBLookupService/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mongodb-services-nar/1.5.0/org.apache.nifi.mongodb.MongoDBLookupService/index.html Fri Jan 12 21:00:14 2018 @@ -0,0 +1,4 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>MongoDBLookupService</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">MongoDBLookupService</h1><h2>Description: </h2><p>Provides a lookup service based around MongoDB. Each key that is specified +will be added to a query as-is. For example, if you specify the two keys, +user and email, the resulting query will be { "user": "tester", "email": "[email protected]" }. +The query is limited to the first result (findOne in the Mongo documentation). If no "Lookup Value Field" is specified then the entire MongoDB result document minus the _id field will be returned as a record.</p><h3>Tags: </h3><p>mongo, mongodb, lookup, record</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>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],...]<br/><strong>Supports Expression Language: true</strong></td></tr><tr><t d 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<br/><strong>Supports Expression Language: true</strong></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<br/><strong>Supports Expression Language: true</strong></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>Implementations: </strong><a href="../../../nifi-ssl-context-service-nar/1.5.0/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a><br/><a href="../../../nifi-ssl-context-service-nar/1.5.0/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</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">Lookup Value Field</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The field whose value will be returned when the lookup key(s) match a record. If not specified then the entire MongoDB result document minus the _id field will be returned as a record.</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mqtt-nar/1.5.0/org.apache.nifi.processors.mqtt.ConsumeMQTT/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mqtt-nar/1.5.0/org.apache.nifi.processors.mqtt.ConsumeMQTT/index.html?rev=1821033&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mqtt-nar/1.5.0/org.apache.nifi.processors.mqtt.ConsumeMQTT/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mqtt-nar/1.5.0/org.apache.nifi.processors.mqtt.ConsumeMQTT/index.html Fri Jan 12 21:00:14 2018 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ConsumeMQTT</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">ConsumeMQTT</h1><h2>Description: </h2><p>Subscribes to a topic and receives messages from an MQTT broker</p><h3>Tags: </h3><p>subscribe, MQTT, IOT, consume, listen</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>Broker URI</strong></td><td id="default-value"></td><td id="allowable-values"></td>< td id="description">The URI to use to connect to the MQTT broker (e.g. tcp://localhost:1883). The 'tcp' and 'ssl' schemes are supported. In order to use 'ssl', the SSL Context Service property must be set.</td></tr><tr><td id="name"><strong>Client ID</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">MQTT client ID to use</td></tr><tr><td id="name">Username</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Username to use when connecting to the broker</td></tr><tr><td id="name">Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Password to use when connecting to the broker</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>Implementations: </strong><a href="../../../nifi-ssl-context-service-nar/1.5.0/org.apache.nifi.ssl.StandardSSLContextS ervice/index.html">StandardSSLContextService</a><br/><a href="../../../nifi-ssl-context-service-nar/1.5.0/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</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">Last Will Topic</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The topic to send the client's Last Will to. If the Last Will topic and message are not set then a Last Will will not be sent.</td></tr><tr><td id="name">Last Will Message</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The message to send as the client's Last Will. If the Last Will topic and message are not set then a Last Will will not be sent.</td></tr><tr><td id="name">Last Will Retain</td><td id="default-value"></td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id= "description">Whether to retain the client's Last Will. If the Last Will topic and message are not set then a Last Will will not be sent.</td></tr><tr><td id="name">Last Will QoS Level</td><td id="default-value"></td><td id="allowable-values"><ul><li>0 - At most once <img src="../../../../../html/images/iconInfo.png" alt="Best effort delivery. A message wonât be acknowledged by the receiver or stored and redelivered by the sender. This is often called âfire and forgetâ and provides the same guarantee as the underlying TCP protocol." title="Best effort delivery. A message wonât be acknowledged by the receiver or stored and redelivered by the sender. This is often called âfire and forgetâ and provides the same guarantee as the underlying TCP protocol."></img></li><li>1 - At least once <img src="../../../../../html/images/iconInfo.png" alt="Guarantees that a message will be delivered at least once to the receiver. The message can also be delivered more tha n once" title="Guarantees that a message will be delivered at least once to the receiver. The message can also be delivered more than once"></img></li><li>2 - Exactly once <img src="../../../../../html/images/iconInfo.png" alt="Guarantees that each message is received only once by the counterpart. It is the safest and also the slowest quality of service level. The guarantee is provided by two round-trip flows between sender and receiver." title="Guarantees that each message is received only once by the counterpart. It is the safest and also the slowest quality of service level. The guarantee is provided by two round-trip flows between sender and receiver."></img></li></ul></td><td id="description">QoS level to be used when publishing the Last Will Message</td></tr><tr><td id="name"><strong>Session state</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>Clean Session <img src="../../../../../html/images/iconInfo.png" alt="Client and Server discard any pre vious session and start a new one. This session lasts as long as the network connection. State data associated with this session is not reused in any subsequent session" title="Client and Server discard any previous session and start a new one. This session lasts as long as the network connection. State data associated with this session is not reused in any subsequent session"></img></li><li>Resume Session <img src="../../../../../html/images/iconInfo.png" alt="Server resumes communications with the client based on state from the current session (as identified by the ClientID). The client and server store the session after the client and server are disconnected. After the disconnection of a session that was not a clean session, the server stores further QoS 1 and QoS 2 messages that match any subscriptions that the client had at the time of disconnection as part of the session state" title="Server resumes communications with the client based on state from the current session (as ide ntified by the ClientID). The client and server store the session after the client and server are disconnected. After the disconnection of a session that was not a clean session, the server stores further QoS 1 and QoS 2 messages that match any subscriptions that the client had at the time of disconnection as part of the session state"></img></li></ul></td><td id="description">Whether to start afresh or resume previous flows. See the allowable value descriptions for more details.</td></tr><tr><td id="name"><strong>MQTT Specification Version</strong></td><td id="default-value">0</td><td id="allowable-values"><ul><li>AUTO <img src="../../../../../html/images/iconInfo.png" alt="Start with v3.1.1 and fallback to v3.1.0 if not supported by a broker" title="Start with v3.1.1 and fallback to v3.1.0 if not supported by a broker"></img></li><li>v3.1.1</li><li>v3.1.0</li></ul></td><td id="description">The MQTT specification version when connecting with the broker. See the allowable value desc riptions for more details.</td></tr><tr><td id="name">Connection Timeout (seconds)</td><td id="default-value">30</td><td id="allowable-values"></td><td id="description">Maximum time interval the client will wait for the network connection to the MQTT server to be established. The default timeout is 30 seconds. A value of 0 disables timeout processing meaning the client will wait until the network connection is made successfully or fails.</td></tr><tr><td id="name">Keep Alive Interval (seconds)</td><td id="default-value">60</td><td id="allowable-values"></td><td id="description">Defines the maximum time interval between messages sent or received. It enables the client to detect if the server is no longer available, without having to wait for the TCP/IP timeout. The client will ensure that at least one message travels across the network within each keep alive period. In the absence of a data-related message during the time period, the client sends a very small "ping" message, which th e server will acknowledge. A value of 0 disables keepalive processing in the client.</td></tr><tr><td id="name"><strong>Topic Filter</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The MQTT topic filter to designate the topics to subscribe to.</td></tr><tr><td id="name"><strong>Quality of Service(QoS)</strong></td><td id="default-value">0</td><td id="allowable-values"><ul><li>0 - At most once <img src="../../../../../html/images/iconInfo.png" alt="Best effort delivery. A message wonât be acknowledged by the receiver or stored and redelivered by the sender. This is often called âfire and forgetâ and provides the same guarantee as the underlying TCP protocol." title="Best effort delivery. A message wonât be acknowledged by the receiver or stored and redelivered by the sender. This is often called âfire and forgetâ and provides the same guarantee as the underlying TCP protocol."></img></li><li>1 - At least once <img src="../../../../../html/images/iconInfo.png" alt="Guarantees that a message will be delivered at least once to the receiver. The message can also be delivered more than once" title="Guarantees that a message will be delivered at least once to the receiver. The message can also be delivered more than once"></img></li><li>2 - Exactly once <img src="../../../../../html/images/iconInfo.png" alt="Guarantees that each message is received only once by the counterpart. It is the safest and also the slowest quality of service level. The guarantee is provided by two round-trip flows between sender and receiver." title="Guarantees that each message is received only once by the counterpart. It is the safest and also the slowest quality of service level. The guarantee is provided by two round-trip flows between sender and receiver."></img></li></ul></td><td id="description">The Quality of Service(QoS) to receive the message with. Accepts values '0', '1' or '2'; '0' for 'at most once', '1' for 'at least once', '2' for 'exactly once'.</td></tr><tr><td id="name"><strong>Max Queue Size</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The MQTT messages are always being sent to subscribers on a topic. If the 'Run Schedule' is significantly behind the rate at which the messages are arriving to this processor then a back up can occur. This property specifies the maximum number of messages this processor will hold in memory at one time.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>Message</td><td>The MQTT message output</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>mqtt.broker</td><td>MQTT broker that was the message source</td></tr><tr><td>mqtt.topic</td><td>MQTT topic on which message was received</td></tr><tr><td>mqtt.qos</td><td>The qualit y of service for this message.</td></tr><tr><td>mqtt.isDuplicate</td><td>Whether or not this message might be a duplicate of one which has already been received.</td></tr><tr><td>mqtt.isRetained</td><td>Whether or not this message was from a current publisher, or was "retained" by the server as the last message published on the topic.</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component does not allow an incoming relationship.<h3>See Also:</h3><p><a href="../org.apache.nifi.processors.mqtt.PublishMQTT/index.html">PublishMQTT</a></p></body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mqtt-nar/1.5.0/org.apache.nifi.processors.mqtt.PublishMQTT/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mqtt-nar/1.5.0/org.apache.nifi.processors.mqtt.PublishMQTT/index.html?rev=1821033&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mqtt-nar/1.5.0/org.apache.nifi.processors.mqtt.PublishMQTT/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mqtt-nar/1.5.0/org.apache.nifi.processors.mqtt.PublishMQTT/index.html Fri Jan 12 21:00:14 2018 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PublishMQTT</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">PublishMQTT</h1><h2>Description: </h2><p>Publishes a message to an MQTT topic</p><h3>Tags: </h3><p>publish, MQTT, IOT</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>Bro ker URI</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The URI to use to connect to the MQTT broker (e.g. tcp://localhost:1883). The 'tcp' and 'ssl' schemes are supported. In order to use 'ssl', the SSL Context Service property must be set.</td></tr><tr><td id="name"><strong>Client ID</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">MQTT client ID to use</td></tr><tr><td id="name">Username</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Username to use when connecting to the broker</td></tr><tr><td id="name">Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Password to use when connecting to the broker</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>Implementations: </strong><a href=".. /../../nifi-ssl-context-service-nar/1.5.0/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a><br/><a href="../../../nifi-ssl-context-service-nar/1.5.0/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</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">Last Will Topic</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The topic to send the client's Last Will to. If the Last Will topic and message are not set then a Last Will will not be sent.</td></tr><tr><td id="name">Last Will Message</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The message to send as the client's Last Will. If the Last Will topic and message are not set then a Last Will will not be sent.</td></tr><tr><td id="name">Last Will Retain</td><td id="default-value "></td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Whether to retain the client's Last Will. If the Last Will topic and message are not set then a Last Will will not be sent.</td></tr><tr><td id="name">Last Will QoS Level</td><td id="default-value"></td><td id="allowable-values"><ul><li>0 - At most once <img src="../../../../../html/images/iconInfo.png" alt="Best effort delivery. A message wonât be acknowledged by the receiver or stored and redelivered by the sender. This is often called âfire and forgetâ and provides the same guarantee as the underlying TCP protocol." title="Best effort delivery. A message wonât be acknowledged by the receiver or stored and redelivered by the sender. This is often called âfire and forgetâ and provides the same guarantee as the underlying TCP protocol."></img></li><li>1 - At least once <img src="../../../../../html/images/iconInfo.png" alt="Guarantees that a message will be de livered at least once to the receiver. The message can also be delivered more than once" title="Guarantees that a message will be delivered at least once to the receiver. The message can also be delivered more than once"></img></li><li>2 - Exactly once <img src="../../../../../html/images/iconInfo.png" alt="Guarantees that each message is received only once by the counterpart. It is the safest and also the slowest quality of service level. The guarantee is provided by two round-trip flows between sender and receiver." title="Guarantees that each message is received only once by the counterpart. It is the safest and also the slowest quality of service level. The guarantee is provided by two round-trip flows between sender and receiver."></img></li></ul></td><td id="description">QoS level to be used when publishing the Last Will Message</td></tr><tr><td id="name"><strong>Session state</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>Clean Session <img src ="../../../../../html/images/iconInfo.png" alt="Client and Server discard any previous session and start a new one. This session lasts as long as the network connection. State data associated with this session is not reused in any subsequent session" title="Client and Server discard any previous session and start a new one. This session lasts as long as the network connection. State data associated with this session is not reused in any subsequent session"></img></li><li>Resume Session <img src="../../../../../html/images/iconInfo.png" alt="Server resumes communications with the client based on state from the current session (as identified by the ClientID). The client and server store the session after the client and server are disconnected. After the disconnection of a session that was not a clean session, the server stores further QoS 1 and QoS 2 messages that match any subscriptions that the client had at the time of disconnection as part of the session state" title="Server resum es communications with the client based on state from the current session (as identified by the ClientID). The client and server store the session after the client and server are disconnected. After the disconnection of a session that was not a clean session, the server stores further QoS 1 and QoS 2 messages that match any subscriptions that the client had at the time of disconnection as part of the session state"></img></li></ul></td><td id="description">Whether to start afresh or resume previous flows. See the allowable value descriptions for more details.</td></tr><tr><td id="name"><strong>MQTT Specification Version</strong></td><td id="default-value">0</td><td id="allowable-values"><ul><li>AUTO <img src="../../../../../html/images/iconInfo.png" alt="Start with v3.1.1 and fallback to v3.1.0 if not supported by a broker" title="Start with v3.1.1 and fallback to v3.1.0 if not supported by a broker"></img></li><li>v3.1.1</li><li>v3.1.0</li></ul></td><td id="description">The MQTT sp ecification version when connecting with the broker. See the allowable value descriptions for more details.</td></tr><tr><td id="name">Connection Timeout (seconds)</td><td id="default-value">30</td><td id="allowable-values"></td><td id="description">Maximum time interval the client will wait for the network connection to the MQTT server to be established. The default timeout is 30 seconds. A value of 0 disables timeout processing meaning the client will wait until the network connection is made successfully or fails.</td></tr><tr><td id="name">Keep Alive Interval (seconds)</td><td id="default-value">60</td><td id="allowable-values"></td><td id="description">Defines the maximum time interval between messages sent or received. It enables the client to detect if the server is no longer available, without having to wait for the TCP/IP timeout. The client will ensure that at least one message travels across the network within each keep alive period. In the absence of a data-related messa ge during the time period, the client sends a very small "ping" message, which the server will acknowledge. A value of 0 disables keepalive processing in the client.</td></tr><tr><td id="name"><strong>Topic</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The topic to publish the message to.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Quality of Service(QoS)</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The Quality of Service(QoS) to send the message with. Accepts three values '0', '1' and '2'; '0' for 'at most once', '1' for 'at least once', '2' for 'exactly once'. Expression language is allowed in order to support publishing messages with different QoS but the end value of the property must be either '0', '1' or '2'. <br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Retain Message</strong></td><td id="de fault-value"></td><td id="allowable-values"></td><td id="description">Whether or not the retain flag should be set on the MQTT message.<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>FlowFiles that are sent successfully to the destination are transferred to this relationship.</td></tr><tr><td>failure</td><td>FlowFiles that failed to send to the destination are transferred to this relationship.</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.<h3>See Also:</h3><p><a href="../org.apache.nifi.processors.mqtt.ConsumeMQTT/index.html">ConsumeMQTT</a></p></body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-parquet-nar/1.5.0/org.apache.nifi.processors.parquet.FetchParquet/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-parquet-nar/1.5.0/org.apache.nifi.processors.parquet.FetchParquet/index.html?rev=1821033&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-parquet-nar/1.5.0/org.apache.nifi.processors.parquet.FetchParquet/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-parquet-nar/1.5.0/org.apache.nifi.processors.parquet.FetchParquet/index.html Fri Jan 12 21:00:14 2018 @@ -0,0 +1,3 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>FetchParquet</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">FetchParquet</h1><h2>Description: </h2><p>Reads from a given Parquet file and writes records to the content of the flow file using the selected record writer. The original Parquet file will remain unchanged, and the content of the flow file will be replaced with records of the selected type. This processor can be used with ListHDFS or ListFile to obtain a listing of files to fetch.</p><h3>Tags: </h3><p>parquet, hadoop, HDFS, get, ingest, fetch, source, restricted, record</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other propert ies (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 Resources</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A file or comma separated list of files which contains the Hadoop file system configuration. Without this, Hadoop will search the classpath for a 'core-site.xml' and 'hdfs-site.xml' file or will revert to a default configuration. To use swebhdfs, see 'Additional Details' section of PutHDFS's documentation.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Kerberos Principal</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Kerberos principal to authenticate as. R equires nifi.kerberos.krb5.file to be set in your nifi.properties<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Kerberos Keytab</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Kerberos keytab associated with the principal. Requires nifi.kerberos.krb5.file to be set in your nifi.properties<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Kerberos Relogin Period</td><td id="default-value">4 hours</td><td id="allowable-values"></td><td id="description">Period of time which should pass before attempting a kerberos relogin. + +This property has been deprecated, and has no effect on processing. Relogins now occur automatically.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Additional Classpath Resources</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A comma-separated list of paths to files and/or directories that will be added to the classpath. When specifying a directory, all files with in the directory will be added to the classpath, but further sub-directories will not be included.</td></tr><tr><td id="name"><strong>Filename</strong></td><td id="default-value">${path}/${filename}</td><td id="allowable-values"></td><td id="description">The name of the file to retrieve<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Record Writer</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>RecordSetWriterFactory<br/><strong>Implementations : </strong><a href="../../../nifi-record-serialization-services-nar/1.5.0/org.apache.nifi.text.FreeFormTextRecordSetWriter/index.html">FreeFormTextRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.5.0/org.apache.nifi.csv.CSVRecordSetWriter/index.html">CSVRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.5.0/org.apache.nifi.avro.AvroRecordSetWriter/index.html">AvroRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.5.0/org.apache.nifi.json.JsonRecordSetWriter/index.html">JsonRecordSetWriter</a><br/><a href="../../../nifi-scripting-nar/1.5.0/org.apache.nifi.record.script.ScriptedRecordSetWriter/index.html">ScriptedRecordSetWriter</a></td><td id="description">The service for writing records to the FlowFile content</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>retry</td><td>FlowFiles will be routed to this relationship if the content of the file cannot be retrieved, but might be able to be in the future if tried again. This generally indicates that the Fetch should be tried again.</td></tr><tr><td>success</td><td>FlowFiles will be routed to this relationship once they have been updated with the content of the file</td></tr><tr><td>failure</td><td>FlowFiles will be routed to this relationship if the content of the file cannot be retrieved and trying again will likely not be helpful. This would occur, for instance, if the file is not found or if there is a permissions issue</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>fetch.failure.reason</td><td>When a FlowFile is routed to 'failure', this attribute is added indicating why the file could not be fetched from the given filesystem.</td></tr><tr><td>record.count</td><td>The number of records in the resulting flow file</td></tr></table ><h3>State management: </h3>This component does not store >state.<h3>Restricted: </h3>Provides operator the ability to retrieve any file >that NiFi has access to in HDFS or the local filesystem.<h3>Input >requirement: </h3>This component requires an incoming relationship.<h3>See >Also:</h3><p><a >href="../org.apache.nifi.processors.parquet.PutParquet/index.html">PutParquet</a></p></body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-parquet-nar/1.5.0/org.apache.nifi.processors.parquet.PutParquet/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-parquet-nar/1.5.0/org.apache.nifi.processors.parquet.PutParquet/index.html?rev=1821033&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-parquet-nar/1.5.0/org.apache.nifi.processors.parquet.PutParquet/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-parquet-nar/1.5.0/org.apache.nifi.processors.parquet.PutParquet/index.html Fri Jan 12 21:00:14 2018 @@ -0,0 +1,3 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutParquet</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">PutParquet</h1><h2>Description: </h2><p>Reads records from an incoming FlowFile using the provided Record Reader, and writes those records to a Parquet file. The schema for the Parquet file must be provided in the processor properties. This processor will first write a temporary dot file and upon successfully writing every record to the dot file, it will rename the dot file to it's final name. If the dot file cannot be renamed, the rename operation will be attempted up to 10 times, and if still not successful, the dot file will be deleted and the flow file will be routed to failure. If any error occ urs while reading records from the input, or writing records to the output, the entire dot file will be removed and the flow file will be routed to failure or retry, depending on the error.</p><h3>Tags: </h3><p>put, parquet, hadoop, HDFS, filesystem, restricted, record</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 Resources</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A file or comma separated list of files which contains the Hadoop file system configuration. Without this, Hadoop will search the class path for a 'core-site.xml' and 'hdfs-site.xml' file or will revert to a default configuration. To use swebhdfs, see 'Additional Details' section of PutHDFS's documentation.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Kerberos Principal</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Kerberos principal to authenticate as. Requires nifi.kerberos.krb5.file to be set in your nifi.properties<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Kerberos Keytab</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Kerberos keytab associated with the principal. Requires nifi.kerberos.krb5.file to be set in your nifi.properties<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Kerberos Relogin Period</td><td id="default-value">4 hours</td><td id="allowable-values"></td><td id="description">Period of time which should pass befo re attempting a kerberos relogin. + +This property has been deprecated, and has no effect on processing. Relogins now occur automatically.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Additional Classpath Resources</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A comma-separated list of paths to files and/or directories that will be added to the classpath. When specifying a directory, all files with in the directory will be added to the classpath, but further sub-directories will not be included.</td></tr><tr><td id="name"><strong>Record Reader</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>RecordReaderFactory<br/><strong>Implementations: </strong><a href="../../../nifi-record-serialization-services-nar/1.5.0/org.apache.nifi.csv.CSVReader/index.html">CSVReader</a><br/><a href="../../../nifi-scripting-nar/1.5.0/org.apache.nifi.record.script.ScriptedReader/index.html">ScriptedReader </a><br/><a href="../../../nifi-record-serialization-services-nar/1.5.0/org.apache.nifi.grok.GrokReader/index.html">GrokReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.5.0/org.apache.nifi.json.JsonTreeReader/index.html">JsonTreeReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.5.0/org.apache.nifi.avro.AvroReader/index.html">AvroReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.5.0/org.apache.nifi.json.JsonPathReader/index.html">JsonPathReader</a></td><td id="description">The service for reading records from incoming flow files.</td></tr><tr><td id="name"><strong>Directory</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The parent directory to which files should be written. Will be created if it doesn't exist.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Compression Type</strong></td><td id="default-value">UNCOMPRESSED</t d><td id="allowable-values"><ul><li>UNCOMPRESSED</li><li>SNAPPY</li><li>GZIP</li><li>LZO</li></ul></td><td id="description">The type of compression for the file being written.</td></tr><tr><td id="name"><strong>Overwrite Files</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Whether or not to overwrite existing files in the same directory with the same name. When set to false, flow files will be routed to failure when a file exists in the same directory with the same name.</td></tr><tr><td id="name">Permissions umask</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A umask represented as an octal number which determines the permissions of files written to HDFS. This overrides the Hadoop Configuration dfs.umaskmode</td></tr><tr><td id="name">Remote Group</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Changes the group of the HDFS file to this value after it is written. This only works if NiFi is running as a user that has HDFS super user privilege to change group</td></tr><tr><td id="name">Remote Owner</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Changes the owner of the HDFS file to this value after it is written. This only works if NiFi is running as a user that has HDFS super user privilege to change owner</td></tr><tr><td id="name">Row Group Size</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The row group size used by the Parquet writer. The value is specified in the format of <Data Size> <Data Unit> where Data Unit is one of B, KB, MB, GB, TB.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Page Size</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The page size used by the Parquet writer. The value is specified in the format of <Data Size> <Data Unit> where Data Unit is one of B, KB, MB, GB, TB.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Dictionary Page Size</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The dictionary page size used by the Parquet writer. The value is specified in the format of <Data Size> <Data Unit> where Data Unit is one of B, KB, MB, GB, TB.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Max Padding Size</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The maximum amount of padding that will be used to align row groups with blocks in the underlying filesystem. If the underlying filesystem is not a block filesystem like HDFS, this has no effect. The value is specified in the format of <Data Size> <Data Unit> where Data Unit is one of B, KB, MB, GB, TB.<br/><strong>Supports Expression Language: true</strong></td></tr><tr>< td id="name">Enable Dictionary Encoding</td><td id="default-value"></td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Specifies whether dictionary encoding should be enabled for the Parquet writer</td></tr><tr><td id="name">Enable Validation</td><td id="default-value"></td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Specifies whether validation should be enabled for the Parquet writer</td></tr><tr><td id="name">Writer Version</td><td id="default-value"></td><td id="allowable-values"><ul><li>PARQUET_1_0</li><li>PARQUET_2_0</li></ul></td><td id="description">Specifies the version used by Parquet writer</td></tr><tr><td id="name">Remove CRC Files</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 the corresponding CRC file should be deleted upon successfully writing a Parquet file</td></tr></table><h3>Relations hips: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>retry</td><td>Flow Files that could not be processed due to issues that can be retried are transferred to this relationship</td></tr><tr><td>success</td><td>Flow Files that have been successfully processed are transferred to this relationship</td></tr><tr><td>failure</td><td>Flow Files that could not be processed due to issue that cannot be retried are transferred to this relationship</td></tr></table><h3>Reads Attributes: </h3><table id="reads-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>filename</td><td>The name of the file to write comes from the value of this attribute.</td></tr></table><h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>filename</td><td>The name of the file is stored in this attribute.</td></tr><tr><td>absolute.hdfs.path</td><td>The absolute path to the file is stored in this attribute.</td></tr><tr><td> record.count</td><td>The number of records written to the Parquet file</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>Provides operator the ability to write to any file that NiFi has access to in HDFS or the local filesystem.<h3>Input requirement: </h3>This component requires an incoming relationship.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-poi-nar/1.5.0/org.apache.nifi.processors.poi.ConvertExcelToCSVProcessor/additionalDetails.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-poi-nar/1.5.0/org.apache.nifi.processors.poi.ConvertExcelToCSVProcessor/additionalDetails.html?rev=1821033&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-poi-nar/1.5.0/org.apache.nifi.processors.poi.ConvertExcelToCSVProcessor/additionalDetails.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-poi-nar/1.5.0/org.apache.nifi.processors.poi.ConvertExcelToCSVProcessor/additionalDetails.html Fri Jan 12 21:00:14 2018 @@ -0,0 +1,97 @@ +<!DOCTYPE html> +<html lang="en"> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + http://www.apache.org/licenses/LICENSE-2.0 + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<head> + <meta charset="utf-8" /> + <title>ConvertExcelToCSVProcessor</title> + <style> +table { + border-collapse: collapse; +} + +table, th, td { + border: 1px solid #ccc; +} + +td.r { + text-align: right; +} + +td { + width: 50px; + padding: 5px; +} + </style> + <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css" /> +</head> + +<body> +<h2>How it extracts CSV data from a sheet</h2> +<p> + ConvertExcelToCSVProcessor extracts CSV data with following rules: +</p> +<ul> + <li>Find the fist cell which has a value in it (the FirstCell).</li> + <li>Scan cells in the first row, starting from the FirstCell, + until it reaches to a cell after which no cell with a value can not be found in the row (the FirstRowLastCell).</li> + <li>Process the 2nd row and later, from the column of FirstCell to the column of FirstRowLastCell.</li> + <li>If a row does not have any cell that has a value, then the row is ignored.</li> +</ul> + +<p> + As an example, the sheet shown below will be: +</p> + +<table> + <tbody> + <tr><th>row </th><th>A</th><th>B</th><th>C</th><th>D</th><th>E</th><th>F</th><th>G</th></tr> + <tr><td class="r"> 1</td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td></tr> + <tr><td class="r"> 2</td><td> </td><td> </td><td>x</td><td>y</td><td>z</td><td> </td><td> </td></tr> + <tr><td class="r"> 3</td><td> </td><td> </td><td>1</td><td> </td><td> </td><td> </td><td> </td></tr> + <tr><td class="r"> 4</td><td>2</td><td> </td><td> </td><td>3</td><td> </td><td> </td><td> </td></tr> + <tr><td class="r"> 5</td><td> </td><td> </td><td> </td><td> </td><td>4</td><td> </td><td> </td></tr> + <tr><td class="r"> 6</td><td> </td><td> </td><td>5</td><td>6</td><td>7</td><td> </td><td> </td></tr> + <tr><td class="r"> 7</td><td> </td><td> </td><td> </td><td> </td><td> </td><td>8</td><td> </td></tr> + <tr><td class="r"> 8</td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td></tr> + <tr><td class="r"> 9</td><td> </td><td> </td><td> </td><td> </td><td>9</td><td> </td><td> </td></tr> + <tr><td class="r"> 10</td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td></tr> + <tr><td class="r"> 11</td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td><td> </td></tr> + </tbody> +</table> + +<p> + converted to following CSV: +</p> + +<pre> +x,y,z +1,, +,3, +,,4 +5,6,7 +,,9 +</pre> + +<ul> + <li>C2(x) is the FirstCell, and E2(z) is the FirstRowLastCell.</li> + <li>A4(2) is ignored because it is out of range. So is F7(8).</li> + <li>Row 7 and 8 are ignored because those do not have a valid cell.</li> + <li>It is important to have a header row as shown in the example to define data area, + especially when a sheet includes empty cells.</li> +</ul> + +</body> +</html> \ No newline at end of file
