Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-registry-nar/1.7.1/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.7.1/org.apache.nifi.schemaregistry.services.AvroSchemaRegistry/index.html?rev=1836075&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-registry-nar/1.7.1/org.apache.nifi.schemaregistry.services.AvroSchemaRegistry/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-registry-nar/1.7.1/org.apache.nifi.schemaregistry.services.AvroSchemaRegistry/index.html Tue Jul 17 01:35:38 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.<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-rethinkdb-nar/1.7.1/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.7.1/org.apache.nifi.processors.rethinkdb.DeleteRethinkDB/index.html?rev=1836075&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-rethinkdb-nar/1.7.1/org.apache.nifi.processors.rethinkdb.DeleteRethinkDB/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-rethinkdb-nar/1.7.1/org.apache.nifi.processors.rethinkdb.DeleteRethinkDB/index.html Tue Jul 17 01:35:38 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 (will be evaluated using flow file attributes and variable registry)</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 (will be evaluated using flow file attribute s and variable registry)</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 (will be evaluated using flow file attributes and variable registry)</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 cha nges 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 (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>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>rethinkdb.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>System Resource Considerations:</h3>None specified.<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.7.1/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.7.1/org.apache.nifi.processors.rethinkdb.GetRethinkDB/index.html?rev=1836075&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-rethinkdb-nar/1.7.1/org.apache.nifi.processors.rethinkdb.GetRethinkDB/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-rethinkdb-nar/1.7.1/org.apache.nifi.processors.rethinkdb.GetRethinkDB/index.html Tue Jul 17 01:35:38 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 (will be evaluated using flow file attributes and variable registry)</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 (w ill be evaluated using flow file attributes and variable registry)</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 (will be evaluated using flow file attributes and variable registry)</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>System Resource Con siderations:</h3>None specified.<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.7.1/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.7.1/org.apache.nifi.processors.rethinkdb.PutRethinkDB/index.html?rev=1836075&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-rethinkdb-nar/1.7.1/org.apache.nifi.processors.rethinkdb.PutRethinkDB/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-rethinkdb-nar/1.7.1/org.apache.nifi.processors.rethinkdb.PutRethinkDB/index.html Tue Jul 17 01:35:38 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 (will be evaluated using >flow file attributes and variable registry)</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 (will be evaluated using flow file attributes and variable registry)</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 (will be evaluated using flow file attributes and variable registry)</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 messa ge</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.generated_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>In put requirement: </h3>This component requires an incoming relationship.<h3>System Resource Considerations:</h3>None specified.<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.7.1/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.7.1/org.apache.nifi.processors.riemann.PutRiemann/index.html?rev=1836075&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-riemann-nar/1.7.1/org.apache.nifi.processors.riemann.PutRiemann/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-riemann-nar/1.7.1/org.apache.nifi.processors.riemann.PutRiemann/index.html Tue Jul 17 01:35:38 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 (will be evaluated using flow file attributes and variable registry)</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 (will be evaluated using flow file attributes and variable registry)</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/><stro ng>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</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 (will be evaluated using flow file attributes and variable registry)</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 (will be evaluated using flow file attributes and variable registry)</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 (will be evaluated using flow file attributes and varia ble registry)</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 (will be evaluated using flow file attributes and variable registry)</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 (will be evaluated using flow file attributes and variable registry)</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 ev ent as a custom attribute<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</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.<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-scripting-nar/1.7.1/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.7.1/org.apache.nifi.lookup.script.ScriptedLookupService/index.html?rev=1836075&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.7.1/org.apache.nifi.lookup.script.ScriptedLookupService/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.7.1/org.apache.nifi.lookup.script.ScriptedLookupService/index.html Tue Jul 17 01:35:38 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</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 (will be evaluated using >variable registry only)</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 (will be evaluated >using variable registry only)</strong></td></tr></table><h3>State management: ></h3>This component does not store state.<h3>Restricted: </h3><table >id="restrictions"><tr><th>Required >Permission</th><th>Explanation</th></tr><tr><td>execute code</td><td>Provides >operator the ability to execute arbitrary code assuming all permissions that >NiFi has.</td></tr></table><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-scripting-nar/1.7.1/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.7.1/org.apache.nifi.processors.script.ExecuteScript/index.html?rev=1836075&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.7.1/org.apache.nifi.processors.script.ExecuteScript/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.7.1/org.apache.nifi.processors.script.ExecuteScript/index.html Tue Jul 17 01:35:38 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</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 (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Script Body</td><td i d="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 (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 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 (will be evaluated using flow file attributes and variable registry)</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><table id="restrictions"><tr><th>Required Permission</th><th>Explanation</th></tr><tr><td>execute code</td><td>Provides operator the ability to execute arbitrary code assuming all permissions that NiFi has.</td></tr></table><h3>System Resource Considerations:</h3>Non e specified.<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.7.1/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.7.1/org.apache.nifi.processors.script.InvokeScriptedProcessor/index.html?rev=1836075&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.7.1/org.apache.nifi.processors.script.InvokeScriptedProcessor/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.7.1/org.apache.nifi.processors.script.InvokeScriptedProcessor/index.html Tue Jul 17 01:35:38 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</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 (will be evaluated using variable registry only)</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 (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 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 (will be evaluated using flow file attributes and variable registry)</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><table id="restrictions"><tr><th>Required Permission</th><th>Explanation</th></tr><tr><td>execute code</td><td>Provides operator the ability to execute arbitrary code assuming all permissions that NiFi has.</td></tr></table><h3>System Resource Considerations:</h3>None specified.<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.7.1/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.7.1/org.apache.nifi.record.script.ScriptedReader/index.html?rev=1836075&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.7.1/org.apache.nifi.record.script.ScriptedReader/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.7.1/org.apache.nifi.record.script.ScriptedReader/index.html Tue Jul 17 01:35:38 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</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 (will be evaluated using variable registry only)</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="de fault-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 (will be evaluated using variable registry only)</strong></td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3><table id="restrictions"><tr><th>Required Permission</th><th>Explanation</th></tr><tr><td>execute code</td><td>Provides operator the ability to execute arbitrary code assuming all permissions that NiFi has.</td></tr></table><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-scripting-nar/1.7.1/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.7.1/org.apache.nifi.record.script.ScriptedRecordSetWriter/index.html?rev=1836075&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.7.1/org.apache.nifi.record.script.ScriptedRecordSetWriter/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.7.1/org.apache.nifi.record.script.ScriptedRecordSetWriter/index.html Tue Jul 17 01:35:38 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</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-g uide.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 (will be evaluated using variable registry only)</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="defa ult-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 (will be evaluated using variable registry only)</strong></td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3><table id="restrictions"><tr><th>Required Permission</th><th>Explanation</th></tr><tr><td>execute code</td><td>Provides operator the ability to execute arbitrary code assuming all permissions that NiFi has.</td></tr></table><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-scripting-nar/1.7.1/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.7.1/org.apache.nifi.reporting.script.ScriptedReportingTask/index.html?rev=1836075&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.7.1/org.apache.nifi.reporting.script.ScriptedReportingTask/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.7.1/org.apache.nifi.reporting.script.ScriptedReportingTask/index.html Tue Jul 17 01:35:38 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 (will be evaluated using variable registry only)</stron g></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 (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 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 (will be evaluated using variable registry only)</strong></td></tr></table></p><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3><table id="restrictions"><tr><th>Required Permission</th><th>Explanation</th></tr><tr><td>execute code</td><td>Provides operator the ability to execute arbitrary code assuming all permissions that NiFi has.</td></tr></table><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-site-to-site-reporting-nar/1.7.1/org.apache.nifi.reporting.SiteToSiteBulletinReportingTask/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.7.1/org.apache.nifi.reporting.SiteToSiteBulletinReportingTask/additionalDetails.html?rev=1836075&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.7.1/org.apache.nifi.reporting.SiteToSiteBulletinReportingTask/additionalDetails.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.7.1/org.apache.nifi.reporting.SiteToSiteBulletinReportingTask/additionalDetails.html Tue Jul 17 01:35:38 2018 @@ -0,0 +1,65 @@ +<!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>SiteToSiteBulletinReportingTask</title> + + <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css" /> + </head> + + <body> + <p> + The Site-to-Site Bulletin Reporting Task allows the user to publish 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> + + <h2>Record writer</h2> + + <p> + The user can define a Record Writer and directly specify the output format and data with the assumption that the input schema + is the following: + </p> + + <pre> + <code> +{ + "type" : "record", + "name" : "bulletins", + "namespace" : "bulletins", + "fields" : [ + { "name" : "objectId", "type" : "string" }, + { "name" : "platform", "type" : "string" }, + { "name" : "bulletinId", "type" : "long" }, + { "name" : "bulletinCategory", "type" : ["string", "null"] }, + { "name" : "bulletinGroupId", "type" : ["string", "null"] }, + { "name" : "bulletinGroupName", "type" : ["string", "null"] }, + { "name" : "bulletinLevel", "type" : ["string", "null"] }, + { "name" : "bulletinMessage", "type" : ["string", "null"] }, + { "name" : "bulletinNodeAddress", "type" : ["string", "null"] }, + { "name" : "bulletinNodeId", "type" : ["string", "null"] }, + { "name" : "bulletinSourceId", "type" : ["string", "null"] }, + { "name" : "bulletinSourceName", "type" : ["string", "null"] }, + { "name" : "bulletinSourceType", "type" : ["string", "null"] }, + { "name" : "bulletinTimestamp", "type" : ["string", "null"], "doc" : "Format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'" } + ] +} + </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.7.1/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.7.1/org.apache.nifi.reporting.SiteToSiteBulletinReportingTask/index.html?rev=1836075&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.7.1/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.7.1/org.apache.nifi.reporting.SiteToSiteBulletinReportingTask/index.html Tue Jul 17 01:35:38 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><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>bulletin, 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 propert ies (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 (will be evaluated using variable registry only)</strong></td></tr><tr><td i d="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 (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/>RestrictedSSLContextService<br/><strong>Implementation: </strong><a href="../../../nifi-ssl-context-service-nar/1.7.1/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</a></td><td id="description">The 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 i nstance to use in the Content URI of each event.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</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>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">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.7.1/org.apache.nifi.avro.AvroRecordSetWriter/index.html">AvroRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.7.1/org.apache.nifi.csv.CSVRecordSetWriter/index.html">CSVRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.7.1/org.apache.nifi.json.JsonRecordSetWriter/index.html">JsonRecordSetWriter</a><br/><a href="../../../nifi-scripting-nar/1.7.1/org.apache.nifi.record.script.ScriptedRecordSetWriter/index.html">ScriptedRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.7.1/org.apache.nifi.xml.XMLRecordSetWriter/index.html">XMLRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.7.1/org.apache.nifi.text.FreeFormTextRecordSetWriter/index.html">FreeFormTextRecordSetWriter</a></td><td id="description">Specifies the Controller Serv ice to use for writing out the records.</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 (will be evaluated using variable registry only)</strong></td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3><table id="restrictions"><tr><th>Required Permission</th><th>Explanation</th></tr><tr><td>export nifi details</td><td>Provides operator the ability to send sensitive details contained in bulletin events to any external system.</td></tr></table><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-site-to-site-reporting-nar/1.7.1/org.apache.nifi.reporting.SiteToSiteMetricsReportingTask/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.7.1/org.apache.nifi.reporting.SiteToSiteMetricsReportingTask/additionalDetails.html?rev=1836075&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.7.1/org.apache.nifi.reporting.SiteToSiteMetricsReportingTask/additionalDetails.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.7.1/org.apache.nifi.reporting.SiteToSiteMetricsReportingTask/additionalDetails.html Tue Jul 17 01:35:38 2018 @@ -0,0 +1,178 @@ +<!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>SiteToSiteMetricsReportingTask</title> + + <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css" /> + </head> + + <body> + <p> + The Site-to-Site Metrics Reporting Task allows the user to publish NiFi's metrics (as in the Ambari reporting task) 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 process or distribute that data. + </p> + + <h2>Ambari format</h2> + + <p> + There are two available output formats. The first one is the Ambari format as defined in the Ambari Metrics Collector + API which is a JSON with dynamic keys. If using this format you might be interested by the below Jolt specification to + transform the data. + </p> + + <pre> + <code> + [ + { + "operation": "shift", + "spec": { + "metrics": { + "*": { + "metrics": { + "*": { + "$": "metrics.[#4].metrics.time", + "@": "metrics.[#4].metrics.value" + } + }, + "*": "metrics.[&1].&" + } + } + } + } + ] + </code> + </pre> + + <p> + This would transform the below sample: + </p> + + <pre> + <code> + { + "metrics": [{ + "metricname": "jvm.gc.time.G1OldGeneration", + "appid": "nifi", + "instanceid": "8927f4c0-0160-1000-597a-ea764ccd81a7", + "hostname": "localhost", + "timestamp": "1520456854361", + "starttime": "1520456854361", + "metrics": { + "1520456854361": "0" + } + }, { + "metricname": "jvm.thread_states.terminated", + "appid": "nifi", + "instanceid": "8927f4c0-0160-1000-597a-ea764ccd81a7", + "hostname": "localhost", + "timestamp": "1520456854361", + "starttime": "1520456854361", + "metrics": { + "1520456854361": "0" + } + }] + } + </code> + </pre> + + <p> + into: + </p> + + <pre> + <code> + { + "metrics": [{ + "metricname": "jvm.gc.time.G1OldGeneration", + "appid": "nifi", + "instanceid": "8927f4c0-0160-1000-597a-ea764ccd81a7", + "hostname": "localhost", + "timestamp": "1520456854361", + "starttime": "1520456854361", + "metrics": { + "time": "1520456854361", + "value": "0" + } + }, { + "metricname": "jvm.thread_states.terminated", + "appid": "nifi", + "instanceid": "8927f4c0-0160-1000-597a-ea764ccd81a7", + "hostname": "localhost", + "timestamp": "1520456854361", + "starttime": "1520456854361", + "metrics": { + "time": "1520456854361", + "value": "0" + } + }] + } + </code> + </pre> + + <h2>Record format</h2> + + <p> + The second format is leveraging the record framework of NiFi so that the user can define a Record Writer and directly + specify the output format and data with the assumption that the input schema is the following: + </p> + + <pre> + <code> + { + "type" : "record", + "name" : "metrics", + "namespace" : "metrics", + "fields" : [ + { "name" : "appid", "type" : "string" }, + { "name" : "instanceid", "type" : "string" }, + { "name" : "hostname", "type" : "string" }, + { "name" : "timestamp", "type" : "long" }, + { "name" : "loadAverage1min", "type" : "double" }, + { "name" : "availableCores", "type" : "int" }, + { "name" : "FlowFilesReceivedLast5Minutes", "type" : "int" }, + { "name" : "BytesReceivedLast5Minutes", "type" : "long" }, + { "name" : "FlowFilesSentLast5Minutes", "type" : "int" }, + { "name" : "BytesSentLast5Minutes", "type" : "long" }, + { "name" : "FlowFilesQueued", "type" : "int" }, + { "name" : "BytesQueued", "type" : "long" }, + { "name" : "BytesReadLast5Minutes", "type" : "long" }, + { "name" : "BytesWrittenLast5Minutes", "type" : "long" }, + { "name" : "ActiveThreads", "type" : "int" }, + { "name" : "TotalTaskDurationSeconds", "type" : "long" }, + { "name" : "TotalTaskDurationNanoSeconds", "type" : "long" }, + { "name" : "jvmuptime", "type" : "long" }, + { "name" : "jvmheap_used", "type" : "double" }, + { "name" : "jvmheap_usage", "type" : "double" }, + { "name" : "jvmnon_heap_usage", "type" : "double" }, + { "name" : "jvmthread_statesrunnable", "type" : ["int", "null"] }, + { "name" : "jvmthread_statesblocked", "type" : ["int", "null"] }, + { "name" : "jvmthread_statestimed_waiting", "type" : ["int", "null"] }, + { "name" : "jvmthread_statesterminated", "type" : ["int", "null"] }, + { "name" : "jvmthread_count", "type" : "int" }, + { "name" : "jvmdaemon_thread_count", "type" : "int" }, + { "name" : "jvmfile_descriptor_usage", "type" : "double" }, + { "name" : "jvmgcruns", "type" : ["long", "null"] }, + { "name" : "jvmgctime", "type" : ["long", "null"] } + ] + } + </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.7.1/org.apache.nifi.reporting.SiteToSiteMetricsReportingTask/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.7.1/org.apache.nifi.reporting.SiteToSiteMetricsReportingTask/index.html?rev=1836075&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.7.1/org.apache.nifi.reporting.SiteToSiteMetricsReportingTask/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.7.1/org.apache.nifi.reporting.SiteToSiteMetricsReportingTask/index.html Tue Jul 17 01:35:38 2018 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>SiteToSiteMetricsReportingTask</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;">SiteToSiteMetricsReportingTask</h1><h2>Description: </h2><p>Publishes same metrics as the Ambari Reporting task using the Site To Site protocol.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>status, metrics, 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 bold) are considered optional. The table also indicates any default values, whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expre ssion 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 (will be evaluated using variable registry only)</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>Suppor ts 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/>RestrictedSSLContextService<br/><strong>Implementation: </strong><a href="../../../nifi-ssl-context-service-nar/1.7.1/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</a></td><td id="description">The 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 (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Co mpress 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>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 Ni Fi 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">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.7.1/org.apache.nifi.avro.AvroRecordSetWriter/index.html" >AvroRecordSetWriter</a><br/><a >href="../../../nifi-record-serialization-services-nar/1.7.1/org.apache.nifi.csv.CSVRecordSetWriter/index.html">CSVRecordSetWriter</a><br/><a > >href="../../../nifi-record-serialization-services-nar/1.7.1/org.apache.nifi.json.JsonRecordSetWriter/index.html">JsonRecordSetWriter</a><br/><a > >href="../../../nifi-scripting-nar/1.7.1/org.apache.nifi.record.script.ScriptedRecordSetWriter/index.html">ScriptedRecordSetWriter</a><br/><a > >href="../../../nifi-record-serialization-services-nar/1.7.1/org.apache.nifi.xml.XMLRecordSetWriter/index.html">XMLRecordSetWriter</a><br/><a > >href="../../../nifi-record-serialization-services-nar/1.7.1/org.apache.nifi.text.FreeFormTextRecordSetWriter/index.html">FreeFormTextRecordSetWriter</a></td><td > id="description">Specifies the Controller Service to use for writing out the >records.</td></tr><tr><td id="name"><strong>Hostname</strong></td><td >id="default-value">${hostname(true)}</td><td id="allowable-values"></td><td >id="descriptio n">The Hostname of this NiFi instance to be included in the metrics<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Application ID</strong></td><td id="default-value">nifi</td><td id="allowable-values"></td><td id="description">The Application ID to be included in the metrics<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Output Format</strong></td><td id="default-value">ambari-format</td><td id="allowable-values"><ul><li>Ambari Format <img src="../../../../../html/images/iconInfo.png" alt="Metrics will be formatted according to the Ambari Metrics API. See Additional Details in Usage documentation." title="Metrics will be formatted according to the Ambari Metrics API. See Additional Details in Usage documentation."></img></li><li>Record Format <img src="../../../../../html/images/iconInfo.png" alt="Me trics will be formatted using the Record Writer property of this reporting task. See Additional Details in Usage documentation to have the description of the default schema." title="Metrics will be formatted using the Record Writer property of this reporting task. See Additional Details in Usage documentation to have the description of the default schema."></img></li></ul></td><td id="description">The output format that will be used for the metrics. If Record Format is selected, a Record Writer must be provided. If Ambari Format is selected, the Record Writer property should be empty.</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<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-site-to-site-reporting-nar/1.7.1/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.7.1/org.apache.nifi.reporting.SiteToSiteProvenanceReportingTask/additionalDetails.html?rev=1836075&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.7.1/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.7.1/org.apache.nifi.reporting.SiteToSiteProvenanceReportingTask/additionalDetails.html Tue Jul 17 01:35:38 2018 @@ -0,0 +1,82 @@ +<!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 process 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> + By default, when published to a NiFi instance, the Provenance data is sent as a JSON array. However, the user can define a Record Writer + and directly specify the output format and data with the assumption that the input schema is 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": "componentName", "type": "string" }, + { "name": "processGroupId", "type": "string" }, + { "name": "processGroupName", "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": "remoteIdentifier", "type": "string" }, + { "name": "alternateIdentifier", "type": "string" }, + { "name": "transitUri", "type": ["null", "string"] } + ] +} +</code> +</pre> + + + </body> +</html> \ No newline at end of file
