Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-nar/1.11.3/org.apache.nifi.processors.elasticsearch.ScrollElasticsearchHttp/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-nar/1.11.3/org.apache.nifi.processors.elasticsearch.ScrollElasticsearchHttp/index.html?rev=1874478&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-nar/1.11.3/org.apache.nifi.processors.elasticsearch.ScrollElasticsearchHttp/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-nar/1.11.3/org.apache.nifi.processors.elasticsearch.ScrollElasticsearchHttp/index.html Tue Feb 25 07:28:36 2020 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ScrollElasticsearchHttp</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;">ScrollElasticsearchHttp</h1><h2>Description: </h2><p>Scrolls through an Elasticsearch query using the specified connection properties. This processor is intended to be run on the primary node, and is designed for scrolling through huge result sets, as in the case of a reindex. The state must be cleared before another query can be run. Each page of results is returned, wrapped in a JSON object like so: { "hits" : [ <doc1>, <doc2>, <docn> ] }. Note that the full body of each page of documents will be read into memory before being written to a Flow File for transfer.</p ><h3>Tags: </h3><p>elasticsearch, query, scroll, read, get, >http</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 >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>Elasticsearch >URL</strong></td><td id="default-value"></td><td >id="allowable-values"></td><td id="description">Elasticsearch URL which will >be connected to, including scheme (http, e. g.), host, and port. The default port for the REST API is 9200.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</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.11.3/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a><br/><a href="../../../nifi-ssl-context-service-nar/1.11.3/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. This service only applies if the Elasticsearch endpoint(s) have been secured with TLS/SSL.</td></tr><tr><td id="name"><strong>Character Set</strong></td><td id="default-value">UTF-8</td><td id ="allowable-values"></td><td id="description">Specifies the character set of the document data.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Username</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Username to access the Elasticsearch cluster<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Password to access the Elasticsearch cluster<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>Connection Timeout</strong></td><td id="default-value">5 secs</td><td id="allowable-values"></td><td id="description">Max wait time for the connection to the Elasticsearch RES T API.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Response Timeout</strong></td><td id="default-value">15 secs</td><td id="allowable-values"></td><td id="description">Max wait time for a response from the Elasticsearch REST API.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Proxy Configuration Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>ProxyConfigurationService<br/><strong>Implementation: </strong><a href="../../../nifi-proxy-configuration-nar/1.11.3/org.apache.nifi.proxy.StandardProxyConfigurationService/index.html">StandardProxyConfigurationService</a></td><td id="description">Specifies the Proxy Configuration Controller Service to proxy network requests. If set, it supersedes proxy settings configured per component. Supported proxie s: HTTP + AuthN, SOCKS</td></tr><tr><td id="name">Proxy Host</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The fully qualified hostname or IP address of the proxy server<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Proxy Port</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The port of the proxy server<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Proxy Username</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Proxy Username<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Proxy Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Proxy Password<br/><strong>Sensitive Property: true</str ong><br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Query</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The Lucene-style query to run against ElasticSearch (e.g., genre:blues AND -artist:muddy)<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Scroll Duration</strong></td><td id="default-value">1m</td><td id="allowable-values"></td><td id="description">The scroll duration is how long each search context is kept in memory.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Page Size</strong></td><td id="default-value">20</td><td id="allowable-values"></td><td id="description">Determines how many documents to return per page during scrolling.<br/><strong>Supports Expressi on Language: true (will be evaluated using variable registry only)</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 read from. If the property is set to _all, the query will match across all indexes.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Type</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The (optional) type of this query, used by Elasticsearch for indexing and searching. If the property is empty, the the query will match across all types.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Fields</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A comma-separated list of fields to retrieve from the document. If the Fields pr operty is left blank, then the entire document's source will be retrieved.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Sort</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A sort parameter (e.g., timestamp:asc). If the Sort property is left blank, then the results will be retrieved in document order.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr></table><h3>Dynamic Properties: </h3><p>Dynamic Properties allow the user to specify both the name and value of a property.<table id="dynamic-properties"><tr><th>Name</th><th>Value</th><th>Description</th></tr><tr><td id="name">A URL query parameter</td><td id="value">The value to set it to</td><td>Adds the specified property name/value as a query parameter in the Elasticsearch URL used for processing<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr></table></p><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>All FlowFiles that are read from Elasticsearch 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. Note that only incoming flow files will be routed to failure.</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>es.index</td><td>The Elasticsearch index containing the document</td></tr><tr><td>es.type</td><td>The Elasticsearch document type</td></tr></table><h3>State management: </h3><table id="stateful"><tr><th>Scope</th><th>Description</th></tr><tr><td>LOCAL</td><td>After each successful scroll page, the latest scroll_id is persisted in scrollId as input for the next scroll call. On ce the entire query is complete, finishedQuery state will be set to true, and the processor will not execute unless this is cleared.</td></tr></table><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-elasticsearch-restapi-nar/1.11.3/org.apache.nifi.processors.elasticsearch.DeleteByQueryElasticsearch/additionalDetails.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-restapi-nar/1.11.3/org.apache.nifi.processors.elasticsearch.DeleteByQueryElasticsearch/additionalDetails.html?rev=1874478&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-restapi-nar/1.11.3/org.apache.nifi.processors.elasticsearch.DeleteByQueryElasticsearch/additionalDetails.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-restapi-nar/1.11.3/org.apache.nifi.processors.elasticsearch.DeleteByQueryElasticsearch/additionalDetails.html Tue Feb 25 07:28:36 2020 @@ -0,0 +1,43 @@ +<!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>DeleteByQueryElasticsearch</title> + <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css" /> +</head> +<body> + <p>This processor executes a delete operation against one or more indices using the _delete_by_query handler. The + query should be a valid Elasticsearch JSON DSL query (Lucene syntax is not supported). An example query:</p> + <pre> + { + "query": { + "match": { + "username.keyword": "john.smith" + } + } + } + </pre> + <p>To delete all of the contents of an index, this could be used:</p> + <pre> + { + "query": { + "match_all": {} + } + } + </pre> +</body> +</html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-restapi-nar/1.11.3/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.11.3/org.apache.nifi.processors.elasticsearch.DeleteByQueryElasticsearch/index.html?rev=1874478&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-restapi-nar/1.11.3/org.apache.nifi.processors.elasticsearch.DeleteByQueryElasticsearch/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-restapi-nar/1.11.3/org.apache.nifi.processors.elasticsearch.DeleteByQueryElasticsearch/index.html Tue Feb 25 07:28:36 2020 @@ -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><p><a href="additionalDetails.html">Additional Details...</a></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/expre ssion-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 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 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/><strong>Implementation: </strong><a href="../../../nifi-elasticsearch-client-service-nar/1.11.3/org.apache.nifi.elasticsearch.ElasticSearchClientServiceImpl/index.html">ElasticSearchClientServiceImpl</a></td><td id="description">An Elasticsearch client service to use fo r 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.11.3/org.apache.nifi.processors.elasticsearch.JsonQueryElasticsearch/additionalDetails.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-restapi-nar/1.11.3/org.apache.nifi.processors.elasticsearch.JsonQueryElasticsearch/additionalDetails.html?rev=1874478&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-restapi-nar/1.11.3/org.apache.nifi.processors.elasticsearch.JsonQueryElasticsearch/additionalDetails.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-restapi-nar/1.11.3/org.apache.nifi.processors.elasticsearch.JsonQueryElasticsearch/additionalDetails.html Tue Feb 25 07:28:36 2020 @@ -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>JsonQueryElasticsearch</title> + <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css" /> +</head> +<body> + <p>This processor is intended for use with the Elasticsearch JSON DSL and Elasticsearch 5.X and newer. It is designed + to be able to take a query from Kibana and execute it as-is against an Elasticsearch cluster. Like all processors in the + "restapi" bundle, it uses the official Elastic client APIs, so it supports leader detection.</p> + <p>The query to execute can be provided either in the Query configuration property or in an attribute on a flowfile. In + the latter case, the name of the attribute (Expression Language is supported here) must be provided in the Query Attribute + property.</p> + <p>Additionally, search results and aggregation results can be split up into multiple flowfiles. Aggregation results + will only be split at the top level because nested aggregations lose their context (and thus lose their value) if + separated from their parent aggregation. The following is an example query that would be accepted:</p> + <pre> + { + "query": { + "match": { + "restaurant.keyword": "Local Pizzaz FTW Inc" + } + }, + "aggs": { + "weekly_sales": { + "date_histogram": { + "field": "date", + "interval": "week" + }, + "aggs": { + "items": { + "terms": { + "field": "product", + "size": 10 + } + } + } + } + } + } + </pre> +</body> +</html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-restapi-nar/1.11.3/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.11.3/org.apache.nifi.processors.elasticsearch.JsonQueryElasticsearch/index.html?rev=1874478&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-restapi-nar/1.11.3/org.apache.nifi.processors.elasticsearch.JsonQueryElasticsearch/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-restapi-nar/1.11.3/org.apache.nifi.processors.elasticsearch.JsonQueryElasticsearch/index.html Tue Feb 25 07:28:36 2020 @@ -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><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>elasticse arch, 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="al lowable-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 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>Contro ller Service API: </strong><br/>ElasticSearchClientService<br/><strong>Implementation: </strong><a href="../../../nifi-elasticsearch-client-service-nar/1.11.3/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." 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 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 fail for reasons unrelated to server availability go 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>Wri tes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</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-elasticsearch-restapi-nar/1.11.3/org.apache.nifi.processors.elasticsearch.PutElasticsearchRecord/additionalDetails.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-restapi-nar/1.11.3/org.apache.nifi.processors.elasticsearch.PutElasticsearchRecord/additionalDetails.html?rev=1874478&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-restapi-nar/1.11.3/org.apache.nifi.processors.elasticsearch.PutElasticsearchRecord/additionalDetails.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-restapi-nar/1.11.3/org.apache.nifi.processors.elasticsearch.PutElasticsearchRecord/additionalDetails.html Tue Feb 25 07:28:36 2020 @@ -0,0 +1,41 @@ +<!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>PutElasticsearchRecord</title> + <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css" /> +</head> +<body> +<p> + This processor is for accessing the Elasticsearch Bulk API. It provides the ability to configure bulk operations on + a per-record basis which is what separates it from PutElasticsearchHttpRecord. For example, it is possible to define + multiple commands to index documents, followed by deletes, creates and update operations against the same index or + other indices as desired. +</p> +<p> + As part of the Elasticsearch REST API bundle, it uses a controller service to manage connection information and + that controller service is built on top of the official Elasticsearch client APIs. That provides features such as + automatic master detection against the cluster which is missing in the other bundles. +</p> +<p> + This processor builds one Elasticsearch Bulk API body per record set. Care should be taken to split up record sets + into appropriately-sized chunks so that NiFi does not run out of memory and the requests sent to Elasticsearch are + not too large for it to handle. When failures do occur, this processor is capable of attempting to write the records + that failed to an output record writer so that only failed records can be processed downstream or replayed. +</p> +</body> +</html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-restapi-nar/1.11.3/org.apache.nifi.processors.elasticsearch.PutElasticsearchRecord/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-restapi-nar/1.11.3/org.apache.nifi.processors.elasticsearch.PutElasticsearchRecord/index.html?rev=1874478&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-restapi-nar/1.11.3/org.apache.nifi.processors.elasticsearch.PutElasticsearchRecord/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-elasticsearch-restapi-nar/1.11.3/org.apache.nifi.processors.elasticsearch.PutElasticsearchRecord/index.html Tue Feb 25 07:28:36 2020 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutElasticsearchRecord</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;">PutElasticsearchRecord</h1><h2>Description: </h2><p>A record-aware Elasticsearch put processor that uses the official Elastic REST client libraries.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>json, elasticsearch, elasticsearch5, elasticsearch6, put, index, 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/expres sion-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>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/><strong>Implementation: </strong> <a href="../../../nifi-elasticsearch-client-service-nar/1.11.3/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>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.11.3/org.apache.nifi.syslog.SyslogReader/index.html">SyslogReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.3/org.apache.nifi.json.JsonPathReader/index.html">JsonPathReader</a><br/><a href="../../../nifi-scripting-nar/1.11.3/org.apache.nifi.record.script.ScriptedReader/index.html">ScriptedReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.3/org.apache.nifi.json.JsonTreeReader/index.html">JsonTreeReader</a ><br/><a >href="../../../nifi-record-serialization-services-nar/1.11.3/org.apache.nifi.grok.GrokReader/index.html">GrokReader</a><br/><a > >href="../../../nifi-record-serialization-services-nar/1.11.3/org.apache.nifi.avro.AvroReader/index.html">AvroReader</a><br/><a > >href="../../../nifi-record-serialization-services-nar/1.11.3/org.apache.nifi.xml.XMLReader/index.html">XMLReader</a><br/><a > >href="../../../nifi-record-serialization-services-nar/1.11.3/org.apache.nifi.csv.CSVReader/index.html">CSVReader</a><br/><a > >href="../../../nifi-parquet-nar/1.11.3/org.apache.nifi.parquet.ParquetReader/index.html">ParquetReader</a><br/><a > >href="../../../nifi-record-serialization-services-nar/1.11.3/org.apache.nifi.syslog.Syslog5424Reader/index.html">Syslog5424Reader</a></td><td > id="description">The record reader to use for reading incoming records from >flowfiles.</td></tr><tr><td id="name"><strong>Batch Size</strong></td><td >id="default-value">100</td><td id="allowable-values"></td><td >id="description">T he number of records to send over in a single batch.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">ID Record Path</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A record path expression to retrieve the ID field for use with Elasticsearch. If left blank the ID will be automatically generated by Elasticsearch.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Index Record Path</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A record path expression to retrieve the index field for use with Elasticsearch. If left blank the index will be determined using the main index property.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr>< tr><td id="name">Type Record Path</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A record path expression to retrieve the type field for use with Elasticsearch. If left blank the type will be determined using the main type property.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Log Error Responses</td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">If this is enabled, errors will be logged to the NiFi logs at the error log level. Otherwise, they will only be logged if debug logging is enabled on NiFi as a whole. The purpose of this option is to give the user the ability to debug failed operations without having to turn on debug logging.</td></tr><tr><td id="name">Error Record Writer</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.11.3/org.apache.nifi.text.FreeFormTextRecordSetWriter/index.html">FreeFormTextRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.3/org.apache.nifi.json.JsonRecordSetWriter/index.html">JsonRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.3/org.apache.nifi.csv.CSVRecordSetWriter/index.html">CSVRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.3/org.apache.nifi.avro.AvroRecordSetWriter/index.html">AvroRecordSetWriter</a><br/><a href="../../../nifi-scripting-nar/1.11.3/org.apache.nifi.record.script.ScriptedRecordSetWriter/index.html">ScriptedRecordSetWriter</a><br/><a href="../../../nifi-parquet-nar/1.11.3/org.apache.nifi.parquet.ParquetRecordSetWriter/index.html">ParquetRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-n ar/1.11.3/org.apache.nifi.xml.XMLRecordSetWriter/index.html">XMLRecordSetWriter</a></td><td id="description">If this configuration property is set, the response from Elasticsearch will be examined for failed records and the failed records will be written to a record set with this record writer service and sent to the "errors" relationship.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>retry</td><td>All flowfiles that fail due to server/cluster availability go to this relationship.</td></tr><tr><td>success</td><td>All flowfiles that succeed in being transferred into Elasticsearch go here.</td></tr><tr><td>failure</td><td>All flowfiles that fail for reasons unrelated to server availability go to this relationship.</td></tr><tr><td>errors</td><td>If an output record write is set, any record that failed to process the way it was configured will be sent to this relationship as part of a failed record record set.</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>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.11.3/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.11.3/org.apache.nifi.processors.email.ConsumeEWS/index.html?rev=1874478&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-email-nar/1.11.3/org.apache.nifi.processors.email.ConsumeEWS/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-email-nar/1.11.3/org.apache.nifi.processors.email.ConsumeEWS/index.html Tue Feb 25 07:28:36 2020 @@ -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.11.3/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.11.3/org.apache.nifi.processors.email.ConsumeIMAP/additionalDetails.html?rev=1874478&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-email-nar/1.11.3/org.apache.nifi.processors.email.ConsumeIMAP/additionalDetails.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-email-nar/1.11.3/org.apache.nifi.processors.email.ConsumeIMAP/additionalDetails.html Tue Feb 25 07:28:36 2020 @@ -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.11.3/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.11.3/org.apache.nifi.processors.email.ConsumeIMAP/index.html?rev=1874478&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-email-nar/1.11.3/org.apache.nifi.processors.email.ConsumeIMAP/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-email-nar/1.11.3/org.apache.nifi.processors.email.ConsumeIMAP/index.html Tue Feb 25 07:28:36 2020 @@ -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.11.3/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.11.3/org.apache.nifi.processors.email.ConsumePOP3/additionalDetails.html?rev=1874478&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-email-nar/1.11.3/org.apache.nifi.processors.email.ConsumePOP3/additionalDetails.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-email-nar/1.11.3/org.apache.nifi.processors.email.ConsumePOP3/additionalDetails.html Tue Feb 25 07:28:36 2020 @@ -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.11.3/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.11.3/org.apache.nifi.processors.email.ConsumePOP3/index.html?rev=1874478&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-email-nar/1.11.3/org.apache.nifi.processors.email.ConsumePOP3/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-email-nar/1.11.3/org.apache.nifi.processors.email.ConsumePOP3/index.html Tue Feb 25 07:28:36 2020 @@ -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.11.3/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.11.3/org.apache.nifi.processors.email.ExtractEmailAttachments/index.html?rev=1874478&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-email-nar/1.11.3/org.apache.nifi.processors.email.ExtractEmailAttachments/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-email-nar/1.11.3/org.apache.nifi.processors.email.ExtractEmailAttachments/index.html Tue Feb 25 07:28:36 2020 @@ -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.11.3/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.11.3/org.apache.nifi.processors.email.ExtractEmailHeaders/index.html?rev=1874478&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-email-nar/1.11.3/org.apache.nifi.processors.email.ExtractEmailHeaders/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-email-nar/1.11.3/org.apache.nifi.processors.email.ExtractEmailHeaders/index.html Tue Feb 25 07:28:36 2020 @@ -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.11.3/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.11.3/org.apache.nifi.processors.email.ExtractTNEFAttachments/index.html?rev=1874478&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-email-nar/1.11.3/org.apache.nifi.processors.email.ExtractTNEFAttachments/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-email-nar/1.11.3/org.apache.nifi.processors.email.ExtractTNEFAttachments/index.html Tue Feb 25 07:28:36 2020 @@ -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.11.3/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.11.3/org.apache.nifi.processors.email.ListenSMTP/index.html?rev=1874478&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-email-nar/1.11.3/org.apache.nifi.processors.email.ListenSMTP/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-email-nar/1.11.3/org.apache.nifi.processors.email.ListenSMTP/index.html Tue Feb 25 07:28:36 2020 @@ -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.11.3/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 SMT P 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.11.3/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.11.3/org.apache.nifi.processors.GeoEnrichIP/index.html?rev=1874478&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-enrich-nar/1.11.3/org.apache.nifi.processors.GeoEnrichIP/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-enrich-nar/1.11.3/org.apache.nifi.processors.GeoEnrichIP/index.html Tue Feb 25 07:28:36 2020 @@ -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<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></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 attribute 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
