Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-riemann-nar/1.4.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.4.0/org.apache.nifi.processors.riemann.PutRiemann/index.html?rev=1811008&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-riemann-nar/1.4.0/org.apache.nifi.processors.riemann.PutRiemann/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-riemann-nar/1.4.0/org.apache.nifi.processors.riemann.PutRiemann/index.html Tue Oct 3 13:30:16 2017 @@ -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.4.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.4.0/org.apache.nifi.lookup.script.ScriptedLookupService/index.html?rev=1811008&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.4.0/org.apache.nifi.lookup.script.ScriptedLookupService/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.4.0/org.apache.nifi.lookup.script.ScriptedLookupService/index.html Tue Oct 3 13:30:16 2017 @@ -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.4.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.4.0/org.apache.nifi.processors.script.ExecuteScript/index.html?rev=1811008&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.4.0/org.apache.nifi.processors.script.ExecuteScript/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.4.0/org.apache.nifi.processors.script.ExecuteScript/index.html Tue Oct 3 13:30:16 2017 @@ -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.4.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.4.0/org.apache.nifi.processors.script.InvokeScriptedProcessor/index.html?rev=1811008&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.4.0/org.apache.nifi.processors.script.InvokeScriptedProcessor/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.4.0/org.apache.nifi.processors.script.InvokeScriptedProcessor/index.html Tue Oct 3 13:30:16 2017 @@ -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.4.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.4.0/org.apache.nifi.record.script.ScriptedReader/index.html?rev=1811008&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.4.0/org.apache.nifi.record.script.ScriptedReader/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.4.0/org.apache.nifi.record.script.ScriptedReader/index.html Tue Oct 3 13:30:16 2017 @@ -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.4.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.4.0/org.apache.nifi.record.script.ScriptedRecordSetWriter/index.html?rev=1811008&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.4.0/org.apache.nifi.record.script.ScriptedRecordSetWriter/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.4.0/org.apache.nifi.record.script.ScriptedRecordSetWriter/index.html Tue Oct 3 13:30:16 2017 @@ -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.4.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.4.0/org.apache.nifi.reporting.script.ScriptedReportingTask/index.html?rev=1811008&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.4.0/org.apache.nifi.reporting.script.ScriptedReportingTask/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.4.0/org.apache.nifi.reporting.script.ScriptedReportingTask/index.html Tue Oct 3 13:30:16 2017 @@ -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.4.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.4.0/org.apache.nifi.reporting.SiteToSiteBulletinReportingTask/index.html?rev=1811008&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.4.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.4.0/org.apache.nifi.reporting.SiteToSiteBulletinReportingTask/index.html Tue Oct 3 13:30:16 2017 @@ -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 in the format 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 t he 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.4.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-val ue">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 P roxy 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"><tr><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.4.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.4.0/org.apache.nifi.reporting.SiteToSiteProvenanceReportingTask/additionalDetails.html?rev=1811008&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.4.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.4.0/org.apache.nifi.reporting.SiteToSiteProvenanceReportingTask/additionalDetails.html Tue Oct 3 13:30:16 2017 @@ -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.4.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.4.0/org.apache.nifi.reporting.SiteToSiteProvenanceReportingTask/index.html?rev=1811008&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.4.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.4.0/org.apache.nifi.reporting.SiteToSiteProvenanceReportingTask/index.html Tue Oct 3 13:30:16 2017 @@ -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 in the format 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 S ervice</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.4.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 c ompress 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">E vent 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, 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="allowable-values"></td><td id="description">Comma-separated li st 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 been run, or if its state has been reset by a user, specif ies 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.4.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.4.0/org.apache.nifi.reporting.SiteToSiteStatusReportingTask/index.html?rev=1811008&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.4.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.4.0/org.apache.nifi.reporting.SiteToSiteStatusReportingTask/index.html Tue Oct 3 13:30:16 2017 @@ -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 in the format 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.4.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 hos tname</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 Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-slack-nar/1.4.0/org.apache.nifi.processors.slack.PutSlack/additionalDetails.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-slack-nar/1.4.0/org.apache.nifi.processors.slack.PutSlack/additionalDetails.html?rev=1811008&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-slack-nar/1.4.0/org.apache.nifi.processors.slack.PutSlack/additionalDetails.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-slack-nar/1.4.0/org.apache.nifi.processors.slack.PutSlack/additionalDetails.html Tue Oct 3 13:30:16 2017 @@ -0,0 +1,53 @@ +<!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>PutSlack</title> + <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css" /> + </head> + + <body> + <!-- Processor Documentation ================================================== --> + <h2>Description:</h2> + <p> + The PutSlack processor sends messages to <a href="https://www.slack.com";>Slack</a>, + a team-oriented messaging service. + </p> + <p> + This processor uses Slack's <a href="https://slack.com/apps/A0F7XDUAZ-incoming-webhooks";>incoming webhooks</a> + custom integration to post messages to a specific channel. Before using PutSlack, your Slack team should be + configured for the incoming webhooks custom integration, and you'll need to configure at least one incoming + webhook. + </p> + <p> + To configure PutSlack, set the following mandatory properties: + <ul> + <li> + <code>Webhook URL</code>: The URL received from Slack that allows the processor to send messages to your team. + </li> + <li> + <code>Webhook Text</code>: The text of the message to send to Slack. + </li> + </ul> + </p> + <p> + Dynamic properties can be used to append items to the "attachments" branch of the JSON payload. Each dynamic property will be processed and added + as an item within the array. The keys are not used by the processor. Instead, for each flowfile, the values of the dynamic properties is converted to JSON and added + to the the attachments key of the JSON payload sent to Slack. For information on the attachment data structure, see <a href="https://api.slack.com/docs/message-attachments";>https://api.slack.com/docs/message-attachments</a> + </p> + </body> +</html> Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-slack-nar/1.4.0/org.apache.nifi.processors.slack.PutSlack/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-slack-nar/1.4.0/org.apache.nifi.processors.slack.PutSlack/index.html?rev=1811008&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-slack-nar/1.4.0/org.apache.nifi.processors.slack.PutSlack/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-slack-nar/1.4.0/org.apache.nifi.processors.slack.PutSlack/index.html Tue Oct 3 13:30:16 2017 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutSlack</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;">PutSlack</h1><h2>Description: </h2><p>Sends a message to your team on slack.com</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>put, slack, notify</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 enc rypted. 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>Webhook URL</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The POST URL provided by Slack to send messages into a channel.<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name"><strong>Webhook Text</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The text sent in the webhook message<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Channel</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A public channel using #channel or direct message using @username. If not specified, the default webhook channel as specified in Slack's Incoming Webhooks web interface is used.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Username</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The displayed Slack username<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Icon URL</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Icon URL to be used for the message<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Icon Emoji</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Icon Emoji to be used for the message. Must begin and end with a colon, e.g. :ghost:<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>Val ue</th><th>Description</th></tr><tr><td id="name">A JSON object to add to Slack's "attachments" JSON payload.</td><td id="value">JSON-formatted string to add to Slack's payload JSON appended to the "attachments" JSON array.</td><td>Converts the contents of each value specified by the Dynamic Property's value to JSON and appends it to the payload being sent to Slack.<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 are routed to success after being successfully sent to Slack</td></tr><tr><td>failure</td><td>FlowFiles are routed to failure if unable to be sent to Slack</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 require s an incoming relationship.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-snmp-nar/1.4.0/org.apache.nifi.snmp.processors.GetSNMP/additionalDetails.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-snmp-nar/1.4.0/org.apache.nifi.snmp.processors.GetSNMP/additionalDetails.html?rev=1811008&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-snmp-nar/1.4.0/org.apache.nifi.snmp.processors.GetSNMP/additionalDetails.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-snmp-nar/1.4.0/org.apache.nifi.snmp.processors.GetSNMP/additionalDetails.html Tue Oct 3 13:30:16 2017 @@ -0,0 +1,70 @@ +<!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>GetSNMP</title> + <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css" /> +</head> + +<body> +<h2>Summary</h2> +<p> + This processor polls a SNMP agent to get information for a given OID (Strategy = GET) or for all the sub-tree associated to a given OID + (Strategy = WALK). This processors supports SNMPv1, SNMPv2c and SNMPv3. The component is based on <a href="http://www.snmp4j.org/";>SNMP4J</a>. +</p> +<p> + When the processor is triggered, it sends the SNMP request and gets the information associated to request OID(s). Once response is received + from the SNMP agent, a FlowFile is constructed. The FlowFile content is empty, all the information is written in the FlowFile attributes. + In case of a single GET request, the properties associated to the received PDU are transferred into the FlowFile as attributes. In case of a + WALK request, only the couples "OID/value" are transferred into the FlowFile as attributes. SNMP attributes names are prefixed with + <i>snmp$</i> prefix. +</p> +<p> + Regarding the attributes representing the couples "OID/value", the attribute name has the following format: + <ul><li>snmp$<i>OID</i>$<i>SMI_Syntax_Value</i></li></ul> + where OID is the request OID, and SMI_Syntax_Value is the integer representing the type of the value associated to the OID. This value is + provided to allow the SetSNMP processor setting values in the correct type. +</p> +<h2>SNMP Properties</h2> +<p> + In case of a single SNMP Get request, the following is the list of available standard SNMP properties which may come with the PDU: + <i>("snmp$errorIndex", "snmp$errorStatus", "snmp$errorStatusText", "snmp$nonRepeaters", "snmp$requestID", "snmp$type")</i> +</p> +<h2>Configuration Details</h2> +<p> + At the time of writing this document it only defines the essential configuration properties which are suitable for most cases. + Other properties will be defined later as this component progresses. + Configuring GetSNMP: +</p> +<ul> + <li><b>Host</b> - [REQUIRED] the name of the host where the SNMP agent is running. (default is localhost)</li> + <li><b>Port</b> - [REQUIRED] the port number on which the SNMP agent is listening. (default is 161)</li> + <li><b>OID</b> - [REQUIRED] the root OID to request.</li> + <li><b>Version</b> - [REQUIRED] the SNMP version to use (SNMPv1 [default], or SNMPv2c, or SNMPv3)</li> + <li><b>Community</b> - [REQUIRED if SNMPv1 or SNMPv2c] the SNMP community to use. (default is public)</li> + <li><b>Security Level</b> - [REQUIRED if SNMPv3] the security level to use. (default is authPriv)</li> + <li><b>Security Name</b> - [REQUIRED if SNMPv3] the security name (user name) to use.</li> + <li><b>Authentication Protocol</b> - [REQUIRED if SNMPv3 and authNoPriv or authPriv] the authentication protocol to use.</li> + <li><b>Authentication Password</b> - [REQUIRED if SNMPv3 and authNoPriv or authPriv] the authentication password to use.</li> + <li><b>Private Protocol</b> - [REQUIRED if SNMPv3 and authPriv] the private protocol to use.</li> + <li><b>Private Password</b> - [REQUIRED if SNMPv3 and authPriv] the private password to use.</li> + <li><b>Retries</b> - [REQUIRED] Sets the number of retries to be performed before a request is timed out. (default is 0)</li> + <li><b>Timeout</b> - [REQUIRED] Sets timeout in milliseconds before a confirmed request is resent or timed out. (default is 5000)</li> +</ul> + +</body> +</html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-snmp-nar/1.4.0/org.apache.nifi.snmp.processors.GetSNMP/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-snmp-nar/1.4.0/org.apache.nifi.snmp.processors.GetSNMP/index.html?rev=1811008&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-snmp-nar/1.4.0/org.apache.nifi.snmp.processors.GetSNMP/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-snmp-nar/1.4.0/org.apache.nifi.snmp.processors.GetSNMP/index.html Tue Oct 3 13:30:16 2017 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>GetSNMP</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;">GetSNMP</h1><h2>Description: </h2><p>Retrieves information from SNMP Agent and outputs a FlowFile with information in attributes and without any content</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>snmp, get, oid, walk</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 is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive pr operty, 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>OID</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The OID to request</td></tr><tr><td id="name">Textual OID</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The textual OID to request</td></tr><tr><td id="name"><strong>SNMP strategy (GET/WALK)</strong></td><td id="default-value">GET</td><td id="allowable-values"><ul><li>GET</li><li>WALK</li></ul></td><td id="description">SNMP strategy to use (SNMP Get or SNMP Walk)</td></tr><tr><td id="name"><strong>Host Name</strong></td><td id="default-value">localhost</td><td id="allowable-values"></td><td id="description">Network address of SNMP Agent (e.g., localhost)</td></tr><tr><td id="name "><strong>Port</strong></td><td id="default-value">161</td><td id="allowable-values"></td><td id="description">Numeric value identifying Port of SNMP Agent (e.g., 161)</td></tr><tr><td id="name"><strong>SNMP Version</strong></td><td id="default-value">SNMPv1</td><td id="allowable-values"><ul><li>SNMPv1</li><li>SNMPv2c</li><li>SNMPv3</li></ul></td><td id="description">SNMP Version to use</td></tr><tr><td id="name">SNMP Community (v1 & v2c)</td><td id="default-value">public</td><td id="allowable-values"></td><td id="description">SNMP Community to use (e.g., public)</td></tr><tr><td id="name"><strong>SNMP Security Level</strong></td><td id="default-value">authPriv</td><td id="allowable-values"><ul><li>noAuthNoPriv</li><li>authNoPriv</li><li>authPriv</li></ul></td><td id="description">SNMP Security Level to use</td></tr><tr><td id="name">SNMP Security name / user name</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Security name used for SNMP exch anges</td></tr><tr><td id="name"><strong>SNMP Authentication Protocol</strong></td><td id="default-value"></td><td id="allowable-values"><ul><li>MD5</li><li>SHA</li><li></li></ul></td><td id="description">SNMP Authentication Protocol to use</td></tr><tr><td id="name">SNMP Authentication pass phrase</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Pass phrase used for SNMP authentication protocol<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name"><strong>SNMP Private Protocol</strong></td><td id="default-value"></td><td id="allowable-values"><ul><li>DES</li><li>3DES</li><li>AES128</li><li>AES192</li><li>AES256</li><li></li></ul></td><td id="description">SNMP Private Protocol to use</td></tr><tr><td id="name">SNMP Private protocol pass phrase</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Pass phrase used for SNMP private protocol<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name"><strong>Number of retries</strong></td><td id="default-value">0</td><td id="allowable-values"></td><td id="description">Set the number of retries when requesting the SNMP Agent</td></tr><tr><td id="name"><strong>Timeout (ms)</strong></td><td id="default-value">5000</td><td id="allowable-values"></td><td id="description">Set the timeout (in milliseconds) when requesting the SNMP Agent</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>All FlowFiles that are received from the SNMP agent are routed to this relationship</td></tr><tr><td>failure</td><td>All FlowFiles that cannot received from the SNMP agent 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>snmp$*</td><td>Attributes retrieved from the SNMP response. It may include: snmp$errorIndex, sn mp$errorStatus, snmp$errorStatusText, snmp$nonRepeaters, snmp$requestID, snmp$type, snmp$variableBindings</td></tr><tr><td>snmp$textualOid</td><td>This attribute will exist if and only if the strategy is GET and will be equal to the value given in Textual Oid property.</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component does not allow an incoming relationship.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-snmp-nar/1.4.0/org.apache.nifi.snmp.processors.SetSNMP/additionalDetails.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-snmp-nar/1.4.0/org.apache.nifi.snmp.processors.SetSNMP/additionalDetails.html?rev=1811008&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-snmp-nar/1.4.0/org.apache.nifi.snmp.processors.SetSNMP/additionalDetails.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-snmp-nar/1.4.0/org.apache.nifi.snmp.processors.SetSNMP/additionalDetails.html Tue Oct 3 13:30:16 2017 @@ -0,0 +1,58 @@ +<!DOCTYPE html> +<html lang="en"> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + http://www.apache.org/licenses/LICENSE-2.0 + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<head> + <meta charset="utf-8" /> + <title>SetSNMP</title> + <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css" /> +</head> + +<body> +<h2>Summary</h2> +<p> + This processor sends SNMP set requests to a SNMP agent in order to update information associated to a given OID. This processor supports + SNMPv1, SNMPv2c and SNMPv3. The component is based on <a href="http://www.snmp4j.org/";>SNMP4J</a>. +</p> +<p> + The processor constructs SNMP Set requests by extracting information from FlowFile attributes. The processor is looking for attributes + prefixed with <i>snmp$</i>. If such an attribute is found, the attribute name is split using the $ character. The second element must + respect the OID format to be considered as a valid OID. If there is a third element, it must represents the SMI Syntax integer value of + the type of data associated to the given OID to allow a correct conversion. If there is no third element, the value is considered as a String + and the value will be sent as an OctetString object. +</p> +<h2>Configuration Details</h2> +<p> + At the time of writing this document it only defines the essential configuration properties which are suitable for most cases. + Other properties will be defined later as this component progresses. + Configuring SetSNMP: +</p> +<ul> + <li><b>Host</b> - [REQUIRED] the name of the host where the SNMP agent is running. (default is localhost)</li> + <li><b>Port</b> - [REQUIRED] the port number on which the SNMP agent is listening. (default is 161)</li> + <li><b>Version</b> - [REQUIRED] the SNMP version to use (SNMPv1 [default], or SNMPv2c, or SNMPv3)</li> + <li><b>Community</b> - [REQUIRED if SNMPv1 or SNMPv2c] the SNMP community to use. (default is public)</li> + <li><b>Security Level</b> - [REQUIRED if SNMPv3] the security level to use. (default is authPriv)</li> + <li><b>Security Name</b> - [REQUIRED if SNMPv3] the security name (user name) to use.</li> + <li><b>Authentication Protocol</b> - [REQUIRED if SNMPv3 and authNoPriv or authPriv] the authentication protocol to use.</li> + <li><b>Authentication Password</b> - [REQUIRED if SNMPv3 and authNoPriv or authPriv] the authentication password to use.</li> + <li><b>Private Protocol</b> - [REQUIRED if SNMPv3 and authPriv] the private protocol to use.</li> + <li><b>Private Password</b> - [REQUIRED if SNMPv3 and authPriv] the private password to use.</li> + <li><b>Retries</b> - [REQUIRED] Sets the number of retries to be performed before a request is timed out. (default is 0)</li> + <li><b>Timeout</b> - [REQUIRED] Sets timeout in milliseconds before a confirmed request is resent or timed out. (default is 5000)</li> +</ul> + +</body> +</html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-snmp-nar/1.4.0/org.apache.nifi.snmp.processors.SetSNMP/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-snmp-nar/1.4.0/org.apache.nifi.snmp.processors.SetSNMP/index.html?rev=1811008&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-snmp-nar/1.4.0/org.apache.nifi.snmp.processors.SetSNMP/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-snmp-nar/1.4.0/org.apache.nifi.snmp.processors.SetSNMP/index.html Tue Oct 3 13:30:16 2017 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>SetSNMP</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;">SetSNMP</h1><h2>Description: </h2><p>Based on incoming FlowFile attributes, the processor will execute SNMP Set requests. When founding attributes with name like snmp$<OID>, the processor will atempt to set the value of attribute to the corresponding OID given in the attribute name</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>snmp, set, oid</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 is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props.key</strong>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Host Name</strong></td><td id="default-value">localhost</td><td id="allowable-values"></td><td id="description">Network address of SNMP Agent (e.g., localhost)</td></tr><tr><td id="name"><strong>Port</strong></td><td id="default-value">161</td><td id="allowable-values"></td><td id="description">Numeric value identifying Port of SNMP Agent (e.g., 161)</td></tr><tr><td id="name"><strong>SNMP Version</strong></td><td id="default-value">SNMPv1</td><td id="allowable-values"><ul><li>SNMPv1</li><li>SNMPv2c</li><li>SNMPv3</li></ul></td><td id="description">SNMP Version to use</td></tr><tr><td id="name">SNMP Community (v1 & v2c)</td><td id="default-value">public</td><td id="allowable-values"></td><td id="description">SNMP Community to use (e.g., public)</td></tr><tr><td id="name"><strong>SNMP Security Level</strong></td><td id="default-value">authPriv</td><td id="allowable-values"><ul><li>noAuthNoPriv</li><li>authNoPriv</li><li>authPriv</li></ul></td><td id="description">SNMP Security Level to use</td></tr><tr><td id="name">SNMP Security name / user name</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Security name used for SNMP exchanges</td></tr><tr><td id="name"><strong>SNMP Authentication Protocol</strong></td><td id="default-value"></td><td id="allowable-values"><ul><li>MD5</li><li>SHA</li><li></li></ul></td><td id="description">SNMP Authentication Protocol to use</td></tr><tr><td id="name">SNMP Authentication pass phrase</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Pass phrase used for S NMP authentication protocol<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name"><strong>SNMP Private Protocol</strong></td><td id="default-value"></td><td id="allowable-values"><ul><li>DES</li><li>3DES</li><li>AES128</li><li>AES192</li><li>AES256</li><li></li></ul></td><td id="description">SNMP Private Protocol to use</td></tr><tr><td id="name">SNMP Private protocol pass phrase</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Pass phrase used for SNMP private protocol<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name"><strong>Number of retries</strong></td><td id="default-value">0</td><td id="allowable-values"></td><td id="description">Set the number of retries when requesting the SNMP Agent</td></tr><tr><td id="name"><strong>Timeout (ms)</strong></td><td id="default-value">5000</td><td id="allowable-values"></td><td id="description">Set the timeout (in milliseconds) when requesting the SNMP Agent</td></tr ></table><h3>Relationships: </h3><table >id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>All > FlowFiles that have been successfully used to perform SNMP Set are routed to >this relationship</td></tr><tr><td>failure</td><td>All FlowFiles that failed >during the SNMP Set care routed to this >relationship</td></tr></table><h3>Reads Attributes: </h3>None >specified.<h3>Writes Attributes: </h3>None specified.<h3>State management: ></h3>This component does not store state.<h3>Restricted: </h3>This component >is not restricted.<h3>Input requirement: </h3>This component requires an >incoming relationship.</body></html> \ No newline at end of file
