You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nifi.apache.org by mc...@apache.org on 2017/06/09 13:20:19 UTC
svn commit: r1798216 [9/39] - in /nifi/site/trunk/docs: ./ nifi-docs/
nifi-docs/components/ nifi-docs/components/org.apache.nifi/
nifi-docs/components/org.apache.nifi/nifi-ambari-nar/
nifi-docs/components/org.apache.nifi/nifi-ambari-nar/1.3.0/ nifi-doc...
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-hbase_1_1_2-client-service-nar/1.3.0/org.apache.nifi.hbase.HBase_1_1_2_ClientService/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-hbase_1_1_2-client-service-nar/1.3.0/org.apache.nifi.hbase.HBase_1_1_2_ClientService/index.html?rev=1798216&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-hbase_1_1_2-client-service-nar/1.3.0/org.apache.nifi.hbase.HBase_1_1_2_ClientService/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-hbase_1_1_2-client-service-nar/1.3.0/org.apache.nifi.hbase.HBase_1_1_2_ClientService/index.html Fri Jun 9 13:20:11 2017
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>HBase_1_1_2_ClientService</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">HBase_1_1_2_ClientService</h1><h2>Description: </h2><p>Implementation of HBaseClientService for HBase 1.1.2. This service can be configured by providing a comma-separated list of configuration files, or by specifying values for the other properties. If configuration files are provided, they will be loaded first, and the values of the additional properties will override the values from the configuration files. In addition, any user defined properties on the processor will also be passed to the HBase configuration.</p><h3>Tags: </h3><p>hbase, client</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">Hadoop Configuration Files</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Comma-separated list of Hadoop Configuration files, such as hbase-site.xml and core-site.xml for kerberos, including full paths to the files.</td></tr><tr><td id="name">Kerberos Principal</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Kerberos principal to authenticate as. Requires nifi.kerberos.krb5.file to be set in your nifi.properties</td></tr><tr><td id="name">Kerberos Keytab</td><td id="default-value"
></td><td id="allowable-values"></td><td id="description">Kerberos keytab associated with the principal. Requires nifi.kerberos.krb5.file to be set in your nifi.properties</td></tr><tr><td id="name">ZooKeeper Quorum</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Comma-separated list of ZooKeeper hosts for HBase. Required if Hadoop Configuration Files are not provided.</td></tr><tr><td id="name">ZooKeeper Client Port</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The port on which ZooKeeper is accepting client connections. Required if Hadoop Configuration Files are not provided.</td></tr><tr><td id="name">ZooKeeper ZNode Parent</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The ZooKeeper ZNode Parent value for HBase (example: /hbase). Required if Hadoop Configuration Files are not provided.</td></tr><tr><td id="name">HBase Client Retries</td><td id="default-value">1</td><td
id="allowable-values"></td><td id="description">The number of times the HBase client will retry connecting. Required if Hadoop Configuration Files are not provided.</td></tr><tr><td id="name">Phoenix Client JAR Location</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The full path to the Phoenix client JAR. Required if Phoenix is installed on top of HBase.<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 HBase configuration property.</td><td id="value">The value of the given HBase configuration property.</td><td>These properties will be set on the HBase configuration after loading any provided configuration files.</td></tr></table></p><h3>State management: </h3>This component does not store st
ate.<h3>Restricted: </h3>This component is not restricted.</body></html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-hive-nar/1.3.0/org.apache.nifi.dbcp.hive.HiveConnectionPool/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-hive-nar/1.3.0/org.apache.nifi.dbcp.hive.HiveConnectionPool/index.html?rev=1798216&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-hive-nar/1.3.0/org.apache.nifi.dbcp.hive.HiveConnectionPool/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-hive-nar/1.3.0/org.apache.nifi.dbcp.hive.HiveConnectionPool/index.html Fri Jun 9 13:20:11 2017
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>HiveConnectionPool</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">HiveConnectionPool</h1><h2>Description: </h2><p>Provides Database Connection Pooling Service for Apache Hive. Connections can be asked from pool and returned after usage.</p><h3>Tags: </h3><p>hive, dbcp, jdbc, database, connection, pooling, store</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>, and whether
a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props.key</strong>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Database Connection URL</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A database connection URL used to connect to a database. May contain database system name, host, port, database name and some parameters. The exact syntax of a database connection URL is specified by the Hive documentation. For example, the server principal is often included as a connection parameter when connecting to a secure Hive server.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Hive Configuration Resources</td><td id="default-value"><
/td><td id="allowable-values"></td><td id="description">A file or comma separated list of files which contains the Hive configuration (hive-site.xml, e.g.). Without this, Hadoop will search the classpath for a 'hive-site.xml' file or will revert to a default configuration. Note that to enable authentication with Kerberos e.g., the appropriate properties must be set in the configuration files. Please see the Hive documentation for more details.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Database User</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Database user name<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The password for the database user<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>M
ax Wait Time</strong></td><td id="default-value">500 millis</td><td id="allowable-values"></td><td id="description">The maximum amount of time that the pool will wait (when there are no available connections) for a connection to be returned before failing, or -1 to wait indefinitely. <br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Max Total Connections</strong></td><td id="default-value">8</td><td id="allowable-values"></td><td id="description">The maximum number of active connections that can be allocated from this pool at the same time, or negative for no limit.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Validation query</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Validation query used to validate connections before returning them. When a borrowed connection is invalid, it gets dropped and a new valid connection will be returned. NOTE: Using validation may h
ave a performance penalty.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Kerberos Principal</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Kerberos principal to authenticate as. Requires nifi.kerberos.krb5.file to be set in your nifi.properties</td></tr><tr><td id="name">Kerberos Keytab</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Kerberos keytab associated with the principal. Requires nifi.kerberos.krb5.file to be set in your nifi.properties</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.</body></html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-hive-nar/1.3.0/org.apache.nifi.processors.hive.ConvertAvroToORC/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-hive-nar/1.3.0/org.apache.nifi.processors.hive.ConvertAvroToORC/index.html?rev=1798216&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-hive-nar/1.3.0/org.apache.nifi.processors.hive.ConvertAvroToORC/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-hive-nar/1.3.0/org.apache.nifi.processors.hive.ConvertAvroToORC/index.html Fri Jun 9 13:20:11 2017
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ConvertAvroToORC</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">ConvertAvroToORC</h1><h2>Description: </h2><p>Converts an Avro record into ORC file format. This processor provides a direct mapping of an Avro record to an ORC record, such that the resulting ORC file will have the same hierarchical structure as the Avro document. If an incoming FlowFile contains a stream of multiple Avro records, the resultant FlowFile will contain a ORC file containing all of the Avro records. If an incoming FlowFile does not contain any records, an empty ORC file is the output. NOTE: Many Avro datatypes (collections, primitives, and unions of primitives, e.g.) can be conve
rted to ORC, but unions of collections and other complex datatypes may not be able to be converted to ORC.</p><h3>Tags: </h3><p>avro, orc, hive, convert</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">ORC Configuration Resources</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A file or comma separated list of files which contains the ORC configuration (hive-site.xml, e.g.). Without this, Hadoop will search the classpath for a 'hive-site.xml' file or will revert to a default configuration. Please see the ORC documentation for m
ore details.</td></tr><tr><td id="name"><strong>Stripe Size</strong></td><td id="default-value">64 MB</td><td id="allowable-values"></td><td id="description">The size of the memory buffer (in bytes) for writing stripes to an ORC file</td></tr><tr><td id="name"><strong>Buffer Size</strong></td><td id="default-value">10 KB</td><td id="allowable-values"></td><td id="description">The maximum size of the memory buffers (in bytes) used for compressing and storing a stripe in memory. This is a hint to the ORC writer, which may choose to use a smaller buffer size based on stripe size and number of columns for efficient stripe writing and memory utilization.</td></tr><tr><td id="name"><strong>Compression Type</strong></td><td id="default-value">NONE</td><td id="allowable-values"><ul><li>NONE</li><li>ZLIB</li><li>SNAPPY</li><li>LZO</li></ul></td><td id="description">No Description Provided.</td></tr><tr><td id="name">Hive Table Name</td><td id="default-value"></td><td id="allowable-values"></
td><td id="description">An optional table name to insert into the hive.ddl attribute. The generated DDL can be used by a PutHiveQL processor (presumably after a PutHDFS processor) to create a table backed by the converted ORC file. If this property is not provided, the full name (including namespace) of the incoming Avro record will be normalized and used as the table name.<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>success</td><td>A FlowFile is routed to this relationship after it has been converted to ORC format.</td></tr><tr><td>failure</td><td>A FlowFile is routed to this relationship if it cannot be parsed as Avro or cannot be converted to ORC for any reason</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 the m
ime type to application/octet-stream</td></tr><tr><td>filename</td><td>Sets the filename to the existing filename with the extension replaced by / added to by .orc</td></tr><tr><td>record.count</td><td>Sets the number of records in the ORC file.</td></tr><tr><td>hive.ddl</td><td>Creates a partial Hive DDL statement for creating a table in Hive from this ORC file. This can be used in ReplaceText for setting the content to the DDL. To make it valid DDL, add "LOCATION '<path_to_orc_file_in_hdfs>'", where the path is the directory that contains this ORC file on HDFS. For example, ConvertAvroToORC can send flow files to a PutHDFS processor to send the file to HDFS, then to a ReplaceText to set the content to this DDL (plus the LOCATION clause as described), then to PutHiveQL processor to create the table if it doesn't exist.</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </
h3>This component requires an incoming relationship.</body></html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-hive-nar/1.3.0/org.apache.nifi.processors.hive.PutHiveQL/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-hive-nar/1.3.0/org.apache.nifi.processors.hive.PutHiveQL/index.html?rev=1798216&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-hive-nar/1.3.0/org.apache.nifi.processors.hive.PutHiveQL/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-hive-nar/1.3.0/org.apache.nifi.processors.hive.PutHiveQL/index.html Fri Jun 9 13:20:11 2017
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutHiveQL</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">PutHiveQL</h1><h2>Description: </h2><p>Executes a HiveQL DDL/DML command (UPDATE, INSERT, e.g.). The content of an incoming FlowFile is expected to be the HiveQL command to execute. The HiveQL command may use the ? to escape parameters. In this case, the parameters to use must exist as FlowFile attributes with the naming convention hiveql.args.N.type and hiveql.args.N.value, where N is a positive integer. The hiveql.args.N.type is expected to be a number indicating the JDBC Type. The content of the FlowFile is expected to be in UTF-8 format.</p><h3>Tags: </h3><p>sql, hive, put, database, update, inser
t</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>Hive Database Connection Pooling Service</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>HiveDBCPService<br/><strong>Implementation:</strong><a href="../org.apache.nifi.dbcp.hive.HiveConnectionPool/index.html">HiveConnectionPool</a></td><td id="description">The Hive Controller Service that is used to obtain connection(s) to the Hive database</td></tr><tr><td id="name"><strong>Batch Size</strong></td><td id="default-value">100</td><td id="allowable-values"></td><td id="description">The preferred number of FlowFiles to put to the database in a single transaction</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 record data.</td></tr><tr><td id="name"><strong>Statement Delimiter</strong></td><td id="default-value">;</td><td id="allowable-values"></td><td id="description">Statement Delimiter used to separate SQL statements in a multiple statement script</td></tr><tr><td id="name"><strong>Rollback On Failure</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Specify how to handle error. By default (false), if an error occurs while processing a FlowFile, the FlowFile will be routed to 'failure' or 'retry' relationship based on error type, and processor can continue with next FlowFile. Instead, you may want to rollback currently processed FlowFiles and stop further processing immediately. In that case, you can do so by enabling this 'Rollb
ack On Failure' property. If enabled, failed FlowFiles will stay in the input relationship without penalizing it and being processed repeatedly until it gets processed successfully or removed by other means. It is important to set adequate 'Yield Duration' to avoid retrying too frequently.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>retry</td><td>A FlowFile is routed to this relationship if the database cannot be updated but attempting the operation again may succeed</td></tr><tr><td>success</td><td>A FlowFile is routed to this relationship after the database is successfully updated</td></tr><tr><td>failure</td><td>A FlowFile is routed to this relationship if the database cannot be updated and retrying the operation will also fail, such as an invalid query or an integrity constraint violation</td></tr></table><h3>Reads Attributes: </h3><table id="reads-attributes"><tr><th>Name</th><th>Description</th></tr><tr>
<td>hiveql.args.N.type</td><td>Incoming FlowFiles are expected to be parametrized HiveQL statements. The type of each Parameter is specified as an integer that represents the JDBC Type of the parameter.</td></tr><tr><td>hiveql.args.N.value</td><td>Incoming FlowFiles are expected to be parametrized HiveQL statements. The value of the Parameters are specified as hiveql.args.1.value, hiveql.args.2.value, hiveql.args.3.value, and so on. The type of the hiveql.args.1.value Parameter is specified by the hiveql.args.1.type attribute.</td></tr></table><h3>Writes Attributes: </h3>None specified.<h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.<h3>See Also:</h3><p><a href="../org.apache.nifi.processors.hive.SelectHiveQL/index.html">SelectHiveQL</a></p></body></html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-hive-nar/1.3.0/org.apache.nifi.processors.hive.PutHiveStreaming/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-hive-nar/1.3.0/org.apache.nifi.processors.hive.PutHiveStreaming/index.html?rev=1798216&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-hive-nar/1.3.0/org.apache.nifi.processors.hive.PutHiveStreaming/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-hive-nar/1.3.0/org.apache.nifi.processors.hive.PutHiveStreaming/index.html Fri Jun 9 13:20:11 2017
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutHiveStreaming</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">PutHiveStreaming</h1><h2>Description: </h2><p>This processor uses Hive Streaming to send flow file data to an Apache Hive table. The incoming flow file is expected to be in Avro format and the table must exist in Hive. Please see the Hive documentation for requirements on the Hive table (format, partitions, etc.). The partition values are extracted from the Avro record based on the names of the partition columns as specified in the processor.</p><h3>Tags: </h3><p>hive, streaming, put, database, store</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <stron
g>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>Hive Metastore URI</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The URI location for the Hive Metastore. Note that this is not the location of the Hive Server. The default port for the Hive metastore is 9043.</td></tr><tr><td id="name">Hive Configuration Resources</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A file or comma separated list of files which contains the Hive configuration (hive-site.xml, e.g.). Without this, Hadoop will search the classpath for a 'hive-site.xml' file or will revert to a default configu
ration. Note that to enable authentication with Kerberos e.g., the appropriate properties must be set in the configuration files. Please see the Hive documentation for more details.</td></tr><tr><td id="name"><strong>Database Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the database in which to put the data.</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 database table in which to put the data.</td></tr><tr><td id="name">Partition Columns</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A comma-delimited list of column names on which the table has been partitioned. The order of values in this list must correspond exactly to the order of partition columns specified during the table creation.</td></tr><tr><td id="name"><strong>Auto-Create Partitions</strong></td><td id="default-va
lue">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Flag indicating whether partitions should be automatically created</td></tr><tr><td id="name"><strong>Max Open Connections</strong></td><td id="default-value">8</td><td id="allowable-values"></td><td id="description">The maximum number of open connections that can be allocated from this pool at the same time, or negative for no limit.</td></tr><tr><td id="name"><strong>Heartbeat Interval</strong></td><td id="default-value">60</td><td id="allowable-values"></td><td id="description">Indicates that a heartbeat should be sent when the specified number of seconds has elapsed. A value of 0 indicates that no heartbeat should be sent.</td></tr><tr><td id="name"><strong>Transactions per Batch</strong></td><td id="default-value">100</td><td id="allowable-values"></td><td id="description">A hint to Hive Streaming indicating how many transactions the processor task will need. This value must be
greater than 1.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Records per Transaction</strong></td><td id="default-value">10000</td><td id="allowable-values"></td><td id="description">Number of records to process before committing the transaction. This value must be greater than 1.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Rollback On Failure</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Specify how to handle error. By default (false), if an error occurs while processing a FlowFile, the FlowFile will be routed to 'failure' or 'retry' relationship based on error type, and processor can continue with next FlowFile. Instead, you may want to rollback currently processed FlowFiles and stop further processing immediately. In that case, you can do so by enabling this 'Rollback On Failure' property. If enabled
, failed FlowFiles will stay in the input relationship without penalizing it and being processed repeatedly until it gets processed successfully or removed by other means. It is important to set adequate 'Yield Duration' to avoid retrying too frequently.NOTE: When an error occurred after a Hive streaming transaction which is derived from the same input FlowFile is already committed, (i.e. a FlowFile contains more records than 'Records per Transaction' and a failure occurred at the 2nd transaction or later) then the succeeded records will be transferred to 'success' relationship while the original input FlowFile stays in incoming queue. Duplicated records can be created for the succeeded ones when the same FlowFile is processed again.</td></tr><tr><td id="name">Kerberos Principal</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Kerberos principal to authenticate as. Requires nifi.kerberos.krb5.file to be set in your nifi.properties</td></tr><tr><td
id="name">Kerberos Keytab</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Kerberos keytab associated with the principal. Requires nifi.kerberos.krb5.file to be set in your nifi.properties</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>retry</td><td>The incoming FlowFile is routed to this relationship if its records cannot be transmitted to Hive. Note that some records may have been processed successfully, they will be routed (as Avro flow files) to the success relationship. The combination of the retry, success, and failure relationships indicate how many records succeeded and/or failed. This can be used to provide a retry capability since full rollback is not possible.</td></tr><tr><td>success</td><td>A FlowFile containing Avro records routed to this relationship after the record has been successfully transmitted to Hive.</td></tr><tr><td>failure</td><td>A FlowFile containing A
vro records routed to this relationship if the record could not be transmitted to Hive.</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>hivestreaming.record.count</td><td>This attribute is written on the flow files routed to the 'success' and 'failure' relationships, and contains the number of records from the incoming flow file written successfully and unsuccessfully, respectively.</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.</body></html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-hive-nar/1.3.0/org.apache.nifi.processors.hive.SelectHiveQL/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-hive-nar/1.3.0/org.apache.nifi.processors.hive.SelectHiveQL/index.html?rev=1798216&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-hive-nar/1.3.0/org.apache.nifi.processors.hive.SelectHiveQL/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-hive-nar/1.3.0/org.apache.nifi.processors.hive.SelectHiveQL/index.html Fri Jun 9 13:20:11 2017
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>SelectHiveQL</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">SelectHiveQL</h1><h2>Description: </h2><p>Execute provided HiveQL SELECT query against a Hive database connection. Query result will be converted to Avro or CSV format. Streaming is used so arbitrarily large result sets are supported. This processor can be scheduled to run on a timer, or cron expression, using the standard scheduling methods, or it can be triggered by an incoming FlowFile. If it is triggered by an incoming FlowFile, then attributes of that FlowFile will be available when evaluating the select query. FlowFile attribute 'selecthiveql.row.count' indicates how many rows were selected.<
/p><h3>Tags: </h3><p>hive, sql, select, jdbc, query, database</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>Hive Database Connection Pooling Service</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>HiveDBCPService<br/><strong>Implementation:</strong><a href="../org.apache.nifi.dbcp.hive.HiveConnectionPool/index.html">HiveConnectionPool</a></td><td id="description">The Hive Controller Service that is used to obtain connection(s) to the Hive database</td></tr><tr><td id="name">HiveQL Select
Query</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">HiveQL SELECT query to execute<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Output Format</strong></td><td id="default-value">Avro</td><td id="allowable-values"><ul><li>Avro</li><li>CSV</li></ul></td><td id="description">How to represent the records coming from Hive (Avro, CSV, e.g.)</td></tr><tr><td id="name"><strong>CSV 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">Include Header in Output</td></tr><tr><td id="name">Alternate CSV Header</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Comma separated list of header fields<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>CSV Delimiter</strong></td><td id="default-value">,</td><td id="allowable-values"></td><td id="description">CSV
Delimiter used to separate fields<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>CSV Quote</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 to force quoting of CSV fields. Note that this might conflict with the setting for CSV Escape.</td></tr><tr><td id="name"><strong>CSV Escape</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 to escape CSV strings in output. Note that this might conflict with the setting for CSV Quote.</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 record data.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>Successfully cr
eated FlowFile from HiveQL query result set.</td></tr><tr><td>failure</td><td>HiveQL query execution failed. Incoming 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>mime.type</td><td>Sets the MIME type for the outgoing flowfile to application/avro-binary for Avro or text/csv for CSV.</td></tr><tr><td>filename</td><td>Adds .avro or .csv to the filename attribute depending on which output format is selected.</td></tr><tr><td>selecthiveql.row.count</td><td>Indicates how many rows were selected/returned by the query.</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component allows an incoming relationship.</body></html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-hl7-nar/1.3.0/org.apache.nifi.processors.hl7.ExtractHL7Attributes/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-hl7-nar/1.3.0/org.apache.nifi.processors.hl7.ExtractHL7Attributes/index.html?rev=1798216&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-hl7-nar/1.3.0/org.apache.nifi.processors.hl7.ExtractHL7Attributes/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-hl7-nar/1.3.0/org.apache.nifi.processors.hl7.ExtractHL7Attributes/index.html Fri Jun 9 13:20:11 2017
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ExtractHL7Attributes</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">ExtractHL7Attributes</h1><h2>Description: </h2><p>Extracts information from an HL7 (Health Level 7) formatted FlowFile and adds the information as FlowFile Attributes. The attributes are named as <Segment Name> <dot> <Field Index>. If the segment is repeating, the naming will be <Segment Name> <underscore> <Segment Index> <dot> <Field Index>. For example, we may have an attribute named "MHS.12" with a value of "2.1" and an attribute named "OBX_11.3" with a value of "93000^CPT4".</p><h3>Tags: </h3><p>HL7, health level 7, healthcare, extract, at
tributes</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>Character Encoding</strong></td><td id="default-value">UTF-8</td><td id="allowable-values"></td><td id="description">The Character Encoding that is used to encode the HL7 data<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Use Segment Names</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Whether or not to use HL7 segment names in attributes</td></tr><tr><td id="name"><st
rong>Parse Segment Fields</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Whether or not to parse HL7 segment fields into attributes</td></tr><tr><td id="name"><strong>Skip Validation</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Whether or not to validate HL7 message values</td></tr><tr><td id="name"><strong>HL7 Input Version</strong></td><td id="default-value">autodetect</td><td id="allowable-values"><ul><li>autodetect</li><li>2.2</li><li>2.3</li><li>2.3.1</li><li>2.4</li><li>2.5</li><li>2.5.1</li><li>2.6</li></ul></td><td id="description">The HL7 version to use for parsing and validation</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>A FlowFile is routed to this relationship if it is properly parsed as HL7 and its attributes
extracted</td></tr><tr><td>failure</td><td>A FlowFile is routed to this relationship if it cannot be mapped to FlowFile Attributes. This would happen if the FlowFile does not contain valid HL7 data</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.</body></html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-hl7-nar/1.3.0/org.apache.nifi.processors.hl7.RouteHL7/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-hl7-nar/1.3.0/org.apache.nifi.processors.hl7.RouteHL7/index.html?rev=1798216&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-hl7-nar/1.3.0/org.apache.nifi.processors.hl7.RouteHL7/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-hl7-nar/1.3.0/org.apache.nifi.processors.hl7.RouteHL7/index.html Fri Jun 9 13:20:11 2017
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>RouteHL7</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">RouteHL7</h1><h2>Description: </h2><p>Routes incoming HL7 data according to user-defined queries. To add a query, add a new property to the processor. The name of the property will become a new relationship for the processor, and the value is an HL7 Query Language query. If a FlowFile matches the query, a copy of the FlowFile will be routed to the associated relationship.</p><h3>Tags: </h3><p>HL7, healthcare, route, Health Level 7</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. Th
e 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>Character Encoding</strong></td><td id="default-value">UTF-8</td><td id="allowable-values"></td><td id="description">The Character Encoding that is used to encode the HL7 data<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">Name of a Relationship</td><td id="value">An HL7 Query Language query</td><td>If a FlowFile matches the query, it will be routed to a relationship with the name of the property</td></tr></table></p><h3>Relationships:
</h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>failure</td><td>Any FlowFile that cannot be parsed as HL7 will be routed to this relationship</td></tr><tr><td>original</td><td>The original FlowFile that comes into this processor will be routed to this relationship, unless it is routed to 'failure'</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>RouteHL7.Route</td><td>The name of the relationship to which the FlowFile was routed</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.</body></html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-html-nar/1.3.0/org.apache.nifi.GetHTMLElement/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-html-nar/1.3.0/org.apache.nifi.GetHTMLElement/index.html?rev=1798216&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-html-nar/1.3.0/org.apache.nifi.GetHTMLElement/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-html-nar/1.3.0/org.apache.nifi.GetHTMLElement/index.html Fri Jun 9 13:20:11 2017
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>GetHTMLElement</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">GetHTMLElement</h1><h2>Description: </h2><p>Extracts HTML element values from the incoming flowfile's content using a CSS selector. The incoming HTML is first converted into a HTML Document Object Model so that HTML elements may be selected in the similar manner that CSS selectors are used to apply styles to HTML. The resulting HTML DOM is then "queried" using the user defined CSS selector string. The result of "querying" the HTML DOM may produce 0-N results. If no results are found the flowfile will be transferred to the "element not found" relationship to indicate so to the end user. If N resul
ts are found a new flowfile will be created and emitted for each result. The query result will either be placed in the content of the new flowfile or as an attribute of the new flowfile. By default the result is written to an attribute. This can be controlled by the "Destination" property. Resulting query values may also have data prepended or appended to them by setting the value of property "Prepend Element Value" or "Append Element Value". Prepended and appended values are treated as string values and concatenated to the result retrieved from the HTML DOM query operation. A more thorough reference for the CSS selector syntax can be found at "http://jsoup.org/apidocs/org/jsoup/select/Selector.html"</p><h3>Tags: </h3><p>get, html, dom, css, element</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 proper
ty 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>URL</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Base URL for the HTML page being parsed. This URL will be used to resolve an absolute URL when an attribute value is extracted from a HTML element.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>CSS Selector</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">CSS selector syntax string used to extract the desired HTML element(s).<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>HTML Character Encoding</strong></td><td id="default-value">UTF-8</td><td id="allowable-values"></td><td id="description">Character encoding of
the input HTML</td></tr><tr><td id="name"><strong>Output Type</strong></td><td id="default-value">HTML</td><td id="allowable-values"><ul><li>HTML</li><li>Text</li><li>Attribute</li><li>Data</li></ul></td><td id="description">Controls the type of DOM value that is retrieved from the HTML element.</td></tr><tr><td id="name"><strong>Destination</strong></td><td id="default-value">flowfile-attribute</td><td id="allowable-values"><ul><li>flowfile-attribute</li><li>flowfile-content</li></ul></td><td id="description">Control if element extracted is written as a flowfile attribute or as flowfile content.</td></tr><tr><td id="name">Prepend Element Value</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Prepends the specified value to the resulting Element<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Append Element Value</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Appends the specif
ied value to the resulting Element<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Attribute Name</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">When getting the value of a HTML element attribute this value is used as the key to determine which attribute on the selected element should be retrieved. This value is used when the "Output Type" is set to "Attribute". If this value is prefixed with 'abs:', then the extracted attribute value will be converted into an absolute URL form using the specified base URL.<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>element not found</td><td>Element could not be found in the HTML document. The original HTML input will remain in the FlowFile content unchanged. Relationship 'original' will not be invoked in this scenario.</td></tr><tr><td>success</td><t
d>Successfully parsed HTML element</td></tr><tr><td>original</td><td>The original HTML input</td></tr><tr><td>invalid html</td><td>The input HTML syntax is invalid</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>HTMLElement</td><td>Flowfile attribute where the element result parsed from the HTML using the CSS selector syntax are placed if the destination is a flowfile attribute.</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.<h3>See Also:</h3><p><a href="../org.apache.nifi.ModifyHTMLElement/index.html">ModifyHTMLElement</a>, <a href="../org.apache.nifi.PutHTMLElement/index.html">PutHTMLElement</a></p></body></html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-html-nar/1.3.0/org.apache.nifi.ModifyHTMLElement/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-html-nar/1.3.0/org.apache.nifi.ModifyHTMLElement/index.html?rev=1798216&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-html-nar/1.3.0/org.apache.nifi.ModifyHTMLElement/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-html-nar/1.3.0/org.apache.nifi.ModifyHTMLElement/index.html Fri Jun 9 13:20:11 2017
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ModifyHTMLElement</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">ModifyHTMLElement</h1><h2>Description: </h2><p>Modifies the value of an existing HTML element. The desired element to be modified is located by using CSS selector syntax. The incoming HTML is first converted into a HTML Document Object Model so that HTML elements may be selected in the similar manner that CSS selectors are used to apply styles to HTML. The resulting HTML DOM is then "queried" using the user defined CSS selector string to find the element the user desires to modify. If the HTML element is found the element's value is updated in the DOM using the value specified "Modified Value"
property. All DOM elements that match the CSS selector will be updated. Once all of the DOM elements have been updated the DOM is rendered to HTML and the result replaces the flowfile content with the updated HTML. A more thorough reference for the CSS selector syntax can be found at "http://jsoup.org/apidocs/org/jsoup/select/Selector.html"</p><h3>Tags: </h3><p>modify, html, dom, css, element</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>CSS Selector</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">CSS selec
tor syntax string used to extract the desired HTML element(s).<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>HTML Character Encoding</strong></td><td id="default-value">UTF-8</td><td id="allowable-values"></td><td id="description">Character encoding of the input HTML</td></tr><tr><td id="name"><strong>Output Type</strong></td><td id="default-value">HTML</td><td id="allowable-values"><ul><li>HTML</li><li>Text</li><li>Attribute</li></ul></td><td id="description">Controls whether the HTML element is output as HTML,Text or Data</td></tr><tr><td id="name"><strong>Modified Value</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Value to update the found HTML elements with<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Attribute Name</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">When modifying the value of an element attribute thi
s value is used as the key to determine which attribute on the selected element will be modified with the new value.<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>element not found</td><td>Element could not be found in the HTML document. The original HTML input will remain in the FlowFile content unchanged. Relationship 'original' will not be invoked in this scenario.</td></tr><tr><td>success</td><td>Successfully parsed HTML element</td></tr><tr><td>original</td><td>The original HTML input</td></tr><tr><td>invalid html</td><td>The input HTML syntax is invalid</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>NumElementsModified</td><td>Total number of HTML element modifications made</td></tr></table><h3>State management: </h3>This component do
es not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.<h3>See Also:</h3><p><a href="../org.apache.nifi.GetHTMLElement/index.html">GetHTMLElement</a>, <a href="../org.apache.nifi.PutHTMLElement/index.html">PutHTMLElement</a></p></body></html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-html-nar/1.3.0/org.apache.nifi.PutHTMLElement/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-html-nar/1.3.0/org.apache.nifi.PutHTMLElement/index.html?rev=1798216&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-html-nar/1.3.0/org.apache.nifi.PutHTMLElement/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-html-nar/1.3.0/org.apache.nifi.PutHTMLElement/index.html Fri Jun 9 13:20:11 2017
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutHTMLElement</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">PutHTMLElement</h1><h2>Description: </h2><p>Places a new HTML element in the existing HTML DOM. The desired position for the new HTML element is specified by using CSS selector syntax. The incoming HTML is first converted into a HTML Document Object Model so that HTML DOM location may be located in a similar manner that CSS selectors are used to apply styles to HTML. The resulting HTML DOM is then "queried" using the user defined CSS selector string to find the position where the user desires to add the new HTML element. Once the new HTML element is added to the DOM it is rendered to HTML and the
result replaces the flowfile content with the updated HTML. A more thorough reference for the CSS selector syntax can be found at "http://jsoup.org/apidocs/org/jsoup/select/Selector.html"</p><h3>Tags: </h3><p>put, html, dom, css, element</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>CSS Selector</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">CSS selector syntax string used to extract the desired HTML element(s).<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>HTML
Character Encoding</strong></td><td id="default-value">UTF-8</td><td id="allowable-values"></td><td id="description">Character encoding of the input HTML</td></tr><tr><td id="name"><strong>Element Insert Location Type</strong></td><td id="default-value">append-html</td><td id="allowable-values"><ul><li>append-html</li><li>prepend-html</li></ul></td><td id="description">Controls whether the new element is prepended or appended to the children of the Element located by the CSS selector. EX: prepended value '<b>Hi</b>' inside of Element (using CSS Selector 'p') '<p>There</p>' would result in '<p><b>Hi</b>There</p>'. Appending the value would result in '<p>There<b>Hi</b></p>'</td></tr><tr><td id="name"><strong>Put Value</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Value used when creating the new Element. Value should be a valid HTML element. The text should be suppli
ed unencoded: characters like '<', '>', etc will be properly HTML encoded in the resulting output.<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>element not found</td><td>Element could not be found in the HTML document. The original HTML input will remain in the FlowFile content unchanged. Relationship 'original' will not be invoked in this scenario.</td></tr><tr><td>success</td><td>Successfully parsed HTML element</td></tr><tr><td>original</td><td>The original HTML input</td></tr><tr><td>invalid html</td><td>The input HTML syntax is invalid</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.<h3>See Also:</h3><p
><a href="../org.apache.nifi.GetHTMLElement/index.html">GetHTMLElement</a>, <a href="../org.apache.nifi.ModifyHTMLElement/index.html">ModifyHTMLElement</a></p></body></html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-http-context-map-nar/1.3.0/org.apache.nifi.http.StandardHttpContextMap/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-http-context-map-nar/1.3.0/org.apache.nifi.http.StandardHttpContextMap/index.html?rev=1798216&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-http-context-map-nar/1.3.0/org.apache.nifi.http.StandardHttpContextMap/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-http-context-map-nar/1.3.0/org.apache.nifi.http.StandardHttpContextMap/index.html Fri Jun 9 13:20:11 2017
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>StandardHttpContextMap</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">StandardHttpContextMap</h1><h2>Description: </h2><p>Provides the ability to store and retrieve HTTP requests and responses external to a Processor, so that multiple Processors can interact with the same HTTP request.</p><h3>Tags: </h3><p>http, request, response</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>Maximum Outstanding Requests</strong></td><td id="default-value">5000</td><td id="allowable-values"></td><td id="description">The maximum number of HTTP requests that can be outstanding at any one time. Any attempt to register an additional HTTP Request will cause an error</td></tr><tr><td id="name"><strong>Request Expiration</strong></td><td id="default-value">1 min</td><td id="allowable-values"></td><td id="description">Specifies how long an HTTP Request should be left unanswered before being evicted from the cache and being responded to with a Service Unavailable status code</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>See Also:</h3><p><a href="../../../nifi-standard-nar/1.3.0/org.apache.nifi.processors.standard.HandleHttpRequest/index.html">HandleHttpRequest</a>, <a href="../../../nifi-standard-nar/1.3.0/org.apache.nifi.processors.standard.HandleHttpResponse/inde
x.html">HandleHttpResponse</a></p></body></html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-hwx-schema-registry-nar/1.3.0/org.apache.nifi.schemaregistry.hortonworks.HortonworksSchemaRegistry/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-hwx-schema-registry-nar/1.3.0/org.apache.nifi.schemaregistry.hortonworks.HortonworksSchemaRegistry/index.html?rev=1798216&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-hwx-schema-registry-nar/1.3.0/org.apache.nifi.schemaregistry.hortonworks.HortonworksSchemaRegistry/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-hwx-schema-registry-nar/1.3.0/org.apache.nifi.schemaregistry.hortonworks.HortonworksSchemaRegistry/index.html Fri Jun 9 13:20:11 2017
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>HortonworksSchemaRegistry</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">HortonworksSchemaRegistry</h1><h2>Description: </h2><p>Provides a Schema Registry Service that interacts with a Hortonworks Schema Registry, available at https://github.com/hortonworks/registry</p><h3>Tags: </h3><p>schema, registry, avro, hortonworks, hwx</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 Langua
ge</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>Schema Registry URL</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">URL of the schema registry that this Controller Service should connect to, including version. For example, http://localhost:9090/api/v1<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Cache Size</strong></td><td id="default-value">1000</td><td id="allowable-values"></td><td id="description">Specifies how many Schemas should be cached from the Hortonworks Schema Registry</td></tr><tr><td id="name"><strong>Cache Expiration</strong></td><td id="default-value">1 hour</td><td id="allowable-values"></td><td id="description">Specifies how long a Schema that is cached should remain in the cache. Once this time period elapses, a cached version of a schema will no longer be used, and the servi
ce will have to communicate with the Hortonworks Schema Registry again in order to obtain the schema.</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.</body></html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-ignite-nar/1.3.0/org.apache.nifi.processors.ignite.cache.GetIgniteCache/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-ignite-nar/1.3.0/org.apache.nifi.processors.ignite.cache.GetIgniteCache/index.html?rev=1798216&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-ignite-nar/1.3.0/org.apache.nifi.processors.ignite.cache.GetIgniteCache/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-ignite-nar/1.3.0/org.apache.nifi.processors.ignite.cache.GetIgniteCache/index.html Fri Jun 9 13:20:11 2017
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>GetIgniteCache</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">GetIgniteCache</h1><h2>Description: </h2><p>Get the byte array from Ignite Cache and adds it as the content of a FlowFile.The processor uses the value of FlowFile attribute (Ignite cache entry key) as the cache key lookup. If the entry corresponding to the key is not found in the cache an error message is associated with the FlowFile Note - The Ignite Kernel periodically outputs node performance statistics to the logs. This message can be turned off by setting the log level for logger 'org.apache.ignite' to WARN in the logback.xml configuration file.</p><h3>Tags: </h3><p>Ignite, get, read, cache
, key</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">Ignite Spring Properties Xml File</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Ignite spring configuration file, <path>/<ignite-configuration>.xml. If the configuration file is not provided, default Ignite configuration configuration is used which binds to 127.0.0.1:47500..47509</td></tr><tr><td id="name">Ignite Cache Name</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the ignite cache</td></tr><tr><td id="name
"><strong>Ignite Cache Entry Identifier</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A FlowFile attribute, or attribute expression used for determining Ignite cache key for the Flow File content<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>success</td><td>All FlowFiles that are written to Ignite cache are routed to this relationship</td></tr><tr><td>failure</td><td>All FlowFiles that cannot be written to Ignite cache 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>ignite.cache.get.failed.reason</td><td>The reason for getting entry from cache</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not
restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.<h3>See Also:</h3><p><a href="../org.apache.nifi.processors.ignite.cache.PutIgniteCache/index.html">PutIgniteCache</a></p></body></html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-ignite-nar/1.3.0/org.apache.nifi.processors.ignite.cache.PutIgniteCache/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-ignite-nar/1.3.0/org.apache.nifi.processors.ignite.cache.PutIgniteCache/index.html?rev=1798216&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-ignite-nar/1.3.0/org.apache.nifi.processors.ignite.cache.PutIgniteCache/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-ignite-nar/1.3.0/org.apache.nifi.processors.ignite.cache.PutIgniteCache/index.html Fri Jun 9 13:20:11 2017
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutIgniteCache</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">PutIgniteCache</h1><h2>Description: </h2><p>Stream the contents of a FlowFile to Ignite Cache using DataStreamer. The processor uses the value of FlowFile attribute (Ignite cache entry key) as the cache key and the byte array of the FlowFile as the value of the cache entry value. Both the string key and a non-empty byte array value are required otherwise the FlowFile is transferred to the failure relation. Note - The Ignite Kernel periodically outputs node performance statistics to the logs. This message can be turned off by setting the log level for logger 'org.apache.ignite' to WARN in the l
ogback.xml configuration file.</p><h3>Tags: </h3><p>Ignite, insert, update, stream, write, put, cache, key</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">Ignite Spring Properties Xml File</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Ignite spring configuration file, <path>/<ignite-configuration>.xml. If the configuration file is not provided, default Ignite configuration configuration is used which binds to 127.0.0.1:47500..47509</td></tr><tr><td id="name">Ignite Cache Name</td><td id="default-value"></td><td i
d="allowable-values"></td><td id="description">The name of the ignite cache</td></tr><tr><td id="name"><strong>Batch Size For Entries</strong></td><td id="default-value">250</td><td id="allowable-values"></td><td id="description">Batch size for entries (1-500).</td></tr><tr><td id="name"><strong>Ignite Cache Entry Identifier</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A FlowFile attribute, or attribute expression used for determining Ignite cache key for the Flow File content<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Data Streamer Per Node Parallel Operations</strong></td><td id="default-value">5</td><td id="allowable-values"></td><td id="description">Data streamer per node parallelism</td></tr><tr><td id="name"><strong>Data Streamer Per Node Buffer Size</strong></td><td id="default-value">250</td><td id="allowable-values"></td><td id="description">Data streamer per node buffer size (1-
500).</td></tr><tr><td id="name"><strong>Data Streamer Auto Flush Frequency in millis</strong></td><td id="default-value">10</td><td id="allowable-values"></td><td id="description">Data streamer flush interval in millis seconds</td></tr><tr><td id="name"><strong>Data Streamer Allow Override</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Whether to override values already in the cache</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>All FlowFiles that are written to Ignite cache are routed to this relationship</td></tr><tr><td>failure</td><td>All FlowFiles that cannot be written to Ignite cache 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>ignite.cache.batch.flow.fi
le.total.count</td><td>The total number of FlowFile in the batch</td></tr><tr><td>ignite.cache.batch.flow.file.item.number</td><td>The item number of FlowFile in the batch</td></tr><tr><td>ignite.cache.batch.flow.file.successful.number</td><td>The successful FlowFile item number</td></tr><tr><td>ignite.cache.batch.flow.file.successful.count</td><td>The number of successful FlowFiles</td></tr><tr><td>ignite.cache.batch.flow.file.failed.number</td><td>The failed FlowFile item number</td></tr><tr><td>ignite.cache.batch.flow.file.failed.count</td><td>The total number of failed FlowFiles in the batch</td></tr><tr><td>ignite.cache.batch.flow.file.failed.reason</td><td>The failed reason attribute key</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.<h3>See Also:</h3><p><a href="../org.apache.nifi.processors.ignite.cache.GetIgniteC
ache/index.html">GetIgniteCache</a></p></body></html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-jms-cf-service-nar/1.3.0/org.apache.nifi.jms.cf.JMSConnectionFactoryProvider/additionalDetails.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-jms-cf-service-nar/1.3.0/org.apache.nifi.jms.cf.JMSConnectionFactoryProvider/additionalDetails.html?rev=1798216&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-jms-cf-service-nar/1.3.0/org.apache.nifi.jms.cf.JMSConnectionFactoryProvider/additionalDetails.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-jms-cf-service-nar/1.3.0/org.apache.nifi.jms.cf.JMSConnectionFactoryProvider/additionalDetails.html Fri Jun 9 13:20:11 2017
@@ -0,0 +1,56 @@
+<!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>JMSConnectionFactoryProvider</title>
+ <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css" />
+ </head>
+
+ <body>
+ <h2>Description:</h2>
+ <p>
+ This ControllerService serves as a general factory service to serving vendor specific
+ instances of the <i>javax.jms.ConnectionFactory</i>. It does so by allowing user to
+ configure vendor specific properties as well as point to the location of the vendor
+ provided JMS client libraries so the correct implementation of the <i>javax.jms.ConnectionFactory</i>
+ can be found, loaded, instantiated and served to the dependent Processors (see PublishJMS, ConsumeJMS).
+ </p>
+ <p>
+ To accommodate variety of JMS vendors and their implementation of the <i>ConnectionFactory</i>
+ this ControllerService exposes only 3 static configuration properties that are common across many implementations
+ of the <i>ConnectionFactory</i>. The rest of the configuration properties are set following
+ <a href="http://docstore.mik.ua/orelly/java-ent/jnut/ch06_02.htm">Java Beans</a> convention (see below).
+ </p>
+ <p>
+ The 3 static configuration properties are:
+ <ul>
+ <li><b>MQ ConnectionFactory Implementation</b> - A fully qualified name of the JMS ConnectionFactory implementation
+ class (i.e., org.apache.activemq.ActiveMQConnectionFactory)</li>
+ <li><b>MQ Client Libraries path</b> - Path to the directory with additional resources (i.e., JARs, configuration files etc.) to be added
+ to the classpath. Such resources typically represent target MQ client libraries for the ConnectionFactory
+ implementation. It is optional if you are using Apache ActiveMQ since its libraries are distributed with this component.</li>
+ <li><b>Broker URI</b> - URI pointing to the network location of the JMS Message broker. For example, 'tcp://myhost:61616' for ActiveMQ or simply 'myhost:1414'.</li>
+ </ul>
+ The rest of the properties are set as Dynamic Properties following <a href="http://docstore.mik.ua/orelly/java-ent/jnut/ch06_02.htm">Java Beans</a>
+ convention where a property name is derived from the <i>set*</i> method of the vendor specific ConnectionFactory's implementation.
+ For example, <i>com.ibm.mq.jms.MQConnectionFactory.setChannel(String)</i> would imply 'channel' property and
+ <i>com.ibm.mq.jms.MQConnectionFactory.setTransportType(int)</i> would imply 'transportType' property.
+ For the list of available properties please consult vendor provided documentation. Here is an example for
+ <a href="https://www-01.ibm.com/support/knowledgecenter/SSFKSJ_8.0.0/com.ibm.mq.javadoc.doc/WMQJMSClasses/com/ibm/mq/jms/MQQueueConnectionFactory.html">IBM's com.ibm.mq.jms.MQConnectionFactory</a>
+ </p>
+ </body>
+</html>
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-jms-cf-service-nar/1.3.0/org.apache.nifi.jms.cf.JMSConnectionFactoryProvider/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-jms-cf-service-nar/1.3.0/org.apache.nifi.jms.cf.JMSConnectionFactoryProvider/index.html?rev=1798216&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-jms-cf-service-nar/1.3.0/org.apache.nifi.jms.cf.JMSConnectionFactoryProvider/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-jms-cf-service-nar/1.3.0/org.apache.nifi.jms.cf.JMSConnectionFactoryProvider/index.html Fri Jun 9 13:20:11 2017
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>JMSConnectionFactoryProvider</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">JMSConnectionFactoryProvider</h1><h2>Description: </h2><p>Provides a generic service to create vendor specific javax.jms.ConnectionFactory implementations. ConnectionFactory can be served once this service is configured successfully</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>jms, messaging, integration, queue, topic, publish, subscribe</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>MQ ConnectionFactory Implementation</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A fully qualified name of the JMS ConnectionFactory implementation class (i.e., org.apache.activemq.ActiveMQConnectionFactory)<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>MQ Client Libraries path (i.e., /usr/jms/lib)</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Path to the directory with additional resources (i.e., JARs, configuration files etc.) to be added to the classpath. Such resources typically represent target MQ client libraries for the ConnectionFactory implementation.<br/><strong>S
upports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Broker URI</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">URI pointing to the network location of the JMS Message broker. For example, 'tcp://myhost:61616' for ActiveMQ or 'myhost:1414' for IBM MQ<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><a href="../../../nifi-ssl-context-service-nar/1.3.0/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></td><td id="description">The SSL Context Service used to provide client certificate information for TLS/SSL connections.</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-pr
operties"><tr><th>Name</th><th>Value</th><th>Description</th></tr><tr><td id="name">The name of a Connection Factory configuration property.</td><td id="value">The value of a given Connection Factory configuration property.</td><td>The properties that are set following Java Beans convention where a property name is derived from the 'set*' method of the vendor specific ConnectionFactory's implementation. For example, 'com.ibm.mq.jms.MQConnectionFactory.setChannel(String)' would imply 'channel' property and 'com.ibm.mq.jms.MQConnectionFactory.setTransportType(int)' would imply 'transportType' property.</td></tr></table></p><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>See Also:</h3><p><a href="../../../nifi-jms-processors-nar/1.3.0/org.apache.nifi.jms.processors.ConsumeJMS/index.html">ConsumeJMS</a>, <a href="../../../nifi-jms-processors-nar/1.3.0/org.apache.nifi.jms.processors.PublishJMS/index.html">PublishJMS
</a></p></body></html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-jms-processors-nar/1.3.0/org.apache.nifi.jms.processors.ConsumeJMS/additionalDetails.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-jms-processors-nar/1.3.0/org.apache.nifi.jms.processors.ConsumeJMS/additionalDetails.html?rev=1798216&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-jms-processors-nar/1.3.0/org.apache.nifi.jms.processors.ConsumeJMS/additionalDetails.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-jms-processors-nar/1.3.0/org.apache.nifi.jms.processors.ConsumeJMS/additionalDetails.html Fri Jun 9 13:20:11 2017
@@ -0,0 +1,61 @@
+<!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>ConsumeJMS</title>
+ <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css" />
+</head>
+
+<body>
+<h2>Summary</h2>
+<p>
+ This processor consumes messages from JMS compliant messaging system and converts them to a FlowFile to be routed to the next component in the flow.
+</p>
+<p>
+ This processor does two things. It constructs FlowFile by extracting information from the consumed JMS message including body, standard
+ <a href="http://docs.spring.io/spring-integration/api/org/springframework/integration/jms/JmsHeaders.html">JMS Headers</a> and Properties.
+ The message body is written to a FlowFile while standard JMS Headers and Properties are set as FlowFile attributes.
+</p>
+
+<h2>Configuration Details</h2>
+<p>
+ At the time of writing this document it only defines the essential configuration properties which are suitable for most cases.
+ Other properties will be defined later as this component progresses.
+ Configuring ConsumeJMS:
+</p>
+<ol>
+ <li><b>User Name</b> - [OPTIONAL] User Name used for authentication and authorization when this processor obtains <i>javax.jms.Connection</i>
+ from the pre-configured <i>javax.jms.ConnectionFactory</i> (see below).
+ </li>
+ <li><b>Password</b> - [OPTIONAL] Password used in conjunction with <b>User Name</b>.
+ </li>
+ <li><b>Destination Name</b> - [REQUIRED] the name of the <i>javax.jms.Destination</i>.
+ Usually provided by administrator (e.g., 'topic://myTopic').
+ </li>
+ <li><b>Destination Type</b> - [OPTIONAL] the type of the <i>javax.jms.Destination</i>. Could be one of 'QUEUE' or 'TOPIC'
+ Usually provided by the administrator. Defaults to 'TOPIC'.
+ </li>
+ <li><b>Session Cache size</b> - [OPTIONAL] Specify the desired size for the JMS Session cache (per JMS Session type). This cache
+ size is the maximum limit for the number of cached Sessions.
+ Usually provided by the administrator (e.g., '2453'). Defaults to '1'.
+ </li>
+ <li><b>Connection Factory Service</b> - [REQUIRED] link to a pre-configured instance of org.apache.nifi.jms.cf.JMSConnectionFactoryProvider.
+ </li>
+</ol>
+
+</body>
+</html>
\ No newline at end of file