Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.TailFile/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.TailFile/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.TailFile/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.TailFile/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>TailFile</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>"Tails" a file, ingesting data from the file as it is written to the file. The file is expected to be textual. Data is ingested only when a new line is encountered (carriage return or new-line character or combination). If the file to tail is periodically "rolled over", as is generally the case with log files, an optional Rolling Filename Pattern can be used to retrieve data from files that have rolled over, even if the rollover occurred while NiFi was not running (provided that the data still exists upon restart of NiFi). It is generally advisable to set the Run Schedule to a few seconds, rather than running with the default value of 0 secs, as this Processor will consume a lot of resources if scheduled very aggressively. At this time, this Processor does not support ingestin g files that have been compressed when 'rolled over'.</p><h3>Tags: </h3><p>tail, file, log, text, source</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>File to Tail</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Fully-qualified filename of the file that should be tailed</td></tr><tr><td id="name">Rolling Filename Pattern</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">If the file to tail "rolls over" as would be the case with log files, this filename pattern will be used to identify files that have rolled over so that if NiFi is restarted, and the file has rolled over, it will be able to pick up w here it left off. This pattern supports wildcard characters * and ? and will assume that the files that have rolled over live in the same directory as the file being tailed.</td></tr><tr><td id="name"><strong>Initial Start Position</strong></td><td id="default-value">Beginning of File</td><td id="allowable-values"><ul><li>Beginning of Time <img src="../../html/images/iconInfo.png" alt="Start with the oldest data that matches the Rolling Filename Pattern and then begin reading from the File to Tail" title="Start with the oldest data that matches the Rolling Filename Pattern and then begin reading from the File to Tail"></img></li><li>Beginning of File <img src="../../html/images/iconInfo.png" alt="Start with the beginning of the File to Tail. Do not ingest any data that has already been rolled over" title="Start with the beginning of the File to Tail. Do not ingest any data that has already been rolled over"></img></li><li>Current Time <img src="../../html/images/iconInfo.png" alt="S tart with the data at the end of the File to Tail. Do not ingest any data thas has already been rolled over or any data in the File to Tail that has already been written." title="Start with the data at the end of the File to Tail. Do not ingest any data thas has already been rolled over or any data in the File to Tail that has already been written."></img></li></ul></td><td id="description">When the Processor first begins to tail data, this property specifies where the Processor should begin reading data. Once data has been ingested from the file, the Processor will continue from the last point from which it has received data.</td></tr><tr><td id="name"><strong>State Location</strong></td><td id="default-value">Local</td><td id="allowable-values"><ul><li>Local <img src="../../html/images/iconInfo.png" alt="State is stored locally. Each node in a cluster will tail a different file." title="State is stored locally. Each node in a cluster will tail a different file."></img></li><li>Rem ote <img src="../../html/images/iconInfo.png" alt="State is located on a remote resource. This Processor will store state across the cluster so that it can be run on Primary Node Only and a new Primary Node can pick up where the last one left off." title="State is located on a remote resource. This Processor will store state across the cluster so that it can be run on Primary Node Only and a new Primary Node can pick up where the last one left off."></img></li></ul></td><td id="description">Specifies where the state is located either local or cluster so that state can be stored appropriately in order to ensure that all data is consumed without duplicating data upon restart of NiFi</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>All FlowFiles are routed to this Relationship.</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.</body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>TailFile</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>"Tails" a file, or a list of files, ingesting data from the file as it is written to the file. The file is expected to be textual. Data is ingested only when a new line is encountered (carriage return or new-line character or combination). If the file to tail is periodically "rolled over", as is generally the case with log files, an optional Rolling Filename Pattern can be used to retrieve data from files that have rolled over, even if the rollover occurred while NiFi was not running (provided that the data still exists upon restart of NiFi). It is generally advisable to set the Run Schedule to a few seconds, rather than running with the default value of 0 secs, as this Processor will consume a lot of resources if scheduled very aggressively. At this time, this Processor does not support ingesting files that have been compressed when 'rolled over'.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>tail, file, log, text, source, 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>Tailing mode</strong></td><td id="default-value">Single file</td><td id="allowable-values"><ul><li>Single file <img src="../../html/images/iconInfo.png" alt="In this mode, only the one file indicated in the 'Files to tail' property will be watched by the processor. In this mode, the file may not exist when starting th e processor." title="In this mode, only the one file indicated in the 'Files to tail' property will be watched by the processor. In this mode, the file may not exist when starting the processor."></img></li><li>Multiple files <img src="../../html/images/iconInfo.png" alt="In this mode, the 'Files to tail' property accepts a regular expression and the processor will look for files in 'Base directory' to list the files to tail by the processor. In this mode, only the files existing when starting the processor will be used." title="In this mode, the 'Files to tail' property accepts a regular expression and the processor will look for files in 'Base directory' to list the files to tail by the processor. In this mode, only the files existing when starting the processor will be used."></img></li></ul></td><td id="description">Mode to use: single file will tail only one file, multiple file will look for a list of file. In Multiple mode the Base directory is required.</td></tr><tr><td id="n ame"><strong>File(s) to Tail</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Path of the file to tail in case of single file mode. If using multifile mode, regular expression to find files to tail in the base directory. In case recursivity is set to true, the regular expression will be used to match the path starting from the base directory (see additional details for examples).<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Rolling Filename Pattern</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">If the file to tail "rolls over" as would be the case with log files, this filename pattern will be used to identify files that have rolled over so that if NiFi is restarted, and the file has rolled over, it will be able to pick up where it left off. This pattern supports wildcard characters * and ?, it also supports the notation ${filename} to specify a pattern based on the name of the file (without extension), and will assume that the files that have rolled over live in the same directory as the file being tailed. The same glob pattern will be used for all files.</td></tr><tr><td id="name">Base directory</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Base directory used to look for files to tail. This property is required when using Multifile mode.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Initial Start Position</strong></td><td id="default-value">Beginning of File</td><td id="allowable-values"><ul><li>Beginning of Time <img src="../../html/images/iconInfo.png" alt="Start with the oldest data that matches the Rolling Filename Pattern and then begin reading from the File to Tail" title="Start with the oldest data that matches the Rolling Filename Pattern and then begin reading from the File to Tail"></img></li><li>Beginning of File <img src="../../html/images/iconInfo .png" alt="Start with the beginning of the File to Tail. Do not ingest any data that has already been rolled over" title="Start with the beginning of the File to Tail. Do not ingest any data that has already been rolled over"></img></li><li>Current Time <img src="../../html/images/iconInfo.png" alt="Start with the data at the end of the File to Tail. Do not ingest any data thas has already been rolled over or any data in the File to Tail that has already been written." title="Start with the data at the end of the File to Tail. Do not ingest any data thas has already been rolled over or any data in the File to Tail that has already been written."></img></li></ul></td><td id="description">When the Processor first begins to tail data, this property specifies where the Processor should begin reading data. Once data has been ingested from a file, the Processor will continue from the last point from which it has received data.</td></tr><tr><td id="name"><strong>State Location</strong></td ><td id="default-value">Local</td><td id="allowable-values"><ul><li>Local <img >src="../../html/images/iconInfo.png" alt="State is stored locally. Each node >in a cluster will tail a different file." title="State is stored locally. >Each node in a cluster will tail a different file."></img></li><li>Remote ><img src="../../html/images/iconInfo.png" alt="State is located on a remote >resource. This Processor will store state across the cluster so that it can >be run on Primary Node Only and a new Primary Node can pick up where the last >one left off." title="State is located on a remote resource. This Processor >will store state across the cluster so that it can be run on Primary Node >Only and a new Primary Node can pick up where the last one left >off."></img></li></ul></td><td id="description">Specifies where the state is >located either local or cluster so that state can be stored appropriately in >order to ensure that all data is consumed without duplicating data upon >restart of NiFi</td></t r><tr><td id="name"><strong>Recursive lookup</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">When using Multiple files mode, this property defines if files must be listed recursively or not in the base directory.</td></tr><tr><td id="name"><strong>Rolling Strategy</strong></td><td id="default-value">Fixed name</td><td id="allowable-values"><ul><li>Fixed name <img src="../../html/images/iconInfo.png" alt="With this rolling strategy, the files where the log messages are appended have always the same name." title="With this rolling strategy, the files where the log messages are appended have always the same name."></img></li><li>Changing name <img src="../../html/images/iconInfo.png" alt="With this rolling strategy, the files where the log messages are appended have not a fixed name (for example: filename contaning the current day." title="With this rolling strategy, the files where the log messages a re appended have not a fixed name (for example: filename contaning the current day."></img></li></ul></td><td id="description">Specifies if the files to tail have a fixed name or not.</td></tr><tr><td id="name">Lookup frequency</td><td id="default-value">10 minutes</td><td id="allowable-values"></td><td id="description">Only used in Multiple files mode and Changing name rolling strategy. It specifies the minimum duration the processor will wait before listing again the files to tail.</td></tr><tr><td id="name">Maximum age</td><td id="default-value">24 hours</td><td id="allowable-values"></td><td id="description">Only used in Multiple files mode and Changing name rolling strategy. It specifies the necessary minimum duration to consider that no new messages will be appended in a file regarding its last modification date. This should not be set too low to avoid duplication of data in case new messages are appended at a lower frequency.</td></tr></table><h3>Relationships: </h3><table id ="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>All FlowFiles are routed to this Relationship.</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>tailfile.original.path</td><td>Path of the original file the flow file comes from.</td></tr></table><h3>State management: </h3><table id="stateful"><tr><th>Scope</th><th>Description</th></tr><tr><td>LOCAL, CLUSTER</td><td>Stores state about where in the Tailed File it left off so that on restart it does not have to duplicate data. State is stored either local or clustered depend on the <File Location> property.</td></tr></table><h3>Restricted: </h3><td>Provides operator the ability to read from any file that NiFi has access to.</td></body></html> \ No newline at end of file
Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.TransformXml/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.TransformXml/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.TransformXml/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.TransformXml/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>TransformXml</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Applies the provided XSLT file to the flowfile XML payload. A new FlowFile is created with transformed content and is routed to the 'success' relationship. If the XSL transform fails, the original FlowFile is routed to the 'failure' relationship</p><h3>Tags: </h3><p>xml, xslt, transform</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>XSLT file name</str ong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Provides the name (including full path) of the XSLT file to apply to the flowfile XML content.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Indent</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Whether or not to indent the output.</td></tr><tr><td id="name"><strong>Cache size</strong></td><td id="default-value">10</td><td id="allowable-values"></td><td id="description">Maximum number of stylesheets to cache. Zero disables the cache.</td></tr><tr><td id="name"><strong>Cache TTL after last access</strong></td><td id="default-value">60 secs</td><td id="allowable-values"></td><td id="description">The cache TTL (time-to-live) or how long to keep stylesheets in the cache after last access.</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">An XSLT transform parameter name</td><td id="value">An XSLT transform parameter value</td><td>These XSLT parameters are passed to the transformer<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>The FlowFile with transformed content will be routed to this relationship</td></tr><tr><td>failure</td><td>If a FlowFile fails processing for any reason (for example, the FlowFile is not valid XML), it will be routed to this relationship</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.</body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>TransformXml</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Applies the provided XSLT file to the flowfile XML payload. A new FlowFile is created with transformed content and is routed to the 'success' relationship. If the XSL transform fails, the original FlowFile is routed to the 'failure' relationship</p><h3>Tags: </h3><p>xml, xslt, transform</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>XSLT file name</str ong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Provides the name (including full path) of the XSLT file to apply to the flowfile XML content.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Indent</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Whether or not to indent the output.</td></tr><tr><td id="name"><strong>Cache size</strong></td><td id="default-value">10</td><td id="allowable-values"></td><td id="description">Maximum number of stylesheets to cache. Zero disables the cache.</td></tr><tr><td id="name"><strong>Cache TTL after last access</strong></td><td id="default-value">60 secs</td><td id="allowable-values"></td><td id="description">The cache TTL (time-to-live) or how long to keep stylesheets in the cache after last access.</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">An XSLT transform parameter name</td><td id="value">An XSLT transform parameter value</td><td>These XSLT parameters are passed to the transformer<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>The FlowFile with transformed content will be routed to this relationship</td></tr><tr><td>failure</td><td>If a FlowFile fails processing for any reason (for example, the FlowFile is not valid XML), it will be routed to this relationship</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>State management: </h3>This processor has no state management.<h3>Restricted: </h3></body></html> \ No newline at end of file Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.UnpackContent/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.UnpackContent/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.UnpackContent/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.UnpackContent/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>UnpackContent</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Unpacks the content of FlowFiles that have been packaged with one of several different Packaging Formats, emitting one to many FlowFiles for each input FlowFile</p><h3>Tags: </h3><p>Unpack, un-merge, tar, zip, archive, flowfile-stream, flowfile-stream-v3</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Packaging Format</strong></td><td id="default-value">use mime.type attribute</td><td id="allowable-values"><ul><li>use mime.type attribute</li><li>tar</li><li>zip</li><l i>flowfile-stream-v3</li><li>flowfile-stream-v2</li><li>flowfile-tar-v1</li></ul></td><td id="description">The Packaging Format used to create the file</td></tr><tr><td id="name"><strong>File Filter</strong></td><td id="default-value">.*</td><td id="allowable-values"></td><td id="description">Only files whose names match the given regular expression will be extracted (tar/zip only)</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>Unpacked FlowFiles are sent to this relationship</td></tr><tr><td>failure</td><td>The original FlowFile is sent to this relationship when it cannot be unpacked for some reason</td></tr><tr><td>original</td><td>The original FlowFile is sent to this relationship after it has been successfully unpacked</td></tr></table><h3>Reads Attributes: </h3><table id="reads-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>mime.type</td><td>If the <Packaging Format> prope rty is set to use mime.type attribute, this attribute is used to determine the FlowFile's MIME Type. In this case, if the attribute is set to application/tar, the TAR Packaging Format will be used. If the attribute is set to application/zip, the ZIP Packaging Format will be used. If the attribute is set to application/flowfile-v3 or application/flowfile-v2 or application/flowfile-v1, the appropriate FlowFile Packaging Format will be used. If this attribute is missing, the FlowFile will be routed to 'failure'. Otherwise, if the attribute's value is not one of those mentioned above, the FlowFile will be routed to 'success' without being unpacked. Use the File Filter property only extract files matching a specific regular expression.</td></tr></table><h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>mime.type</td><td>If the FlowFile is successfully unpacked, its MIME Type is no longer known, so the mime.type attribute is set to application/octet-stream.</td></tr><tr><td>fragment.identifier</td><td>All unpacked FlowFiles produced from the same parent FlowFile will have the same randomly generated UUID added for this attribute</td></tr><tr><td>fragment.index</td><td>A one-up number that indicates the ordering of the unpacked FlowFiles that were created from a single parent FlowFile</td></tr><tr><td>fragment.count</td><td>The number of unpacked FlowFiles generated from the parent FlowFile</td></tr><tr><td>segment.original.filename </td><td>The filename of the parent FlowFile. Extensions of .tar, .zip or .pkg are removed because the MergeContent processor automatically adds those extensions if it is used to rebuild the original FlowFile</td></tr></table><h3>See Also:</h3><p><a href="../org.apache.nifi.processors.standard.MergeContent/index.html">MergeContent</a></p></body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>UnpackContent</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Unpacks the content of FlowFiles that have been packaged with one of several different Packaging Formats, emitting one to many FlowFiles for each input FlowFile</p><h3>Tags: </h3><p>Unpack, un-merge, tar, zip, archive, flowfile-stream, flowfile-stream-v3</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Packaging Format</strong></td><td id="default-value">use mime.type attribute</td><td id="allowable-values"><ul><li>use mime.type attribute</li><li>tar</li><li>zip</li><l i>flowfile-stream-v3</li><li>flowfile-stream-v2</li><li>flowfile-tar-v1</li></ul></td><td id="description">The Packaging Format used to create the file</td></tr><tr><td id="name"><strong>File Filter</strong></td><td id="default-value">.*</td><td id="allowable-values"></td><td id="description">Only files whose names match the given regular expression will be extracted (tar/zip only)</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>Unpacked FlowFiles are sent to this relationship</td></tr><tr><td>failure</td><td>The original FlowFile is sent to this relationship when it cannot be unpacked for some reason</td></tr><tr><td>original</td><td>The original FlowFile is sent to this relationship after it has been successfully unpacked</td></tr></table><h3>Reads Attributes: </h3><table id="reads-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>mime.type</td><td>If the <Packaging Format> prope rty is set to use mime.type attribute, this attribute is used to determine the FlowFile's MIME Type. In this case, if the attribute is set to application/tar, the TAR Packaging Format will be used. If the attribute is set to application/zip, the ZIP Packaging Format will be used. If the attribute is set to application/flowfile-v3 or application/flowfile-v2 or application/flowfile-v1, the appropriate FlowFile Packaging Format will be used. If this attribute is missing, the FlowFile will be routed to 'failure'. Otherwise, if the attribute's value is not one of those mentioned above, the FlowFile will be routed to 'success' without being unpacked. Use the File Filter property only extract files matching a specific regular expression.</td></tr></table><h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>mime.type</td><td>If the FlowFile is successfully unpacked, its MIME Type is no longer known, so the mime.type attribute is set to application/octet-stream.</td></tr><tr><td>fragment.identifier</td><td>All unpacked FlowFiles produced from the same parent FlowFile will have the same randomly generated UUID added for this attribute</td></tr><tr><td>fragment.index</td><td>A one-up number that indicates the ordering of the unpacked FlowFiles that were created from a single parent FlowFile</td></tr><tr><td>fragment.count</td><td>The number of unpacked FlowFiles generated from the parent FlowFile</td></tr><tr><td>segment.original.filename </td><td>The filename of the parent FlowFile. Extensions of .tar, .zip or .pkg are removed because the MergeContent processor automatically adds those extensions if it is used to rebuild the original FlowFile</td></tr></table><h3>State management: </h3>This processor has no state management.<h3>Restricted: </h3><h3>See Also:</h3><p><a href="../org.apache.nifi.processors.standard.MergeContent/index.html">MergeContent</a></p></body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ValidateCsv/additionalDetails.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ValidateCsv/additionalDetails.html?rev=1771896&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ValidateCsv/additionalDetails.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ValidateCsv/additionalDetails.html Tue Nov 29 12:33:21 2016 @@ -0,0 +1,109 @@ +<!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>ValidateCsv</title> + <link rel="stylesheet" href="../../css/component-usage.css" type="text/css"/> +</head> + +<body> +<!-- Processor Documentation ================================================== --> +<h2>Usage Information</h2> + +<p> + The Validate CSV processor is based on the super-csv library and the concept of + <a href="http://super-csv.github.io/super-csv/cell_processors.html"; target="_blank">Cell Processors</a>. + The corresponding java documentation can be found + <a href="http://super-csv.github.io/super-csv/apidocs/org/supercsv/cellprocessor/ift/CellProcessor.html"; target="_blank">here</a>. +</p> + +<p> + The cell processors cannot be nested (except with Optional which gives the possibility to define a CellProcessor for values + that could be null) and must be defined in a comma-delimited string as the Schema property. +</p> + +<p> + The supported cell processors are: + <ul> + <li>ParseBigDecimal</li> + <li>ParseBool</li> + <li>ParseChar</li> + <li>ParseDate</li> + <li>ParseDouble</li> + <li>ParseInt</li> + <li>Optional</li> + <li>DMinMax</li> + <li>Equals</li> + <li>ForbidSubStr</li> + <li>LMinMax</li> + <li>NotNull</li> + <li>Null</li> + <li>RequireHashCode</li> + <li>RequireSubStr</li> + <li>Strlen</li> + <li>StrMinMax</li> + <li>StrNotNullOrEmpty</li> + <li>StrRegEx</li> + <li>Unique</li> + <li>UniqueHashCode</li> + <li>IsIncludedIn</li> + </ul> +</p> + +<p> + Here are some examples: + + <ul> + <b>Schema property:</b> Null, ParseDate("dd/MM/yyyy"), Optional(ParseDouble())<br /> + <b>Meaning:</b> the input CSV has three columns, the first one can be null and has no specification, the second one must be a date + formatted as expected, and the third one must a double or null (no value). + </ul> + + <ul> + <b>Schema property:</b> ParseBigDecimal(), ParseBool(), ParseChar(), ParseInt(), ParseLong()<br /> + <b>Meaning:</b> the input CSV has five columns, the first one must be a big decimal, the second one must be a boolean, + the third one must be a char, the fourth one must be an integer and the fifth one must be a long. + </ul> + + <ul> + <b>Schema property:</b> Equals(), NotNull(), StrNotNullOrEmpty()<br /> + <b>Meaning:</b> the input CSV has three columns, all the values of the first column must be equal to each other, all the values + of the second column must be not null, and all the values of the third column are not null/empty string values. + </ul> + + <ul> + <b>Schema property:</b> Strlen(4), StrMinMax(3,5), StrRegex("[a-z0-9\\._]+@[a-z0-9\\.]+")<br /> + <b>Meaning:</b> the input CSV has three columns, all the values of the first column must be 4-characters long, all the values + of the second column must be between 3 and 5 characters (inclusive), and all the values of the last column must match + the provided regular expression (email address). + </ul> + + <ul> + <b>Schema property:</b> Unique(), UniqueHashCode()<br /> + <b>Meaning:</b> the input CSV has two columns. All the values of the first column must be unique (all the values are stored in + memory and this can be consuming depending of the input). All the values of the second column must be unique (only hash + codes of the input values are stored to ensure uniqueness). + </ul> + + <ul> + <b>Schema property:</b> ForbidSubStr("test", "tset"), RequireSubStr("test")<br /> + <b>Meaning:</b> the input CSV has two columns. None of the values in the first column must contain one of the provided strings. + And all the values of the second column must contain the provided string. + </ul> +</p> +</body> +</html> Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ValidateCsv/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ValidateCsv/index.html?rev=1771896&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ValidateCsv/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ValidateCsv/index.html Tue Nov 29 12:33:21 2016 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ValidateCsv</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Validates the contents of FlowFiles against a user-specified CSV schema. Take a look at the additional documentation of this processor for some schema examples.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>csv, schema, validation</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Schema</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The schema to be used for validation. Is expected a com ma-delimited string representing the cell processors to apply. The following cell processors are allowed in the schema definition: [ParseBigDecimal, ParseBool, ParseChar, ParseDate, ParseDouble, ParseInt, ParseLong, Optional, DMinMax, Equals, ForbidSubStr, LMinMax, NotNull, Null, RequireHashCode, RequireSubStr, Strlen, StrMinMax, StrNotNullOrEmpty, StrRegEx, Unique, UniqueHashCode, IsIncludedIn]. Note: cell processors cannot be nested except with Optional.</td></tr><tr><td id="name"><strong>Header</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">True if the incoming flow file contains a header to ignore, false otherwise.</td></tr><tr><td id="name"><strong>Delimiter character</strong></td><td id="default-value">,</td><td id="allowable-values"></td><td id="description">Character used as 'delimiter' in the incoming data. Example: ,</td></tr><tr><td id="name"><strong>Quote character</strong></td><td id=" default-value">"</td><td id="allowable-values"></td><td id="description">Character used as 'quote' in the incoming data. Example: "</td></tr><tr><td id="name"><strong>End of line symbols</strong></td><td id="default-value">\n</td><td id="allowable-values"></td><td id="description">Symbols used as 'end of line' in the incoming data. Example: \n</td></tr><tr><td id="name"><strong>Validation strategy</strong></td><td id="default-value">FlowFile validation</td><td id="allowable-values"><ul><li>Line by line validation <img src="../../html/images/iconInfo.png" alt="In case an error is found, the input CSV file will be split into two FlowFiles: one routed to the 'valid' relationship containing all the correct lines and one routed to the 'invalid' relationship containing all the incorrect lines. Take care if choosing this option while using Unique cell processors in schema definition:the first occurrence will be considered valid and the next ones as invalid." title="In case an error is foun d, the input CSV file will be split into two FlowFiles: one routed to the 'valid' relationship containing all the correct lines and one routed to the 'invalid' relationship containing all the incorrect lines. Take care if choosing this option while using Unique cell processors in schema definition:the first occurrence will be considered valid and the next ones as invalid."></img></li><li>FlowFile validation <img src="../../html/images/iconInfo.png" alt="As soon as an error is found in the CSV file, the validation will stop and the whole flow file will be routed to the 'invalid' relationship. This option offers best performances." title="As soon as an error is found in the CSV file, the validation will stop and the whole flow file will be routed to the 'invalid' relationship. This option offers best performances."></img></li></ul></td><td id="description">Strategy to apply when routing input files to output relationships.</td></tr></table><h3>Relationships: </h3><table id="relationsh ips"><tr><th>Name</th><th>Description</th></tr><tr><td>valid</td><td>FlowFiles that are successfully validated against the schema are routed to this relationship</td></tr><tr><td>invalid</td><td>FlowFiles that are not valid according to the specified schema are routed to this relationship</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>State management: </h3>This processor has no state management.<h3>Restricted: </h3></body></html> \ No newline at end of file Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ValidateXml/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ValidateXml/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ValidateXml/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ValidateXml/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ValidateXml</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Validates the contents of FlowFiles against a user-specified XML Schema file</p><h3>Tags: </h3><p>xml, schema, validation, xsd</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Schema File</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The path to the Schema file that is to be used for validation</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>valid</td><td>F lowFiles that are successfully validated against the schema are routed to this relationship</td></tr><tr><td>invalid</td><td>FlowFiles that are not valid according to the specified schema are routed to this relationship</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.</body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ValidateXml</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Validates the contents of FlowFiles against a user-specified XML Schema file</p><h3>Tags: </h3><p>xml, schema, validation, xsd</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Schema File</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The path to the Schema file that is to be used for validation</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>valid</td><td>F lowFiles that are successfully validated against the schema are routed to this relationship</td></tr><tr><td>invalid</td><td>FlowFiles that are not valid according to the specified schema are routed to this relationship</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>State management: </h3>This processor has no state management.<h3>Restricted: </h3></body></html> \ No newline at end of file Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.twitter.GetTwitter/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.twitter.GetTwitter/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.twitter.GetTwitter/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.twitter.GetTwitter/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>GetTwitter</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Pulls status changes from Twitter's streaming API</p><h3>Tags: </h3><p>twitter, tweets, social media, status, json</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property 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>Twitter Endpoint</strong></td><td id="defaul t-value">Sample Endpoint</td><td id="allowable-values"><ul><li>Sample Endpoint <img src="../../html/images/iconInfo.png" alt="The endpoint that provides public data, aka a 'garden hose'" title="The endpoint that provides public data, aka a 'garden hose'"></img></li><li>Firehose Endpoint <img src="../../html/images/iconInfo.png" alt="The endpoint that provides access to all tweets" title="The endpoint that provides access to all tweets"></img></li><li>Filter Endpoint <img src="../../html/images/iconInfo.png" alt="Endpoint that allows the stream to be filtered by specific terms or User IDs" title="Endpoint that allows the stream to be filtered by specific terms or User IDs"></img></li></ul></td><td id="description">Specifies which endpoint data should be pulled from</td></tr><tr><td id="name"><strong>Consumer Key</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The Consumer Key provided by Twitter</td></tr><tr><td id="name"><strong>Consumer Secret</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The Consumer Secret provided by Twitter<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name"><strong>Access Token</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The Access Token provided by Twitter</td></tr><tr><td id="name"><strong>Access Token Secret</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The Access Token Secret provided by Twitter<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name">Languages</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A comma-separated list of languages for which tweets should be fetched</td></tr><tr><td id="name">Terms to Filter On</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A comma-separated list of terms to filter on. Ignored unless Endpoint is set to 'Filter Endpoint'. The filter works such that if any term matches, the status update will be retrieved; multiple terms separated by a space function as an 'AND'. I.e., 'it was, hello' will retrieve status updates that have either 'hello' or both 'it' AND 'was'</td></tr><tr><td id="name">IDs to Follow</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A comma-separated list of Twitter User ID's to follow. Ignored unless Endpoint is set to 'Filter Endpoint'.</td></tr><tr><td id="name">Locations to Filter On</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A comma-separated list of coordinates specifying one or more bounding boxes to filter on.Each bounding box is specified by a pair of coordinates in the format: swLon,swLat,neLon,neLat. Multiple bounding boxes can be specified as such: swLon1,swLat1,neLon1,neLat1,swLon2,swLat2,neLon2,neLat2.Ignored unless Endpoint is set to 'Filter Endpoint'.</td></tr></table>< h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>All status updates will be 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>mime.type</td><td>Sets mime type to application/json</td></tr></table></body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>GetTwitter</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Pulls status changes from Twitter's streaming API</p><h3>Tags: </h3><p>twitter, tweets, social media, status, json</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property 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>Twitter Endpoint</strong></td><td id="defaul t-value">Sample Endpoint</td><td id="allowable-values"><ul><li>Sample Endpoint <img src="../../html/images/iconInfo.png" alt="The endpoint that provides public data, aka a 'garden hose'" title="The endpoint that provides public data, aka a 'garden hose'"></img></li><li>Firehose Endpoint <img src="../../html/images/iconInfo.png" alt="The endpoint that provides access to all tweets" title="The endpoint that provides access to all tweets"></img></li><li>Filter Endpoint <img src="../../html/images/iconInfo.png" alt="Endpoint that allows the stream to be filtered by specific terms or User IDs" title="Endpoint that allows the stream to be filtered by specific terms or User IDs"></img></li></ul></td><td id="description">Specifies which endpoint data should be pulled from</td></tr><tr><td id="name"><strong>Consumer Key</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The Consumer Key provided by Twitter</td></tr><tr><td id="name"><strong>Consumer Secret</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The Consumer Secret provided by Twitter<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name"><strong>Access Token</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The Access Token provided by Twitter</td></tr><tr><td id="name"><strong>Access Token Secret</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The Access Token Secret provided by Twitter<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name">Languages</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A comma-separated list of languages for which tweets should be fetched</td></tr><tr><td id="name">Terms to Filter On</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A comma-separated list of terms to filter on. Ignored unless Endpoint is set to 'Filter Endpoint'. The filter works such that if any term matches, the status update will be retrieved; multiple terms separated by a space function as an 'AND'. I.e., 'it was, hello' will retrieve status updates that have either 'hello' or both 'it' AND 'was'</td></tr><tr><td id="name">IDs to Follow</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A comma-separated list of Twitter User ID's to follow. Ignored unless Endpoint is set to 'Filter Endpoint'.</td></tr><tr><td id="name">Locations to Filter On</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A comma-separated list of coordinates specifying one or more bounding boxes to filter on.Each bounding box is specified by a pair of coordinates in the format: swLon,swLat,neLon,neLat. Multiple bounding boxes can be specified as such: swLon1,swLat1,neLon1,neLat1,swLon2,swLat2,neLon2,neLat2.Ignored unless Endpoint is set to 'Filter Endpoint'.</td></tr></table>< h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>All status updates will be 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>mime.type</td><td>Sets mime type to application/json</td></tr></table><h3>State management: </h3>This processor has no state management.<h3>Restricted: </h3></body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.websocket.ConnectWebSocket/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.websocket.ConnectWebSocket/index.html?rev=1771896&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.websocket.ConnectWebSocket/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.websocket.ConnectWebSocket/index.html Tue Nov 29 12:33:21 2016 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ConnectWebSocket</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Acts as a WebSocket client endpoint to interact with a remote WebSocket server. FlowFiles are transferred to downstream relationships according to received message types as WebSocket client configured with this processor receives messages from remote WebSocket server.</p><h3>Tags: </h3><p>subscribe, WebSocket, consume, listen</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>WebSocket Client ControllerService</strong></td><td id="default-value"></td><td id="allowable -values"><strong>Controller Service API: </strong><br/>WebSocketClientService<br/><strong>Implementation:</strong><br/><a href="../org.apache.nifi.websocket.jetty.JettyWebSocketClient/index.html">JettyWebSocketClient</a></td><td id="description">A WebSocket CLIENT Controller Service which can connect to a WebSocket server.</td></tr><tr><td id="name"><strong>WebSocket Client Id</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The client ID to identify WebSocket session. It should be unique within the WebSocket Client Controller Service. Otherwise, it throws WebSocketConfigurationException when it gets started.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>text message</td><td>The WebSocket text message output</td></tr><tr><td>binary message</td><td>The WebSocket binary message output</td></tr><tr><td>connected</td><td>The WebSocket session is established</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>websocket.controller.service.id</td><td>WebSocket > Controller Service >id.</td></tr><tr><td>websocket.session.id</td><td>Established WebSocket >session id.</td></tr><tr><td>websocket.endpoint.id</td><td>WebSocket endpoint >id.</td></tr><tr><td>websocket.local.address</td><td>WebSocket client >address.</td></tr><tr><td>websocket.remote.address</td><td>WebSocket server >address.</td></tr><tr><td>websocket.message.type</td><td>TEXT or >BINARY.</td></tr></table><h3>State management: </h3>This processor has no >state management.<h3>Restricted: </h3></body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.websocket.ListenWebSocket/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.websocket.ListenWebSocket/index.html?rev=1771896&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.websocket.ListenWebSocket/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.websocket.ListenWebSocket/index.html Tue Nov 29 12:33:21 2016 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ListenWebSocket</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Acts as a WebSocket server endpoint to accept client connections. FlowFiles are transferred to downstream relationships according to received message types as the WebSocket server configured with this processor receives client requests</p><h3>Tags: </h3><p>subscribe, WebSocket, consume, listen</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>WebSocket Server ControllerService</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Servic e API: </strong><br/>WebSocketServerService<br/><strong>Implementation:</strong><br/><a href="../org.apache.nifi.websocket.jetty.JettyWebSocketServer/index.html">JettyWebSocketServer</a></td><td id="description">A WebSocket SERVER Controller Service which can accept WebSocket requests.</td></tr><tr><td id="name"><strong>Server URL Path</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The WetSocket URL Path on which this processor listens to. Must starts with '/', e.g. '/example'.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>text message</td><td>The WebSocket text message output</td></tr><tr><td>binary message</td><td>The WebSocket binary message output</td></tr><tr><td>connected</td><td>The WebSocket session is established</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Descriptio n</th></tr><tr><td>websocket.controller.service.id</td><td>WebSocket Controller Service id.</td></tr><tr><td>websocket.session.id</td><td>Established WebSocket session id.</td></tr><tr><td>websocket.endpoint.id</td><td>WebSocket endpoint id.</td></tr><tr><td>websocket.local.address</td><td>WebSocket server address.</td></tr><tr><td>websocket.remote.address</td><td>WebSocket client address.</td></tr><tr><td>websocket.message.type</td><td>TEXT or BINARY.</td></tr></table><h3>State management: </h3>This processor has no state management.<h3>Restricted: </h3></body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.websocket.PutWebSocket/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.websocket.PutWebSocket/index.html?rev=1771896&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.websocket.PutWebSocket/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.websocket.PutWebSocket/index.html Tue Nov 29 12:33:21 2016 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutWebSocket</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Sends messages to a WebSocket remote endpoint using a WebSocket session that is established by either ListenWebSocket or ConnectWebSocket.</p><h3>Tags: </h3><p>WebSocket, publish, send</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>WebSocket Session Id</strong></td><td id="default-value">${websocket.session.id}</td><td id="allowable-values"></td><td id ="description">A NiFi Expression to retrieve the session id.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>WebSocket ControllerService Id</strong></td><td id="default-value">${websocket.controller.service.id}</td><td id="allowable-values"></td><td id="description">A NiFi Expression to retrieve the id of a WebSocket ControllerService.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>WebSocket Endpoint Id</strong></td><td id="default-value">${websocket.endpoint.id}</td><td id="allowable-values"></td><td id="description">A NiFi Expression to retrieve the endpoint id of a WebSocket ControllerService.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>WebSocket Message Type</strong></td><td id="default-value">TEXT</td><td id="allowable-values"></td><td id="description">The type of message content: TEXT or BINARY<br/><strong>Supports Expression Language: true</str ong></td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>FlowFiles that are sent successfully to the destination are transferred to this relationship.</td></tr><tr><td>failure</td><td>FlowFiles that failed to send to the destination are transferred 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>websocket.controller.service.id</td><td>WebSocket Controller Service id.</td></tr><tr><td>websocket.session.id</td><td>Established WebSocket session id.</td></tr><tr><td>websocket.endpoint.id</td><td>WebSocket endpoint id.</td></tr><tr><td>websocket.message.type</td><td>TEXT or BINARY.</td></tr><tr><td>websocket.local.address</td><td>WebSocket server address.</td></tr><tr><td>websocket.remote.address</td><td>WebSocket client address.</td></tr><tr><td>websocket.failure.detai l</td><td>Detail of the failure.</td></tr></table><h3>State management: </h3>This processor has no state management.<h3>Restricted: </h3></body></html> \ No newline at end of file Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.windows.event.log.ConsumeWindowsEventLog/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.windows.event.log.ConsumeWindowsEventLog/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.windows.event.log.ConsumeWindowsEventLog/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.windows.event.log.ConsumeWindowsEventLog/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ConsumeWindowsEventLog</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Registers a Windows Event Log Subscribe Callback to receive FlowFiles from Events on Windows. These can be filtered via channel and XPath.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>ingest, event, windows</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Channel</strong></td><td id="default-value">System</td><td id="allowable-values"></td><td id="description">The Windows Event Log Channel to listen to.</td></tr><tr><t d id="name"><strong>XPath Query</strong></td><td id="default-value">*</td><td id="allowable-values"></td><td id="description">XPath Query to filter events. (See https://msdn.microsoft.com/en-us/library/windows/desktop/dd996910(v=vs.85).aspx for examples.)</td></tr><tr><td id="name"><strong>Maximum Buffer Size</strong></td><td id="default-value">1048576</td><td id="allowable-values"></td><td id="description">The individual Event Log XMLs are rendered to a buffer. This specifies the maximum size in bytes that the buffer will be allowed to grow to. (Limiting the maximum size of an individual Event XML.)</td></tr><tr><td id="name"><strong>Maximum queue size</strong></td><td id="default-value">1024</td><td id="allowable-values"></td><td id="description">Events are received asynchronously and must be output as FlowFiles when the processor is triggered. This specifies the maximum number of events to queue for transformation into FlowFiles.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>Relationship for successfully consumed events.</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>mime.type</td><td>Will set a MIME type value of application/xml.</td></tr></table></body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ConsumeWindowsEventLog</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Registers a Windows Event Log Subscribe Callback to receive FlowFiles from Events on Windows. These can be filtered via channel and XPath.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>ingest, event, windows</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Channel</strong></td><td id="default-value">System</td><td id="allowable-values"></td><td id="description">The Windows Event Log Channel to listen to.</td></tr><tr><t d id="name"><strong>XPath Query</strong></td><td id="default-value">*</td><td id="allowable-values"></td><td id="description">XPath Query to filter events. (See https://msdn.microsoft.com/en-us/library/windows/desktop/dd996910(v=vs.85).aspx for examples.)</td></tr><tr><td id="name"><strong>Maximum Buffer Size</strong></td><td id="default-value">1048576</td><td id="allowable-values"></td><td id="description">The individual Event Log XMLs are rendered to a buffer. This specifies the maximum size in bytes that the buffer will be allowed to grow to. (Limiting the maximum size of an individual Event XML.)</td></tr><tr><td id="name"><strong>Maximum queue size</strong></td><td id="default-value">1024</td><td id="allowable-values"></td><td id="description">Events are received asynchronously and must be output as FlowFiles when the processor is triggered. This specifies the maximum number of events to queue for transformation into FlowFiles.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>Relationship for successfully consumed events.</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>mime.type</td><td>Will set a MIME type value of application/xml.</td></tr></table><h3>State management: </h3>This processor has no state management.<h3>Restricted: </h3></body></html> \ No newline at end of file Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.yandex.YandexTranslate/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.yandex.YandexTranslate/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.yandex.YandexTranslate/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.yandex.YandexTranslate/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>YandexTranslate</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Translates content and attributes from one language to another</p><h3>Tags: </h3><p>yandex, translate, translation, language</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>Yandex API Key</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The API Key that is registered with Yandex</td></tr><tr><td id="name">< strong>Input Language</strong></td><td id="default-value">es</td><td id="allowable-values"></td><td id="description">The language of incoming data<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Target Language</strong></td><td id="default-value">en</td><td id="allowable-values"></td><td id="description">The language to translate the text into<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Translate Content</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Specifies whether or not the content should be translated. If false, only the text specified by user-defined properties will be translated.</td></tr><tr><td id="name"><strong>Character Set</strong></td><td id="default-value">UTF-8</td><td id="allowable-values"></td><td id="description">Specifies the character set of the data to be translated<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">The name of an attribute to set that will contain the translated text of the value</td><td id="value">The value to translate</td><td>User-defined properties are used to translate arbitrary text based on attributes.<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>translation.failure</td><td>This relationship is used if the translation cannot be performed for some reason other than communications failure</td></tr><tr><td>success</td><td>This relationship is used when the translation is successful</td></tr><tr><td>comms.failure</td><td>This relationship is used when the translation fails due to a problem such as a network failure, and for which the translation should be attempted again</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>yandex.translate.failure.reason</td><td>If the text cannot be translated, this attribute will be set indicating the reason for the failure</td></tr><tr><td>language</td><td>When the translation succeeds, if the content was translated, this attribute will be set indicating the new language of the content</td></tr></table></body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>YandexTranslate</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Translates content and attributes from one language to another</p><h3>Tags: </h3><p>yandex, translate, translation, language</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>Yandex API Key</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The API Key that is registered with Yandex</td></tr><tr><td id="name">< strong>Input Language</strong></td><td id="default-value">es</td><td id="allowable-values"></td><td id="description">The language of incoming data<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Target Language</strong></td><td id="default-value">en</td><td id="allowable-values"></td><td id="description">The language to translate the text into<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Translate Content</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Specifies whether or not the content should be translated. If false, only the text specified by user-defined properties will be translated.</td></tr><tr><td id="name"><strong>Character Set</strong></td><td id="default-value">UTF-8</td><td id="allowable-values"></td><td id="description">Specifies the character set of the data to be translated<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">The name of an attribute to set that will contain the translated text of the value</td><td id="value">The value to translate</td><td>User-defined properties are used to translate arbitrary text based on attributes.<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>translation.failure</td><td>This relationship is used if the translation cannot be performed for some reason other than communications failure</td></tr><tr><td>success</td><td>This relationship is used when the translation is successful</td></tr><tr><td>comms.failure</td><td>This relationship is used when the translation fails due to a problem such as a network failure, and for which the translation should be attempted again</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>yandex.translate.failure.reason</td><td>If the text cannot be translated, this attribute will be set indicating the reason for the failure</td></tr><tr><td>language</td><td>When the translation succeeds, if the content was translated, this attribute will be set indicating the new language of the content</td></tr></table><h3>State management: </h3>This processor has no state management.<h3>Restricted: </h3></body></html> \ No newline at end of file Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.reporting.SiteToSiteProvenanceReportingTask/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.reporting.SiteToSiteProvenanceReportingTask/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.reporting.SiteToSiteProvenanceReportingTask/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.reporting.SiteToSiteProvenanceReportingTask/index.html Tue Nov 29 12:33:21 2016 @@ -1 +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><body><h2>Description: </h2><p>Publishes Provenance events using the Site To Site protocol.</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, 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>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 s end the Provenance Events 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 delivery Provenance Events 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/>SSLContextService<br/><strong>Implementation:</strong><br/><a href="../org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</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 events when 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>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></body></html> \ No newline at end of file +<!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><body><h2>Description: </h2><p>Publishes Provenance events using the Site To Site protocol.</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, 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>Destination URL</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The URL of the destination NiFi i nstance to send the Provenance Events 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 delivery Provenance Events 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/>SSLContextService<br/><strong>Implementation:</strong><br/><a href="../org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</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 i d="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 events when 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>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 event Id so that on restart the task knows where it left off.</td></tr></table><h3>Restricted: </h3><td>Provides operator the ability send sensitive details contained in Provenance events to any external system.</td></body></html> \ No newline at end of file
