Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.PutDistributedMapCache/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.PutDistributedMapCache/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.PutDistributedMapCache/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.PutDistributedMapCache/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutDistributedMapCache</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Gets the content of a FlowFile and puts it to a distributed map cache, using a cache key computed from FlowFile attributes. If the cache already contains the entry and the cache update strategy is 'keep original' the entry is not replaced.'</p><h3>Tags: </h3><p>map, cache, put, distributed</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>Cache Entry Identifier</strong></td><td id="default-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 cache key<br/><strong>Supports Expression Language: true</strong></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 flow files</td></tr><tr><td id="name"><strong>Cache update strategy</strong></td><td id="default-value">replace</td><td id="allowable-values"><ul><li>Replace if present <img src="../../html/images/iconInfo.png" alt="Adds t he specified entry to the cache, replacing any value that is currently set." title="Adds the specified entry to the cache, replacing any value that is currently set."></img></li><li>Keep original <img src="../../html/images/iconInfo.png" alt="Adds the specified entry to the cache, if the key does not exist." title="Adds the specified entry to the cache, if the key does not exist."></img></li></ul></td><td id="description">Determines how the cache is updated if the cache already contains the entry</td></tr><tr><td id="name">Max cache entry size</td><td id="default-value">1 MB</td><td id="allowable-values"></td><td id="description">The maximum amount of data to put into cache</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 inserted into cache will be routed to this relationship</td></tr><tr><td>failure</td><td>Any FlowFile that cannot be inserted into the cache will b e 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>cached</td><td>All FlowFiles will have an attribute 'cached'. The value of this attribute is true, is the FlowFile is cached, otherwise false.</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>, <a href="../org.apache.nifi.processors.standard.FetchDistributedMapCache/index.html">FetchDistributedMapCache</a></p></body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutDistributedMapCache</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Gets the content of a FlowFile and puts it to a distributed map cache, using a cache key computed from FlowFile attributes. If the cache already contains the entry and the cache update strategy is 'keep original' the entry is not replaced.'</p><h3>Tags: </h3><p>map, cache, put, distributed</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>Cache Entry Identifier</strong></td><td id="default-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 cache key<br/><strong>Supports Expression Language: true</strong></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 flow files</td></tr><tr><td id="name"><strong>Cache update strategy</strong></td><td id="default-value">replace</td><td id="allowable-values"><ul><li>Replace if present <img src="../../html/images/iconInfo.png" alt="Adds t he specified entry to the cache, replacing any value that is currently set." title="Adds the specified entry to the cache, replacing any value that is currently set."></img></li><li>Keep original <img src="../../html/images/iconInfo.png" alt="Adds the specified entry to the cache, if the key does not exist." title="Adds the specified entry to the cache, if the key does not exist."></img></li></ul></td><td id="description">Determines how the cache is updated if the cache already contains the entry</td></tr><tr><td id="name">Max cache entry size</td><td id="default-value">1 MB</td><td id="allowable-values"></td><td id="description">The maximum amount of data to put into cache</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 inserted into cache will be routed to this relationship</td></tr><tr><td>failure</td><td>Any FlowFile that cannot be inserted into the cache will b e 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>cached</td><td>All FlowFiles will have an attribute 'cached'. The value of this attribute is true, is the FlowFile is cached, otherwise false.</td></tr></table><h3>State management: </h3>This processor has no state management.<h3>Restricted: </h3><h3>See Also:</h3><p><a href="../org.apache.nifi.distributed.cache.client.DistributedMapCacheClientService/index.html">DistributedMapCacheClientService</a>, <a href="../org.apache.nifi.distributed.cache.server.map.DistributedMapCacheServer/index.html">DistributedMapCacheServer</a>, <a href="../org.apache.nifi.processors.standard.FetchDistributedMapCache/index.html">FetchDistributedMapCache</a></p></body></html> \ No newline at end of file
Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.PutEmail/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.PutEmail/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.PutEmail/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.PutEmail/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutEmail</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Sends an e-mail to configured recipients for each incoming FlowFile</p><h3>Tags: </h3><p>email, put, notify, smtp</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>Allow able Values</th><th>Description</th></tr><tr><td id="name"><strong>SMTP Hostname</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The hostname of the SMTP host<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>SMTP Port</strong></td><td id="default-value">25</td><td id="allowable-values"></td><td id="description">The Port used for SMTP communications<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">SMTP Username</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Username for the SMTP account<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">SMTP Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Password for the SMTP account<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong> SMTP Auth</strong></td><td id="default-value">true</td><td id="allowable-values"></td><td id="description">Flag indicating whether authentication should be used<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>SMTP TLS</strong></td><td id="default-value">false</td><td id="allowable-values"></td><td id="description">Flag indicating whether TLS should be enabled<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>SMTP Socket Factory</strong></td><td id="default-value">javax.net.ssl.SSLSocketFactory</td><td id="allowable-values"></td><td id="description">Socket Factory to use for SMTP Connection<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>SMTP X-Mailer Header</strong></td><td id="default-value">NiFi</td><td id="allowable-values"></td><td id="description">X-Mailer used in the header of the outgoing email<br/><strong>Supports Expression Language: true</strong></ td></tr><tr><td id="name"><strong>Content Type</strong></td><td id="default-value">text/plain</td><td id="allowable-values"></td><td id="description">Mime Type used to interpret the contents of the email, such as text/plain or text/html<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>From</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Specifies the Email address to use as the sender<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">To</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The recipients to include in the To-Line of the email<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">CC</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The recipients to include in the CC-Line of the email<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td i d="name">BCC</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The recipients to include in the BCC-Line of the email<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Subject</strong></td><td id="default-value">Message from NiFi</td><td id="allowable-values"></td><td id="description">The email subject<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Message</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The body of the email message<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Attach File</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Specifies whether or not the FlowFile content should be attached to the email</td></tr><tr><td id="name"><strong>Include All Attributes In Message</strong></td ><td id="default-value">false</td><td >id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td >id="description">Specifies whether or not all FlowFile attributes should be >recorded in the body of the email message</td></tr></table><h3>Relationships: ></h3><table >id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>FlowFiles > that are successfully sent will be routed to this >relationship</td></tr><tr><td>failure</td><td>FlowFiles that fail to send >will be routed to this relationship</td></tr></table><h3>Reads Attributes: ></h3>None specified.<h3>Writes Attributes: </h3>None specified.</body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutEmail</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Sends an e-mail to configured recipients for each incoming FlowFile</p><h3>Tags: </h3><p>email, put, notify, smtp</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>Allow able Values</th><th>Description</th></tr><tr><td id="name"><strong>SMTP Hostname</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The hostname of the SMTP host<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>SMTP Port</strong></td><td id="default-value">25</td><td id="allowable-values"></td><td id="description">The Port used for SMTP communications<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">SMTP Username</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Username for the SMTP account<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">SMTP Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Password for the SMTP account<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong> SMTP Auth</strong></td><td id="default-value">true</td><td id="allowable-values"></td><td id="description">Flag indicating whether authentication should be used<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>SMTP TLS</strong></td><td id="default-value">false</td><td id="allowable-values"></td><td id="description">Flag indicating whether TLS should be enabled<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>SMTP Socket Factory</strong></td><td id="default-value">javax.net.ssl.SSLSocketFactory</td><td id="allowable-values"></td><td id="description">Socket Factory to use for SMTP Connection<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>SMTP X-Mailer Header</strong></td><td id="default-value">NiFi</td><td id="allowable-values"></td><td id="description">X-Mailer used in the header of the outgoing email<br/><strong>Supports Expression Language: true</strong></ td></tr><tr><td id="name"><strong>Content Type</strong></td><td id="default-value">text/plain</td><td id="allowable-values"></td><td id="description">Mime Type used to interpret the contents of the email, such as text/plain or text/html<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>From</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Specifies the Email address to use as the sender<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">To</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The recipients to include in the To-Line of the email<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">CC</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The recipients to include in the CC-Line of the email<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td i d="name">BCC</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The recipients to include in the BCC-Line of the email<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Subject</strong></td><td id="default-value">Message from NiFi</td><td id="allowable-values"></td><td id="description">The email subject<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Message</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The body of the email message<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Attach File</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Specifies whether or not the FlowFile content should be attached to the email</td></tr><tr><td id="name"><strong>Include All Attributes In Message</strong></td ><td id="default-value">false</td><td >id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td >id="description">Specifies whether or not all FlowFile attributes should be >recorded in the body of the email message</td></tr></table><h3>Relationships: ></h3><table >id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>FlowFiles > that are successfully sent will be routed to this >relationship</td></tr><tr><td>failure</td><td>FlowFiles that fail to send >will be routed to this relationship</td></tr></table><h3>Reads Attributes: ></h3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>State >management: </h3>This processor has no state management.<h3>Restricted: ></h3></body></html> \ No newline at end of file Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.PutFTP/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.PutFTP/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.PutFTP/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.PutFTP/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutFTP</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Sends FlowFiles to an FTP Server</p><h3>Tags: </h3><p>remote, copy, egress, put, ftp, archive, files</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>Hostname</strong></td><td >id="default-value"></td><td id="allowable-values"></td><td >id="description">The fully qualified hostname or IP address of the remote >system<br/><strong>Supports Expression Language: >true</strong></td></tr><tr><td id="name"><strong>Port</strong></td><td >id="default-value">21</td><td id="allowable-values"></td><td >id="description">The port that the remote system is listening on for file >transfers</td></tr><tr><td id="name"><strong>Username</strong></td><td >id="default-value"></td><td id="allowable-values"></td><td >id="description">Username</td></tr><tr><td id="name">Password</td><td >id="default-value"></td><td id="allowable-values"></td><td >id="description">Password for the user account<br/><strong>Sensitive >Property: true</strong></td></tr><tr><td id="name">Remote Path</td><td >id="default-value"></td><td id="allowable-values"></td><td >id="description">The path on the remote system from which to pull or push files<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Create Directory</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Specifies whether or not the remote directory should be created if it does not exist.</td></tr><tr><td id="name"><strong>Batch Size</strong></td><td id="default-value">500</td><td id="allowable-values"></td><td id="description">The maximum number of FlowFiles to send in a single connection</td></tr><tr><td id="name"><strong>Connection Timeout</strong></td><td id="default-value">30 sec</td><td id="allowable-values"></td><td id="description">Amount of time to wait before timing out while creating a connection</td></tr><tr><td id="name"><strong>Data Timeout</strong></td><td id="default-value">30 sec</td><td id="allowable-values"></td><td id="description">When transferring a file between the local and remote system, this value specifies how l ong is allowed to elapse without any data being transferred between systems</td></tr><tr><td id="name"><strong>Conflict Resolution</strong></td><td id="default-value">NONE</td><td id="allowable-values"><ul><li>REPLACE</li><li>IGNORE</li><li>RENAME</li><li>REJECT</li><li>FAIL</li><li>NONE</li></ul></td><td id="description">Determines how to handle the problem of filename collisions</td></tr><tr><td id="name">Dot Rename</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, then the filename of the sent file is prepended with a "." and then renamed back to the original once the file is completely sent. Otherwise, there is no rename. This property is ignored if the Temporary Filename property is set.</td></tr><tr><td id="name">Temporary Filename</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">If set, the filename of the sent file will be equal to the value specified during the transfer and after successful completion will be renamed to the original filename. If this value is set, the Dot Rename property is ignored.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Transfer Mode</td><td id="default-value">Binary</td><td id="allowable-values"><ul><li>Binary</li><li>ASCII</li></ul></td><td id="description">The FTP Transfer Mode</td></tr><tr><td id="name">Connection Mode</td><td id="default-value">Passive</td><td id="allowable-values"><ul><li>Active</li><li>Passive</li></ul></td><td id="description">The FTP Connection Mode</td></tr><tr><td id="name">Reject Zero-Byte Files</td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Determines whether or not Zero-byte files should be rejected without attempting to transfer</td></tr><tr><td id="name">Last Modified Time</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The lastMod ifiedTime to assign to the file after transferring it. If not set, the lastModifiedTime will not be changed. Format must be yyyy-MM-dd'T'HH:mm:ssZ. You may also use expression language such as ${file.lastModifiedTime}. If the value is invalid, the processor will not be invalid but will fail to change lastModifiedTime of the file.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Permissions</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The permissions to assign to the file after transferring it. Format must be either UNIX rwxrwxrwx with a - in place of denied permissions (e.g. rw-r--r--) or an octal number (e.g. 644). If not set, the permissions will not be changed. You may also use expression language such as ${file.permissions}. If the value is invalid, the processor will not be invalid but will fail to change permissions of the file.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id=" name"><strong>Use Compression</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 whether or not ZLIB compression should be used when transferring files</td></tr><tr><td id="name">Proxy Type</td><td id="default-value">DIRECT</td><td id="allowable-values"><ul><li>DIRECT</li><li>HTTP</li><li>SOCKS</li></ul></td><td id="description">Proxy type used for file transfers</td></tr><tr><td id="name">Proxy Host</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The fully qualified hostname or IP address of the proxy server</td></tr><tr><td id="name">Proxy Port</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The port of the proxy server</td></tr><tr><td id="name">Http Proxy Username</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Http Proxy Username</td></tr><tr><td id="name">Http Proxy Password</td> <td id="default-value"></td><td id="allowable-values"></td><td id="description">Http Proxy Password<br/><strong>Sensitive Property: 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">pre.cmd._____</td><td id="value">Not used</td><td>The command specified in the key will be executed before doing a put. You may add these optional properties to send any commands to the FTP server before the file is actually transferred (before the put command). This option is only available for the PutFTP processor, as only FTP has this functionality. This is essentially the same as sending quote commands to an FTP server from the command line. While this is the same as sending a quote command, it is very important that you leave off the .</td></tr><tr><td id="name">post.cmd._____</td><td id="value">Not used</td><td>The command specified in the key will be executed after doing a put. You may add these optional properties to send any commands to the FTP server before the file is actually transferred (before the put command). This option is only available for the PutFTP processor, as only FTP has this functionality. This is essentially the same as sending quote commands to an FTP server from the command line. While this is the same as sending a quote command, it is very important that you leave off the .</td></tr></table></p><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>FlowFiles that are successfully sent will be routed to success</td></tr><tr><td>reject</td><td>FlowFiles that were rejected by the destination system</td></tr><tr><td>failure</td><td>FlowFiles that failed to send to the remote system; failure is usually looped back to this processor</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3> Writes Attributes: </h3>None specified.<h3>See Also:</h3><p><a href="../org.apache.nifi.processors.standard.GetFTP/index.html">GetFTP</a></p></body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutFTP</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Sends FlowFiles to an FTP Server</p><h3>Tags: </h3><p>remote, copy, egress, put, ftp, archive, files</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>Hostname</strong></td><td >id="default-value"></td><td id="allowable-values"></td><td >id="description">The fully qualified hostname or IP address of the remote >system<br/><strong>Supports Expression Language: >true</strong></td></tr><tr><td id="name"><strong>Port</strong></td><td >id="default-value">21</td><td id="allowable-values"></td><td >id="description">The port that the remote system is listening on for file >transfers</td></tr><tr><td id="name"><strong>Username</strong></td><td >id="default-value"></td><td id="allowable-values"></td><td >id="description">Username</td></tr><tr><td id="name">Password</td><td >id="default-value"></td><td id="allowable-values"></td><td >id="description">Password for the user account<br/><strong>Sensitive >Property: true</strong></td></tr><tr><td id="name">Remote Path</td><td >id="default-value"></td><td id="allowable-values"></td><td >id="description">The path on the remote system from which to pull or push files<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Create Directory</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Specifies whether or not the remote directory should be created if it does not exist.</td></tr><tr><td id="name"><strong>Batch Size</strong></td><td id="default-value">500</td><td id="allowable-values"></td><td id="description">The maximum number of FlowFiles to send in a single connection</td></tr><tr><td id="name"><strong>Connection Timeout</strong></td><td id="default-value">30 sec</td><td id="allowable-values"></td><td id="description">Amount of time to wait before timing out while creating a connection</td></tr><tr><td id="name"><strong>Data Timeout</strong></td><td id="default-value">30 sec</td><td id="allowable-values"></td><td id="description">When transferring a file between the local and remote system, this value specifies how l ong is allowed to elapse without any data being transferred between systems</td></tr><tr><td id="name"><strong>Conflict Resolution</strong></td><td id="default-value">NONE</td><td id="allowable-values"><ul><li>REPLACE</li><li>IGNORE</li><li>RENAME</li><li>REJECT</li><li>FAIL</li><li>NONE</li></ul></td><td id="description">Determines how to handle the problem of filename collisions</td></tr><tr><td id="name">Dot Rename</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, then the filename of the sent file is prepended with a "." and then renamed back to the original once the file is completely sent. Otherwise, there is no rename. This property is ignored if the Temporary Filename property is set.</td></tr><tr><td id="name">Temporary Filename</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">If set, the filename of the sent file will be equal to the value specified during the transfer and after successful completion will be renamed to the original filename. If this value is set, the Dot Rename property is ignored.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Transfer Mode</td><td id="default-value">Binary</td><td id="allowable-values"><ul><li>Binary</li><li>ASCII</li></ul></td><td id="description">The FTP Transfer Mode</td></tr><tr><td id="name">Connection Mode</td><td id="default-value">Passive</td><td id="allowable-values"><ul><li>Active</li><li>Passive</li></ul></td><td id="description">The FTP Connection Mode</td></tr><tr><td id="name">Reject Zero-Byte Files</td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Determines whether or not Zero-byte files should be rejected without attempting to transfer</td></tr><tr><td id="name">Last Modified Time</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The lastMod ifiedTime to assign to the file after transferring it. If not set, the lastModifiedTime will not be changed. Format must be yyyy-MM-dd'T'HH:mm:ssZ. You may also use expression language such as ${file.lastModifiedTime}. If the value is invalid, the processor will not be invalid but will fail to change lastModifiedTime of the file.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Permissions</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The permissions to assign to the file after transferring it. Format must be either UNIX rwxrwxrwx with a - in place of denied permissions (e.g. rw-r--r--) or an octal number (e.g. 644). If not set, the permissions will not be changed. You may also use expression language such as ${file.permissions}. If the value is invalid, the processor will not be invalid but will fail to change permissions of the file.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id=" name"><strong>Use Compression</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 whether or not ZLIB compression should be used when transferring files</td></tr><tr><td id="name">Proxy Type</td><td id="default-value">DIRECT</td><td id="allowable-values"><ul><li>DIRECT</li><li>HTTP</li><li>SOCKS</li></ul></td><td id="description">Proxy type used for file transfers</td></tr><tr><td id="name">Proxy Host</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The fully qualified hostname or IP address of the proxy server</td></tr><tr><td id="name">Proxy Port</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The port of the proxy server</td></tr><tr><td id="name">Http Proxy Username</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Http Proxy Username</td></tr><tr><td id="name">Http Proxy Password</td> <td id="default-value"></td><td id="allowable-values"></td><td id="description">Http Proxy Password<br/><strong>Sensitive Property: 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">pre.cmd._____</td><td id="value">Not used</td><td>The command specified in the key will be executed before doing a put. You may add these optional properties to send any commands to the FTP server before the file is actually transferred (before the put command). This option is only available for the PutFTP processor, as only FTP has this functionality. This is essentially the same as sending quote commands to an FTP server from the command line. While this is the same as sending a quote command, it is very important that you leave off the .</td></tr><tr><td id="name">post.cmd._____</td><td id="value">Not used</td><td>The command specified in the key will be executed after doing a put. You may add these optional properties to send any commands to the FTP server before the file is actually transferred (before the put command). This option is only available for the PutFTP processor, as only FTP has this functionality. This is essentially the same as sending quote commands to an FTP server from the command line. While this is the same as sending a quote command, it is very important that you leave off the .</td></tr></table></p><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>FlowFiles that are successfully sent will be routed to success</td></tr><tr><td>reject</td><td>FlowFiles that were rejected by the destination system</td></tr><tr><td>failure</td><td>FlowFiles that failed to send to the remote system; failure is usually looped back to this processor</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3> Writes Attributes: </h3>None specified.<h3>State management: </h3>This processor has no state management.<h3>Restricted: </h3><h3>See Also:</h3><p><a href="../org.apache.nifi.processors.standard.GetFTP/index.html">GetFTP</a></p></body></html> \ No newline at end of file Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.PutFile/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.PutFile/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.PutFile/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.PutFile/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutFile</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Writes the contents of a FlowFile to the local file system</p><h3>Tags: </h3><p>put, local, copy, archive, files, filesystem</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>Directory</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The directory to which files should be written. You may use expression language such as /aa/bb/${path}<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Conflict Resolution Strategy</strong></td><td id="default-value">fail</td><td id="allowable-values"><ul><li>replace</li><li>ignore</li><li>fail</li></ul></td><td id="description">Indicates what should happen when a file with the same name already exists in the output directory</td></tr><tr><td id="name"><strong>Create Missing Directories</strong></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, then missing destination directories will be created. If false, flowfiles are penalized and sent to failure.</td></tr><tr><td id="name">Maximum File Count</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Specifies the maximum number of files that can exist in the output directory</td></tr><tr><td id="name">Last Modified Time</td><td id="default-value"></td><td id="all owable-values"></td><td id="description">Sets the lastModifiedTime on the output file to the value of this attribute. Format must be yyyy-MM-dd'T'HH:mm:ssZ. You may also use expression language such as ${file.lastModifiedTime}.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Permissions</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Sets the permissions on the output file to the value of this attribute. Format must be either UNIX rwxrwxrwx with a - in place of denied permissions (e.g. rw-r--r--) or an octal number (e.g. 644). You may also use expression language such as ${file.permissions}.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Owner</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Sets the owner on the output file to the value of this attribute. You may also use expression language such as ${file.owner}.<br/><strong>Supports Ex pression Language: true</strong></td></tr><tr><td id="name">Group</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Sets the group on the output file to the value of this attribute. You may also use expression language such as ${file.group}.<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>Files that have been successfully written to the output directory are transferred to this relationship</td></tr><tr><td>failure</td><td>Files that could not be written to the output directory for some reason are transferred to this relationship</td></tr></table><h3>Reads Attributes: </h3><table id="reads-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>filename</td><td>The filename to use when writing the FlowFile to disk.</td></tr></table><h3>Writes Attributes: </h3>None specified.<h3>See Also:</h3><p><a href=". ./org.apache.nifi.processors.standard.FetchFile/index.html">FetchFile</a>, <a href="../org.apache.nifi.processors.standard.GetFile/index.html">GetFile</a></p></body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutFile</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Writes the contents of a FlowFile to the local file system</p><h3>Tags: </h3><p>put, local, copy, archive, files, filesystem, restricted</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the <a href="../../html/expression-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Directory</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The directory to which files should be written. You may use expression l anguage such as /aa/bb/${path}<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Conflict Resolution Strategy</strong></td><td id="default-value">fail</td><td id="allowable-values"><ul><li>replace</li><li>ignore</li><li>fail</li></ul></td><td id="description">Indicates what should happen when a file with the same name already exists in the output directory</td></tr><tr><td id="name"><strong>Create Missing Directories</strong></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, then missing destination directories will be created. If false, flowfiles are penalized and sent to failure.</td></tr><tr><td id="name">Maximum File Count</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Specifies the maximum number of files that can exist in the output directory</td></tr><tr><td id="name">Last Modified Time</td><td id="default-value"></td ><td id="allowable-values"></td><td id="description">Sets the lastModifiedTime >on the output file to the value of this attribute. Format must be >yyyy-MM-dd'T'HH:mm:ssZ. You may also use expression language such as >${file.lastModifiedTime}.<br/><strong>Supports Expression Language: >true</strong></td></tr><tr><td id="name">Permissions</td><td >id="default-value"></td><td id="allowable-values"></td><td >id="description">Sets the permissions on the output file to the value of this >attribute. Format must be either UNIX rwxrwxrwx with a - in place of denied >permissions (e.g. rw-r--r--) or an octal number (e.g. 644). You may also use >expression language such as ${file.permissions}.<br/><strong>Supports >Expression Language: true</strong></td></tr><tr><td id="name">Owner</td><td >id="default-value"></td><td id="allowable-values"></td><td >id="description">Sets the owner on the output file to the value of this >attribute. You may also use expression language such as >${file.owner}.<br/><strong >Supports Expression Language: true</strong></td></tr><tr><td >id="name">Group</td><td id="default-value"></td><td >id="allowable-values"></td><td id="description">Sets the group on the output >file to the value of this attribute. You may also use expression language >such as ${file.group}.<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>Files > that have been successfully written to the output directory are transferred >to this relationship</td></tr><tr><td>failure</td><td>Files that could not be >written to the output directory for some reason are transferred to this >relationship</td></tr></table><h3>Reads Attributes: </h3><table >id="reads-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>filename</td><td>The > filename to use when writing the FlowFile to >disk.</td></tr></table><h3>Writes Attributes: </h3>None specified.<h3>State >managemen t: </h3>This processor has no state management.<h3>Restricted: </h3><td>Provides operator the ability to write to any file that NiFi has access to.</td><h3>See Also:</h3><p><a href="../org.apache.nifi.processors.standard.FetchFile/index.html">FetchFile</a>, <a href="../org.apache.nifi.processors.standard.GetFile/index.html">GetFile</a></p></body></html> \ No newline at end of file Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.PutJMS/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.PutJMS/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.PutJMS/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.PutJMS/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutJMS</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Creates a JMS Message from the contents of a FlowFile and sends the message to a JMS Server</p><h3>Tags: </h3><p>jms, send, put</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>JMS Provider</strong></td><td id="default-value">ActiveMQ</td><td id="allowable-values"><ul><li>ActiveMQ</li></ul></td><td id="description">The Provider used for the JMS Server</td></tr><tr><td id="name"><strong>URL</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The URL of the JMS Server</td></tr><tr><td id="name"><strong>Destination Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the JMS Topic or queue to use</td></tr><tr><td id="name"><strong>Destination Type</strong></td><td id="default-value">Queue</td><td id="allowable-values"><ul><li>Queue</li><li>Topic</li></ul></td><td id="description">The type of the JMS Destination to use</td></tr><tr><td id="name"><strong>Communications Timeout</strong></td><td id="default-value">30 sec</td><td id="allowable-values"></td><td id="description">The amount of time to wait when attempting to receive a message before giving up and assuming failure</td></tr><tr><td id="name"><strong>Message Batch Size</strong></td><td id="default-value">10</td><td id="allowable-values"></td><td id="description">The number of messages to pull/push in a single iteration of the processor</td></tr><tr><td id="name">Username</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Username used for authentication and authorization</td></tr><tr><td id="name">Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Password used for authentication and authorization<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name">SSL Context Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>SSLContextService<br/><strong>Implementation:</strong><br/><a href="../org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLConte xtService</a></td><td id="description">The Controller Service to use in order to obtain an SSL Context.</td></tr><tr><td id="name"><strong>Message Type</strong></td><td id="default-value">byte</td><td id="allowable-values"><ul><li>byte</li><li>stream</li><li>text</li><li>map</li><li>empty</li></ul></td><td id="description">The Type of JMS Message to Construct</td></tr><tr><td id="name">Message Priority</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The Priority of the Message<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Reply-To Queue</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the queue to which a reply to should be added<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Max Buffer Size</strong></td><td id="default-value">1 MB</td><td id="allowable-values"></td><td id="description">The maximum amount of data that can be buffered for a JMS Message. If a FlowFile's size exceeds this value, the FlowFile will be routed to failure.</td></tr><tr><td id="name">Message Time to Live</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The amount of time that the message should live on the destination before being removed; if not specified, the message will never expire.</td></tr><tr><td id="name"><strong>Copy Attributes to JMS Properties</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 FlowFile Attributes should be translated into JMS Message Properties. If true, all attributes starting with 'jms.' will be set as Properties on the JMS Message (without the 'jms.' prefix). If an attribute exists that starts with the same value but ends in '.type', that attribute will be used to determine the JMS Message Property type.</td></tr><tr><td id="name">Client ID Prefix</td><td id="defa ult-value"></td><td id="allowable-values"></td><td id="description">A human-readable ID that can be used to associate connections with yourself so that the maintainers of the JMS Server know who to contact if problems arise</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 sent to the JMS destination are routed to this relationship</td></tr><tr><td>failure</td><td>All FlowFiles that cannot be routed to the JMS destination are routed to this relationship</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>See Also:</h3><p><a href="../org.apache.nifi.processors.standard.GetJMSQueue/index.html">GetJMSQueue</a>, <a href="../org.apache.nifi.processors.standard.GetJMSTopic/index.html">GetJMSTopic</a></p></body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutJMS</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Creates a JMS Message from the contents of a FlowFile and sends the message to a JMS Server</p><h3>Tags: </h3><p>jms, send, put</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>JMS Provider</strong></td><td id="default-value">ActiveMQ</td><td id="allowable-values"><ul><li>ActiveMQ</li></ul></td><td id="description">The Provider used for the JMS Server</td></tr><tr><td id="name"><strong>URL</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The URL of the JMS Server</td></tr><tr><td id="name"><strong>Destination Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the JMS Topic or queue to use</td></tr><tr><td id="name"><strong>Destination Type</strong></td><td id="default-value">Queue</td><td id="allowable-values"><ul><li>Queue</li><li>Topic</li></ul></td><td id="description">The type of the JMS Destination to use</td></tr><tr><td id="name"><strong>Communications Timeout</strong></td><td id="default-value">30 sec</td><td id="allowable-values"></td><td id="description">The amount of time to wait when attempting to receive a message before giving up and assuming failure</td></tr><tr><td id="name"><strong>Message Batch Size</strong></td><td id="default-value">10</td><td id="allowable-values"></td><td id="description">The number of messages to pull/push in a single iteration of the processor</td></tr><tr><td id="name">Username</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Username used for authentication and authorization</td></tr><tr><td id="name">Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Password used for authentication and authorization<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name">SSL Context Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>SSLContextService<br/><strong>Implementation:</strong><br/><a href="../org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLConte xtService</a></td><td id="description">The Controller Service to use in order to obtain an SSL Context.</td></tr><tr><td id="name"><strong>Message Type</strong></td><td id="default-value">byte</td><td id="allowable-values"><ul><li>byte</li><li>stream</li><li>text</li><li>map</li><li>empty</li></ul></td><td id="description">The Type of JMS Message to Construct</td></tr><tr><td id="name">Message Priority</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The Priority of the Message<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Reply-To Queue</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the queue to which a reply to should be added<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Max Buffer Size</strong></td><td id="default-value">1 MB</td><td id="allowable-values"></td><td id="description">The maximum amount of data that can be buffered for a JMS Message. If a FlowFile's size exceeds this value, the FlowFile will be routed to failure.</td></tr><tr><td id="name">Message Time to Live</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The amount of time that the message should live on the destination before being removed; if not specified, the message will never expire.</td></tr><tr><td id="name"><strong>Copy Attributes to JMS Properties</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 FlowFile Attributes should be translated into JMS Message Properties. If true, all attributes starting with 'jms.' will be set as Properties on the JMS Message (without the 'jms.' prefix). If an attribute exists that starts with the same value but ends in '.type', that attribute will be used to determine the JMS Message Property type.</td></tr><tr><td id="name">Client ID Prefix</td><td id="defa ult-value"></td><td id="allowable-values"></td><td id="description">A human-readable ID that can be used to associate connections with yourself so that the maintainers of the JMS Server know who to contact if problems arise</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 sent to the JMS destination are routed to this relationship</td></tr><tr><td>failure</td><td>All FlowFiles that cannot be routed to the JMS destination are routed to this relationship</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>State management: </h3>This processor has no state management.<h3>Restricted: </h3><h3>See Also:</h3><p><a href="../org.apache.nifi.processors.standard.GetJMSQueue/index.html">GetJMSQueue</a>, <a href="../org.apache.nifi.processors.standard.GetJMSTopic/index.html">GetJMSTopic</a></p></body></html> \ No newline at end of file Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.PutSFTP/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.PutSFTP/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.PutSFTP/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.PutSFTP/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutSFTP</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Sends FlowFiles to an SFTP Server</p><h3>Tags: </h3><p>remote, copy, egress, put, sftp, archive, files</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>Hostname</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The fully qualified hostname or IP address of the remote system<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Port</strong></td><td id="default-value">22</td><td id="allowable-values"></td><td id="description">The port that the remote system is listening on for file transfers</td></tr><tr><td id="name"><strong>Username</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Username</td></tr><tr><td id="name">Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Password for the user account<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name">Private Key Path</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The fully qualified path to the Private Key file </td></tr><tr><td id="name">Private Key Passphrase</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Password for the private key<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name">Remote Path</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The path on the remote system from which to pull or push files<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Create Directory</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Specifies whether or not the remote directory should be created if it does not exist.</td></tr><tr><td id="name"><strong>Batch Size</strong></td><td id="default-value">500</td><td id="allowable-values"></td><td id="description">The maximum number of FlowFiles to send in a single connection</td></tr><tr><td id="name"><strong>Connection Timeout</strong></td>< td id="default-value">30 sec</td><td id="allowable-values"></td><td id="description">Amount of time to wait before timing out while creating a connection</td></tr><tr><td id="name"><strong>Data Timeout</strong></td><td id="default-value">30 sec</td><td id="allowable-values"></td><td id="description">When transferring a file between the local and remote system, this value specifies how long is allowed to elapse without any data being transferred between systems</td></tr><tr><td id="name"><strong>Conflict Resolution</strong></td><td id="default-value">NONE</td><td id="allowable-values"><ul><li>REPLACE</li><li>IGNORE</li><li>RENAME</li><li>REJECT</li><li>FAIL</li><li>NONE</li></ul></td><td id="description">Determines how to handle the problem of filename collisions</td></tr><tr><td id="name">Reject Zero-Byte Files</td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Determines whether or not Zero-byte files should b e rejected without attempting to transfer</td></tr><tr><td id="name">Dot Rename</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, then the filename of the sent file is prepended with a "." and then renamed back to the original once the file is completely sent. Otherwise, there is no rename. This property is ignored if the Temporary Filename property is set.</td></tr><tr><td id="name">Temporary Filename</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">If set, the filename of the sent file will be equal to the value specified during the transfer and after successful completion will be renamed to the original filename. If this value is set, the Dot Rename property is ignored.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Host Key File</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">If supplied, the given file will be used as the Host Key; otherwise, no use host key file will be used</td></tr><tr><td id="name">Last Modified Time</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The lastModifiedTime to assign to the file after transferring it. If not set, the lastModifiedTime will not be changed. Format must be yyyy-MM-dd'T'HH:mm:ssZ. You may also use expression language such as ${file.lastModifiedTime}. If the value is invalid, the processor will not be invalid but will fail to change lastModifiedTime of the file.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Permissions</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The permissions to assign to the file after transferring it. Format must be either UNIX rwxrwxrwx with a - in place of denied permissions (e.g. rw-r--r--) or an octal number (e.g. 644). If not set, the permissions will not be changed. You may also use expres sion language such as ${file.permissions}. If the value is invalid, the processor will not be invalid but will fail to change permissions of the file.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Remote Owner</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Integer value representing the User ID to set on the file after transferring it. If not set, the owner will not be set. You may also use expression language such as ${file.owner}. If the value is invalid, the processor will not be invalid but will fail to change the owner of the file.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Remote Group</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Integer value representing the Group ID to set on the file after transferring it. If not set, the group will not be set. You may also use expression language such as ${file.group}. If the value is inv alid, the processor will not be invalid but will fail to change the group of the file.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Strict Host Key Checking</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 whether or not strict enforcement of hosts keys should be applied</td></tr><tr><td id="name"><strong>Send Keep Alive On Timeout</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Indicates whether or not to send a single Keep Alive message when SSH socket times out</td></tr><tr><td id="name"><strong>Use Compression</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 whether or not ZLIB compression should be used when transferring files</td></tr></table><h3>Dynamic Propert ies: </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">Disable Directory Listing</td><td id="value">true or false</td><td>Disables directory listings before operations which might fail, such as configurations which create directory structures.</td></tr></table></p><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>FlowFiles that are successfully sent will be routed to success</td></tr><tr><td>reject</td><td>FlowFiles that were rejected by the destination system</td></tr><tr><td>failure</td><td>FlowFiles that failed to send to the remote system; failure is usually looped back to this processor</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>See Also:</h3><p><a href="../org.apache.nifi.processors.standard.GetSFTP/index.h tml">GetSFTP</a></p></body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutSFTP</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Sends FlowFiles to an SFTP Server</p><h3>Tags: </h3><p>remote, copy, egress, put, sftp, archive, files</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>Hostname</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The fully qualified hostname or IP address of the remote system<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Port</strong></td><td id="default-value">22</td><td id="allowable-values"></td><td id="description">The port that the remote system is listening on for file transfers</td></tr><tr><td id="name"><strong>Username</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Username</td></tr><tr><td id="name">Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Password for the user account<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name">Private Key Path</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The fully qualified path to the Private Key file </td></tr><tr><td id="name">Private Key Passphrase</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Password for the private key<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name">Remote Path</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The path on the remote system from which to pull or push files<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Create Directory</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Specifies whether or not the remote directory should be created if it does not exist.</td></tr><tr><td id="name"><strong>Batch Size</strong></td><td id="default-value">500</td><td id="allowable-values"></td><td id="description">The maximum number of FlowFiles to send in a single connection</td></tr><tr><td id="name"><strong>Connection Timeout</strong></td>< td id="default-value">30 sec</td><td id="allowable-values"></td><td id="description">Amount of time to wait before timing out while creating a connection</td></tr><tr><td id="name"><strong>Data Timeout</strong></td><td id="default-value">30 sec</td><td id="allowable-values"></td><td id="description">When transferring a file between the local and remote system, this value specifies how long is allowed to elapse without any data being transferred between systems</td></tr><tr><td id="name"><strong>Conflict Resolution</strong></td><td id="default-value">NONE</td><td id="allowable-values"><ul><li>REPLACE</li><li>IGNORE</li><li>RENAME</li><li>REJECT</li><li>FAIL</li><li>NONE</li></ul></td><td id="description">Determines how to handle the problem of filename collisions</td></tr><tr><td id="name">Reject Zero-Byte Files</td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Determines whether or not Zero-byte files should b e rejected without attempting to transfer</td></tr><tr><td id="name">Dot Rename</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, then the filename of the sent file is prepended with a "." and then renamed back to the original once the file is completely sent. Otherwise, there is no rename. This property is ignored if the Temporary Filename property is set.</td></tr><tr><td id="name">Temporary Filename</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">If set, the filename of the sent file will be equal to the value specified during the transfer and after successful completion will be renamed to the original filename. If this value is set, the Dot Rename property is ignored.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Host Key File</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">If supplied, the given file will be used as the Host Key; otherwise, no use host key file will be used</td></tr><tr><td id="name">Last Modified Time</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The lastModifiedTime to assign to the file after transferring it. If not set, the lastModifiedTime will not be changed. Format must be yyyy-MM-dd'T'HH:mm:ssZ. You may also use expression language such as ${file.lastModifiedTime}. If the value is invalid, the processor will not be invalid but will fail to change lastModifiedTime of the file.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Permissions</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The permissions to assign to the file after transferring it. Format must be either UNIX rwxrwxrwx with a - in place of denied permissions (e.g. rw-r--r--) or an octal number (e.g. 644). If not set, the permissions will not be changed. You may also use expres sion language such as ${file.permissions}. If the value is invalid, the processor will not be invalid but will fail to change permissions of the file.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Remote Owner</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Integer value representing the User ID to set on the file after transferring it. If not set, the owner will not be set. You may also use expression language such as ${file.owner}. If the value is invalid, the processor will not be invalid but will fail to change the owner of the file.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Remote Group</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Integer value representing the Group ID to set on the file after transferring it. If not set, the group will not be set. You may also use expression language such as ${file.group}. If the value is inv alid, the processor will not be invalid but will fail to change the group of the file.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Strict Host Key Checking</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 whether or not strict enforcement of hosts keys should be applied</td></tr><tr><td id="name"><strong>Send Keep Alive On Timeout</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Indicates whether or not to send a single Keep Alive message when SSH socket times out</td></tr><tr><td id="name"><strong>Use Compression</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 whether or not ZLIB compression should be used when transferring files</td></tr></table><h3>Dynamic Propert ies: </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">Disable Directory Listing</td><td id="value">true or false</td><td>Disables directory listings before operations which might fail, such as configurations which create directory structures.</td></tr></table></p><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>FlowFiles that are successfully sent will be routed to success</td></tr><tr><td>reject</td><td>FlowFiles that were rejected by the destination system</td></tr><tr><td>failure</td><td>FlowFiles that failed to send to the remote system; failure is usually looped back to this processor</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>State management: </h3>This processor has no state management.<h3>Restricted: </ h3><h3>See Also:</h3><p><a href="../org.apache.nifi.processors.standard.GetSFTP/index.html">GetSFTP</a></p></body></html> \ No newline at end of file
