Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.solr.PutSolrContentStream/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.solr.PutSolrContentStream/index.html?rev=1704031&r1=1704030&r2=1704031&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.solr.PutSolrContentStream/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.solr.PutSolrContentStream/index.html Sat Sep 19 13:57:03 2015 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutSolrContentStream</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Sends the contents of a FlowFile as a ContentStream to Solr</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>Apache, Solr, Put, 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>Solr Type</strong></td><td id="default-value">Standard</td><td id="allowable-values"><ul><li>Cloud <img src="../../html/images/ic onInfo.png" alt="A SolrCloud instance." title="A SolrCloud instance."></img></li><li>Standard <img src="../../html/images/iconInfo.png" alt="A stand-alone Solr instance." title="A stand-alone Solr instance."></img></li></ul></td><td id="description">The type of Solr instance, Cloud or Standard.</td></tr><tr><td id="name"><strong>Solr Location</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The Solr url for a Solr Type of Standard (ex: http://localhost:8984/solr/gettingstarted), or the ZooKeeper hosts for a Solr Type of Cloud (ex: localhost:9983).</td></tr><tr><td id="name">Collection</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The Solr collection name, only used with a Solr Type of Cloud<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Content Stream Path</strong></td><td id="default-value">/update/json/docs</td><td id="allowable-values"></td><td id="descrip tion">The path in Solr to post the ContentStream<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Content-Type</strong></td><td id="default-value">application/json</td><td id="allowable-values"></td><td id="description">Content-Type being sent to Solr<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Commit Within</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The number of milliseconds before the given update is committed<br/><strong>Supports Expression Language: true</strong></td></tr></table><h3>Dynamic Properties: </h3><p>Dynamic Properties allow the user to specify both the name and value of a property.<table id="dynamic-properties"><tr><th>Name</th><th>Value</th><th>Description</th></tr><tr><td id="name">A Solr request parameter name</td><td id="value">A Solr request parameter value</td><td>These parameters will be passed to Solr on the request</td></tr></table></p>< h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>failure</td><td>FlowFiles that failed for any reason other than Solr being unreachable</td></tr><tr><td>connection_failure</td><td>FlowFiles that failed because Solr is unreachable</td></tr><tr><td>success</td><td>The original FlowFile</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>PutSolrContentStream</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Sends the contents of a FlowFile as a ContentStream to Solr</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>Apache, Solr, Put, 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>Solr Type</strong></td><td id="default-value">Standard</td><td id="allowable-values"><ul><li>Cloud <img src="../../html/images/ic onInfo.png" alt="A SolrCloud instance." title="A SolrCloud instance."></img></li><li>Standard <img src="../../html/images/iconInfo.png" alt="A stand-alone Solr instance." title="A stand-alone Solr instance."></img></li></ul></td><td id="description">The type of Solr instance, Cloud or Standard.</td></tr><tr><td id="name"><strong>Solr Location</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The Solr url for a Solr Type of Standard (ex: http://localhost:8984/solr/gettingstarted), or the ZooKeeper hosts for a Solr Type of Cloud (ex: localhost:9983).</td></tr><tr><td id="name">Collection</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The Solr collection name, only used with a Solr Type of Cloud<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Content Stream Path</strong></td><td id="default-value">/update/json/docs</td><td id="allowable-values"></td><td id="descrip tion">The path in Solr to post the ContentStream<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Content-Type</strong></td><td id="default-value">application/json</td><td id="allowable-values"></td><td id="description">Content-Type being sent to Solr<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Commit Within</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The number of milliseconds before the given update is committed<br/><strong>Supports Expression Language: true</strong></td></tr></table><h3>Dynamic Properties: </h3><p>Dynamic Properties allow the user to specify both the name and value of a property.<table id="dynamic-properties"><tr><th>Name</th><th>Value</th><th>Description</th></tr><tr><td id="name">A Solr request parameter name</td><td id="value">A Solr request parameter value</td><td>These parameters will be passed to Solr on the request</td></tr></table></p>< h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>The original FlowFile</td></tr><tr><td>failure</td><td>FlowFiles that failed for any reason other than Solr being unreachable</td></tr><tr><td>connection_failure</td><td>FlowFiles that failed because Solr is unreachable</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.</body></html> \ No newline at end of file
Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.Base64EncodeContent/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.Base64EncodeContent/index.html?rev=1704031&r1=1704030&r2=1704031&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.Base64EncodeContent/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.Base64EncodeContent/index.html Sat Sep 19 13:57:03 2015 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>Base64EncodeContent</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Encodes or decodes content to and from base64</p><h3>Tags: </h3><p>encode, base64</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>Mode</strong></td><td id="default-value">Encode</td><td id="allowable-values"><ul><li>Encode</li><li>Decode</li></ul></td><td id="description">Specifies whether the content should be encoded or decoded</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>failure</td><td>A ny FlowFile that cannot be encoded or decoded will be routed to failure</td></tr><tr><td>success</td><td>Any FlowFile that is successfully encoded or decoded will be routed to success</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>Base64EncodeContent</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Encodes or decodes content to and from base64</p><h3>Tags: </h3><p>encode, base64</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>Mode</strong></td><td id="default-value">Encode</td><td id="allowable-values"><ul><li>Encode</li><li>Decode</li></ul></td><td id="description">Specifies whether the content should be encoded or decoded</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>A ny FlowFile that is successfully encoded or decoded will be routed to success</td></tr><tr><td>failure</td><td>Any FlowFile that cannot be encoded or decoded will be routed to failure</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.</body></html> \ No newline at end of file Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.CompressContent/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.CompressContent/index.html?rev=1704031&r1=1704030&r2=1704031&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.CompressContent/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.CompressContent/index.html Sat Sep 19 13:57:03 2015 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>CompressContent</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Compresses or decompresses the contents of FlowFiles using a user-specified compression algorithm and updates the mime.type attribute as appropriate</p><h3>Tags: </h3><p>content, compress, decompress, gzip, bzip2, lzma, xz-lzma2</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>Mode</strong></td><td id="default-value">compress</td><td id="allowable-values"><ul><li>compress</li><li>decompress</li></ul></td><td id="description">Indicates whether the processor should com press content or decompress content. Must be either 'compress' or 'decompress'</td></tr><tr><td id="name"><strong>Compression Format</strong></td><td id="default-value">use mime.type attribute</td><td id="allowable-values"><ul><li>use mime.type attribute</li><li>gzip</li><li>bzip2</li><li>xz-lzma2</li><li>lzma</li></ul></td><td id="description">The compression format to use. Valid values are: GZIP, BZIP2, XZ-LZMA2, and LZMA</td></tr><tr><td id="name"><strong>Compression Level</strong></td><td id="default-value">1</td><td id="allowable-values"><ul><li>0</li><li>1</li><li>2</li><li>3</li><li>4</li><li>5</li><li>6</li><li>7</li><li>8</li><li>9</li></ul></td><td id="description">The compression level to use; this is valid only when using GZIP compression. A lower value results in faster processing but less compression; a value of 0 indicates no compression but simply archiving</td></tr><tr><td id="name"><strong>Update Filename</strong></td><td id="default-value">false</td><td id="allowa ble-values"><ul><li>true</li><li>false</li></ul></td><td id="description">If true, will remove the filename extension when decompressing data (only if the extension indicates the appropriate compression format) and add the appropriate extension when compressing data</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>failure</td><td>FlowFiles will be transferred to the failure relationship if they fail to compress/decompress</td></tr><tr><td>success</td><td>FlowFiles will be transferred to the success relationship after successfully being compressed or decompressed</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 Compression Format is set to use mime.type attribute, this attribute is used to determine the compression type. Otherwise, this attribute is ignored.</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 Mode property is set to compress, the appropriate MIME Type is set. If the Mode property is set to decompress and the file is successfully decompressed, this attribute is removed, as the MIME Type is no longer known.</td></tr></table></body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>CompressContent</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Compresses or decompresses the contents of FlowFiles using a user-specified compression algorithm and updates the mime.type attribute as appropriate</p><h3>Tags: </h3><p>content, compress, decompress, gzip, bzip2, lzma, xz-lzma2</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>Mode</strong></td><td id="default-value">compress</td><td id="allowable-values"><ul><li>compress</li><li>decompress</li></ul></td><td id="description">Indicates whether the processor should com press content or decompress content. Must be either 'compress' or 'decompress'</td></tr><tr><td id="name"><strong>Compression Format</strong></td><td id="default-value">use mime.type attribute</td><td id="allowable-values"><ul><li>use mime.type attribute</li><li>gzip</li><li>bzip2</li><li>xz-lzma2</li><li>lzma</li></ul></td><td id="description">The compression format to use. Valid values are: GZIP, BZIP2, XZ-LZMA2, and LZMA</td></tr><tr><td id="name"><strong>Compression Level</strong></td><td id="default-value">1</td><td id="allowable-values"><ul><li>0</li><li>1</li><li>2</li><li>3</li><li>4</li><li>5</li><li>6</li><li>7</li><li>8</li><li>9</li></ul></td><td id="description">The compression level to use; this is valid only when using GZIP compression. A lower value results in faster processing but less compression; a value of 0 indicates no compression but simply archiving</td></tr><tr><td id="name"><strong>Update Filename</strong></td><td id="default-value">false</td><td id="allowa ble-values"><ul><li>true</li><li>false</li></ul></td><td id="description">If true, will remove the filename extension when decompressing data (only if the extension indicates the appropriate compression format) and add the appropriate extension when compressing data</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>FlowFiles will be transferred to the success relationship after successfully being compressed or decompressed</td></tr><tr><td>failure</td><td>FlowFiles will be transferred to the failure relationship if they fail to compress/decompress</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 Compression Format is set to use mime.type attribute, this attribute is used to determine the compression type. Otherwise, this attribute is ignored.</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 Mode property is set to compress, the appropriate MIME Type is set. If the Mode property is set to decompress and the file is successfully decompressed, this attribute is removed, as the MIME Type is no longer known.</td></tr></table></body></html> \ No newline at end of file Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ControlRate/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ControlRate/index.html?rev=1704031&r1=1704030&r2=1704031&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ControlRate/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ControlRate/index.html Sat Sep 19 13:57:03 2015 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ControlRate</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Controls the rate at which data is transferred to follow-on processors.</p><h3>Tags: </h3><p>rate control, throttle, rate, throughput</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>Rate Control Criteria</strong></td><td id="default-value">data rate</td><td id="allowable-values"><ul><li>data rate</li><li>flowfile count</li><li>attribute value</li></ul></td><td id="description">Indicates the criteria that is used to control the throughput rate. Changing this value resets the rate counters.</td></tr><tr><td id="name"><strong>Maximum Rate</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The maximum rate at which data should pass through this processor. The format of this property is expected to be a positive integer, or a Data Size (such as '1 MB') if Rate Control Criteria is set to 'data rate'.</td></tr><tr><td id="name">Rate Controlled Attribute</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of an attribute whose values build toward the rate limit if Rate Control Criteria is set to 'attribute value'. The value of the attribute referenced by this property must be a positive integer, or the FlowFile will be routed to failure. This value is ignored if Rate Control Criteria is not set to 'attribute value'. Changing this value resets the rate counters.</td></tr><tr><td id="name"><strong>Time Duration</strong></td><td id="default-value">1 min</td><td id="allowable-v alues"></td><td id="description">The amount of time to which the Maximum Data Size and Maximum Number of Files pertains. Changing this value resets the rate counters.</td></tr><tr><td id="name">Grouping Attribute</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">By default, a single "throttle" is used for all FlowFiles. If this value is specified, a separate throttle is used for each value specified by the attribute with this name. Changing this value resets the rate counters.</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 transferred 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>ControlRate</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Controls the rate at which data is transferred to follow-on processors.</p><h3>Tags: </h3><p>rate control, throttle, rate, throughput</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>Rate Control Criteria</strong></td><td id="default-value">data rate</td><td id="allowable-values"><ul><li>data rate</li><li>flowfile count</li><li>attribute value</li></ul></td><td id="description">Indicates the criteria that is used to control the throughput rate. Changing this value resets the rate counters.</td></tr><tr><td id="name"><strong>Maximum Rate</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The maximum rate at which data should pass through this processor. The format of this property is expected to be a positive integer, or a Data Size (such as '1 MB') if Rate Control Criteria is set to 'data rate'.</td></tr><tr><td id="name">Rate Controlled Attribute</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of an attribute whose values build toward the rate limit if Rate Control Criteria is set to 'attribute value'. The value of the attribute referenced by this property must be a positive long, or the FlowFile will be routed to failure. This value is ignored if Rate Control Criteria is not set to 'attribute value'. Changing this value resets the rate counters.</td></tr><tr><td id="name"><strong>Time Duration</strong></td><td id="default-value">1 min</td><td id="allowable-valu es"></td><td id="description">The amount of time to which the Maximum Data Size and Maximum Number of Files pertains. Changing this value resets the rate counters.</td></tr><tr><td id="name">Grouping Attribute</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">By default, a single "throttle" is used for all FlowFiles. If this value is specified, a separate throttle is used for each value specified by the attribute with this name. Changing this value resets the rate counters.</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 transferred 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 Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ConvertJSONToSQL/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ConvertJSONToSQL/index.html?rev=1704031&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ConvertJSONToSQL/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ConvertJSONToSQL/index.html Sat Sep 19 13:57:03 2015 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ConvertJSONToSQL</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Converts a JSON-formatted FlowFile into an UPDATE or INSERT SQL statement. The incoming FlowFile is expected to be "flat" JSON message, meaning that it consists of a single JSON element and each field maps to a simple type. If a field maps to a JSON object, that JSON object will be interpreted as Text. If the input is an array of JSON elements, each element in the array is output as a separate FlowFile to the 'sql' relationship. Upon successful conversion, the original FlowFile is routed to the 'original' relationship and the SQL is routed to the 'sql' relationship.</p><h3>Tags: </h3><p>json, sql, database, rdbms, insert, update, relational, flat</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other pr operties (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>JDBC Connection Pool</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>DBCPService<br/><strong>Implementation:</strong><br/><a href="../org.apache.nifi.dbcp.DBCPConnectionPool/index.html">DBCPConnectionPool</a></td><td id="description">Specifies the JDBC Connection Pool to use in order to convert the JSON message to a SQL statement. The Connection Pool is necessary in order to determine the appropriate database column types.</td></tr><tr><td id="name"><strong>Statement Type</strong></td><td id="default-value"></td><td id="allowable-values"><ul><li>UPDATE</li><li>INSERT</li></ ul></td><td id="description">Specifies the type of SQL Statement to generate</td></tr><tr><td id="name"><strong>Table Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the table that the statement should update<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Catalog Name</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the catalog that the statement should update. This may not apply for the database that you are updating. In this case, leave the field empty<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Translate Field Names</td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">If true, the Processor will attempt to translate JSON field names into the appropriate column names for the table specified. If false, the JSON field names must mat ch the column names exactly, or the column will not be updated</td></tr><tr><td id="name">Unmatched Field Behavior</td><td id="default-value">Ignore Unmatched Fields</td><td id="allowable-values"><ul><li>Ignore Unmatched Fields <img src="../../html/images/iconInfo.png" alt="Any field in the JSON document that cannot be mapped to a column in the database is ignored" title="Any field in the JSON document that cannot be mapped to a column in the database is ignored"></img></li><li>Fail <img src="../../html/images/iconInfo.png" alt="If the JSON document has any field that cannot be mapped to a column in the database, the FlowFile will be routed to the failure relationship" title="If the JSON document has any field that cannot be mapped to a column in the database, the FlowFile will be routed to the failure relationship"></img></li></ul></td><td id="description">If an incoming JSON element has a field that does not map to any of the database table's columns, this property specifies how t o handle the situation</td></tr><tr><td id="name">Update Keys</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A comma-separated list of column names that uniquely identifies a row in the database for UPDATE statements. If the Statement Type is UPDATE and this property is not set, the table's Primary Keys are used. In this case, if no Primary Key exists, the conversion to SQL will fail. This property is ignored if the Statement Type is INSERT<br/><strong>Supports Expression Language: true</strong></td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>sql</td><td>A FlowFile is routed to this relationship when its contents have successfully been converted into a SQL statement</td></tr><tr><td>failure</td><td>A FlowFile is routed to this relationship if it cannot be converted into a SQL statement. Common causes include invalid JSON content or the JSON content missing a required field (if u sing an INSERT statement type).</td></tr><tr><td>original</td><td>When a FlowFile is converted to SQL, the original JSON FlowFile is 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 of FlowFile that is routed to 'sql' to 'text/plain'.</td></tr><tr><td>sql.table</td><td>Sets the sql.table attribute of FlowFile that is routed to 'sql' to the name of the table that is updated by the SQL statement.</td></tr><tr><td>sql.catalog</td><td>If the Catalog name is set for this database, specifies the name of the catalog that the SQL statement will update. If no catalog is used, this attribute will not be added.</td></tr><tr><td>fragment.identifier</td><td>All FlowFiles routed to the 'sql' relationship for the same incoming FlowFile (multiple will be output for the same incoming FlowFile if the incoming FlowFile is a J SON Array) will have the same value for the fragment.identifier attribute. This can then be used to correlate the results.</td></tr><tr><td>fragment.count</td><td>The number of SQL FlowFiles that were produced for same incoming FlowFile. This can be used in conjunction with the fragment.identifier attribute in order to know how many FlowFiles belonged to the same incoming FlowFile.</td></tr><tr><td>fragment.index</td><td>The position of this FlowFile in the list of outgoing FlowFiles that were all derived from the same incoming FlowFile. This can be used in conjunction with the fragment.identifier and fragment.count attributes to know which FlowFiles originated from the same incoming FlowFile and in what order the SQL FlowFiles were produced</td></tr><tr><td>sql.args.N.type</td><td>The output SQL statements are parameterized in order to avoid SQL Injection Attacks. The types of the Parameters to use are stored in attributes named sql.args.1.type, sql.args.2.type, sql.args.3.type, an d so on. The type is a number representing a JDBC Type constant. Generally, this is useful only for software to read and interpret but is added so that a processor such as PutSQL can understand how to interpret the values.</td></tr><tr><td>sql.args.N.value</td><td>The output SQL statements are parameterized in order to avoid SQL Injection Attacks. The values of the Parameters to use are stored in the attributes named sql.args.1.value, sql.args.2.value, sql.args.3.value, and so on. Each of these attributes has a corresponding sql.args.N.type attribute that indicates how the value should be interpreted when inserting it into the database.</td></tr></table><h3>See Also:</h3><p><a href="../org.apache.nifi.processors.standard.PutSQL/index.html">PutSQL</a></p></body></html> \ No newline at end of file Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.DetectDuplicate/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.DetectDuplicate/index.html?rev=1704031&r1=1704030&r2=1704031&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.DetectDuplicate/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.DetectDuplicate/index.html Sat Sep 19 13:57:03 2015 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>DetectDuplicate</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Caches a value, computed from FlowFile attributes, for each incoming FlowFile and determines if the cached value has already been seen. If so, routes the FlowFile to 'duplicate' with an attribute named 'original.identifier' that specifies the original FlowFile's"description", which is specified in the <FlowFile Description> property. If the FlowFile is not determined to be a duplicate, the Processor routes the FlowFile to 'non-duplicate'</p><h3>Tags: </h3><p>hash, dupe, duplicate, dedupe</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/expressi on-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>Cache Entry Identifier</strong></td><td id="default-value">${hash.value}</td><td id="allowable-values"></td><td id="description">A FlowFile attribute, or the results of an Attribute Expression Language statement, which will be evaluated against a FlowFile in order to determine the value used to identify duplicates; it is this value that is cached<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>FlowFile Description</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">When a FlowFile is added to the cache, this value is stored along with it so that if a duplicate is found, this description of the original FlowFile will be added to the duplicate's "original.flowfile.description" attribute<br/><strong>Supports Exp ression Language: true</strong></td></tr><tr><td id="name">Age Off Duration</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Time interval to age off cached FlowFiles</td></tr><tr><td id="name"><strong>Distributed Cache Service</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>DistributedMapCacheClient<br/><strong>Implementation:</strong><br/><a href="../org.apache.nifi.distributed.cache.client.DistributedMapCacheClientService/index.html">DistributedMapCacheClientService</a></td><td id="description">The Controller Service that is used to cache unique identifiers, used to determine duplicates</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>non-duplicate</td><td>If a FlowFile's Cache Entry Identifier was not found in the cache, it will be routed to this relationship</td></tr><tr><td>duplicate</td><td>If a FlowFile has be en detected to be a duplicate, it will be routed to this relationship</td></tr><tr><td>failure</td><td>If unable to communicate with the cache, the FlowFile will be penalized and 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>original.flowfile.description</td><td>All FlowFiles routed to the duplicate relationship will have an attribute added named original.flowfile.description. The value of this attribute is determined by the attributes of the original copy of the data and by the FlowFile Description property.</td></tr></table><h3>See Also:</h3><p><a href="../org.apache.nifi.distributed.cache.client.DistributedMapCacheClientService/index.html">DistributedMapCacheClientService</a>, <a href="../org.apache.nifi.distributed.cache.server.map.DistributedMapCacheServer/index.html">DistributedMapCacheServer</a></p></body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>DetectDuplicate</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Caches a value, computed from FlowFile attributes, for each incoming FlowFile and determines if the cached value has already been seen. If so, routes the FlowFile to 'duplicate' with an attribute named 'original.identifier' that specifies the original FlowFile's"description", which is specified in the <FlowFile Description> property. If the FlowFile is not determined to be a duplicate, the Processor routes the FlowFile to 'non-duplicate'</p><h3>Tags: </h3><p>hash, dupe, duplicate, dedupe</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/expressi on-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>Cache Entry Identifier</strong></td><td id="default-value">${hash.value}</td><td id="allowable-values"></td><td id="description">A FlowFile attribute, or the results of an Attribute Expression Language statement, which will be evaluated against a FlowFile in order to determine the value used to identify duplicates; it is this value that is cached<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>FlowFile Description</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">When a FlowFile is added to the cache, this value is stored along with it so that if a duplicate is found, this description of the original FlowFile will be added to the duplicate's "original.flowfile.description" attribute<br/><strong>Supports Exp ression Language: true</strong></td></tr><tr><td id="name">Age Off Duration</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Time interval to age off cached FlowFiles</td></tr><tr><td id="name"><strong>Distributed Cache Service</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>DistributedMapCacheClient<br/><strong>Implementation:</strong><br/><a href="../org.apache.nifi.distributed.cache.client.DistributedMapCacheClientService/index.html">DistributedMapCacheClientService</a></td><td id="description">The Controller Service that is used to cache unique identifiers, used to determine duplicates</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>duplicate</td><td>If a FlowFile has been detected to be a duplicate, it will be routed to this relationship</td></tr><tr><td>non-duplicate</td><td>If a FlowFile's Cache Entry Identifi er was not found in the cache, it will be routed to this relationship</td></tr><tr><td>failure</td><td>If unable to communicate with the cache, the FlowFile will be penalized and 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>original.flowfile.description</td><td>All FlowFiles routed to the duplicate relationship will have an attribute added named original.flowfile.description. The value of this attribute is determined by the attributes of the original copy of the data and by the FlowFile Description property.</td></tr></table><h3>See Also:</h3><p><a href="../org.apache.nifi.distributed.cache.client.DistributedMapCacheClientService/index.html">DistributedMapCacheClientService</a>, <a href="../org.apache.nifi.distributed.cache.server.map.DistributedMapCacheServer/index.html">DistributedMapCacheServer</a></p></body></html> \ No newline at end of file Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.EncryptContent/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.EncryptContent/index.html?rev=1704031&r1=1704030&r2=1704031&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.EncryptContent/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.EncryptContent/index.html Sat Sep 19 13:57:03 2015 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>EncryptContent</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Encrypts or Decrypts a FlowFile using either symmetric encryption with a password and randomly generated salt, or asymmetric encryption using a public and secret key.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>encryption, decryption, password, JCE, OpenPGP, PGP, GPG</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>Mode</strong></td><td id="default-value">Encrypt</td><td id="allowable-values"><ul><li>Encrypt</li><li>Decrypt</li></ul></td><td id="description">Specifies whether the content should be encrypted or decrypted</td></tr><tr><td id="name"><strong>Encryption Algorithm</strong></td><td id="default-value">MD5_256AES</td><td id="allowable-values"><ul><li>MD5_128AES</li><li>MD5_256AES</li><li>SHA1_RC2</li><li>SHA1_DES</li><li>MD5_192AES</li><li>MD5_DES</li><li>MD5_RC2</li><li>SHA_192AES</li><li>SHA_40RC4</li><li>SHA256_128AES</li><li>SHA_128RC2</li><li>SHA_128AES</li><li>SHA256_192AES</li><li>SHA_2KEYTRIPLEDES</li><li>SHA256_256AES</li><li>SHA_40RC2</li><li>SHA_256AES</li><li>SHA_3KEYTRIPLEDES</li><li>SHA_TWOFISH</li><li>SHA_128RC4</li><li>PGP</li><li>PGP_ASCII_ARMOR</li></ul></td><td id="description">The Encryption Algorithm to use</td>< /tr><tr><td id="name">Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The Password to use for encrypting or decrypting the data<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name">Public Keyring File</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">In a PGP encrypt mode, this keyring contains the public key of the recipient</td></tr><tr><td id="name">Public Key User Id</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">In a PGP encrypt mode, this user id of the recipient</td></tr><tr><td id="name">Private Keyring File</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">In a PGP decrypt mode, this keyring contains the private key of the recipient</td></tr><tr><td id="name">Private Keyring Passphrase</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">In a PGP decrypt mode, this is the priv ate keyring passphrase<br/><strong>Sensitive Property: true</strong></td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>failure</td><td>Any FlowFile that cannot be encrypted or decrypted will be routed to failure</td></tr><tr><td>success</td><td>Any FlowFile that is successfully encrypted or decrypted will be routed to success</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>EncryptContent</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Encrypts or Decrypts a FlowFile using either symmetric encryption with a password and randomly generated salt, or asymmetric encryption using a public and secret key.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>encryption, decryption, password, JCE, OpenPGP, PGP, GPG</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>Mode</strong></td><td id="default-value">Encrypt</td><td id="allowable-values"><ul><li>Encrypt</li><li>Decrypt</li></ul></td><td id="description">Specifies whether the content should be encrypted or decrypted</td></tr><tr><td id="name"><strong>Encryption Algorithm</strong></td><td id="default-value">MD5_256AES</td><td id="allowable-values"><ul><li>MD5_128AES</li><li>MD5_256AES</li><li>SHA1_RC2</li><li>SHA1_DES</li><li>MD5_192AES</li><li>MD5_DES</li><li>MD5_RC2</li><li>SHA_192AES</li><li>SHA_40RC4</li><li>SHA256_128AES</li><li>SHA_128RC2</li><li>SHA_128AES</li><li>SHA256_192AES</li><li>SHA_2KEYTRIPLEDES</li><li>SHA256_256AES</li><li>SHA_40RC2</li><li>SHA_256AES</li><li>SHA_3KEYTRIPLEDES</li><li>SHA_TWOFISH</li><li>SHA_128RC4</li><li>PGP</li><li>PGP_ASCII_ARMOR</li></ul></td><td id="description">The Encryption Algorithm to use</td>< /tr><tr><td id="name">Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The Password to use for encrypting or decrypting the data<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name">Public Keyring File</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">In a PGP encrypt mode, this keyring contains the public key of the recipient</td></tr><tr><td id="name">Public Key User Id</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">In a PGP encrypt mode, this user id of the recipient</td></tr><tr><td id="name">Private Keyring File</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">In a PGP decrypt mode, this keyring contains the private key of the recipient</td></tr><tr><td id="name">Private Keyring Passphrase</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">In a PGP decrypt mode, this is the priv ate keyring passphrase<br/><strong>Sensitive Property: true</strong></td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>Any FlowFile that is successfully encrypted or decrypted will be routed to success</td></tr><tr><td>failure</td><td>Any FlowFile that cannot be encrypted or decrypted will be routed to failure</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.</body></html> \ No newline at end of file Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.EvaluateJsonPath/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.EvaluateJsonPath/index.html?rev=1704031&r1=1704030&r2=1704031&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.EvaluateJsonPath/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.EvaluateJsonPath/index.html Sat Sep 19 13:57:03 2015 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>EvaluateJsonPath</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Evaluates one or more JsonPath expressions against the content of a FlowFile. The results of those expressions are assigned to FlowFile Attributes or are written to the content of the FlowFile itself, depending on configuration of the Processor. JsonPaths are entered by adding user-defined properties; the name of the property maps to the Attribute Name into which the result will be placed (if the Destination is flowfile-attribute; otherwise, the property name is ignored). The value of the property must be a valid JsonPath expression. If the JsonPath evaluates to a JSON array or JSON object and the Return Type is set to 'scalar' the FlowFile will be unmodified and will be routed to failure. A Return Type of JSON can return scalar values if the provided JsonPath evaluate s to the specified value and will be routed as a match.If Destination is 'flowfile-content' and the JsonPath does not evaluate to a defined path, the FlowFile will be routed to 'unmatched' without having its contents modified. If Destination is flowfile-attribute and the expression matches nothing, attributes will be created with empty strings as the value, and the FlowFile will always be routed to 'matched.'</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>JSON, evaluate, JsonPath</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>Destination</strong></td><td id="default-value">flowfile-content</td><td id="allowable-values"><ul><li>flowfile-con tent</li><li>flowfile-attribute</li></ul></td><td id="description">Indicates whether the results of the JsonPath evaluation are written to the FlowFile content or a FlowFile attribute; if using attribute, must specify the Attribute Name property. If set to flowfile-content, only one JsonPath may be specified, and the property name is ignored.</td></tr><tr><td id="name"><strong>Return Type</strong></td><td id="default-value">auto-detect</td><td id="allowable-values"><ul><li>auto-detect</li><li>json</li><li>scalar</li></ul></td><td id="description">Indicates the desired return type of the JSON Path expressions. Selecting 'auto-detect' will set the return type to 'json' for a Destination of 'flowfile-content', and 'string' for a Destination of 'flowfile-attribute'.</td></tr><tr><td id="name"><strong>Path Not Found Behavior</strong></td><td id="default-value">ignore</td><td id="allowable-values"><ul><li>warn</li><li>ignore</li></ul></td><td id="description">Indicates how to handle miss ing JSON path expressions when destination is set to 'flowfile-attribute'. Selecting 'warn' will generate a warning when a JSON path expression is not found.</td></tr><tr><td id="name"><strong>Null Value Representation</strong></td><td id="default-value">empty string</td><td id="allowable-values"><ul><li>the string 'null'</li><li>empty string</li></ul></td><td id="description">Indicates the desired representation of JSON Path expressions resulting in a null value.</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 FlowFile attribute(if <Destination> is set to 'flowfile-attribute')</td><td id="value">A JsonPath expression</td><td>If <Destination>='flowfile-attribute' then that FlowFile attribute will be set to any JSON objects that match the JsonPath. If <Destination>='flowfile-co ntent' then the FlowFile content will be updated to any JSON objects that match the JsonPath.</td></tr></table></p><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>matched</td><td>FlowFiles are routed to this relationship when the JsonPath is successfully evaluated and the FlowFile is modified as a result</td></tr><tr><td>unmatched</td><td>FlowFiles are routed to this relationship when the JsonPath does not match the content of the FlowFile and the Destination is set to flowfile-content</td></tr><tr><td>failure</td><td>FlowFiles are routed to this relationship when the JsonPath cannot be evaluated against the content of the FlowFile; for instance, if the FlowFile is not valid JSON</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>EvaluateJsonPath</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Evaluates one or more JsonPath expressions against the content of a FlowFile. The results of those expressions are assigned to FlowFile Attributes or are written to the content of the FlowFile itself, depending on configuration of the Processor. JsonPaths are entered by adding user-defined properties; the name of the property maps to the Attribute Name into which the result will be placed (if the Destination is flowfile-attribute; otherwise, the property name is ignored). The value of the property must be a valid JsonPath expression. A Return Type of 'auto-detect' will make a determination based off the configured destination. When 'Destination' is set to 'flowfile-attribute,' a return type of 'scalar' will be used. When 'Destination' is set to 'flowfile-content,' a re turn type of 'JSON' will be used.If the JsonPath evaluates to a JSON array or JSON object and the Return Type is set to 'scalar' the FlowFile will be unmodified and will be routed to failure. A Return Type of JSON can return scalar values if the provided JsonPath evaluates to the specified value and will be routed as a match.If Destination is 'flowfile-content' and the JsonPath does not evaluate to a defined path, the FlowFile will be routed to 'unmatched' without having its contents modified. If Destination is flowfile-attribute and the expression matches nothing, attributes will be created with empty strings as the value, and the FlowFile will always be routed to 'matched.'</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>JSON, evaluate, JsonPath</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>Destination</strong></td><td id="default-value">flowfile-content</td><td id="allowable-values"><ul><li>flowfile-content</li><li>flowfile-attribute</li></ul></td><td id="description">Indicates whether the results of the JsonPath evaluation are written to the FlowFile content or a FlowFile attribute; if using attribute, must specify the Attribute Name property. If set to flowfile-content, only one JsonPath may be specified, and the property name is ignored.</td></tr><tr><td id="name"><strong>Return Type</strong></td><td id="default-value">auto-detect</td><td id="allowable-values"><ul><li>auto-detect</li><li>json</li><li>scalar</li></ul></td><td id="description">Indicates the desired return type of the JSON Path expressions. Selecting 'auto-detect' will set the return type to 'json' for a Destination of 'flowfile-content', and 'sc alar' for a Destination of 'flowfile-attribute'.</td></tr><tr><td id="name"><strong>Path Not Found Behavior</strong></td><td id="default-value">ignore</td><td id="allowable-values"><ul><li>warn</li><li>ignore</li></ul></td><td id="description">Indicates how to handle missing JSON path expressions when destination is set to 'flowfile-attribute'. Selecting 'warn' will generate a warning when a JSON path expression is not found.</td></tr><tr><td id="name"><strong>Null Value Representation</strong></td><td id="default-value">empty string</td><td id="allowable-values"><ul><li>empty string</li><li>the string 'null'</li></ul></td><td id="description">Indicates the desired representation of JSON Path expressions resulting in a null value.</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 FlowFile attribut e(if <Destination> is set to 'flowfile-attribute')</td><td id="value">A JsonPath expression</td><td>If <Destination>='flowfile-attribute' then that FlowFile attribute will be set to any JSON objects that match the JsonPath. If <Destination>='flowfile-content' then the FlowFile content will be updated to any JSON objects that match the JsonPath.</td></tr></table></p><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>failure</td><td>FlowFiles are routed to this relationship when the JsonPath cannot be evaluated against the content of the FlowFile; for instance, if the FlowFile is not valid JSON</td></tr><tr><td>unmatched</td><td>FlowFiles are routed to this relationship when the JsonPath does not match the content of the FlowFile and the Destination is set to flowfile-content</td></tr><tr><td>matched</td><td>FlowFiles are routed to this relationship when the JsonPath is successfully evaluated and the FlowFile is modif ied as a result</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.</body></html> \ No newline at end of file Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.EvaluateRegularExpression/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.EvaluateRegularExpression/index.html?rev=1704031&r1=1704030&r2=1704031&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.EvaluateRegularExpression/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.EvaluateRegularExpression/index.html Sat Sep 19 13:57:03 2015 @@ -1,4 +1,4 @@ <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>EvaluateRegularExpression</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>WARNING: This has been deprecated and will be removed in 0.2.0. Use ExtractText instead.</p><h3>Tags: </h3><p>deprecated</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>Character Set</strong></td><td id="default-value">UTF-8</td><td id="allowable-values"></td><td id="description">The Character Set in which the file is encoded</td></tr><tr><td id="name"><strong>Maximum Buffer Size</strong></td><td id="default-value">1 MB</td><td id="allowable-values"></td><td id="description">Specifies the maximum amount of data to buffer (per file) in order to apply the regular expressions. Files larger than the specified maximum will not be fully evaluated.</td></tr><tr><td id="name"><strong>Enable Canonical Equivalence</strong></td><td id="default-value" >false</td><td >id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td >id="description">Indicates that two characters match only when their full >canonical decompositions match.</td></tr><tr><td id="name"><strong>Enable >Case-insensitive Matching</strong></td><td id="default-value">false</td><td >id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td >id="description">Indicates that two characters match even if they are in a >different case. Can also be specified via the embeded flag >(?i).</td></tr><tr><td id="name"><strong>Permit Whitespace and Comments in >Pattern</strong></td><td id="default-value">false</td><td >id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td >id="description">In this mode, whitespace is ignored, and embedded comments >starting with # are ignored until the end of a line. Can also be specified >via the embeded flag (?x).</td></tr><tr><td id="name"><strong>Enable DOTALL >Mode</strong></td><td id="default-value">false</td><td id="al lowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Indicates that the expression '.' should match any character, including a line terminator. Can also be specified via the embeded flag (?s).</td></tr><tr><td id="name"><strong>Enable Literal Parsing of the Pattern</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Indicates that Metacharacters and escape characters should be given no special meaning.</td></tr><tr><td id="name"><strong>Enable Multiline Mode</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Indicates that '^' and '$' should match just after and just before a line terminator or end of sequence, instead of only the begining or end of the entire input. Can also be specified via the embeded flag (?m).</td></tr><tr><td id="name"><strong>Enable Unicode-aware Case Folding</strong></t d><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">When used with 'Enable Case-insensitive Matching', matches in a manner consistent with the Unicode Standard. Can also be specified via the embeded flag (?u).</td></tr><tr><td id="name"><strong>Enable Unicode Predefined Character Classes</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 conformance with the Unicode Technical Standard #18: Unicode Regular Expression Annex C: Compatibility Properties. Can also be specified via the embeded flag (?U).</td></tr><tr><td id="name"><strong>Enable Unix Lines Mode</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Indicates that only the ' -' line terminator is recognized int the behavior of '.', '^', and '$'. Can also be specified via the embeded flag (?d).</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 FlowFile attribute</td><td id="value">A regular expression with exactly one capturing group</td><td>Will update the specified FlowFile attribute with the group captured by the regular expression</td></tr></table></p><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>matched</td><td>FlowFiles are routed to this relationship when the Regular Expression is successfully evaluated and the FlowFile is modified as a result</td></tr><tr><td>unmatched</td><td>FlowFiles are routed to this relationship when no provided Regular Expression matches the content of the FlowFile</td></tr></table><h 3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>See Also:</h3><p><a href="../org.apache.nifi.processors.standard.ExtractText/index.html">ExtractText</a></p></body></html> \ No newline at end of file +' line terminator is recognized int the behavior of '.', '^', and '$'. Can also be specified via the embeded flag (?d).</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 FlowFile attribute</td><td id="value">A regular expression with exactly one capturing group</td><td>Will update the specified FlowFile attribute with the group captured by the regular expression</td></tr></table></p><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>unmatched</td><td>FlowFiles are routed to this relationship when no provided Regular Expression matches the content of the FlowFile</td></tr><tr><td>matched</td><td>FlowFiles are routed to this relationship when the Regular Expression is successfully evaluated and the FlowFile is modified as a result</td></tr></table><h 3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>See Also:</h3><p><a href="../org.apache.nifi.processors.standard.ExtractText/index.html">ExtractText</a></p></body></html> \ No newline at end of file Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.EvaluateXPath/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.EvaluateXPath/index.html?rev=1704031&r1=1704030&r2=1704031&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.EvaluateXPath/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.EvaluateXPath/index.html Sat Sep 19 13:57:03 2015 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>EvaluateXPath</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Evaluates one or more XPaths against the content of a FlowFile. The results of those XPaths are assigned to FlowFile Attributes or are written to the content of the FlowFile itself, depending on configuration of the Processor. XPaths are entered by adding user-defined properties; the name of the property maps to the Attribute Name into which the result will be placed (if the Destination is flowfile-attribute; otherwise, the property name is ignored). The value of the property must be a valid XPath expression. If the XPath evaluates to more than one node and the Return Type is set to 'nodeset' (either directly, or via 'auto-detect' with a Destination of 'flowfile-content'), the FlowFile will be unmodified and will be routed to failure. If the XPath does not evaluate to a N ode, the FlowFile will be routed to 'unmatched' without having its contents modified. If Destination is flowfile-attribute and the expression matches nothing, attributes will be created with empty strings as the value, and the FlowFile will always be routed to 'matched'</p><h3>Tags: </h3><p>XML, evaluate, XPath</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>Destination</strong></td><td id="default-value">flowfile-content</td><td id="allowable-values"><ul><li>flowfile-content</li><li>flowfile-attribute</li></ul></td><td id="description">Indicates whether the results of the XPath evaluation are written to the FlowFile content or a FlowFile attribute; if using attribute, must spec ify the Attribute Name property. If set to flowfile-content, only one XPath may be specified, and the property name is ignored.</td></tr><tr><td id="name"><strong>Return Type</strong></td><td id="default-value">auto-detect</td><td id="allowable-values"><ul><li>auto-detect</li><li>nodeset</li><li>string</li></ul></td><td id="description">Indicates the desired return type of the Xpath expressions. Selecting 'auto-detect' will set the return type to 'nodeset' for a Destination of 'flowfile-content', and 'string' for a Destination of 'flowfile-attribute'.</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 FlowFile attribute(if <Destination> is set to 'flowfile-attribute'</td><td id="value">An XPath expression</td><td>If <Destination>='flowfile-attribute' then the FlowFile attribute is set to the result of the XPath Expression. If <Destination>='flowfile-content' then the FlowFile content is set to the result of the XPath Expression.</td></tr></table></p><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>matched</td><td>FlowFiles are routed to this relationship when the XPath is successfully evaluated and the FlowFile is modified as a result</td></tr><tr><td>unmatched</td><td>FlowFiles are routed to this relationship when the XPath does not match the content of the FlowFile and the Destination is set to flowfile-content</td></tr><tr><td>failure</td><td>FlowFiles are routed to this relationship when the XPath cannot be evaluated against the content of the FlowFile; for instance, if the FlowFile is not valid XML, or if the Return Type is 'nodeset' and the XPath evaluates to multiple nodes</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Nam e</th><th>Description</th></tr><tr><td>user-defined</td><td>This processor adds user-defined attributes if the <Destination> property is set to flowfile-attribute.</td></tr></table></body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>EvaluateXPath</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Evaluates one or more XPaths against the content of a FlowFile. The results of those XPaths are assigned to FlowFile Attributes or are written to the content of the FlowFile itself, depending on configuration of the Processor. XPaths are entered by adding user-defined properties; the name of the property maps to the Attribute Name into which the result will be placed (if the Destination is flowfile-attribute; otherwise, the property name is ignored). The value of the property must be a valid XPath expression. If the XPath evaluates to more than one node and the Return Type is set to 'nodeset' (either directly, or via 'auto-detect' with a Destination of 'flowfile-content'), the FlowFile will be unmodified and will be routed to failure. If the XPath does not evaluate to a N ode, the FlowFile will be routed to 'unmatched' without having its contents modified. If Destination is flowfile-attribute and the expression matches nothing, attributes will be created with empty strings as the value, and the FlowFile will always be routed to 'matched'</p><h3>Tags: </h3><p>XML, evaluate, XPath</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>Destination</strong></td><td id="default-value">flowfile-content</td><td id="allowable-values"><ul><li>flowfile-content</li><li>flowfile-attribute</li></ul></td><td id="description">Indicates whether the results of the XPath evaluation are written to the FlowFile content or a FlowFile attribute; if using attribute, must spec ify the Attribute Name property. If set to flowfile-content, only one XPath may be specified, and the property name is ignored.</td></tr><tr><td id="name"><strong>Return Type</strong></td><td id="default-value">auto-detect</td><td id="allowable-values"><ul><li>auto-detect</li><li>nodeset</li><li>string</li></ul></td><td id="description">Indicates the desired return type of the Xpath expressions. Selecting 'auto-detect' will set the return type to 'nodeset' for a Destination of 'flowfile-content', and 'string' for a Destination of 'flowfile-attribute'.</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 FlowFile attribute(if <Destination> is set to 'flowfile-attribute'</td><td id="value">An XPath expression</td><td>If <Destination>='flowfile-attribute' then the FlowFile attribute is set to the result of the XPath Expression. If <Destination>='flowfile-content' then the FlowFile content is set to the result of the XPath Expression.</td></tr></table></p><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>failure</td><td>FlowFiles are routed to this relationship when the XPath cannot be evaluated against the content of the FlowFile; for instance, if the FlowFile is not valid XML, or if the Return Type is 'nodeset' and the XPath evaluates to multiple nodes</td></tr><tr><td>unmatched</td><td>FlowFiles are routed to this relationship when the XPath does not match the content of the FlowFile and the Destination is set to flowfile-content</td></tr><tr><td>matched</td><td>FlowFiles are routed to this relationship when the XPath is successfully evaluated and the FlowFile is modified as a result</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Nam e</th><th>Description</th></tr><tr><td>user-defined</td><td>This processor adds user-defined attributes if the <Destination> property is set to flowfile-attribute.</td></tr></table></body></html> \ No newline at end of file Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.EvaluateXQuery/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.EvaluateXQuery/index.html?rev=1704031&r1=1704030&r2=1704031&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.EvaluateXQuery/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.EvaluateXQuery/index.html Sat Sep 19 13:57:03 2015 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>EvaluateXQuery</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Evaluates one or more XQueries against the content of a FlowFile. The results of those XQueries are assigned to FlowFile Attributes or are written to the content of the FlowFile itself, depending on configuration of the Processor. XQueries are entered by adding user-defined properties; the name of the property maps to the Attribute Name into which the result will be placed (if the Destination is 'flowfile-attribute'; otherwise, the property name is ignored). The value of the property must be a valid XQuery. If the XQuery returns more than one result, new attributes or FlowFiles (for Destinations of 'flowfile-attribute' or 'flowfile-content' respectively) will be created for each result (attributes will have a '.n' one-up number appended to the specified attribute nam e). If any provided XQuery returns a result, the FlowFile(s) will be routed to 'matched'. If no provided XQuery returns a result, the FlowFile will be routed to 'unmatched'. If the Destination is 'flowfile-attribute' and the XQueries matche nothing, no attributes will be applied to the FlowFile.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>XML, evaluate, XPath, XQuery</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>Destination</strong></td><td id="default-value">flowfile-content</td><td id="allowable-values"><ul><li>flowfile-content</li><li>flowfile-attribute</li></ul></td><td id="description">Indicates whether the results of the XQuery evaluation are written to the FlowFile content or a FlowFile attribute. If set to <flowfile-content>, only one XQuery may be specified and the property name is ignored. If set to <flowfile-attribute> and the XQuery returns more than one result, multiple attributes will be added to theFlowFile, each named with a '.n' one-up number appended to the specified attribute name</td></tr><tr><td id="name"><strong>Output: Method</strong></td><td id="default-value">xml</td><td id="allowable-values"><ul><li>xml</li><li>html</li><li>text</li></ul></td><td id="description">Identifies the overall method that should be used for outputting a result tree.</td></tr><tr><td id="name"><strong>Output: Omit XML Declaration</strong></td><td id="default-value">false</td><td id="allowable-values"></td><td id="description">Specifies whether the processor should output an XML declaration when transforming a result tree.</td></tr><tr><td id="name"><strong>Output: Indent</strong></td><td id="defaul t-value">false</td><td id="allowable-values"></td><td id="description">Specifies whether the processor may add additional whitespace when outputting a result tree.</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 FlowFile attribute(if <Destination> is set to 'flowfile-attribute'</td><td id="value">An XQuery</td><td>If <Destination>='flowfile-attribute' then the FlowFile attribute is set to the result of the XQuery. If <Destination>='flowfile-content' then the FlowFile content is set to the result of the XQuery.</td></tr></table></p><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>matched</td><td>FlowFiles are routed to this relationship when the XQuery is successfully evaluated and the FlowFile is modified as a result</td></tr> <tr><td>unmatched</td><td>FlowFiles are routed to this relationship when the XQuery does not match the content of the FlowFile and the Destination is set to flowfile-content</td></tr><tr><td>failure</td><td>FlowFiles are routed to this relationship when the XQuery cannot be evaluated against the content of the FlowFile.</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>user-defined</td><td>This processor adds user-defined attributes if the <Destination> property is set to flowfile-attribute .</td></tr></table></body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>EvaluateXQuery</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Evaluates one or more XQueries against the content of a FlowFile. The results of those XQueries are assigned to FlowFile Attributes or are written to the content of the FlowFile itself, depending on configuration of the Processor. XQueries are entered by adding user-defined properties; the name of the property maps to the Attribute Name into which the result will be placed (if the Destination is 'flowfile-attribute'; otherwise, the property name is ignored). The value of the property must be a valid XQuery. If the XQuery returns more than one result, new attributes or FlowFiles (for Destinations of 'flowfile-attribute' or 'flowfile-content' respectively) will be created for each result (attributes will have a '.n' one-up number appended to the specified attribute nam e). If any provided XQuery returns a result, the FlowFile(s) will be routed to 'matched'. If no provided XQuery returns a result, the FlowFile will be routed to 'unmatched'. If the Destination is 'flowfile-attribute' and the XQueries matche nothing, no attributes will be applied to the FlowFile.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>XML, evaluate, XPath, XQuery</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>Destination</strong></td><td id="default-value">flowfile-content</td><td id="allowable-values"><ul><li>flowfile-content</li><li>flowfile-attribute</li></ul></td><td id="description">Indicates whether the results of the XQuery evaluation are written to the FlowFile content or a FlowFile attribute. If set to <flowfile-content>, only one XQuery may be specified and the property name is ignored. If set to <flowfile-attribute> and the XQuery returns more than one result, multiple attributes will be added to theFlowFile, each named with a '.n' one-up number appended to the specified attribute name</td></tr><tr><td id="name"><strong>Output: Method</strong></td><td id="default-value">xml</td><td id="allowable-values"><ul><li>xml</li><li>html</li><li>text</li></ul></td><td id="description">Identifies the overall method that should be used for outputting a result tree.</td></tr><tr><td id="name"><strong>Output: Omit XML Declaration</strong></td><td id="default-value">false</td><td id="allowable-values"></td><td id="description">Specifies whether the processor should output an XML declaration when transforming a result tree.</td></tr><tr><td id="name"><strong>Output: Indent</strong></td><td id="defaul t-value">false</td><td id="allowable-values"></td><td id="description">Specifies whether the processor may add additional whitespace when outputting a result tree.</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 FlowFile attribute(if <Destination> is set to 'flowfile-attribute'</td><td id="value">An XQuery</td><td>If <Destination>='flowfile-attribute' then the FlowFile attribute is set to the result of the XQuery. If <Destination>='flowfile-content' then the FlowFile content is set to the result of the XQuery.</td></tr></table></p><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>failure</td><td>FlowFiles are routed to this relationship when the XQuery cannot be evaluated against the content of the FlowFile.</td></tr><tr><td>un matched</td><td>FlowFiles are routed to this relationship when the XQuery does not match the content of the FlowFile and the Destination is set to flowfile-content</td></tr><tr><td>matched</td><td>FlowFiles are routed to this relationship when the XQuery is successfully evaluated and the FlowFile is modified as a result</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>user-defined</td><td>This processor adds user-defined attributes if the <Destination> property is set to flowfile-attribute .</td></tr></table></body></html> \ No newline at end of file
