Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-restapi-nar/1.7.1/org.apache.nifi.processors.elasticsearch.DeleteByQueryElasticsearch/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-restapi-nar/1.7.1/org.apache.nifi.processors.elasticsearch.DeleteByQueryElasticsearch/index.html?rev=1836075&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-restapi-nar/1.7.1/org.apache.nifi.processors.elasticsearch.DeleteByQueryElasticsearch/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-restapi-nar/1.7.1/org.apache.nifi.processors.elasticsearch.DeleteByQueryElasticsearch/index.html Tue Jul 17 01:35:38 2018 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>DeleteByQueryElasticsearch</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;">DeleteByQueryElasticsearch</h1><h2>Description: </h2><p>Delete from an ElasticSearch index using a query. The query can be loaded from a flowfile body or from the Query parameter.</p><h3>Tags: </h3><p>elastic, elasticsearch, delete, query</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><tabl e id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name">Query</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A query in JSON syntax, not Lucene syntax. Ex: {"query":{"match":{"somefield":"somevalue"}}}. If this parameter is not set, the query will be read from the flowfile content.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Query Attribute</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">If set, the executed query will be set on each result flowfile in the specified attribute.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Index</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The na me of the index to use.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Type</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The type of this document (used by Elasticsearch for indexing and searching)<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Client Service</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>ElasticSearchClientService<br/><strong>Implementation: </strong><a href="../../../nifi-elasticsearch-client-service-nar/1.7.1/org.apache.nifi.elasticsearch.ElasticSearchClientServiceImpl/index.html">ElasticSearchClientServiceImpl</a></td><td id="description">An ElasticSearch client service to use for running queries.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>If the delete by query succeeds, and a flowfile was read, it will be sent to this relationship.</td></tr><tr><td>failure</td><td>If the delete by query fails, and a flowfile was read, it will be sent to this relationship.</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>elasticsearch.delete.took</td><td>The amount of time that it took to complete the delete operation in ms.</td></tr><tr><td>elasticsearch.delete.error</td><td>The error message provided by ElasticSearch if there is an error running the delete.</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 allows an incoming relationship.<h3>System Resource Considerations:</h3>None specified.</body></html> \ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-restapi-nar/1.7.1/org.apache.nifi.processors.elasticsearch.JsonQueryElasticsearch/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-restapi-nar/1.7.1/org.apache.nifi.processors.elasticsearch.JsonQueryElasticsearch/index.html?rev=1836075&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-restapi-nar/1.7.1/org.apache.nifi.processors.elasticsearch.JsonQueryElasticsearch/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-restapi-nar/1.7.1/org.apache.nifi.processors.elasticsearch.JsonQueryElasticsearch/index.html Tue Jul 17 01:35:38 2018 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>JsonQueryElasticsearch</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;">JsonQueryElasticsearch</h1><h2>Description: </h2><p>A processor that allows the user to run a query (with aggregations) written with the ElasticSearch JSON DSL. It does not automatically paginate queries for the user. If an incoming relationship is added to this processor, it will use the flowfile's content for the query. Care should be taken on the size of the query because the entire response from ElasticSearch will be loaded into memory all at once and converted into the resulting flowfiles.</p><h3>Tags: </h3><p>elasticsearch, elasticsearch 5, query, read, get, 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">Query</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A query in JSON syntax, not Lucene syntax. Ex: {"query":{"match":{"somefield":"somevalue"}}}. If this parameter is not set, the query will be read from the flowfile content.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Query Attribute</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">If set, the executed qu ery will be set on each result flowfile in the specified attribute.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Index</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the index to use.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Type</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The type of this document (used by Elasticsearch for indexing and searching)<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Client Service</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>ElasticSearchClientService<br/><st rong>Implementation: </strong><a href="../../../nifi-elasticsearch-client-service-nar/1.7.1/org.apache.nifi.elasticsearch.ElasticSearchClientServiceImpl/index.html">ElasticSearchClientServiceImpl</a></td><td id="description">An ElasticSearch client service to use for running queries.</td></tr><tr><td id="name"><strong>Split up search results</strong></td><td id="default-value">splitUp-no</td><td id="allowable-values"><ul><li>No <img src="../../../../../html/images/iconInfo.png" alt="Don't split up results." title="Don't split up results."></img></li><li>Yes <img src="../../../../../html/images/iconInfo.png" alt="Split up results." title="Split up results."></img></li></ul></td><td id="description">Split up search results into one flowfile per result.</td></tr><tr><td id="name"><strong>Split up aggregation results</strong></td><td id="default-value">splitUp-no</td><td id="allowable-values"><ul><li>No <img src="../../../../../html/images/iconInfo.png" alt="Don't split up results." tit le="Don't split up results."></img></li><li>Yes <img src="../../../../../html/images/iconInfo.png" alt="Split up results." title="Split up results."></img></li></ul></td><td id="description">Split up aggregation results into one flowfile per result.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>aggregations</td><td>Aggregations are routed to this relationship.</td></tr><tr><td>failure</td><td>All FlowFiles that cannot be read from Elasticsearch are routed to this relationship</td></tr><tr><td>original</td><td>All original flowfiles that don't cause an error to occur go to this relationship. This applies even if you select the "split up hits" option to send individual hits to the "hits" relationship.</td></tr><tr><td>hits</td><td>Search hits are routed to this relationship.</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Desc ription</th></tr><tr><td>mime.type</td><td>application/json</td></tr><tr><td>aggregation.name</td><td>The name of the aggregation whose results are in the output flowfile</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 allows an incoming relationship.<h3>System Resource Considerations:</h3>None specified.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-email-nar/1.7.1/org.apache.nifi.processors.email.ConsumeEWS/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-email-nar/1.7.1/org.apache.nifi.processors.email.ConsumeEWS/index.html?rev=1836075&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-email-nar/1.7.1/org.apache.nifi.processors.email.ConsumeEWS/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-email-nar/1.7.1/org.apache.nifi.processors.email.ConsumeEWS/index.html Tue Jul 17 01:35:38 2018 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ConsumeEWS</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;">ConsumeEWS</h1><h2>Description: </h2><p>Consumes messages from Microsoft Exchange using Exchange Web Services. The raw-bytes of each received email message are written as contents of the FlowFile</p><h3>Tags: </h3><p>Email, EWS, Exchange, Get, Ingest, Ingress, Message, Consume</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, whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Lan guage</a>, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props.key</strong>.</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>User Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">User Name used for authentication and authorization with Email server.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Password</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Password used for authentication and authorization with Email server.<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: tru e (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Folder</strong></td><td id="default-value">INBOX</td><td id="allowable-values"></td><td id="description">Email folder to retrieve messages from (e.g., INBOX)<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Fetch Size</strong></td><td id="default-value">10</td><td id="allowable-values"></td><td id="description">Specify the maximum number of Messages to fetch per call to Email Server.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Delete Messages</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Specify whether mail messages should be deleted after retrieval.</td></tr><tr><td id="name"><strong>Connection timeout</strong></td><t d id="default-value">30 sec</td><td id="allowable-values"></td><td id="description">The amount of time to wait to connect to Email server<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Exchange Version</strong></td><td id="default-value">Exchange2010_SP2</td><td id="allowable-values"><ul><li>Exchange2007_SP1</li><li>Exchange2010</li><li>Exchange2010_SP1</li><li>Exchange2010_SP2</li></ul></td><td id="description">What version of Exchange Server the server is running.</td></tr><tr><td id="name">EWS URL</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">URL of the EWS Endpoint. Required if Autodiscover is false.</td></tr><tr><td id="name"><strong>Auto Discover URL</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Whether or not to use the Exchange email address to Autodiscover the EWS endpoint URL.</td></tr><tr><td id="name"><strong>Mark Messages as Read</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Specify if messages should be marked as read after retrieval.</td></tr><tr><td id="name">Original Headers to Include</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Comma delimited list specifying which headers from the original message to include in the exported email message. Blank means copy all headers. Some headers can cause problems with message parsing, specifically the 'Content-Type' header.</td></tr><tr><td id="name">Original Headers to Exclude</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Comma delimited list specifying which headers from the original message to exclude in the exported email message. Blank means don't exclude any headers.</td></tr></table><h3>Relationships: </h3><table id="relat ionships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>All messages that are the are successfully received from Email server and converted to FlowFiles 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 does not allow an incoming relationship.<h3>System Resource Considerations:</h3>None specified.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-email-nar/1.7.1/org.apache.nifi.processors.email.ConsumeIMAP/additionalDetails.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-email-nar/1.7.1/org.apache.nifi.processors.email.ConsumeIMAP/additionalDetails.html?rev=1836075&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-email-nar/1.7.1/org.apache.nifi.processors.email.ConsumeIMAP/additionalDetails.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-email-nar/1.7.1/org.apache.nifi.processors.email.ConsumeIMAP/additionalDetails.html Tue Jul 17 01:35:38 2018 @@ -0,0 +1,58 @@ +<!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>ConsumeIMAP</title> +<link rel="stylesheet" href="../../../../../css/component-usage.css" + type="text/css" /> +</head> + +<body> + <!-- Processor Documentation ================================================== --> + <h2>Description:</h2> + <p>This Processor consumes email messages via IMAP protocol and sends the content of an email message as content of the Flow File. + Content of the incoming email message is written as raw bytes to the content of the outgoing Flow File. + </p> + + <p>Different email providers may require additional Java Mail properties which could be provided as dynamic properties. + For example, below is a sample configuration for GMail: + + </p> + <p> + <b>Processor's static properties:</b> + <ul> + <li><b>Host Name</b> - imap.gmail.com</li> + <li><b>Port</b> - 993</li> + <li><b>User Name</b> - <i>[your user name]</i></li> + <li><b>Password</b> - <i>[your password]</i></li> + <li><b>Folder</b> - INBOX</li> + </ul> + <b>Processor's dynamic properties:</b> + <ul> + <li><b>mail.imap.socketFactory.class</b> - javax.net.ssl.SSLSocketFactory</li> + <li><b>mail.imap.socketFactory.fallback</b> - false</li> + <li><b>mail.store.protocol</b> - imaps</li> + </ul> + </p> + <p> + Another useful property is <b>mail.debug</b> which allows Java Mail API to print protocol messages to the console helping you to both understand what's going on as well as debug issues. + </p> + <p> + For the full list of available Java Mail properties please refer to <a href="http://connector.sourceforge.net/doc-files/Properties.html";>here</a> + </p> +</body> +</html> Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-email-nar/1.7.1/org.apache.nifi.processors.email.ConsumeIMAP/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-email-nar/1.7.1/org.apache.nifi.processors.email.ConsumeIMAP/index.html?rev=1836075&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-email-nar/1.7.1/org.apache.nifi.processors.email.ConsumeIMAP/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-email-nar/1.7.1/org.apache.nifi.processors.email.ConsumeIMAP/index.html Tue Jul 17 01:35:38 2018 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ConsumeIMAP</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;">ConsumeIMAP</h1><h2>Description: </h2><p>Consumes messages from Email Server using IMAP protocol. The raw-bytes of each received email message are written as contents of the FlowFile</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>Email, Imap, Get, Ingest, Ingress, Message, Consume</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, whether a property supports the <a href="../../../../../html/express ion-language-guide.html">NiFi Expression Language</a>, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props.key</strong>.</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 Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Network address of Email server (e.g., pop.gmail.com, imap.gmail.com . . .)<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Port</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Numeric value identifying Port of Email server (e.g., 993)<br/><strong>Supports Expression Language: true (will be e valuated using variable registry only)</strong></td></tr><tr><td id="name"><strong>User Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">User Name used for authentication and authorization with Email server.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Password</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Password used for authentication and authorization with Email server.<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Folder</strong></td><td id="default-value">INBOX</td><td id="allowable-values"></td><td id="description">Email folder to retrieve messages from (e.g., INBOX)<br/><strong>Supports Expression Language: true (will be evaluated using variable reg istry only)</strong></td></tr><tr><td id="name"><strong>Fetch Size</strong></td><td id="default-value">10</td><td id="allowable-values"></td><td id="description">Specify the maximum number of Messages to fetch per call to Email Server.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Delete Messages</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Specify whether mail messages should be deleted after retrieval.</td></tr><tr><td id="name"><strong>Connection timeout</strong></td><td id="default-value">30 sec</td><td id="allowable-values"></td><td id="description">The amount of time to wait to connect to Email server<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Mark Messages as Read</strong></td><td id="default-value">f alse</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Specify if messages should be marked as read after retrieval.</td></tr><tr><td id="name"><strong>Use SSL</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Specifies if IMAP connection must be obtained via SSL encrypted connection (i.e., IMAPS)</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>All messages that are the are successfully received from Email server and converted to FlowFiles 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 does not allow an incoming relationship.<h3>Syste m Resource Considerations:</h3>None specified.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-email-nar/1.7.1/org.apache.nifi.processors.email.ConsumePOP3/additionalDetails.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-email-nar/1.7.1/org.apache.nifi.processors.email.ConsumePOP3/additionalDetails.html?rev=1836075&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-email-nar/1.7.1/org.apache.nifi.processors.email.ConsumePOP3/additionalDetails.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-email-nar/1.7.1/org.apache.nifi.processors.email.ConsumePOP3/additionalDetails.html Tue Jul 17 01:35:38 2018 @@ -0,0 +1,57 @@ +<!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>ConsumePOP3</title> +<link rel="stylesheet" href="../../../../../css/component-usage.css" + type="text/css" /> +</head> + +<body> + <!-- Processor Documentation ================================================== --> + <h2>Description:</h2> + <p>This Processor consumes email messages via POP3 protocol and sends the content of an email message as content of the Flow File. + Content of the incoming email message is written as raw bytes to the content of the outgoing Flow File. + </p> + + <p>Since different serves may require different Java Mail + properties such properties could be provided via dynamic properties. + For example, below is a sample configuration for GMail: + </p> + <p> + <b>Processor's static properties:</b> + <ul> + <li><b>Host Name</b> - pop.gmail.com</li> + <li><b>Port</b> - 995</li> + <li><b>User Name</b> - <i>[your user name]</i></li> + <li><b>Password</b> - <i>[your password]</i></li> + <li><b>Folder</b> - INBOX</li> + </ul> + <b>Processor's dynamic properties:</b> + <ul> + <li><b>mail.pop3.socketFactory.class</b> - javax.net.ssl.SSLSocketFactory</li> + <li><b>mail.pop3.socketFactory.fallback</b> - false</li> + </ul> + </p> + <p> + Another useful property is <b>mail.debug</b> which allows Java Mail API to print protocol messages to the console helping you to both understand what's going on as well as debug issues. + </p> + <p> + For the full list of available Java Mail properties please refer to <a href="http://connector.sourceforge.net/doc-files/Properties.html";>here</a> + </p> +</body> +</html> Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-email-nar/1.7.1/org.apache.nifi.processors.email.ConsumePOP3/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-email-nar/1.7.1/org.apache.nifi.processors.email.ConsumePOP3/index.html?rev=1836075&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-email-nar/1.7.1/org.apache.nifi.processors.email.ConsumePOP3/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-email-nar/1.7.1/org.apache.nifi.processors.email.ConsumePOP3/index.html Tue Jul 17 01:35:38 2018 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ConsumePOP3</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;">ConsumePOP3</h1><h2>Description: </h2><p>Consumes messages from Email Server using POP3 protocol. The raw-bytes of each received email message are written as contents of the FlowFile</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>Email, POP3, Get, Ingest, Ingress, Message, Consume</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, whether a property supports the <a href="../../../../../html/express ion-language-guide.html">NiFi Expression Language</a>, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props.key</strong>.</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 Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Network address of Email server (e.g., pop.gmail.com, imap.gmail.com . . .)<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Port</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Numeric value identifying Port of Email server (e.g., 993)<br/><strong>Supports Expression Language: true (will be e valuated using variable registry only)</strong></td></tr><tr><td id="name"><strong>User Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">User Name used for authentication and authorization with Email server.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Password</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Password used for authentication and authorization with Email server.<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Folder</strong></td><td id="default-value">INBOX</td><td id="allowable-values"></td><td id="description">Email folder to retrieve messages from (e.g., INBOX)<br/><strong>Supports Expression Language: true (will be evaluated using variable reg istry only)</strong></td></tr><tr><td id="name"><strong>Fetch Size</strong></td><td id="default-value">10</td><td id="allowable-values"></td><td id="description">Specify the maximum number of Messages to fetch per call to Email Server.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Delete Messages</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Specify whether mail messages should be deleted after retrieval.</td></tr><tr><td id="name"><strong>Connection timeout</strong></td><td id="default-value">30 sec</td><td id="allowable-values"></td><td id="description">The amount of time to wait to connect to Email server<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Descri ption</th></tr><tr><td>success</td><td>All messages that are the are successfully received from Email server and converted to FlowFiles 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 does not allow an incoming relationship.<h3>System Resource Considerations:</h3>None specified.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-email-nar/1.7.1/org.apache.nifi.processors.email.ExtractEmailAttachments/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-email-nar/1.7.1/org.apache.nifi.processors.email.ExtractEmailAttachments/index.html?rev=1836075&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-email-nar/1.7.1/org.apache.nifi.processors.email.ExtractEmailAttachments/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-email-nar/1.7.1/org.apache.nifi.processors.email.ExtractEmailAttachments/index.html Tue Jul 17 01:35:38 2018 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ExtractEmailAttachments</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;">ExtractEmailAttachments</h1><h2>Description: </h2><p>Extract attachments from a mime formatted email file, splitting them into individual flowfiles.</p><h3>Tags: </h3><p>split, email</p><h3>Properties: </h3><p>This component has no required or optional properties.</p><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>failure</td><td>Flowfiles that could not be parsed</td></tr><tr><td>original</td><td>The original file</td></tr><tr><td>attachments</td><td>Each individual attachment will be routed to the attachments relationship</td></tr></t able><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>filename </td><td>The filename of the attachment</td></tr><tr><td>email.attachment.parent.filename </td><td>The filename of the parent FlowFile</td></tr><tr><td>email.attachment.parent.uuid</td><td>The UUID of the original FlowFile.</td></tr><tr><td>mime.type</td><td>The mime type of the attachment.</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.<h3>System Resource Considerations:</h3>None specified.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-email-nar/1.7.1/org.apache.nifi.processors.email.ExtractEmailHeaders/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-email-nar/1.7.1/org.apache.nifi.processors.email.ExtractEmailHeaders/index.html?rev=1836075&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-email-nar/1.7.1/org.apache.nifi.processors.email.ExtractEmailHeaders/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-email-nar/1.7.1/org.apache.nifi.processors.email.ExtractEmailHeaders/index.html Tue Jul 17 01:35:38 2018 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ExtractEmailHeaders</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;">ExtractEmailHeaders</h1><h2>Description: </h2><p>Using the flowfile content as source of data, extract header from an RFC compliant email file adding the relevant attributes to the flowfile. This processor does not perform extensive RFC validation but still requires a bare minimum compliance with RFC 2822</p><h3>Tags: </h3><p>split, email</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">Additional Header List</td><td id="default-value">x-mailer</td><td id="allowable-values"></td><td id="description">COLON separated list of additional headers to be extracted from the flowfile content.NOTE the header key is case insensitive and will be matched as lower-case. Values will respect email contents.</td></tr><tr><td id="name">Email Address Parsing</td><td id="default-value">true</td><td id="allowable-values"><ul><li>Strict Address Parsing <img src="../../../../../html/images/iconInfo.png" alt="Strict email address format will be enforced. FlowFiles will be transfered to the failure relationship if the email address is invalid." title="Strict email address format will be enforced. FlowFiles will be transfered to the failure relationship if the email address is invalid."></img></li><li>Non-Strict Address Parsing <img src="../../../../../html/images/iconInfo.png" alt="Accept emails, even if the address is poorly formed and doesn't strictly comply with RFC Validation." title="Accept emails, even if the address is poorly formed and doesn't strictly comply with RFC Validation."></img></li></ul></td><td id="description">If "strict", strict address format parsing rules are applied to mailbox and mailbox list fields, such as "to" and "from" headers, and FlowFiles with poorly formed addresses will be routed to the failure relationship, similar to messages that fail RFC compliant format validation. If "non-strict", the processor will extract the contents of mailbox list headers as comma-separated values without attempting to parse each value as well-formed Internet mailbox addresses. This is optional and defaults to Strict Address Parsing</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>Extraction was successful</td></tr><tr><td>failure</td><td>Flowfiles that could not be parsed as a RF C-2822 compliant message</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>email.headers.bcc.*</td><td>Each individual BCC recipient (if available)</td></tr><tr><td>email.headers.cc.*</td><td>Each individual CC recipient (if available)</td></tr><tr><td>email.headers.from.*</td><td>Each individual mailbox contained in the From of the Email (array as per RFC-2822)</td></tr><tr><td>email.headers.message-id</td><td>The value of the Message-ID header (if available)</td></tr><tr><td>email.headers.received_date</td><td>The Received-Date of the message (if available)</td></tr><tr><td>email.headers.sent_date</td><td>Date the message was sent</td></tr><tr><td>email.headers.subject</td><td>Subject of the message (if available)</td></tr><tr><td>email.headers.to.*</td><td>Each individual TO recipient (if available)</td></tr><tr><td>email.attachment_count</td><td>Number of attachm ents of the message</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.<h3>System Resource Considerations:</h3>None specified.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-email-nar/1.7.1/org.apache.nifi.processors.email.ExtractTNEFAttachments/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-email-nar/1.7.1/org.apache.nifi.processors.email.ExtractTNEFAttachments/index.html?rev=1836075&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-email-nar/1.7.1/org.apache.nifi.processors.email.ExtractTNEFAttachments/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-email-nar/1.7.1/org.apache.nifi.processors.email.ExtractTNEFAttachments/index.html Tue Jul 17 01:35:38 2018 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ExtractTNEFAttachments</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;">ExtractTNEFAttachments</h1><h2>Description: </h2><p>Extract attachments from a mime formatted email file, splitting them into individual flowfiles.</p><h3>Tags: </h3><p>split, email</p><h3>Properties: </h3><p>This component has no required or optional properties.</p><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>failure</td><td>Each individual flowfile that could not be parsed will be routed to the failure relationship</td></tr><tr><td>original</td><td>Each original flowfile (i.e. before extraction) will be routed to the original relati onship</td></tr><tr><td>attachments</td><td>Each individual attachment will be routed to the attachments 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>filename </td><td>The filename of the attachment</td></tr><tr><td>email.tnef.attachment.parent.filename </td><td>The filename of the parent FlowFile</td></tr><tr><td>email.tnef.attachment.parent.uuid</td><td>The UUID of the original FlowFile.</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.<h3>System Resource Considerations:</h3>None specified.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-email-nar/1.7.1/org.apache.nifi.processors.email.ListenSMTP/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-email-nar/1.7.1/org.apache.nifi.processors.email.ListenSMTP/index.html?rev=1836075&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-email-nar/1.7.1/org.apache.nifi.processors.email.ListenSMTP/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-email-nar/1.7.1/org.apache.nifi.processors.email.ListenSMTP/index.html Tue Jul 17 01:35:38 2018 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ListenSMTP</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;">ListenSMTP</h1><h2>Description: </h2><p>This processor implements a lightweight SMTP server to an arbitrary port, allowing nifi to listen for incoming email. Note this server does not perform any email validation. If direct exposure to the internet is sought, it may be a better idea to use the combination of NiFi and an industrial scale MTA (e.g. Postfix). Threading for this processor is managed by the underlying smtp server used so the processor need not support more than one thread.</p><h3>Tags: </h3><p>listen, email, smtp</p><h3>Properties: </h3><p>In the list below, the names of required properti es 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>Listening Port</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The TCP port the ListenSMTP processor will bind to.NOTE that on Unix derivative operating systems this port must be higher than 1024 unless NiFi is running as with root user permissions.</td></tr><tr><td id="name"><strong>Maximum number of SMTP connection</strong></td><td id="default-value">1</td><td id="allowable-values"></td><td id="description">The maximum number of simultaneous SMTP connections.</td></tr><tr><td id="name"><strong>SMTP connection timeout</strong></td><td id="default-value">60 seconds</td><td id="allowable-values"></td><td id="description">The maximum time to wait for an action of SMTP client.</td></tr><tr><td id="name"><strong>SMTP Maximum Message Size</strong></td><td id="default-value">20 MB</td><td id="allowable-values"></td><td id="description">The maximum number of bytes the server will accept.</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/>RestrictedSSLContextService<br/><strong>Implementation: </strong><a href="../../../nifi-ssl-context-service-nar/1.7.1/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</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.</td></tr><tr><td id="name">Client Auth</td><td id="default-value"></td><td id="allowable-values"><ul><li>NONE</li><li>REQUIRED</li></ul></td><td id="description">The client authentication policy to use for the SSL Context. Only used if an SSL Context Service is provided.</td></tr><tr><td id="name">SMTP hostname</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The hostname to be embedded into the banner displayed when an SMTP client connects to the processor TCP port .</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>All new messages will be routed as FlowFiles to this relationship</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>smtp.helo</td><td>The value used during HELO</td></tr><tr><td>smtp.certificates.*.serial</td><td>The serial numbers for each of the certificates used by an TLS peer</td></tr><tr><td>smtp.certificates.*.principal</td><td>The principal for each of the certificates used by an TLS peer</td></tr><tr><td>smtp.src</td><td>The source IP and port of the SMTP connection</td></tr><tr><td>smtp.from</td><td>The value used during MAIL FROM (i.e. envelope)</td></tr><tr><td>smtp.recipient.*</td><td>The values used during RCPT TO (i.e. envelope)</td></tr><tr><td>mime.type</td><td>Mime type of the message</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>System Resource Considerations:</h3>None specified.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-enrich-nar/1.7.1/org.apache.nifi.processors.GeoEnrichIP/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-enrich-nar/1.7.1/org.apache.nifi.processors.GeoEnrichIP/index.html?rev=1836075&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-enrich-nar/1.7.1/org.apache.nifi.processors.GeoEnrichIP/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-enrich-nar/1.7.1/org.apache.nifi.processors.GeoEnrichIP/index.html Tue Jul 17 01:35:38 2018 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>GeoEnrichIP</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;">GeoEnrichIP</h1><h2>Description: </h2><p>Looks up geolocation information for an IP address and adds the geo information to FlowFile attributes. The geo data is provided as a MaxMind database. The attribute that contains the IP address to lookup is provided by the 'IP Address Attribute' property. If the name of the attribute provided is 'X', then the the attributes added by enrichment will take the form X.geo.<fieldName></p><h3>Tags: </h3><p>geo, enrich, ip, maxmind</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"><strong>MaxMind Database File</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Path to Maxmind IP Enrichment Database File</td></tr><tr><td id="name"><strong>IP Address Attribute</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of an attribute whose value is a dotted decimal IP address for which enrichment should occur<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></ tr><tr><td>not found</td><td>Where to route flow files after unsuccessfully enriching attributes because no data was found</td></tr><tr><td>found</td><td>Where to route flow files after successfully enriching attributes with data provided by database</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>X.geo.lookup.micros</td><td>The number of microseconds that the geo lookup took</td></tr><tr><td>X.geo.city</td><td>The city identified for the IP address</td></tr><tr><td>X.geo.accuracy</td><td>The accuracy radius if provided by the database (in Kilometers)</td></tr><tr><td>X.geo.latitude</td><td>The latitude identified for this IP address</td></tr><tr><td>X.geo.longitude</td><td>The longitude identified for this IP address</td></tr><tr><td>X.geo.subdivision.N</td><td>Each subdivision that is identified for this IP address is added with a one-up number appended to the att ribute name, starting with 0</td></tr><tr><td>X.geo.subdivision.isocode.N</td><td>The ISO code for the subdivision that is identified by X.geo.subdivision.N</td></tr><tr><td>X.geo.country</td><td>The country identified for this IP address</td></tr><tr><td>X.geo.country.isocode</td><td>The ISO Code for the country identified</td></tr><tr><td>X.geo.postalcode</td><td>The postal code for the country identified</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.<h3>System Resource Considerations:</h3>None specified.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-enrich-nar/1.7.1/org.apache.nifi.processors.ISPEnrichIP/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-enrich-nar/1.7.1/org.apache.nifi.processors.ISPEnrichIP/index.html?rev=1836075&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-enrich-nar/1.7.1/org.apache.nifi.processors.ISPEnrichIP/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-enrich-nar/1.7.1/org.apache.nifi.processors.ISPEnrichIP/index.html Tue Jul 17 01:35:38 2018 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ISPEnrichIP</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;">ISPEnrichIP</h1><h2>Description: </h2><p>Looks up ISP information for an IP address and adds the information to FlowFile attributes. The ISP data is provided as a MaxMind ISP database (Note that this is NOT the same as the GeoLite database utilizedby some geo enrichment tools). The attribute that contains the IP address to lookup is provided by the 'IP Address Attribute' property. If the name of the attribute provided is 'X', then the the attributes added by enrichment will take the form X.isp.<fieldName></p><h3>Tags: </h3><p>ISP, enrich, ip, maxmind</p><h3>Properties: </h3><p>In the list belo w, 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>MaxMind Database File</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Path to Maxmind IP Enrichment Database File</td></tr><tr><td id="name"><strong>IP Address Attribute</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of an attribute whose value is a dotted decimal IP address for which enrichment should occur<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr></table><h3 >Relationships: </h3><table >id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>not >found</td><td>Where to route flow files after unsuccessfully enriching >attributes because no data was found</td></tr><tr><td>found</td><td>Where to >route flow files after successfully enriching attributes with data provided >by database</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>X.isp.lookup.micros</td><td>The > number of microseconds that the geo lookup >took</td></tr><tr><td>X.isp.asn</td><td>The Autonomous System Number (ASN) >identified for the IP >address</td></tr><tr><td>X.isp.asn.organization</td><td>The Organization >Associated with the ASN identified</td></tr><tr><td>X.isp.name</td><td>The >name of the ISP associated with the IP address >provided</td></tr><tr><td>X.isp.organization</td><td>The Organization >associated with the IP address provided</td></tr></table ><h3>State management: </h3>This component does not store >state.<h3>Restricted: </h3>This component is not restricted.<h3>Input >requirement: </h3>This component requires an incoming relationship.<h3>System >Resource Considerations:</h3>None specified.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-enrich-nar/1.7.1/org.apache.nifi.processors.enrich.QueryDNS/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-enrich-nar/1.7.1/org.apache.nifi.processors.enrich.QueryDNS/index.html?rev=1836075&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-enrich-nar/1.7.1/org.apache.nifi.processors.enrich.QueryDNS/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-enrich-nar/1.7.1/org.apache.nifi.processors.enrich.QueryDNS/index.html Tue Jul 17 01:35:38 2018 @@ -0,0 +1,2 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>QueryDNS</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;">QueryDNS</h1><h2>Description: </h2><p>A powerful DNS query processor primary designed to enrich DataFlows with DNS based APIs (e.g. RBLs, ShadowServer's ASN lookup) but that can be also used to perform regular DNS lookups.</p><h3>Tags: </h3><p>dns, enrich, ip</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"><strong>Lookup value</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The value that should be used to populate the query<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Results Parser</strong></td><td id="default-value">None</td><td id="allowable-values"><ul><li>Split <img src="../../../../../html/images/iconInfo.png" alt="Use a delimiter character or RegEx to split the results into attributes" title="Use a delimiter character or RegEx to split the results into attributes"></img></li><li>RegEx <img src="../../../../../html/images/iconInfo.png" alt="Use a regular expression to split the results into attributes " title="Use a regular expression to split the results into attributes "></img></li><li>None <img src="../../../../../html/images/iconInfo.png" alt="Do not split results" title="Do not split results"></img></li></ul></td><td id="description">The method used to slice the results into attribute groups</td></tr><tr><td id="name">Parser RegEx</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Choice between a splitter and regex matcher used to parse the results of the query into attribute groups. +NOTE: This is a multiline regular expression, therefore, the DFM should decide how to handle trailing new line characters.</td></tr><tr><td id="name"><strong>DNS Query Retries</strong></td><td id="default-value">1</td><td id="allowable-values"></td><td id="description">The number of attempts before giving up and moving on</td></tr><tr><td id="name"><strong>DNS Query Timeout</strong></td><td id="default-value">1500 ms</td><td id="allowable-values"></td><td id="description">The amount of time to wait until considering a query as failed</td></tr><tr><td id="name">DNS Servers</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A comma separated list of DNS servers to be used. (Defaults to system wide if none is used)</td></tr><tr><td id="name"><strong>DNS Query Type</strong></td><td id="default-value">TXT</td><td id="allowable-values"></td><td id="description">The DNS query type to be used by the processor (e.g. TXT, A)</td></tr></table><h3>Relationships : </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>not found</td><td>Where to route flow files if data enrichment query rendered no results</td></tr><tr><td>found</td><td>Where to route flow files after successfully enriching attributes with data</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>enrich.dns.record*.group*</td><td>The captured fields of the DNS query response for each of the records received</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.<h3>System Resource Considerations:</h3>None specified.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-enrich-nar/1.7.1/org.apache.nifi.processors.enrich.QueryWhois/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-enrich-nar/1.7.1/org.apache.nifi.processors.enrich.QueryWhois/index.html?rev=1836075&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-enrich-nar/1.7.1/org.apache.nifi.processors.enrich.QueryWhois/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-enrich-nar/1.7.1/org.apache.nifi.processors.enrich.QueryWhois/index.html Tue Jul 17 01:35:38 2018 @@ -0,0 +1,2 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>QueryWhois</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;">QueryWhois</h1><h2>Description: </h2><p>A powerful whois query processor primary designed to enrich DataFlows with whois based APIs (e.g. ShadowServer's ASN lookup) but that can be also used to perform regular whois lookups.</p><h3>Tags: </h3><p>whois, enrich, ip</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>Lookup value</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The value that should be used to populate the query<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Whois Query Type</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The Whois query type to be used by the processor (if used)</td></tr><tr><td id="name"><strong>Whois Server</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The Whois server to be used</td></tr><tr><td id="name"><strong>Whois Server Port</strong></td><td id="default-value">43</td><td id="allowable-values"></td><td id="description">The TCP port of the remote Whois server</td></tr><tr><td id="name">< strong>Whois Query Timeout</strong></td><td id="default-value">1500 ms</td><td id="allowable-values"></td><td id="description">The amount of time to wait until considering a query as failed</td></tr><tr><td id="name"><strong>Batch Size</strong></td><td id="default-value">25</td><td id="allowable-values"></td><td id="description">The number of incoming FlowFiles to process in a single execution of this processor. </td></tr><tr><td id="name"><strong>Bulk Protocol</strong></td><td id="default-value">None</td><td id="allowable-values"><ul><li>Begin/End <img src="../../../../../html/images/iconInfo.png" alt="The evaluated input of each flowfile is enclosed within begin and end tags. Each row contains a delimited set of fields" title="The evaluated input of each flowfile is enclosed within begin and end tags. Each row contains a delimited set of fields"></img></li><li>None <img src="../../../../../html/images/iconInfo.png" alt="Queries are made without any particular dialect" title="Queri es are made without any particular dialect"></img></li></ul></td><td id="description">The protocol used to perform the bulk query. </td></tr><tr><td id="name"><strong>Results Parser</strong></td><td id="default-value">None</td><td id="allowable-values"><ul><li>Split <img src="../../../../../html/images/iconInfo.png" alt="Use a delimiter character or RegEx to split the results into attributes" title="Use a delimiter character or RegEx to split the results into attributes"></img></li><li>RegEx <img src="../../../../../html/images/iconInfo.png" alt="Use a regular expression to split the results into attributes " title="Use a regular expression to split the results into attributes "></img></li><li>None <img src="../../../../../html/images/iconInfo.png" alt="Do not split results" title="Do not split results"></img></li></ul></td><td id="description">The method used to slice the results into attribute groups</td></tr><tr><td id="name">Parser RegEx</td><td id="default-value"></td><td id= "allowable-values"></td><td id="description">Choice between a splitter and regex matcher used to parse the results of the query into attribute groups. +NOTE: This is a multiline regular expression, therefore, the DFM should decide how to handle trailing new line characters.</td></tr><tr><td id="name">Key lookup group (multiline / batch)</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">When performing a batched lookup, the following RegEx numbered capture group or Column number will be used to match the whois server response with the lookup field</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>not found</td><td>Where to route flow files if data enrichment query rendered no results</td></tr><tr><td>found</td><td>Where to route flow files after successfully enriching attributes with data</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>enrich.dns.record*.group*</td><td>The captured fields of the Whois query response for each of the records received</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.<h3>System Resource Considerations:</h3>None specified.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-evtx-nar/1.7.1/org.apache.nifi.processors.evtx.ParseEvtx/additionalDetails.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-evtx-nar/1.7.1/org.apache.nifi.processors.evtx.ParseEvtx/additionalDetails.html?rev=1836075&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-evtx-nar/1.7.1/org.apache.nifi.processors.evtx.ParseEvtx/additionalDetails.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-evtx-nar/1.7.1/org.apache.nifi.processors.evtx.ParseEvtx/additionalDetails.html Tue Jul 17 01:35:38 2018 @@ -0,0 +1,91 @@ +<!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>ParseEvtx</title> + + <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css" /> + </head> + + <body> + <!-- Processor Documentation ================================================== --> + <h2>Description:</h2> + <p>This processor is used to parse Windows event logs in the binary evtx format. The input flow files' content should be evtx files. The processor has 4 outputs: + <ul> + <li>The original unmodified FlowFile</li> + <li>The XML resulting from parsing at the configured granularity</li> + <li>Failed parsing with partial output</li> + <li>Malformed chunk in binary form</li> + </ul> + </p> + <h2>Output XML Example:</h2> + <p> + <pre> +<?xml version="1.0"?> +<Events> + <Event xmlns="http://schemas.microsoft.com/win/2004/08/events/event"> + <System> + <Provider Name="Service Control Manager" Guid="{555908d1-a6d7-4695-8e1e-26931d2012f4}" Ev +entSourceName="Service Control Manager"/> + <EventID Qualifiers="16384">7036</EventID> + <Version>0</Version> + <Level>4</Level> + <Task>0</Task> + <Opcode>0</Opcode> + <Keywords>0x8080000000000000</Keywords> + <TimeCreated SystemTime="2016-01-08 16:49:47.518"/> + <EventRecordID>780</EventRecordID> + <Correlation ActivityID="" RelatedActivityID=""/> + <Execution ProcessID="480" ThreadID="596"/> + <Channel>System</Channel> + <Computer>win7-pro-vm</Computer> + <Security UserID=""/> + </System> + <EventData> + <Data Name="param1">Workstation</Data> + <Data Name="param2">running</Data> + <Binary>TABhAG4AbQBhAG4AVwBvAHIAawBzAHQAYQB0AGkAbwBuAC8ANAAAAA==</Binary> + </EventData> + </Event> + <Event xmlns="http://schemas.microsoft.com/win/2004/08/events/event"> + <System> + <Provider Name="Service Control Manager" Guid="{555908d1-a6d7-4695-8e1e-26931d2012f4}" EventSourceName="Service Control Manager"/> + <EventID Qualifiers="16384">7036</EventID> + <Version>0</Version> + <Level>4</Level> + <Task>0</Task> + <Opcode>0</Opcode> + <Keywords>0x8080000000000000</Keywords> + <TimeCreated SystemTime="2016-01-08 16:49:47.535"/> + <EventRecordID>781</EventRecordID> + <Correlation ActivityID="" RelatedActivityID=""/> + <Execution ProcessID="480" ThreadID="576"/> + <Channel>System</Channel> + <Computer>win7-pro-vm</Computer> + <Security UserID=""/> + </System> + <EventData> + <Data Name="param1">Cryptographic Services</Data> + <Data Name="param2">running</Data> + <Binary>QwByAHkAcAB0AFMAdgBjAC8ANAAAAA==</Binary> + </EventData> + </Event> +</Events> + </pre> + </p> +</body> +</html> Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-evtx-nar/1.7.1/org.apache.nifi.processors.evtx.ParseEvtx/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-evtx-nar/1.7.1/org.apache.nifi.processors.evtx.ParseEvtx/index.html?rev=1836075&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-evtx-nar/1.7.1/org.apache.nifi.processors.evtx.ParseEvtx/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-evtx-nar/1.7.1/org.apache.nifi.processors.evtx.ParseEvtx/index.html Tue Jul 17 01:35:38 2018 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ParseEvtx</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;">ParseEvtx</h1><h2>Description: </h2><p>Parses the contents of a Windows Event Log file (evtx) and writes the resulting XML to the FlowFile</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>logs, windows, event, evtx, message, file</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 i d="name"><strong>Granularity</strong></td><td id="default-value">Chunk</td><td id="allowable-values"><ul><li>Record</li><li>Chunk</li><li>File</li></ul></td><td id="description">Output flow file for each Record, Chunk, or File encountered in the event log</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>Any FlowFile that was successfully converted from evtx to XML</td></tr><tr><td>failure</td><td>Any FlowFile that encountered an exception during conversion will be transferred to this relationship with as much parsing as possible done</td></tr><tr><td>original</td><td>The unmodified input FlowFile will be transferred to this relationship</td></tr><tr><td>bad chunk</td><td>Any bad chunks of records will be transferred to this relationship in their original binary form</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 filename of the evtx file</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 output filename</td></tr><tr><td>mime.type</td><td>The output filetype (application/xml for success and failure relationships, original value for bad chunk and original relationships)</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.<h3>System Resource Considerations:</h3>None specified.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-flume-nar/1.7.1/org.apache.nifi.processors.flume.ExecuteFlumeSink/additionalDetails.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-flume-nar/1.7.1/org.apache.nifi.processors.flume.ExecuteFlumeSink/additionalDetails.html?rev=1836075&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-flume-nar/1.7.1/org.apache.nifi.processors.flume.ExecuteFlumeSink/additionalDetails.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-flume-nar/1.7.1/org.apache.nifi.processors.flume.ExecuteFlumeSink/additionalDetails.html Tue Jul 17 01:35:38 2018 @@ -0,0 +1,155 @@ +<!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>ExecuteFlumeSink</title> + <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css" /> +</head> + +<body> +<h2>Data Model</h2> +<p> + This processor executes an Apache Flume sink. FlowFiles are wrapped in Flume's + Event interface. The content of the FlowFile becomes the body of the Event and + the attributes of the FlowFile become Event headers. The following special + headers are also set: +</p> +<table id="headers"> + <tr> + <th>Flume Event Header</th> + <th>FlowFile Attribute</th> + </tr> + <tr> + <td>nifi.entry.date</td> + <td>FlowFile#getEntryDate()</td> + </tr> + <tr> + <td>nifi.id</td> + <td>FlowFile#getId()</td> + </tr> + <tr> + <td>nifi.last.queue.date</td> + <td>FlowFile#getLastQueueDate()</td> + </tr> + <tr> + <td>nifi.lineage.start.date</td> + <td>FlowFile#getLineageStartDate()</td> + </tr> + <tr> + <td>nifi.size</td> + <td>FlowFile#getSize()</td> + </tr> +</table> +<h2>Warning</h2> +<p> + In NiFi, the contents of a FlowFile are accessed via a stream, but in Flume it is + stored in a byte array. This means the full content will be loaded into memory when + a FlowFile is processed by the ExecuteFlumeSink processor. You should consider the + typical size of the FlowFiles you'll process and the batch size, if any, your sink + is configured with when setting NiFi's heap size. +</p> +<h2>Configuration Details</h2> +<p> + This processor is designed to execute arbitrary Flume sinks. Most of the details + of configuring the sink is deferred to Flume's built-in configuration system. + For details on the available settings for each sink type, refer to the Flume + <a href="http://flume.apache.org/FlumeUserGuide.html#flume-sinks";>User Guide</a>. + Configuring the Flume sink is a four step process: +</p> +<ol> + <li>Set the Sink Type property to a valid Flume sink type.</li> + <li> + Set the Agent Name property to the name of the agent in your + Flume configuration. This is the prefix of the properties in the Flume + configuration file. Example: <code>tier1</code> + </li> + <li> + Set the Sink Name property to the name of the sink in your Flume + configuration. If Agent Name is <code>tier1</code>, then the Sink Name + is the value of the <code>tier1.sinks</code> property. Example: <code>sink-1</code> + </li> + <li> + Copy and paste the configuration for the sink from your Flume configuration + file into the Flume Configuration property. Assuming you're using + the same Agent Name and Sink Name as in the examples above, this will be all + of the properties that start with <code>tier1.sinks.sink-1</code>. + Do not copy the <code>tier1.sinks.sink-1.type</code> or + <code>tier1.sinks.sink-1.channel</code> properties. + </li> +</ol> +<h2>Usage Example</h2> +<p> + Assuming you had the following existing Flume configuration file: +</p> + <pre> +a1.sources = r1 +a1.sinks = k1 +a1.channels = c1 + +a1.sources.r1.type = netcat +a1.sources.r1.bind = localhost +a1.sources.r1.port = 44444 + +a1.sinks.k1.type = hdfs +a1.sinks.k1.channel = c1 +a1.sinks.k1.hdfs.path = /flume/events/%y-%m-%d/%H%M/%S +a1.sinks.k1.hdfs.filePrefix = events- +a1.sinks.k1.hdfs.round = true +a1.sinks.k1.hdfs.roundValue = 10 +a1.sinks.k1.hdfs.roundUnit = minute + +a1.channels.c1.type = memory +a1.channels.c1.capacity = 1000 +a1.channels.c1.transactionCapacity = 100 + +a1.sources.r1.channels = c1 +a1.sinks.k1.channel = c1</pre> +<p> + Then you'd configure the ExecuteFlumeSink as follows: +</p> +<table id="example"> + <tr> + <th>Property</th> + <th>Value</th> + </tr> + <tr> + <td>Sink Type</td> + <td>hdfs</td> + </tr> + <tr> + <td>Agent Name</td> + <td>a1</td> + </tr> + <tr> + <td>Sink Name</td> + <td>k1</td> + </tr> + <tr> + <td>Flume Configuration</td> + <td> + <code> + a1.sinks.k1.hdfs.path = /flume/events/%y-%m-%d/%H%M/%S<br> + a1.sinks.k1.hdfs.filePrefix = events-<br> + a1.sinks.k1.hdfs.round = true<br> + a1.sinks.k1.hdfs.roundValue = 10<br> + a1.sinks.k1.hdfs.roundUnit = minute + </code> + </td> + </tr> +</table> +</body> +</html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-flume-nar/1.7.1/org.apache.nifi.processors.flume.ExecuteFlumeSink/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-flume-nar/1.7.1/org.apache.nifi.processors.flume.ExecuteFlumeSink/index.html?rev=1836075&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-flume-nar/1.7.1/org.apache.nifi.processors.flume.ExecuteFlumeSink/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-flume-nar/1.7.1/org.apache.nifi.processors.flume.ExecuteFlumeSink/index.html Tue Jul 17 01:35:38 2018 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ExecuteFlumeSink</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;">ExecuteFlumeSink</h1><h2>Description: </h2><p>Execute a Flume sink. Each input FlowFile is converted into a Flume Event for processing by the sink.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>flume, hadoop, put, sink</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>Sink Type</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The component type name for the sink. For some sinks, this is a short, symbolic name (e.g. hdfs). For others, it's the fully-qualified name of the Sink class. See the Flume User Guide for details.</td></tr><tr><td id="name"><strong>Agent Name</strong></td><td id="default-value">tier1</td><td id="allowable-values"></td><td id="description">The name of the agent used in the Flume sink configuration</td></tr><tr><td id="name"><strong>Sink Name</strong></td><td id="default-value">sink-1</td><td id="allowable-values"></td><td id="description">The name of the sink used in the Flume sink configuration</td></tr><tr><td id="name"><strong>Flume Configuration</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The Flume configuration for the sink copied from the flume.properties file</td></tr></table><h3>Relationships: </h3><table id="r elationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td></td></tr><tr><td>failure</td><td></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><table id="restrictions"><tr><th>Required Permission</th><th>Explanation</th></tr><tr><td>execute code</td><td>Provides operator the ability to execute arbitrary Flume configurations assuming all permissions that NiFi has.</td></tr></table><h3>Input requirement: </h3>This component requires an incoming relationship.<h3>System Resource Considerations:</h3>None specified.</body></html> \ No newline at end of file
