Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-redis-nar/1.5.0/org.apache.nifi.redis.service.RedisConnectionPoolService/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-redis-nar/1.5.0/org.apache.nifi.redis.service.RedisConnectionPoolService/index.html?rev=1821033&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-redis-nar/1.5.0/org.apache.nifi.redis.service.RedisConnectionPoolService/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-redis-nar/1.5.0/org.apache.nifi.redis.service.RedisConnectionPoolService/index.html Fri Jan 12 21:00:14 2018 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>RedisConnectionPoolService</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;">RedisConnectionPoolService</h1><h2>Description: </h2><p>A service that provides connections to Redis.</p><h3>Tags: </h3><p>redis, cache</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>Redis Mode</strong></td><td id="default-value">Standalone</td><td id="allowable-values"><ul><li>Standalone <img src="../../../../../html/images/iconInfo.png" alt="A single standalone Redis instance." title="A single standalone Redis instance."></img></li><li>Sentinel <img src="../../../../../html/images/iconInfo.png" alt="Redis Sentinel which provides high-availability. Described further at https://redis.io/topics/sentinel"; title="Redis Sentinel which provides high-availability. Described further at https://redis.io/topics/sentinel";></img></li><li>Cluster <img src="../../../../../html/images/iconInfo.png" alt="Clustered Redis which provides sharding and replication. Described further at https:/ /redis.io/topics/cluster-spec" title="Clustered Redis which provides sharding and replication. Described further at https://redis.io/topics/cluster-spec";></img></li></ul></td><td id="description">The type of Redis being communicated with - standalone, sentinel, or clustered.</td></tr><tr><td id="name"><strong>Connection String</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The connection string for Redis. In a standalone instance this value will be of the form hostname:port. In a sentinel instance this value will be the comma-separated list of sentinels, such as host1:port1,host2:port2,host3:port3. In a clustered instance this value will be the comma-separated list of cluster masters, such as host1:port,host2:port,host3:port.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Database Index</strong></td><td id="default-value">0</td><td id="allowable-values"></td><td id="description">The database in dex to be used by connections created from this connection pool. See the databases property in redis.conf, by default databases 0-15 will be available.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Communication Timeout</strong></td><td id="default-value">10 seconds</td><td id="allowable-values"></td><td id="description">The timeout to use when attempting to communicate with Redis.</td></tr><tr><td id="name"><strong>Cluster Max Redirects</strong></td><td id="default-value">5</td><td id="allowable-values"></td><td id="description">The maximum number of redirects that can be performed when clustered.</td></tr><tr><td id="name">Sentinel Master</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the sentinel master, require when Mode is set to Sentinel<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Password</td><td id="default-value"></td><td id="allowable-values" ></td><td id="description">The password used to authenticate to the Redis >server. See the requirepass property in redis.conf.<br/><strong>Sensitive >Property: true</strong><br/><strong>Supports Expression Language: >true</strong></td></tr><tr><td id="name"><strong>Pool - Max >Total</strong></td><td id="default-value">8</td><td >id="allowable-values"></td><td id="description">The maximum number of >connections that can be allocated by the pool (checked out to clients, or >idle awaiting checkout). A negative value indicates that there is no >limit.</td></tr><tr><td id="name"><strong>Pool - Max Idle</strong></td><td >id="default-value">8</td><td id="allowable-values"></td><td >id="description">The maximum number of idle connections that can be held in >the pool, or a negative value if there is no limit.</td></tr><tr><td >id="name"><strong>Pool - Min Idle</strong></td><td >id="default-value">0</td><td id="allowable-values"></td><td >id="description">The target for the minimum number of idle connecti ons to maintain in the pool. If the configured value of Min Idle is greater than the configured value for Max Idle, then the value of Max Idle will be used instead.</td></tr><tr><td id="name"><strong>Pool - Block When Exhausted</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 clients should block and wait when trying to obtain a connection from the pool when the pool has no available connections. Setting this to false means an error will occur immediately when a client requests a connection and none are available.</td></tr><tr><td id="name"><strong>Pool - Max Wait Time</strong></td><td id="default-value">10 seconds</td><td id="allowable-values"></td><td id="description">The amount of time to wait for an available connection when Block When Exhausted is set to true.</td></tr><tr><td id="name"><strong>Pool - Min Evictable Idle Time</strong></td><td id="default-value">60 seconds</td><td i d="allowable-values"></td><td id="description">The minimum amount of time an object may sit idle in the pool before it is eligible for eviction.</td></tr><tr><td id="name"><strong>Pool - Time Between Eviction Runs</strong></td><td id="default-value">30 seconds</td><td id="allowable-values"></td><td id="description">The amount of time between attempting to evict idle connections from the pool.</td></tr><tr><td id="name"><strong>Pool - Num Tests Per Eviction Run</strong></td><td id="default-value">-1</td><td id="allowable-values"></td><td id="description">The number of connections to tests per eviction attempt. A negative value indicates to test all connections.</td></tr><tr><td id="name"><strong>Pool - Test On Create</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Whether or not connections should be tested upon creation.</td></tr><tr><td id="name"><strong>Pool - Test On Borrow</strong></td><td id=" default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Whether or not connections should be tested upon borrowing from the pool.</td></tr><tr><td id="name"><strong>Pool - Test On Return</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Whether or not connections should be tested upon returning to the pool.</td></tr><tr><td id="name"><strong>Pool - Test While Idle</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 connections should be tested while idle.</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.</body></html> \ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-redis-nar/1.5.0/org.apache.nifi.redis.service.RedisDistributedMapCacheClientService/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-redis-nar/1.5.0/org.apache.nifi.redis.service.RedisDistributedMapCacheClientService/index.html?rev=1821033&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-redis-nar/1.5.0/org.apache.nifi.redis.service.RedisDistributedMapCacheClientService/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-redis-nar/1.5.0/org.apache.nifi.redis.service.RedisDistributedMapCacheClientService/index.html Fri Jan 12 21:00:14 2018 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>RedisDistributedMapCacheClientService</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;">RedisDistributedMapCacheClientService</h1><h2>Description: </h2><p>An implementation of DistributedMapCacheClient that uses Redis as the backing cache. This service relies on the WATCH, MULTI, and EXEC commands in Redis, which are not fully supported when Redis is clustered. As a result, this service can only be used with a Redis Connection Pool that is configured for standalone or sentinel mode. Sentinel mode can be used to provide high-availability configurations.</p><h3>Tags: </h3><p>redis, distributed, cache, map</p><h3>Properties: </h3><p>In the list below, the names o f 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>Redis Connection Pool</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>RedisConnectionPool<br/><strong>Implementation: </strong><a href="../org.apache.nifi.redis.service.RedisConnectionPoolService/index.html">RedisConnectionPoolService</a></td><td id="description">No Description Provided.</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-registry-nar/1.5.0/org.apache.nifi.schemaregistry.services.AvroSchemaRegistry/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-registry-nar/1.5.0/org.apache.nifi.schemaregistry.services.AvroSchemaRegistry/index.html?rev=1821033&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-registry-nar/1.5.0/org.apache.nifi.schemaregistry.services.AvroSchemaRegistry/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-registry-nar/1.5.0/org.apache.nifi.schemaregistry.services.AvroSchemaRegistry/index.html Fri Jan 12 21:00:14 2018 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>AvroSchemaRegistry</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;">AvroSchemaRegistry</h1><h2>Description: </h2><p>Provides a service for registering and accessing schemas. You can register a schema as a dynamic property where 'name' represents the schema name and 'value' represents the textual representation of the actual schema following the syntax and semantics of Avro's Schema format.</p><h3>Tags: </h3><p>schema, registry, avro, json, csv</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>Validate Field >Names</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 validate the field names in the Avro >schema based on Avro naming rules. If set to true, all field names must be >valid Avro names, which must begin with [A-Za-z_], and subsequently contain >only [A-Za-z0-9_]. If set to false, no validation will be performed on the >field names.</td></tr></table><h3>State management: </h3>This component does >not store state.<h3>Restricted: </h3>This component is not >restricted.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-rethinkdb-nar/1.5.0/org.apache.nifi.processors.rethinkdb.DeleteRethinkDB/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-rethinkdb-nar/1.5.0/org.apache.nifi.processors.rethinkdb.DeleteRethinkDB/index.html?rev=1821033&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-rethinkdb-nar/1.5.0/org.apache.nifi.processors.rethinkdb.DeleteRethinkDB/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-rethinkdb-nar/1.5.0/org.apache.nifi.processors.rethinkdb.DeleteRethinkDB/index.html Fri Jan 12 21:00:14 2018 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>DeleteRethinkDB</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;">DeleteRethinkDB</h1><h2>Description: </h2><p>Processor to remove a JSON document from RethinkDB (https://www.rethinkdb.com/) using the document id.</p><h3>Tags: </h3><p>rethinkdb, delete, remove</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>DB Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">RethinkDB database to connect to</td></tr><tr><td id="name"><strong>Hostname</strong></td><td id="default-value">localhost</td><td id="allowable-values"></td><td id="description">RethinkDB hostname</td></tr><tr><td id="name"><strong>DB Port</strong></td><td id="default-value">28015</td><td id="allowable-values"></td><td id="description">RethinkDB database port to connect to</td></tr><tr><td id="name">Username</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Username for accessing RethinkDB</td></tr><tr><td id="nam e">Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Password for user<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name"><strong>Table name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">RethinkDB table to connect to</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</strong></td></tr><tr><td id="name"><strong>Document Identifier</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A FlowFile attribute, or attribute expression used for determining RethinkDB key for the Flow File content<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Return deleted value</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>True <img src="../../../../../html/images/iconInfo.png" alt="Return changed document" title="Return changed document"></img></li><li>False <img src="../../../../../html/images/iconInfo.png" alt="Do not return changed document" title="Do not return changed document"></img></li></ul></td><td id="description">Return old value which were deleted<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Durablity of documents</strong></td><td id="default-value">hard</td><td id="allowable-values"><ul><li>Hard <img src="../../../../../html/images/iconInfo.png" alt="Save change to disk before ack" title="Save change to disk before ack"></img></li><li>Soft <img src="../../../../../html/images/iconInfo.png" alt="Don't save changes to disk before ack" title="Don't save changes to disk before ack"></img></li></ul></td><td id="description">Durability of documents being inserted<br/><strong>Supports Expression Language: true</strong> </td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>Sucessful FlowFiles are routed to this relationship</td></tr><tr><td>not_found</td><td>Document not found are routed to this relationship</td></tr><tr><td>failure</td><td>Failed FlowFiles 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>Description</th></tr><tr><td>rethinkdb.error.message</td><td>RethinkDB error message</td></tr><tr><td>rethinkdb.delete.errors</td><td>Error count while delete documents</td></tr><tr><td>rethinkdb.delete.deleted</td><td>Number of documents deleted</td></tr><tr><td>rethinkdb.delete.inserted</td><td>Number of documents inserted</td></tr><tr><td>rethinkdb.delete.replaced</td><td>Number of documents replaced</td></tr><tr><td>rethinkdb.delete.skipped</td><td>Number of documents skipped</td></tr><tr><td>ret hinkdb.delete.unchanged</td><td>Number of documents unchanged since they already existed</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>See Also:</h3><p><a href="../org.apache.nifi.processors.rethinkdb.PutRethinkDB/index.html">PutRethinkDB</a>, <a href="../org.apache.nifi.processors.rethinkdb.GetRethinkDB/index.html">GetRethinkDB</a></p></body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-rethinkdb-nar/1.5.0/org.apache.nifi.processors.rethinkdb.GetRethinkDB/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-rethinkdb-nar/1.5.0/org.apache.nifi.processors.rethinkdb.GetRethinkDB/index.html?rev=1821033&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-rethinkdb-nar/1.5.0/org.apache.nifi.processors.rethinkdb.GetRethinkDB/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-rethinkdb-nar/1.5.0/org.apache.nifi.processors.rethinkdb.GetRethinkDB/index.html Fri Jan 12 21:00:14 2018 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>GetRethinkDB</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;">GetRethinkDB</h1><h2>Description: </h2><p>Processor to get a JSON document from RethinkDB (https://www.rethinkdb.com/) using the document id. The FlowFile will contain the retrieved document</p><h3>Tags: </h3><p>rethinkdb, get, read, fetch</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>DB Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">RethinkDB database to connect to</td></tr><tr><td id="name"><strong>Hostname</strong></td><td id="default-value">localhost</td><td id="allowable-values"></td><td id="description">RethinkDB hostname</td></tr><tr><td id="name"><strong>DB Port</strong></td><td id="default-value">28015</td><td id="allowable-values"></td><td id="description">RethinkDB database port to connect to</td></tr><tr><td id="name">Username</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Username for ac cessing RethinkDB</td></tr><tr><td id="name">Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Password for user<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name"><strong>Table name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">RethinkDB table to connect to</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</strong></td></tr><tr><td id="name"><strong>Document Identifier</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A FlowFile attribute, or attribute expression used for determining RethinkDB key for the Flow File content<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Read Mode</strong></td><td id="default-value">single</td><td id="allowable-values"><ul><li>Single <img src="../../../../../html/images/iconInfo.png" alt="Read values from memory from primary replica (Default)" title="Read values from memory from primary replica (Default)"></img></li><li>Majority <img src="../../../../../html/images/iconInfo.png" alt="Read values committed to disk on majority of replicas" title="Read values committed to disk on majority of replicas"></img></li><li>Outdated <img src="../../../../../html/images/iconInfo.png" alt="Read values from memory from an arbitrary replica " title="Read values from memory from an arbitrary replica "></img></li></ul></td><td id="description">Read mode used for consistency<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Max size of documents</strong></td><td id="default-value">1 MB</td><td id="allowable-values"></td><td id="description">Maximum size of documents allowed to be posted in one batch</td></tr></table><h3 >Relationships: </h3><table >id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>Sucessful > FlowFiles are routed to this >relationship</td></tr><tr><td>not_found</td><td>Document not found are routed >to this relationship</td></tr><tr><td>failure</td><td>Failed FlowFiles 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>Description</th></tr><tr><td>rethinkdb.error.message</td><td>RethinkDB > error 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>See Also:</h3><p><a >href="../org.apache.nifi.processors.rethinkdb.PutRethinkDB/index.html">PutRethinkDB</a>, > <a >href="../org.apache.nifi.processors.rethinkdb.DeleteRethinkDB/index.html">DeleteRethinkDB</a></p></body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-rethinkdb-nar/1.5.0/org.apache.nifi.processors.rethinkdb.PutRethinkDB/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-rethinkdb-nar/1.5.0/org.apache.nifi.processors.rethinkdb.PutRethinkDB/index.html?rev=1821033&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-rethinkdb-nar/1.5.0/org.apache.nifi.processors.rethinkdb.PutRethinkDB/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-rethinkdb-nar/1.5.0/org.apache.nifi.processors.rethinkdb.PutRethinkDB/index.html Fri Jan 12 21:00:14 2018 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutRethinkDB</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;">PutRethinkDB</h1><h2>Description: </h2><p>Processor to write the JSON content of a FlowFile to RethinkDB (https://www.rethinkdb.com/). The flow file should contain either JSON Object an array of JSON documents</p><h3>Tags: </h3><p>rethinkdb, stream, insert, update, write, put</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression La nguage</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>DB Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">RethinkDB database to connect to</td></tr><tr><td id="name"><strong>Hostname</strong></td><td id="default-value">localhost</td><td id="allowable-values"></td><td id="description">RethinkDB hostname</td></tr><tr><td id="name"><strong>DB Port</strong></td><td id="default-value">28015</td><td id="allowable-values"></td><td id="description">RethinkDB database port to connect to</td></tr><tr><td id="name">Username</td><td id="default-value"></td><td id="allowable-values"></td ><td id="description">Username for accessing RethinkDB</td></tr><tr><td >id="name">Password</td><td id="default-value"></td><td >id="allowable-values"></td><td id="description">Password for >user<br/><strong>Sensitive Property: true</strong></td></tr><tr><td >id="name"><strong>Table name</strong></td><td id="default-value"></td><td >id="allowable-values"></td><td id="description">RethinkDB table to connect >to</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</strong></td></tr><tr><td id="name"><strong>Conflict >strategy</strong></td><td id="default-value">update</td><td >id="allowable-values"><ul><li>Update <img >src="../../../../../html/images/iconInfo.png" alt="Update the document having >same id with new values" title="Update the document having same id with new >values"></img></li><li>Replace <img src="../../../../../html/images/iconInfo.png" alt="Replace the document with having same id new document" title="Replace the document with having same id new document"></img></li><li>Error <img src="../../../../../html/images/iconInfo.png" alt="Return error if the document with same id exists" title="Return error if the document with same id exists"></img></li></ul></td><td id="description">Conflict strategy to be used in case of inserting existing document.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Durablity of documents</strong></td><td id="default-value">hard</td><td id="allowable-values"><ul><li>Hard <img src="../../../../../html/images/iconInfo.png" alt="Save change to disk before ack" title="Save change to disk before ack"></img></li><li>Soft <img src="../../../../../html/images/iconInfo.png" alt="Don't save changes to disk before ack" title="Don't save changes to disk before ack"></img></li></ul></td><td id="description">Durabi lity of documents being inserted<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Max size of documents</strong></td><td id="default-value">1 MB</td><td id="allowable-values"></td><td id="description">Maximum size of documents allowed to be posted in one batch</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>Sucessful FlowFiles are routed to this relationship</td></tr><tr><td>failure</td><td>Failed FlowFiles 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>Description</th></tr><tr><td>rethinkdb.error.message</td><td>RethinkDB error message</td></tr><tr><td>rethinkdb.insert.errors</td><td>Error count while inserting documents</td></tr><tr><td>rethinkdb.insert.deleted</td><td>Number of documents deleted</td></tr><tr><td>rethinkdb.insert.gener ated_keys</td><td>Keys generated on inserting documents</td></tr><tr><td>rethinkdb.insert.inserted</td><td>Number of documents inserted</td></tr><tr><td>rethinkdb.insert.replaced</td><td>Number of documents replaced</td></tr><tr><td>rethinkdb.insert.skipped</td><td>Number of documents skipped because they already existed</td></tr><tr><td>rethinkdb.insert.unchanged</td><td>Number of documents unchanged since they already existed</td></tr><tr><td>rethinkdb.insert.first_error</td><td>First error while inserting documents</td></tr><tr><td>rethinkdb.insert.warnings</td><td>Warning message in case of large number of ids being returned on insertion</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>See Also:</h3><p><a href="../org.apache.nifi.processors.rethinkdb.GetRethinkDB/index.html">GetRethinkDB</a>, <a href="../org.apache. nifi.processors.rethinkdb.DeleteRethinkDB/index.html">DeleteRethinkDB</a></p></body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-riemann-nar/1.5.0/org.apache.nifi.processors.riemann.PutRiemann/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-riemann-nar/1.5.0/org.apache.nifi.processors.riemann.PutRiemann/index.html?rev=1821033&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-riemann-nar/1.5.0/org.apache.nifi.processors.riemann.PutRiemann/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-riemann-nar/1.5.0/org.apache.nifi.processors.riemann.PutRiemann/index.html Fri Jan 12 21:00:14 2018 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutRiemann</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;">PutRiemann</h1><h2>Description: </h2><p>Send events to Riemann (http://riemann.io) when FlowFiles pass through this processor. You can use events to notify Riemann that a FlowFile passed through, or you can attach a more meaningful metric, such as, the time a FlowFile took to get to this processor. All attributes attached to events support the NiFi Expression Language.</p><h3>Tags: </h3><p>riemann, monitoring, metrics</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 als o 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>Riemann Address</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Hostname of Riemann server</td></tr><tr><td id="name"><strong>Riemann Port</strong></td><td id="default-value">5555</td><td id="allowable-values"></td><td id="description">Port that Riemann is listening on</td></tr><tr><td id="name"><strong>Transport Protocol</strong></td><td id="default-value">TCP</td><td id="allowable-values"><ul><li>TCP</li><li>UDP</li></ul></td><td id="description">Transport protocol to speak to Riemann in</td></tr><tr><td id="name"><strong>Timeout</strong></td><td id="default-value">1000</td><td id="allowable-values"></td><td id="description">Timeout in millis econds when writing events to Riemann</td></tr><tr><td id="name">Batch Size</td><td id="default-value">100</td><td id="allowable-values"></td><td id="description">Batch size for incoming FlowFiles</td></tr><tr><td id="name">Description</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Description associated to the event<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Service</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Name of service associated to this event (e.g. FTP File Fetched)<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">State</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">State of service associated to this event in string form (e.g. ok, warning, foo)<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Metric</td><td id="default-value"></td><td id="allowable-values" ></td><td id="description">Floating point number associated to this >event<br/><strong>Supports Expression Language: >true</strong></td></tr><tr><td id="name">TTL</td><td >id="default-value"></td><td id="allowable-values"></td><td >id="description">Floating point value in seconds until Riemann considers this >event as "expired"<br/><strong>Supports Expression Language: >true</strong></td></tr><tr><td id="name">Tags</td><td >id="default-value"></td><td id="allowable-values"></td><td >id="description">Comma separated list of tags associated to the >event<br/><strong>Supports Expression Language: >true</strong></td></tr><tr><td id="name">Host</td><td >id="default-value">${hostname()}</td><td id="allowable-values"></td><td >id="description">A hostname associated to this event (e.g. >nifi-app1)<br/><strong>Supports Expression Language: >true</strong></td></tr><tr><td id="name">Time</td><td >id="default-value"></td><td id="allowable-values"></td><td >id="description">Time of event in unix epoch seconds ( long), default: (current time)<br/><strong>Supports Expression Language: true</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">Custom Event Attribute</td><td id="value">Any value or expression</td><td>These values will be attached to the Riemann event as a custom attribute<br/><strong>Supports Expression Language: true</strong></td></tr></table></p><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>Metrics successfully written to Riemann</td></tr><tr><td>failure</td><td>Metrics which failed to write to Riemann</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted. <h3>Input requirement: </h3>This component requires an incoming relationship.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.5.0/org.apache.nifi.lookup.script.ScriptedLookupService/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.5.0/org.apache.nifi.lookup.script.ScriptedLookupService/index.html?rev=1821033&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.5.0/org.apache.nifi.lookup.script.ScriptedLookupService/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.5.0/org.apache.nifi.lookup.script.ScriptedLookupService/index.html Fri Jan 12 21:00:14 2018 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ScriptedLookupService</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;">ScriptedLookupService</h1><h2>Description: </h2><p>Allows the user to provide a scripted LookupService instance in order to enrich records from an incoming flow file.</p><h3>Tags: </h3><p>lookup, record, script, invoke, groovy, python, jython, jruby, ruby, javascript, js, lua, luaj, restricted</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>Script Engine</strong></td><td id="default-value">Clojure</td><td id="allowable-values"><ul><li>Clojure</li><li>ECMAScript</li><li>Groovy</li><li>lua</li><li>python</li><li>ruby</li></ul></td><td id="description">The engine to execute scripts</td></tr><tr><td id="name">Script File</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Path to script file to execute. Only one of Script File or Script Body may be used<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Script Body</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Body of script to execute. Only one of Script File or Script Body may be used</td></tr><tr><td id="name">Module Directory</td><td id="default-value"></td><td id="allowable-values"></td> <td id="description">Comma-separated list of paths to files and/or directories which contain modules required by the script.<br/><strong>Supports Expression Language: true</strong></td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>Provides operator the ability to execute arbitrary code assuming all permissions that NiFi has.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.5.0/org.apache.nifi.processors.script.ExecuteScript/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.5.0/org.apache.nifi.processors.script.ExecuteScript/index.html?rev=1821033&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.5.0/org.apache.nifi.processors.script.ExecuteScript/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.5.0/org.apache.nifi.processors.script.ExecuteScript/index.html Fri Jan 12 21:00:14 2018 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ExecuteScript</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;">ExecuteScript</h1><h2>Description: </h2><p>Experimental - Executes a script given the flow file and a process session. The script is responsible for handling the incoming flow file (transfer to SUCCESS or remove, e.g.) as well as any flow files created by the script. If the handling is incomplete or incorrect, the session will be rolled back. Experimental: Impact of sustained usage not yet verified.</p><h3>Tags: </h3><p>script, execute, groovy, python, jython, jruby, ruby, javascript, js, lua, luaj, clojure, restricted</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>Script Engine</strong></td><td id="default-value">Clojure</td><td id="allowable-values"><ul><li>Clojure</li><li>ECMAScript</li><li>Groovy</li><li>lua</li><li>python</li><li>ruby</li></ul></td><td id="description">The engine to execute scripts</td></tr><tr><td id="name">Script File</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Path to script file to execute. Only one of Script File or Script Body may be used<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Script Body</td><td id="default-value"></td><td id="allowa ble-values"></td><td id="description">Body of script to execute. Only one of Script File or Script Body may be used</td></tr><tr><td id="name">Module Directory</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Comma-separated list of paths to files and/or directories which contain modules required by the script.<br/><strong>Supports Expression Language: true</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 script engine property to update</td><td id="value">The value to set it to</td><td>Updates a script engine property specified by the Dynamic Property's key with the value specified by the Dynamic Property's value<br/><strong>Supports Expression Language: true</strong></td></tr></table></p><h3>Relationships: </h3><table id="relationships"><tr><th>Name</ th><th>Description</th></tr><tr><td>success</td><td>FlowFiles that were successfully processed</td></tr><tr><td>failure</td><td>FlowFiles that failed to be processed</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>State management: </h3><table id="stateful"><tr><th>Scope</th><th>Description</th></tr><tr><td>LOCAL, CLUSTER</td><td>Scripts can store and retrieve state using the State Management APIs. Consult the State Manager section of the Developer's Guide for more details.</td></tr></table><h3>Restricted: </h3>Provides operator the ability to execute arbitrary code assuming all permissions that NiFi has.<h3>See Also:</h3><p><a href="../org.apache.nifi.processors.script.InvokeScriptedProcessor/index.html">InvokeScriptedProcessor</a></p></body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.5.0/org.apache.nifi.processors.script.InvokeScriptedProcessor/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.5.0/org.apache.nifi.processors.script.InvokeScriptedProcessor/index.html?rev=1821033&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.5.0/org.apache.nifi.processors.script.InvokeScriptedProcessor/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.5.0/org.apache.nifi.processors.script.InvokeScriptedProcessor/index.html Fri Jan 12 21:00:14 2018 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>InvokeScriptedProcessor</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;">InvokeScriptedProcessor</h1><h2>Description: </h2><p>Experimental - Invokes a script engine for a Processor defined in the given script. The script must define a valid class that implements the Processor interface, and it must set a variable 'processor' to an instance of the class. Processor methods such as onTrigger() will be delegated to the scripted Processor instance. Also any Relationships or PropertyDescriptors defined by the scripted processor will be added to the configuration dialog. Experimental: Impact of sustained usage not yet verified.</p><h3>Tags: </h3><p>script, invoke, groovy, python, jython, jruby, ruby, javascript, js, lua, luaj, restricted</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>Script Engine</strong></td><td id="default-value">Clojure</td><td id="allowable-values"><ul><li>Clojure</li><li>ECMAScript</li><li>Groovy</li><li>lua</li><li>python</li><li>ruby</li></ul></td><td id="description">The engine to execute scripts</td></tr><tr><td id="name">Script File</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Path to script file to execute. Only one of Script File or Script Body may be used<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Script Body</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Body of script to execute. Only one of Script File or Script Body may be used</td></tr><tr><td id="name">Module Directory</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Comma-separated list of paths to files and/or directories which contain modules required by the script.<br/><strong>Supports Expression Language: true</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 script engine property to update</td><td id="value">The value to set it to</td><td>Updates a script engine property specified by the Dynamic Property's key with the value specified by the Dynamic Prope rty's value<br/><strong>Supports Expression Language: true</strong></td></tr></table></p><h3>Relationships: </h3>This processor has no relationships.<h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>State management: </h3><table id="stateful"><tr><th>Scope</th><th>Description</th></tr><tr><td>LOCAL, CLUSTER</td><td>Scripts can store and retrieve state using the State Management APIs. Consult the State Manager section of the Developer's Guide for more details.</td></tr></table><h3>Restricted: </h3>Provides operator the ability to execute arbitrary code assuming all permissions that NiFi has.<h3>See Also:</h3><p><a href="../org.apache.nifi.processors.script.ExecuteScript/index.html">ExecuteScript</a></p></body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.5.0/org.apache.nifi.record.script.ScriptedReader/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.5.0/org.apache.nifi.record.script.ScriptedReader/index.html?rev=1821033&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.5.0/org.apache.nifi.record.script.ScriptedReader/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.5.0/org.apache.nifi.record.script.ScriptedReader/index.html Fri Jan 12 21:00:14 2018 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ScriptedReader</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;">ScriptedReader</h1><h2>Description: </h2><p>Allows the user to provide a scripted RecordReaderFactory instance in order to read/parse/generate records from an incoming flow file.</p><h3>Tags: </h3><p>record, recordFactory, script, invoke, groovy, python, jython, jruby, ruby, javascript, js, lua, luaj, restricted</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the <a href="../../../../../html/express ion-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Script Engine</strong></td><td id="default-value">Clojure</td><td id="allowable-values"><ul><li>Clojure</li><li>ECMAScript</li><li>Groovy</li><li>lua</li><li>python</li><li>ruby</li></ul></td><td id="description">The engine to execute scripts</td></tr><tr><td id="name">Script File</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Path to script file to execute. Only one of Script File or Script Body may be used<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Script Body</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Body of script to execute. Only one of Script File or Script Body may be used</td></tr><tr><td id="name">Module Directory</td><td id="default-value"></td><td id="allowable-v alues"></td><td id="description">Comma-separated list of paths to files and/or directories which contain modules required by the script.<br/><strong>Supports Expression Language: true</strong></td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>Provides operator the ability to execute arbitrary code assuming all permissions that NiFi has.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.5.0/org.apache.nifi.record.script.ScriptedRecordSetWriter/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.5.0/org.apache.nifi.record.script.ScriptedRecordSetWriter/index.html?rev=1821033&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.5.0/org.apache.nifi.record.script.ScriptedRecordSetWriter/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.5.0/org.apache.nifi.record.script.ScriptedRecordSetWriter/index.html Fri Jan 12 21:00:14 2018 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ScriptedRecordSetWriter</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;">ScriptedRecordSetWriter</h1><h2>Description: </h2><p>Allows the user to provide a scripted RecordSetWriterFactory instance in order to write records to an outgoing flow file.</p><h3>Tags: </h3><p>record, writer, script, invoke, groovy, python, jython, jruby, ruby, javascript, js, lua, luaj, restricted</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/expressio n-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>Script Engine</strong></td><td id="default-value">Clojure</td><td id="allowable-values"><ul><li>Clojure</li><li>ECMAScript</li><li>Groovy</li><li>lua</li><li>python</li><li>ruby</li></ul></td><td id="description">The engine to execute scripts</td></tr><tr><td id="name">Script File</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Path to script file to execute. Only one of Script File or Script Body may be used<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Script Body</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Body of script to execute. Only one of Script File or Script Body may be used</td></tr><tr><td id="name">Module Directory</td><td id="default-value"></td><td id="allowable-val ues"></td><td id="description">Comma-separated list of paths to files and/or directories which contain modules required by the script.<br/><strong>Supports Expression Language: true</strong></td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>Provides operator the ability to execute arbitrary code assuming all permissions that NiFi has.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.5.0/org.apache.nifi.reporting.script.ScriptedReportingTask/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.5.0/org.apache.nifi.reporting.script.ScriptedReportingTask/index.html?rev=1821033&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.5.0/org.apache.nifi.reporting.script.ScriptedReportingTask/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.5.0/org.apache.nifi.reporting.script.ScriptedReportingTask/index.html Fri Jan 12 21:00:14 2018 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ScriptedReportingTask</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;">ScriptedReportingTask</h1><h2>Description: </h2><p>Provides reporting and status information to a script. ReportingContext, ComponentLog, and VirtualMachineMetrics objects are made available as variables (context, log, and vmMetrics, respectively) to the script for further processing. The context makes various information available such as events, provenance, bulletins, controller services, process groups, Java Virtual Machine metrics, etc.</p><h3>Tags: </h3><p>reporting, script, execute, groovy, python, jython, jruby, ruby, javascript, js, lua, luaj</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>Script Engine</strong></td><td id="default-value">Clojure</td><td id="allowable-values"><ul><li>Clojure</li><li>ECMAScript</li><li>Groovy</li><li>lua</li><li>python</li><li>ruby</li></ul></td><td id="description">The engine to execute scripts</td></tr><tr><td id="name">Script File</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Path to script file to execute. Only one of Script File or Script Body may be used<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Script Body</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Body of script to execute. Only one of Script File or Script Body may be used</td></tr><tr><td id="name">Module Directory</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Comma-separated list of paths to files and/or directories which contain modules required by the script.<br/><strong>Supports Expression Language: true</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 script engine property to update</td><td id="value">The value to set it to</td><td>Updates a script engine property specified by the Dynamic Property's key with the value specified by the Dynamic Property's value<br/><strong>Supports Expression Language: true</strong></td></tr></table></p><h3>State management: </h 3>This component does not store state.<h3>Restricted: </h3>Provides operator the ability to execute arbitrary code assuming all permissions that NiFi has.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.5.0/org.apache.nifi.reporting.SiteToSiteBulletinReportingTask/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.5.0/org.apache.nifi.reporting.SiteToSiteBulletinReportingTask/index.html?rev=1821033&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.5.0/org.apache.nifi.reporting.SiteToSiteBulletinReportingTask/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.5.0/org.apache.nifi.reporting.SiteToSiteBulletinReportingTask/index.html Fri Jan 12 21:00:14 2018 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>SiteToSiteBulletinReportingTask</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;">SiteToSiteBulletinReportingTask</h1><h2>Description: </h2><p>Publishes Bulletin events using the Site To Site protocol. Note: only up to 5 bulletins are stored per component and up to 10 bulletins at controller level for a duration of up to 5 minutes. If this reporting task is not scheduled frequently enough some bulletins may not be sent.</p><h3>Tags: </h3><p>bulletin, site, site to site, restricted</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>Destination URL</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The URL of the destination NiFi instance to send data to, should be a comma-separated list of address in the format of http(s)://host:port/nifi.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Input Port Name</strong></td><td id="default-value"></td><td id="allowable-values"></ td><td id="description">The name of the Input Port to deliver data to.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">SSL Context Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>RestrictedSSLContextService<br/><strong>Implementation: </strong><a href="../../../nifi-ssl-context-service-nar/1.5.0/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</a></td><td id="description">The SSL Context Service to use when communicating with the destination. If not specified, communications will not be secure.</td></tr><tr><td id="name"><strong>Instance URL</strong></td><td id="default-value">http://${hostname(true)}:8080/nifi</td><td id="allowable-values"></td><td id="description">The URL of this instance to use in the Content URI of each event.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Compress Ev ents</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Indicates whether or not to compress the data being sent.</td></tr><tr><td id="name"><strong>Communications Timeout</strong></td><td id="default-value">30 secs</td><td id="allowable-values"></td><td id="description">Specifies how long to wait to a response from the destination before deciding that an error has occurred and canceling the transaction</td></tr><tr><td id="name"><strong>Transport Protocol</strong></td><td id="default-value">RAW</td><td id="allowable-values"><ul><li>RAW</li><li>HTTP</li></ul></td><td id="description">Specifies which transport protocol to use for Site-to-Site communication.</td></tr><tr><td id="name">HTTP Proxy hostname</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Specify the proxy server's hostname to use. If not specified, HTTP traffics are sent directly to the target NiFi instan ce.</td></tr><tr><td id="name">HTTP Proxy port</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Specify the proxy server's port number, optional. If not specified, default port 80 will be used.</td></tr><tr><td id="name">HTTP Proxy username</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Specify an user name to connect to the proxy server, optional.</td></tr><tr><td id="name">HTTP Proxy password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Specify an user password to connect to the proxy server, optional.<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name"><strong>Platform</strong></td><td id="default-value">nifi</td><td id="allowable-values"></td><td id="description">The value to use for the platform field in each provenance event.<br/><strong>Supports Expression Language: true</strong></td></tr></table><h3>State management: </h3><table id="stateful"><t r><th>Scope</th><th>Description</th></tr><tr><td>LOCAL</td><td>Stores the Reporting Task's last bulletin ID so that on restart the task knows where it left off.</td></tr></table><h3>Restricted: </h3>Provides operator the ability to send sensitive details contained in bulletin events to any external system.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.5.0/org.apache.nifi.reporting.SiteToSiteProvenanceReportingTask/additionalDetails.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.5.0/org.apache.nifi.reporting.SiteToSiteProvenanceReportingTask/additionalDetails.html?rev=1821033&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.5.0/org.apache.nifi.reporting.SiteToSiteProvenanceReportingTask/additionalDetails.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.5.0/org.apache.nifi.reporting.SiteToSiteProvenanceReportingTask/additionalDetails.html Fri Jan 12 21:00:14 2018 @@ -0,0 +1,77 @@ +<!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>SiteToSiteProvenanceReportingTask</title> + + <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css" /> + </head> + + <body> + <p> + The Site-to-Site Provenance Reporting Task allows the user to publish all of the Provenance Events from a NiFi instance back to + the same NiFi instance or another NiFi instance. This provides a great deal of power because it allows the user to make use of + all of the different Processors that are available in NiFi in order to processor or distribute that data. When possible, it is + advisable to send the Provenance data to a different NiFi instance than the one that this Reporting Task is running on, because + when the data is received over Site-to-Site and processed, that in and of itself will generate Provenance events. As a result, there + is a cycle that is created. However, the data is sent in batches (1,000 by default). This means that for each batch of Provenance events + that are sent back to NiFi, the receiving NiFi will have to generate only a single event per component. + </p> + + <p> + When published to a NiFi instance, the Provenance data is sent as a JSON array. Quite often, it can be useful to work with this data using + a schema. As such, the schema for this Provenance data can be defined as follows: + </p> + +<pre> +<code> +{ + "namespace": "nifi", + "name": "provenanceEvent", + "type": "record", + "fields": [ + { "name": "eventId", "type": "string" }, + { "name": "eventOrdinal", "type": "long" }, + { "name": "eventType", "type": "string" }, + { "name": "timestampMillis", "type": "long" }, + { "name": "durationMillis", "type": "long" }, + { "name": "lineageStart", "type": { "type": "long", "logicalType": "timestamp-millis" } }, + { "name": "details", "type": "string" }, + { "name": "componentId", "type": "string" }, + { "name": "componentType", "type": "string" }, + { "name": "entityId", "type": "string" }, + { "name": "entityType", "type": "string" }, + { "name": "entitySize", "type": ["null", "long"] }, + { "name": "previousEntitySize", "type": ["null", "long"] }, + { "name": "updatedAttributes", "type": { "type": "map", "values": "string" } }, + { "name": "previousAttributes", "type": { "type": "map", "values": "string" } }, + { "name": "actorHostname", "type": "string" }, + { "name": "contentURI", "type": "string" }, + { "name": "previousContentURI", "type": "string" }, + { "name": "parentIds", "type": { "type": "array", "items": "string" } }, + { "name": "childIds", "type": { "type": "array", "items": "string" } }, + { "name": "platform", "type": "string" }, + { "name": "application", "type": "string" }, + { "name": "transitUri", "type": ["null", "string"] } + ] +} +</code> +</pre> + + + </body> +</html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.5.0/org.apache.nifi.reporting.SiteToSiteProvenanceReportingTask/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.5.0/org.apache.nifi.reporting.SiteToSiteProvenanceReportingTask/index.html?rev=1821033&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.5.0/org.apache.nifi.reporting.SiteToSiteProvenanceReportingTask/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.5.0/org.apache.nifi.reporting.SiteToSiteProvenanceReportingTask/index.html Fri Jan 12 21:00:14 2018 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>SiteToSiteProvenanceReportingTask</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;">SiteToSiteProvenanceReportingTask</h1><h2>Description: </h2><p>Publishes Provenance events using the Site To Site protocol.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>provenance, lineage, tracking, site, site to site, restricted</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">Ni Fi 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>Destination URL</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The URL of the destination NiFi instance to send data to, should be a comma-separated list of address in the format of http(s)://host:port/nifi.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Input Port Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the Input Port to deliver data to.<br/><strong>Supports Expression Language: true</strong></td ></tr><tr><td id="name">SSL Context Service</td><td >id="default-value"></td><td id="allowable-values"><strong>Controller Service >API: </strong><br/>RestrictedSSLContextService<br/><strong>Implementation: ></strong><a >href="../../../nifi-ssl-context-service-nar/1.5.0/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</a></td><td > id="description">The SSL Context Service to use when communicating with the >destination. If not specified, communications will not be >secure.</td></tr><tr><td id="name"><strong>Instance URL</strong></td><td >id="default-value">http://${hostname(true)}:8080/nifi</td><td >id="allowable-values"></td><td id="description">The URL of this instance to >use in the Content URI of each event.<br/><strong>Supports Expression >Language: true</strong></td></tr><tr><td id="name"><strong>Compress >Events</strong></td><td id="default-value">true</td><td >id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="descr iption">Indicates whether or not to compress the data being sent.</td></tr><tr><td id="name"><strong>Communications Timeout</strong></td><td id="default-value">30 secs</td><td id="allowable-values"></td><td id="description">Specifies how long to wait to a response from the destination before deciding that an error has occurred and canceling the transaction</td></tr><tr><td id="name"><strong>Batch Size</strong></td><td id="default-value">1000</td><td id="allowable-values"></td><td id="description">Specifies how many records to send in a single batch, at most.</td></tr><tr><td id="name"><strong>Transport Protocol</strong></td><td id="default-value">RAW</td><td id="allowable-values"><ul><li>RAW</li><li>HTTP</li></ul></td><td id="description">Specifies which transport protocol to use for Site-to-Site communication.</td></tr><tr><td id="name">HTTP Proxy hostname</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Specify the proxy server's hostname to use. If not specified, HTTP traffics are sent directly to the target NiFi instance.</td></tr><tr><td id="name">HTTP Proxy port</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Specify the proxy server's port number, optional. If not specified, default port 80 will be used.</td></tr><tr><td id="name">HTTP Proxy username</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Specify an user name to connect to the proxy server, optional.</td></tr><tr><td id="name">HTTP Proxy password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Specify an user password to connect to the proxy server, optional.<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name"><strong>Platform</strong></td><td id="default-value">nifi</td><td id="allowable-values"></td><td id="description">The value to use for the platform field in each provenance event.<br/><strong>Supports Expression Language: true< /strong></td></tr><tr><td id="name">Event Type</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Comma-separated list of event types that will be used to filter the provenance events sent by the reporting task. Available event types are [CREATE, RECEIVE, FETCH, SEND, REMOTE_INVOCATION, DOWNLOAD, DROP, EXPIRE, FORK, JOIN, CLONE, CONTENT_MODIFIED, ATTRIBUTES_MODIFIED, ROUTE, ADDINFO, REPLAY, UNKNOWN]. If no filter is set, all the events are sent. If multiple filters are set, the filters are cumulative.</td></tr><tr><td id="name">Component Type</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Regular expression to filter the provenance events based on the component type. Only the events matching the regular expression will be sent. If no filter is set, all the events are sent. If multiple filters are set, the filters are cumulative.</td></tr><tr><td id="name">Component ID</td><td id="default-value"></td><td id="allowa ble-values"></td><td id="description">Comma-separated list of component UUID that will be used to filter the provenance events sent by the reporting task. If no filter is set, all the events are sent. If multiple filters are set, the filters are cumulative.</td></tr><tr><td id="name"><strong>Start Position</strong></td><td id="default-value">beginning-of-stream</td><td id="allowable-values"><ul><li>Beginning of Stream <img src="../../../../../html/images/iconInfo.png" alt="Start reading provenance Events from the beginning of the stream (the oldest event first)" title="Start reading provenance Events from the beginning of the stream (the oldest event first)"></img></li><li>End of Stream <img src="../../../../../html/images/iconInfo.png" alt="Start reading provenance Events from the end of the stream, ignoring old events" title="Start reading provenance Events from the end of the stream, ignoring old events"></img></li></ul></td><td id="description">If the Reporting Task has never be en run, or if its state has been reset by a user, specifies where in the stream of Provenance Events the Reporting Task should start</td></tr></table><h3>State management: </h3><table id="stateful"><tr><th>Scope</th><th>Description</th></tr><tr><td>LOCAL</td><td>Stores the Reporting Task's last event Id so that on restart the task knows where it left off.</td></tr></table><h3>Restricted: </h3>Provides operator the ability send sensitive details contained in Provenance events to any external system.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.5.0/org.apache.nifi.reporting.SiteToSiteStatusReportingTask/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.5.0/org.apache.nifi.reporting.SiteToSiteStatusReportingTask/index.html?rev=1821033&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.5.0/org.apache.nifi.reporting.SiteToSiteStatusReportingTask/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.5.0/org.apache.nifi.reporting.SiteToSiteStatusReportingTask/index.html Fri Jan 12 21:00:14 2018 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>SiteToSiteStatusReportingTask</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;">SiteToSiteStatusReportingTask</h1><h2>Description: </h2><p>Publishes Status events using the Site To Site protocol. The component type and name filter regexes form a union: only components matching both regexes will be reported. However, all process groups are recursively searched for matching components, regardless of whether the process group matches the component filters.</p><h3>Tags: </h3><p>status, metrics, history, site, site to site</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in b old) 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>Destination URL</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The URL of the destination NiFi instance to send data to, should be a comma-separated list of address in the format of http(s)://host:port/nifi.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Input Port Name</strong></td><td id="default- value"></td><td id="allowable-values"></td><td id="description">The name of the Input Port to deliver data to.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">SSL Context Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>RestrictedSSLContextService<br/><strong>Implementation: </strong><a href="../../../nifi-ssl-context-service-nar/1.5.0/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</a></td><td id="description">The SSL Context Service to use when communicating with the destination. If not specified, communications will not be secure.</td></tr><tr><td id="name"><strong>Instance URL</strong></td><td id="default-value">http://${hostname(true)}:8080/nifi</td><td id="allowable-values"></td><td id="description">The URL of this instance to use in the Content URI of each event.<br/><strong>Supports Expression Language: true</strong></td></ tr><tr><td id="name"><strong>Compress Events</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Indicates whether or not to compress the data being sent.</td></tr><tr><td id="name"><strong>Communications Timeout</strong></td><td id="default-value">30 secs</td><td id="allowable-values"></td><td id="description">Specifies how long to wait to a response from the destination before deciding that an error has occurred and canceling the transaction</td></tr><tr><td id="name"><strong>Batch Size</strong></td><td id="default-value">1000</td><td id="allowable-values"></td><td id="description">Specifies how many records to send in a single batch, at most.</td></tr><tr><td id="name"><strong>Transport Protocol</strong></td><td id="default-value">RAW</td><td id="allowable-values"><ul><li>RAW</li><li>HTTP</li></ul></td><td id="description">Specifies which transport protocol to use for Site-to-Site communication.</td> </tr><tr><td id="name">HTTP Proxy hostname</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Specify the proxy server's hostname to use. If not specified, HTTP traffics are sent directly to the target NiFi instance.</td></tr><tr><td id="name">HTTP Proxy port</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Specify the proxy server's port number, optional. If not specified, default port 80 will be used.</td></tr><tr><td id="name">HTTP Proxy username</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Specify an user name to connect to the proxy server, optional.</td></tr><tr><td id="name">HTTP Proxy password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Specify an user password to connect to the proxy server, optional.<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name"><strong>Platform</strong></td><td id="default-value">nifi </td><td id="allowable-values"></td><td id="description">The value to use for the platform field in each status record.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Component Type Filter Regex</strong></td><td id="default-value">(Processor|ProcessGroup|RemoteProcessGroup|RootProcessGroup|Connection|InputPort|OutputPort)</td><td id="allowable-values"></td><td id="description">A regex specifying which component types to report. Any component type matching this regex will be included. Component types are: Processor, RootProcessGroup, ProcessGroup, RemoteProcessGroup, Connection, InputPort, OutputPort<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Component Name Filter Regex</strong></td><td id="default-value">.*</td><td id="allowable-values"></td><td id="description">A regex specifying which component names to report. Any component name matching this regex will be included.<br/><strong>Supports Expression Language: true</strong></td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.</body></html> \ No newline at end of file
