Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.11.4/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.11.4/org.apache.nifi.reporting.SiteToSiteProvenanceReportingTask/additionalDetails.html?rev=1875518&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.11.4/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.11.4/org.apache.nifi.reporting.SiteToSiteProvenanceReportingTask/additionalDetails.html Sun Mar 22 13:18:15 2020 @@ -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> +{ + "type" : "record", + "name" : "provenance", + "namespace" : "provenance", + "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": ["null", "string"] }, + { "name": "componentId", "type": ["null", "string"] }, + { "name": "componentType", "type": ["null", "string"] }, + { "name": "componentName", "type": ["null", "string"] }, + { "name": "processGroupId", "type": ["null", "string"] }, + { "name": "processGroupName", "type": ["null", "string"] }, + { "name": "entityId", "type": ["null", "string"] }, + { "name": "entityType", "type": ["null", "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": ["null", "string"] }, + { "name": "contentURI", "type": ["null", "string"] }, + { "name": "previousContentURI", "type": ["null", "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": ["null", "string"] }, + { "name": "alternateIdentifier", "type": ["null", "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.11.4/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.11.4/org.apache.nifi.reporting.SiteToSiteProvenanceReportingTask/index.html?rev=1875518&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.11.4/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.11.4/org.apache.nifi.reporting.SiteToSiteProvenanceReportingTask/index.html Sun Mar 22 13:18:15 2020 @@ -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</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 Expressio n 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 or, if clustered, a comma-separated list of address in the format of http(s)://host:port/nifi. This destination URL will only be used to initiate the Site-to-Site connection. The data sent by this reporting task will be load-balanced on all the nodes of the destination (if clustered).<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><str ong>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.11.4/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 u se 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>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="allowabl e-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.11.4/org.apache.nifi.xml.XMLRecordSetWriter/index.html">XMLRecordSetWriter</a><br/><a href="../../../nifi-parquet-nar/1.11.4/org.apache.nifi.parquet.ParquetRecordSetWriter/index.html">ParquetRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.4/org.apache.nifi.csv.CSVRecordSetWriter/index.html">CSVRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.4/org.apache.nifi.text.FreeFormTextRecordSetWriter/index.html">FreeFormTextRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.4/org.apache.nifi.json.JsonRecordSetWriter/index.html">JsonRecordSetWriter</a><br/><a hr ef="../../../nifi-scripting-nar/1.11.4/org.apache.nifi.record.script.ScriptedRecordSetWriter/index.html">ScriptedRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.4/org.apache.nifi.avro.AvroRecordSetWriter/index.html">AvroRecordSetWriter</a></td><td id="description">Specifies the Controller Service to use for writing out the records.</td></tr><tr><td id="name"><strong>Include Null Values</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Indicate if null values should be included in records. Default will be false</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 event.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Event Type to Include</td><td i d="default-value"></td><td id="allowable-values"></td><td id="description">Comma-separated list of event types that will be used to filter the provenance events sent by the reporting task. Available event types are [CREATE, RECEIVE, FETCH, SEND, REMOTE_INVOCATION, DOWNLOAD, DROP, EXPIRE, FORK, JOIN, CLONE, CONTENT_MODIFIED, ATTRIBUTES_MODIFIED, ROUTE, ADDINFO, REPLAY, UNKNOWN]. If no filter is set, all the events are sent. If multiple filters are set, the filters are cumulative.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Event Type to Exclude</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 exclude the provenance events sent by the reporting task. Available event types are [CREATE, RECEIVE, FETCH, SEND, REMOTE_INVOCATION, DOWNLOAD, DROP, EXPIRE, FORK, JOIN, CLONE, CONTENT_MODIFIED, ATTRIBUTES_MODIFIED, RO UTE, ADDINFO, REPLAY, UNKNOWN]. If no filter is set, all the events are sent. If multiple filters are set, the filters are cumulative. If an event type is included in Event Type to Include and excluded here, then the exclusion takes precedence and the event will not be sent.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Component Type to Include</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.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Component Type to Exclude</td><td id="default-value"></td><td id="allowable-values"></td><td id="descr iption">Regular expression to exclude the provenance events based on the component type. The events matching the regular expression will not be sent. If no filter is set, all the events are sent. If multiple filters are set, the filters are cumulative. If a component type is included in Component Type to Include and excluded here, then the exclusion takes precedence and the event will not be sent.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Component ID to Include</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Comma-separated list of component UUID that will be used to filter the provenance events sent by the reporting task. If no filter is set, all the events are sent. If multiple filters are set, the filters are cumulative.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Comp onent ID to Exclude</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Comma-separated list of component UUID that will be used to exclude 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. If a component UUID is included in Component ID to Include and excluded here, then the exclusion takes precedence and the event will not be sent.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Component Name to Include</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 name. 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.<br/><strong>Supports Expression Languag e: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Component Name to Exclude</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Regular expression to exclude the provenance events based on the component name. The events matching the regular expression will not be sent. If no filter is set, all the events are sent. If multiple filters are set, the filters are cumulative. If a component name is included in Component Name to Include and excluded here, then the exclusion takes precedence and the event will not be sent.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></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, specifies where in the stream of Provenance Events the Reporting Task should start</td></tr></table><h3>State management: </h3><table id="stateful"><tr><th>Scope</th><th>Description</th></tr><tr><td>LOCAL</td><td>Stores the Reporting Task's last event Id so that on restart the task knows where it left off.</td></tr></table><h3>Restricted: </h3><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 se nsitive details contained in Provenance 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.11.4/org.apache.nifi.reporting.SiteToSiteStatusReportingTask/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.11.4/org.apache.nifi.reporting.SiteToSiteStatusReportingTask/additionalDetails.html?rev=1875518&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.11.4/org.apache.nifi.reporting.SiteToSiteStatusReportingTask/additionalDetails.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.11.4/org.apache.nifi.reporting.SiteToSiteStatusReportingTask/additionalDetails.html Sun Mar 22 13:18:15 2020 @@ -0,0 +1,135 @@ +<!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>SiteToSiteStatusReportingTask</title> + + <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css" /> + </head> + + <body> + <p> + The Site-to-Site Status Reporting Task allows the user to publish 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> + + <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" : "status", + "namespace" : "status", + "fields" : [ + // common fields for all components + { "name" : "statusId", "type" : "string"}, + { "name" : "timestampMillis", "type": { "type": "long", "logicalType": "timestamp-millis" } }, + { "name" : "timestamp", "type" : "string"}, + { "name" : "actorHostname", "type" : "string"}, + { "name" : "componentType", "type" : "string"}, + { "name" : "componentName", "type" : "string"}, + { "name" : "parentId", "type" : ["string", "null"]}, + { "name" : "parentName", "type" : ["string", "null"]}, + { "name" : "parentPath", "type" : ["string", "null"]}, + { "name" : "platform", "type" : "string"}, + { "name" : "application", "type" : "string"}, + { "name" : "componentId", "type" : "string"}, + + // PG + RPG + Ports + Processors + { "name" : "activeThreadCount", "type" : ["long", "null"]}, + + // PG + Ports + Processors + { "name" : "flowFilesReceived", "type" : ["long", "null"]}, + { "name" : "flowFilesSent", "type" : ["long", "null"]}, + + // PG + Ports + Processors + { "name" : "bytesReceived", "type" : ["long", "null"]}, + { "name" : "bytesSent", "type" : ["long", "null"]}, + + // PG + Connections + { "name" : "queuedCount", "type" : ["long", "null"]}, + + // PG + Processors + { "name" : "bytesRead", "type" : ["long", "null"]}, + { "name" : "bytesWritten", "type" : ["long", "null"]}, + { "name" : "terminatedThreadCount", "type" : ["long", "null"]}, + + // Processors + Ports + { "name" : "runStatus", "type" : ["string", "null"]}, + + // fields for process group status + { "name" : "bytesTransferred", "type" : ["long", "null"]}, + { "name" : "flowFilesTransferred", "type" : ["long", "null"]}, + { "name" : "inputContentSize", "type" : ["long", "null"]}, + { "name" : "outputContentSize", "type" : ["long", "null"]}, + { "name" : "queuedContentSize", "type" : ["long", "null"]}, + { "name" : "versionedFlowStatus", "type" : ["string", "null"]}, + + // fields for remote process groups + { "name" : "activeRemotePortCount", "type" : ["long", "null"]}, + { "name" : "inactiveRemotePortCount", "type" : ["long", "null"]}, + { "name" : "receivedContentSize", "type" : ["long", "null"]}, + { "name" : "receivedCount", "type" : ["long", "null"]}, + { "name" : "sentContentSize", "type" : ["long", "null"]}, + { "name" : "sentCount", "type" : ["long", "null"]}, + { "name" : "averageLineageDuration", "type" : ["long", "null"]}, + { "name" : "transmissionStatus", "type" : ["string", "null"]}, + { "name" : "targetURI", "type" : ["string", "null"]}, + + // fields for input/output ports + connections + PG + { "name" : "inputBytes", "type" : ["long", "null"]}, + { "name" : "inputCount", "type" : ["long", "null"]}, + { "name" : "outputBytes", "type" : ["long", "null"]}, + { "name" : "outputCount", "type" : ["long", "null"]}, + { "name" : "transmitting", "type" : ["boolean", "null"]}, + + // fields for connections + { "name" : "sourceId", "type" : ["string", "null"]}, + { "name" : "sourceName", "type" : ["string", "null"]}, + { "name" : "destinationId", "type" : ["string", "null"]}, + { "name" : "destinationName", "type" : ["string", "null"]}, + { "name" : "maxQueuedBytes", "type" : ["long", "null"]}, + { "name" : "maxQueuedCount", "type" : ["long", "null"]}, + { "name" : "queuedBytes", "type" : ["long", "null"]}, + { "name" : "backPressureBytesThreshold", "type" : ["long", "null"]}, + { "name" : "backPressureObjectThreshold", "type" : ["long", "null"]}, + { "name" : "backPressureDataSizeThreshold", "type" : ["string", "null"]}, + { "name" : "isBackPressureEnabled", "type" : ["string", "null"]}, + + // fields for processors + { "name" : "processorType", "type" : ["string", "null"]}, + { "name" : "averageLineageDurationMS", "type" : ["long", "null"]}, + { "name" : "flowFilesRemoved", "type" : ["long", "null"]}, + { "name" : "invocations", "type" : ["long", "null"]}, + { "name" : "processingNanos", "type" : ["long", "null"]}, + { "name" : "executionNode", "type" : ["string", "null"]}, + { "name" : "counters", "type": ["null", { "type": "map", "values": "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.11.4/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.11.4/org.apache.nifi.reporting.SiteToSiteStatusReportingTask/index.html?rev=1875518&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.11.4/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.11.4/org.apache.nifi.reporting.SiteToSiteStatusReportingTask/index.html Sun Mar 22 13:18:15 2020 @@ -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><p><a href="additionalDetails.html">Additional Details...</a></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 propertie s 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 or, if clustered, a comma-separated list of address in the format of http(s)://host:port/nifi. This destination URL will only be used to initiate the Site-to-Site connection. The data sent by this reporting task will be load-balanced on all the nodes of the destination (if clustered).<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>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.11.4/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 spe cified, 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>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="defaul t-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="descripti on">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.11.4/org.apache.nifi.xml.XMLRecordSetWriter/index.html">XMLRecordSetWriter</a><br/><a href="../../../nifi-parquet-nar/1.11.4/org.apache.nifi.parquet.ParquetRecordSetWriter/index.html">ParquetRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.4/org.apache.nifi.csv.CSVRecordSetWriter/index.html">CSVRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.4/ org.apache.nifi.text.FreeFormTextRecordSetWriter/index.html">FreeFormTextRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.4/org.apache.nifi.json.JsonRecordSetWriter/index.html">JsonRecordSetWriter</a><br/><a href="../../../nifi-scripting-nar/1.11.4/org.apache.nifi.record.script.ScriptedRecordSetWriter/index.html">ScriptedRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.4/org.apache.nifi.avro.AvroRecordSetWriter/index.html">AvroRecordSetWriter</a></td><td id="description">Specifies the Controller Service to use for writing out the records.</td></tr><tr><td id="name"><strong>Include Null Values</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Indicate if null values should be included in records. Default will be false</td></tr><tr><td id="name"><strong>Platform</strong></td><td id="default-value">nifi</td><td id="allowable-value s"></td><td id="description">The value to use for the platform field in each status record.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</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 (will be evaluated using variable registry only)</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 com ponent name matching this regex will be included.<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>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.11.4/org.apache.nifi.reporting.sink.SiteToSiteReportingRecordSink/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.11.4/org.apache.nifi.reporting.sink.SiteToSiteReportingRecordSink/index.html?rev=1875518&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.11.4/org.apache.nifi.reporting.sink.SiteToSiteReportingRecordSink/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.11.4/org.apache.nifi.reporting.sink.SiteToSiteReportingRecordSink/index.html Sun Mar 22 13:18:15 2020 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>SiteToSiteReportingRecordSink</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;">SiteToSiteReportingRecordSink</h1><h2>Description: </h2><p>Provides a service to write records using a configured RecordSetWriter over a Site-to-Site connection.</p><h3>Tags: </h3><p>db, s2s, site, record</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>, and whether a property is considered "sensi tive", 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>Record Writer</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>RecordSetWriterFactory<br/><strong>Implementations: </strong><a href="../../../nifi-record-serialization-services-nar/1.11.4/org.apache.nifi.xml.XMLRecordSetWriter/index.html">XMLRecordSetWriter</a><br/><a href="../../../nifi-parquet-nar/1.11.4/org.apache.nifi.parquet.ParquetRecordSetWriter/index.html">ParquetRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.4/org.apache.nifi.csv.CSVRecordSetWriter/index.html">CSVRecordSetWriter</a><br/><a href="../../../nifi-reco rd-serialization-services-nar/1.11.4/org.apache.nifi.text.FreeFormTextRecordSetWriter/index.html">FreeFormTextRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.4/org.apache.nifi.json.JsonRecordSetWriter/index.html">JsonRecordSetWriter</a><br/><a href="../../../nifi-scripting-nar/1.11.4/org.apache.nifi.record.script.ScriptedRecordSetWriter/index.html">ScriptedRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.4/org.apache.nifi.avro.AvroRecordSetWriter/index.html">AvroRecordSetWriter</a></td><td id="description">Specifies the Controller Service to use for writing out the records.</td></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 or, if clustered, a comma-separated list of address in the format of http(s)://host:port/nifi. This destination URL will only be used to initiate the Site-t o-Site connection. The data sent by this reporting task will be load-balanced on all the nodes of the destination (if clustered).<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>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.11.4/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</a></td><td id="description">The SSL Context Service to use when communicating with the dest ination. 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>Compress Events</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Indicates whether or not to compress the data being sent.</td></tr><tr><td id="name"><strong>Communications Timeout</strong></td><td id="default-value">30 secs</td><td id="allowable-values"></td><td id="description">Specifies how long to wait to a response from the destination before deciding that an error has occurred and canceling the transaction</td></tr><tr><td id="name"><strong>Batch Size</strong> </td><td id="default-value">1000</td><td id="allowable-values"></td><td id="description">Specifies how many records to send in a single batch, at most.</td></tr><tr><td id="name"><strong>Transport Protocol</strong></td><td id="default-value">RAW</td><td id="allowable-values"><ul><li>RAW</li><li>HTTP</li></ul></td><td id="description">Specifies which transport protocol to use for Site-to-Site communication.</td></tr><tr><td id="name">HTTP Proxy hostname</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Specify the proxy server's hostname to use. If not specified, HTTP traffics are sent directly to the target NiFi instance.</td></tr><tr><td id="name">HTTP Proxy port</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Specify the proxy server's port number, optional. If not specified, default port 80 will be used.</td></tr><tr><td id="name">HTTP Proxy username</td><td id="default-value"></td><td id="allowable-values"></t d><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></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-slack-nar/1.11.4/org.apache.nifi.processors.slack.PostSlack/additionalDetails.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-slack-nar/1.11.4/org.apache.nifi.processors.slack.PostSlack/additionalDetails.html?rev=1875518&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-slack-nar/1.11.4/org.apache.nifi.processors.slack.PostSlack/additionalDetails.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-slack-nar/1.11.4/org.apache.nifi.processors.slack.PostSlack/additionalDetails.html Sun Mar 22 13:18:15 2020 @@ -0,0 +1,107 @@ +<!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>PostSlack</title> + <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css" /> + <style> + dt {font-style: italic;} + </style> + </head> + + <body> + <!-- Processor Documentation ================================================== --> + <h2>Description:</h2> + <p> + The PostSlack processor sends messages on Slack, a team-oriented messaging service. + The message can be a simple text message, furthermore Slack attachments can also be specified + or the FlowFile content (e.g. an image) can be uploaded and attached to the message too. + </p> + <h3>Slack App setup</h3> + <p> + This processor uses Slack Web API methods to post messages to a specific channel. + Before using PostSlack, you need to create a Slack App, to add a Bot User to the app, + and to install the app in your Slack workspace. After the app installed, you can get + the Bot User's OAuth Access Token that will be needed to authenticate and authorize + your PostSlack processor to Slack. + </p> + <h3>Message types</h3> + <p> + You can send the following types of messages with PostSlack: + </p> + <dl> + <dt>Text-only message</dt> + <dd> + A simple text message. In this case you must specify the <Text> property, + while <Upload FlowFile> is 'No' and no attachments defined through dynamic properties. + File related properties will be ignored in this case. + </dd> + <dt>Text message with attachment</dt> + <dd> + Besides the <Text> property, one or more attachments are also defined through dynamic properties + (for more details see the <a href="additionalDetails.html#slack-attachments">Slack attachments</a> section below). + The <Upload FlowFile> property needs to be set to 'No'. File related properties will be ignored. + </dd> + <dt>Attachment-only message</dt> + <dd> + The same as the previous one, but the <Text> property is not specified + (so no text section will be displayed at the beginning of the message, only the attachment(s)). + </dd> + <dt>Text message with file upload</dt> + <dd> + You need to specify the <Text> property and set <Upload FlowFile> to 'Yes'. + The content of the FlowFile will be uploaded with the message and it will be displayed + below the text. You should specify <File Name> and <File Mime Type> properties too + (otherwise some fallback values will be set), and optionally <File Title>. + The dynamic properties will be ignored in this case. + </dd> + <dt>File upload message without text</dt> + <dd> + The same as the previous one, but the <Text> property is not specified + (so no text section will be displayed at the beginning of the message, only the uploaded file). + </dd> + </dl> + <h3 id="slack-attachments">Slack attachments</h3> + <p> + Slack content and link attachments can be added to the message through dynamic properties. + Please note that this kind of Slack message attachments does not involve the file + upload itself, but rather contain links to external resources (or internal resources already uploaded + to Slack). Please also note that this functionality does not work together with file upload + (so it can only be used when 'Upload FlowFile' has been set to 'No'). + </p> + <p> + The Dynamic Properties can be used to specify these Slack message attachments as JSON snippets. + Each property value will be converted to JSON and will be added to the array of attachments in the JSON + payload being sent to Slack. + </p> + <p> + Example JSON snippets to define Slack attachments: + </p> + <pre> + { + "text": "Text that appears within the attachment", + "image_url": "http://some-website.com/path/to/image.jpg"; + } + </pre> + <pre> + { + "title": "Title of the attachment", + "image_url": "http://some-website.com/path/to/image.jpg"; + } + </pre> + </body> +</html> Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-slack-nar/1.11.4/org.apache.nifi.processors.slack.PostSlack/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-slack-nar/1.11.4/org.apache.nifi.processors.slack.PostSlack/index.html?rev=1875518&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-slack-nar/1.11.4/org.apache.nifi.processors.slack.PostSlack/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-slack-nar/1.11.4/org.apache.nifi.processors.slack.PostSlack/index.html Sun Mar 22 13:18:15 2020 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PostSlack</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;">PostSlack</h1><h2>Description: </h2><p>Sends a message on Slack. The FlowFile content (e.g. an image) can be uploaded and attached to the message.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>slack, post, notify, upload, message</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>Post Message URL</strong></td><td id="default-value">https://slack.com/api/chat.postMessage</td><td id="allowable-values"></td><td id="description">Slack Web API URL for posting text messages to channels. It only needs to be changed if Slack changes its API URL.</td></tr><tr><td id="name"><strong>File Upload URL</strong></td><td id="default-value">https://slack.com/api/files.upload</td><td id="allowable-values"></td><td id="description">Slack Web API URL for uploading files to channels. It only needs to be changed if Slack changes its API URL.</td></tr><tr><td id="name"><strong>A ccess Token</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">OAuth Access Token used for authenticating/authorizing the Slack request sent by NiFi.<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name"><strong>Channel</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Slack channel, private group, or IM channel to send the message to.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Text</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Text of the Slack message to send. Only required if no attachment has been specified and 'Upload File' has been set to 'No'.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Upload FlowFile</strong></td> <td id="default-value">false</td><td id="allowable-values"><ul><li>Yes <img src="../../../../../html/images/iconInfo.png" alt="Upload and attach FlowFile content to the Slack message." title="Upload and attach FlowFile content to the Slack message."></img></li><li>No <img src="../../../../../html/images/iconInfo.png" alt="Don't upload and attach FlowFile content to the Slack message." title="Don't upload and attach FlowFile content to the Slack message."></img></li></ul></td><td id="description">Whether or not to upload and attach the FlowFile content to the Slack message.</td></tr><tr><td id="name">File Title</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Title of the file displayed in the Slack message. The property value will only be used if 'Upload FlowFile' has been set to 'Yes'.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">File Name</t d><td id="default-value">${filename}</td><td id="allowable-values"></td><td id="description">Name of the file to be uploaded. The property value will only be used if 'Upload FlowFile' has been set to 'Yes'. If the property evaluated to null or empty string, then the file name will be set to 'file' in the Slack message.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">File Mime Type</td><td id="default-value">${mime.type}</td><td id="allowable-values"></td><td id="description">Mime type of the file to be uploaded. The property value will only be used if 'Upload FlowFile' has been set to 'Yes'. If the property evaluated to null or empty string, then the mime type will be set to 'application/octet-stream' in the Slack message.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr></table><h3>Dynamic Proper ties: </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"><Arbitrary name></td><td id="value">JSON snippet specifying a Slack message "attachment"</td><td>The property value will be converted to JSON and will be added to the array of attachments in the JSON payload being sent to Slack. The property name will not be used by the processor.<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 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 Attribute s: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>slack.file.url</td><td>The Slack URL of the uploaded file. It will be added if 'Upload FlowFile' has been set to 'Yes'.</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.<h3>System Resource Considerations:</h3>None specified.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-slack-nar/1.11.4/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.11.4/org.apache.nifi.processors.slack.PutSlack/additionalDetails.html?rev=1875518&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-slack-nar/1.11.4/org.apache.nifi.processors.slack.PutSlack/additionalDetails.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-slack-nar/1.11.4/org.apache.nifi.processors.slack.PutSlack/additionalDetails.html Sun Mar 22 13:18:15 2020 @@ -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.11.4/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.11.4/org.apache.nifi.processors.slack.PutSlack/index.html?rev=1875518&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-slack-nar/1.11.4/org.apache.nifi.processors.slack.PutSlack/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-slack-nar/1.11.4/org.apache.nifi.processors.slack.PutSlack/index.html Sun Mar 22 13:18:15 2020 @@ -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><br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</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 (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Ch annel</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 (will be evaluated using flow file attributes and variable registry)</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 (will be evaluated using flow file attributes and variable registry)</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 (will be evaluated using flow file attributes and variable registry)</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 (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">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 (will be evaluated using flow file attributes and variable registry)</strong></td></tr></table></p><h3>Relation ships: </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 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-snmp-nar/1.11.4/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.11.4/org.apache.nifi.snmp.processors.GetSNMP/additionalDetails.html?rev=1875518&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-snmp-nar/1.11.4/org.apache.nifi.snmp.processors.GetSNMP/additionalDetails.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-snmp-nar/1.11.4/org.apache.nifi.snmp.processors.GetSNMP/additionalDetails.html Sun Mar 22 13:18:15 2020 @@ -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.11.4/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.11.4/org.apache.nifi.snmp.processors.GetSNMP/index.html?rev=1875518&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-snmp-nar/1.11.4/org.apache.nifi.snmp.processors.GetSNMP/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-snmp-nar/1.11.4/org.apache.nifi.snmp.processors.GetSNMP/index.html Sun Mar 22 13:18:15 2020 @@ -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.<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-snmp-nar/1.11.4/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.11.4/org.apache.nifi.snmp.processors.SetSNMP/additionalDetails.html?rev=1875518&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-snmp-nar/1.11.4/org.apache.nifi.snmp.processors.SetSNMP/additionalDetails.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-snmp-nar/1.11.4/org.apache.nifi.snmp.processors.SetSNMP/additionalDetails.html Sun Mar 22 13:18:15 2020 @@ -0,0 +1,58 @@ +<!DOCTYPE html> +<html lang="en"> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + http://www.apache.org/licenses/LICENSE-2.0 + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<head> + <meta charset="utf-8" /> + <title>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.11.4/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.11.4/org.apache.nifi.snmp.processors.SetSNMP/index.html?rev=1875518&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-snmp-nar/1.11.4/org.apache.nifi.snmp.processors.SetSNMP/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-snmp-nar/1.11.4/org.apache.nifi.snmp.processors.SetSNMP/index.html Sun Mar 22 13:18:15 2020 @@ -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.<h3>System Resource Considerations:</h3>None >specified.</body></html> \ No newline at end of file
![http://some-website.com/path/to/image.jpg"](http://some-website.com/path/to/image.jpg"){kind=link}