http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/0fa553ac/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PostHTTP/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PostHTTP/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PostHTTP/index.html deleted file mode 100644 index b32a586..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PostHTTP/index.html +++ /dev/null @@ -1,187 +0,0 @@ -<!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>PostHTTP</title> - - - <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> - </head> - - <body> - - <!-- Processor Documentation ================================================== --> - <h2>Description:</h2> - <p>This processor performs an HTTP post with the content of - each incoming FlowFile. - </p> - - <p> - <strong>Uses Attributes:</strong> - </p> - <table border="1"> - <thead> - <tr> - <th>Attribute Name</th> - <th>Description</th> - </tr> - </thead> - <tbody> - <tr> - <td>mime.type</td> - <td>If not sending data as a FlowFile, the mime.type attribute will be used to set the HTTP Header for <code>Content-Type</code>.</td> - </tr> - </tbody> - </table> - - <p> - <strong>Properties:</strong> - </p> - <p>In the list below, the names of required properties appear - in bold. Any other properties (not in bold) are considered optional. - If a property has a default value, it is indicated. If a property - supports the use of the NiFi Expression Language (or simply, - "expression language"), that is also indicated.</p> - <ul> - <li><strong>URL</strong> - <ul> - <li>The URL to post to. The first part of the URL must be - static. However, the path of the URL may be defined using - NiFi Expression Language. For example, https://${hostname} - is not valid, but https://1.1.1.1:8080/files/${nf.file.name} is - valid.</li> - <li>Default value: no default</li> - <li>Supports expression language: true</li> - </ul></li> - <li>Max Batch Size - <ul> - <li>Specifies the max data size for a batch of FlowFiles to - send in a single HTTP POST. If nothing is specified, each FlowFile - will be sent separately.</li> - <li>Default value: 100 MB</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li>Max Data To Post per Second - <ul> - <li>The maximum amount of data to send per second. This allows - the bandwidth to be throttled to a specified data rate. If not - specified, the data rate is not throttled.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li>SSL Context Service - <ul> - <li>The Controller Service to use for obtaining an SSL Context. The SSL Context controller service is a mechanism for providing all the - security properties that allow for secure communications between NiFi extensions and other systems. See the User Guide or the Controller Services documentation - via the "help" link in the upper-right corner of the GUI for more information about the StandardSSLContextService. The value for this property is the - identifier name that is configured in the StandardSSLContextService.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li>Username - <ul> - <li>The username required to access the URL.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li>Password - <ul> - <li>The password required to access the URL.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li><strong>Send as FlowFile</strong> - <ul> - <li>A Boolean value (true/false), indicating whether to package - the FlowFile's contents and attributes together and send them as a - FlowFile package; otherwise, it will send only the FlowFile's - content.</li> - <li>Default value: false</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Use Chunked Encoding</strong> - <ul> - <li>Specifies whether to use chunked encoding to send the data. If false, the entire - content of the FlowFile will be buffered into memory. The default is true.</li> - <li>Default value: true</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Compression Level</strong> - <ul> - <li>Specifies the GZIP compression level to use when sending - the file. The value must be within the range of 0-9. A value of 0 - indicates that the file should not be GZIP'd.</li> - <li>Default value: 0</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Connection Timeout</strong> - <ul> - <li>The amount of time to wait before timing out while creating - a connection.</li> - <li>Default value: 30 sec</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Data Timeout</strong> - <ul> - <li>The amount of time to wait before timing out while - transferring data.</li> - <li>Default value: 30 sec</li> - <li>Supports expression language: false</li> - </ul></li> - <li>Attributes to Send as HTTP Headers (Regex) - <ul> - <li>Specifies the regular expression that determines the names - of FlowFile attributes that should be sent as HTTP headers.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li>User Agent - <ul> - <li>What to report as the user agent when a connection is made - to the remote server.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul> - </li> - </ul> - - <p> - <strong>Relationships:</strong> - </p> - <ul> - <li>failure - <ul> - <li>If something prevents the processor from successfully - posting the FlowFile, then the FlowFile follows this relationship.</li> - </ul> - </li> - <li>success - <ul> - <li>If the processor successfully posts the FlowFile, then it - follows this relationship.</li> - </ul> - </li> - </ul> - - </body> -</html>
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/0fa553ac/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PutEmail/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PutEmail/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PutEmail/index.html deleted file mode 100644 index 1160dba..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PutEmail/index.html +++ /dev/null @@ -1,114 +0,0 @@ -<!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>PutEmail</title> - - <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> - </head> - - <body> - <!-- Processor Documentation ================================================== --> - <h2>Description:</h2> - <p> - This processor sends an e-mail to configured recipients for each incoming FlowFile.</p> - <p> - <strong>Properties:</strong> - </p> - <p> - In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. If a property has a default value, it is indicated. If a property supports the use of the NiFi Expression Language (or simply, "expression language"), that is also indicated. - </p> - <ul> - <li><strong>SMTP Hostname</strong> - <ul> - <li>The hostname of the SMTP host.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>SMTP Port</strong> - <ul> - <li>The port used for SMTP communication.</li> - <li>Default value: 25</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>From</strong> - <ul> - <li>Specifies the email address to use as the sender.</li> - <li>Default value: no default</li> - <li>Supports expression language: true</li> - </ul></li> - <li>To - <ul> - <li>The recipients to include in the To line of the email.</li> - <li>Default value: no default</li> - <li>Supports expression language: true</li> - </ul></li> - <li>CC - <ul> - <li>The recipients to include in the CC line of the email.</li> - <li>Default value: no default</li> - <li>Supports expression language: true</li> - </ul></li> - <li>BCC - <ul> - <li>The recipients to include in the BCC line of the email.</li> - <li>Default value: no default</li> - <li>Supports expression language: true</li> - </ul></li> - <li><strong>Subject</strong> - <ul> - <li>This content will appear in the email Subject line.</li> - <li>Default value: Message from NiFi</li> - <li>Supports expression language: true</li> - </ul></li> - <li><strong>Message</strong> - <ul> - <li>The body of the email message.</li> - <li>Default value: no default</li> - <li>Supports expression language: true</li> - </ul></li> - <li><strong>Attach File</strong> - <ul> - <li>A Boolean value (true/false), indicating whether to attach the FlowFile content to the email.</li> - <li>Default value: false</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Include All Attributes In Message</strong> - <ul> - <li>A Boolean value (true/false), indicating whether or not all FlowFile attributes should be recorded - in the body of the email message.</li> - <li>Default value: false</li> - <li>Supports expression language: false</li> - </ul></li> - </ul> - <p> - <strong>Relationships:</strong> - </p> - <ul> - <li>failure - <ul> - <li>If FlowFiles fail to send, then they follow this relationship.</li> - </ul></li> - <li>success - <ul> - <li>If an email is successfully sent for a given FlowFile, then the FlowFile follows this relationship.</li> - </ul></li> - </ul> - - - </body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/0fa553ac/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PutFTP/additionalDetails.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PutFTP/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PutFTP/additionalDetails.html new file mode 100644 index 0000000..fbece63 --- /dev/null +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PutFTP/additionalDetails.html @@ -0,0 +1,66 @@ +<!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>PutFTP</title> + <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> + </head> + + <body> + <!-- Processor Documentation ================================================== --> + + <p> + <strong>Optional User-Defined Properties:</strong> + </p> + <ul> + <li>pre.cmd.# + <ul> + <li>Optional properties of this type can be added by the user and should be used for <strong>VERY + RARE</strong> cases only. You will know when you need to use it when the recipient specifies that you must + send FTP commands prior to the transfer. Otherwise, do not use it. 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. + </li> + <li><strong>NOTE</strong>: While this is the same as sending a quote command, it is very important that + you leave off the �quote� part of the command from the text value you enter in. For example, if you want + to mimic the command line ftp command quote stat you would give the text value of stat. You have the + option of sending a number of commands to the FTP server before the file is sent. If you have only one + command, then the name of the optional parameter will be pre.cmd.1. If you have a second command, then + the next optional parameter you give is pre.cmd.2, and so on. There is no limit to the number of pre + commands you can send. The commands will be sent in the order of their number, so pre.cmd.1 will be sent + first, pre.cmd.2 will be sent next, etc. This is true regardless of what order they are added to the + processor properties. The property names determine the order.</li> + <li><strong>NOTE</strong>: If the optional property name does not follow the pattern pre.cmd.<em>integer</em> + - then the command will not be sent. If a command is given which is not recognized by the server, then + that will be logged.</li> + <li>Supports expression language: true. FlowFile attributes can be used in commands using the expression language</li> + </ul> + </li> + <li>post.cmd.# + <ul> + <li>Optional properties of this type can be added by the user and should be used for <strong>VERY + RARE</strong> cases only. You will know when you need to use it when the recipient specifies that you must + send FTP commands after the transfer. Otherwise, do not use it. These are the same as the pre commands. + (See pre commands above) except that these commands are sent after the file transfer. + </li> + <li>Supports expression language: true. FlowFile attributes can be used in commands using the expression language</li> + </ul> + </li> + </ul> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/0fa553ac/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PutFTP/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PutFTP/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PutFTP/index.html deleted file mode 100644 index 2edee6a..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PutFTP/index.html +++ /dev/null @@ -1,283 +0,0 @@ -<!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>PutFTP</title> - <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> - </head> - - <body> - <!-- Processor Documentation ================================================== --> - <h2>Description:</h2> - <p> - This processor sends FlowFiles via FTP to an FTP server. - </p> - <p> - <strong>Properties:</strong> - </p> - <p> - In the list below, the names of required properties appear in bold. - Any other properties (not in bold) are considered optional. If a - property has a default value, it is indicated. If a property supports - the use of the NiFi Expression Language (or simply, - "expression language"), that is also indicated. - </p> - <ul> - <li> - <strong>Hostname</strong> - <ul> - <li>The fully qualified hostname or IP address of the remote - system.</li> - <li>Default value: no default</li> - <li>Supports expression language: true</li> - </ul> - </li> - <li> - <strong>Port</strong> - <ul> - <li>The port that the remote system is listening on for file transfers.</li> - <li>Default value: 21</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li> - <strong>Username</strong> - <ul> - <li>The username for the user account.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li> - Password - <ul> - <li>The password for the user account.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li> - Remote Path - <ul> - <li>The path on the remote system to which files should be put. If not specified, uses the user's home directory. You may use expression language such as /aa/bb/${path}.</li> - <li>Default value: no default</li> - <li>Supports expression language: true</li> - </ul> - </li> - <li><strong>Create Directory</strong> - <ul> - <li>Specifies whether or not the remote directory should be created if it does not exist. Recommend setting to true when Remote Path uses expression language.</li> - <li>Default value: false</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li> - <strong>Batch Size</strong> - <ul> - <li>The maximum number of FlowFiles to send in a single connection.</li> - <li>Default value: 500</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li> - <strong>Connection Timeout</strong> - <ul> - <li>The amount of time to wait before timing out while creating a - connection.</li> - <li>Default value: 30 sec</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li> - <strong>Data Timeout</strong> - <ul> - <li>The amount of time to wait before timing out while transferring - data.</li> - <li>Default value: 30 sec</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li> - <strong>Conflict Resolution</strong> - <ul> - <li> - Specifies what action the processor should take if a conflict - prevents it from delivering the files. Valid options are: - <ul> - <li>replace</li> - <li>ignore</li> - <li>rename</li> - <li>reject</li> - <li>fail</li> - <li>NONE</li> - </ul> - </li> - <li>Default value: NONE</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li> - Dot Rename - <ul> - <li>A Boolean value (true/false), indicating whether to prepend the - filename of the file with a dot (.) while the file is transferring - and remove the dot when the file is completely transferred.</li> - <li>Default value: true</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li> - Temporary Filename - <ul> - <li>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. - </li> - <li>Default value: no default</li> - <li>Supports expression language: true</li> - </ul> - </li> - <li> - Transfer Mode - <ul> - <li> - The FTP transfer mode. Valid options are: Binary or ASCII. - </li> - <li>Default value: Binary</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li> - Connection Mode - <ul> - <li> - The FTP connection mode. Valid options are: Active or Passive. - For most clients, this should be set to Passive.</li> - <li>Default value: Passive</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li> - Reject Zero-Byte Files - <ul> - <li>A Boolean value (true/false), indicating whether to reject - files that have zero bytes of content rather than transferring - them. </li> - <li>Default value: true</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li>Last Modified Time - <ul> - <li>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.</li> - <li>Default value: no default</li> - <li>Supports expression language: true</li> - </ul> - </li> - <li>Permissions - <ul> - <li>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. - </li> - <li>Default value: no default</li> - <li>Supports expression language: true</li> - </ul> - </li> - <li> - <strong>Use Compression</strong> - <ul> - <li>A Boolean value (true/false), indicating whether to use ZLIB - compression when transferring files.</li> - <li>Default value: false</li> - <li>Supports expression language: false</li> - </ul> - </li> - </ul> - <p> - <strong>Optional User-Defined Properties:</strong> - </p> - <p> - <ul> - <li>pre.cmd.# - <ul> - <li>Optional properties of this type can be added by the user and should be used for <strong>VERY - RARE</strong> cases only. You will know when you need to use it when the recipient specifies that you must - send FTP commands prior to the transfer. Otherwise, do not use it. 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. - </li> - <li><strong>NOTE</strong>: While this is the same as sending a quote command, it is very important that - you leave off the âquoteâ part of the command from the text value you enter in. For example, if you want - to mimic the command line ftp command quote stat you would give the text value of stat. You have the - option of sending a number of commands to the FTP server before the file is sent. If you have only one - command, then the name of the optional parameter will be pre.cmd.1. If you have a second command, then - the next optional parameter you give is pre.cmd.2, and so on. There is no limit to the number of pre - commands you can send. The commands will be sent in the order of their number, so pre.cmd.1 will be sent - first, pre.cmd.2 will be sent next, etc. This is true regardless of what order they are added to the - processor properties. The property names determine the order.</li> - <li><strong>NOTE</strong>: If the optional property name does not follow the pattern pre.cmd.<em>integer</em> - - then the command will not be sent. If a command is given which is not recognized by the server, then - that will be logged.</li> - <li>Supports expression language: true. FlowFile attributes can be used in commands using the expression language</li> - </ul> - </li> - <li>post.cmd.# - <ul> - <li>Optional properties of this type can be added by the user and should be used for <strong>VERY - RARE</strong> cases only. You will know when you need to use it when the recipient specifies that you must - send FTP commands after the transfer. Otherwise, do not use it. These are the same as the pre commands. - (See pre commands above) except that these commands are sent after the file transfer. - </li> - <li>Supports expression language: true. FlowFile attributes can be used in commands using the expression language</li> - </ul> - </li> - </ul> - </p> - - <p> - <strong>Relationships:</strong> - </p> - <ul> - <li> - failure - <ul> - <li>If something prevents a FlowFile from being transferred, then - it follows this relationship.</li> - </ul> - </li> - <li> - reject - <ul> - <li>FlowFiles that were rejected by the destination system follow this relationship.</li> - </ul> - </li> - <li> - success - <ul> - <li>If a FlowFile is successfully transferred, then it follows this - relationship.</li> - </ul> - </li> - </ul> -</body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/0fa553ac/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PutFile/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PutFile/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PutFile/index.html deleted file mode 100644 index bdb40d6..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PutFile/index.html +++ /dev/null @@ -1,109 +0,0 @@ -<!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>PutFile</title> - - <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> - </head> - - <body> - <!-- Processor Documentation ================================================== --> - <h2>Description:</h2> - <p> - This processor writes FlowFiles to the local file system.</p> - <p> - <strong>Properties:</strong> - </p> - <p> - In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. If a property has a default value, it is indicated. If a property supports the use of the NiFi Expression Language (or simply, "expression language"), that is also indicated. - </p> - <ul> - <li><strong>Directory</strong> - <ul> - <li>The local file path to the location where files should be written. You may use expression language such as /aa/bb/${path}.</li> - <li>Default value: no default</li> - <li>Supports expression language: true</li> - </ul></li> - <li><strong>Keep Directory Structure</strong> - <ul> - <li>A Boolean value (true/false), indicating whether to maintain the file structure and write FlowFiles to subdirectories of the file path defined in the Directory property. - <b>Note:</b> This property is maintained for backward compatibility purposes but is considered "Deprecated" and should not be used (value should remain 'false'). - Rather than using this property, if the goal is to append the FlowFile's path to the <code>/aa/bb directory</code>, for example, the <code>Directory</code> property should - instead be set to <code>/aa/bb/${path}</code>. - </li> - <li>Default value: false</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Conflict Resolution Strategy</strong> - <ul> - <li>Indicates what should happen if the processor cannot write a file to the file path defined in the Directory property. This could happen, for example, if a file of the same name already exists in the directory. Valid options can be selected from the drop-down menu and include: - <ul> - <li>replace</li> - <li>ignore</li> - <li>fail</li> - </ul></li> - <li>Default value: fail</li> - <li>Supports expression language: false</li> - </ul></li> - <li>Maximum File Count - <ul> - <li>The maximum number of files that can exist in the output directory.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul></li> - <li>Last Modified Time - <ul> - <li>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}.</li> - <li>Default value: no default</li> - <li>Supports expression language: true</li> - </ul></li> - <li>Permissions - <ul> - <li>Sets the read/write/execute 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}.</li> - <li>Default value: no default</li> - <li>Supports expression language: true</li> - </ul></li> - <li>Owner - <ul> - <li>Sets the owner on the output file to the value of this attribute. You may also use expression language such as ${file.owner}. Normal access rules apply, meaning your system may not let you change file ownership.</li> - <li>Default value: no default</li> - <li>Supports expression language: true</li> - </ul></li> - <li>Group - <ul> - <li>Sets the group on the output file to the value of this attribute. You may also use expression language such as ${file.group}. Normal access rules apply, meaning your system may not let you change group ownership.</li> - <li>Default value: no default</li> - <li>Supports expression language: true</li> - </ul></li> - </ul> - <p> - <strong>Relationships:</strong> - </p> - <ul> - <li>failure - <ul> - <li>If something prevents a FlowFile from being written to its destination directory, then it follows this relationship.</li> - </ul></li> - <li>success - <ul> - <li>If a FlowFile is successfully written to its destination directory, then it follows this relationship.</li> - </ul></li> - </ul> - - </body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/0fa553ac/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PutJMS/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PutJMS/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PutJMS/index.html deleted file mode 100644 index 387d03c..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PutJMS/index.html +++ /dev/null @@ -1,152 +0,0 @@ -<!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>PutJMS</title> - - <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> - </head> - - <body> - <!-- Processor Documentation ================================================== --> - <h2>Description:</h2> - <p> - This processor creates a JMS message from the contents of a FlowFile and sends the message to a JMS server.</p> - <p> - <strong>Properties:</strong> - </p> - <p> - In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. If a property has a default value, it is indicated. If a property supports the use of the NiFi Expression Language (or simply, "expression language"), that is also indicated. - </p> - <ul> - <li><strong>JMS Provider</strong> - <ul> - <li>This property specifies the provider used for the JMS server. Available options include: - <ul> - <li>ActiveMQ</li> - </ul></li> - <li>Default value: ActiveMQ</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>URL</strong> - <ul> - <li>The URL of the JMS server.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Destination Name</strong> - <ul> - <li>The name of the JMS topic of queue to use.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Destination Type</strong> - <ul> - <li>The type of JMS Destination to use. Options are Queue and Topic.</li> - <li>Default value: Queue</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Communications Timeout</strong> - <ul> - <li>The amount of time to wait when attempting to receive a message before giving up and assuming failure.</li> - <li>Default value: 30 sec</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Batch Size</strong> - <ul> - <li>The number of messages to Put in a single iteration of the processor</li> - <li>Default value: 10</li> - <li>Supports expression language: false</li> - </ul></li> - <li>Username - <ul> - <li>The username used for authentication and authorization.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul></li> - <li>Password - <ul> - <li>The password used for authentication and authorization.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Message Type</strong> - <ul> - <li>The type of JMS message to construct. Available options include: - <ul> - <li>byte</li> - <li>stream</li> - <li>text</li> - <li>empty</li> - </ul></li> - <li>Default value: byte</li> - <li>Supports expression language: false</li> - </ul></li> - <li>Message Priority - <ul> - <li>The priority of the message.</li> - <li>Default value: no default</li> - <li>Supports expression language: true</li> - </ul></li> - <li>Reply-to Queue - <ul> - <li>The name of the queue to which a reply should be added.</li> - <li>Default value: no default</li> - <li>Supports expression language: true</li> - </ul></li> - <li><strong>Max Buffer Size</strong> - <ul> - <li>The maximum amount of data that can be buffered for a JMS message. If a FlowFile's size exceeds this value, it will be routed to failure. </li> - <li>Default value: 1 MB</li> - <li>Supports expression language: false</li> - </ul></li> - <li>Message Time to Live - <ul> - <li>The amount of time that the message should live on the destination before being removed; if not specified, the message will never expire.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul></li> - <li>Copy Attributes to JMS Properties - <ul> - <li>A Boolean value (true/false), indicating whether 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. </li> - <li>Default value: true</li> - <li>Supports expression language: false</li> - </ul></li> - <li>Client ID Prefix - <ul> - <li>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.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul></li> - </ul> - <p> - <strong>Relationships:</strong> - </p> - <ul> - <li>failure - <ul> - <li>If something prevents a FlowFile from being routed to the JMS destination, then it follows this relationship.</li> - </ul></li> - <li>success - <ul> - <li>If a FlowFile is successfully routed to the JMS destination, then it follows this relationship.</li> - </ul></li> - </ul> - - - </body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/0fa553ac/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PutSFTP/additionalDetails.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PutSFTP/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PutSFTP/additionalDetails.html new file mode 100644 index 0000000..656e150 --- /dev/null +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PutSFTP/additionalDetails.html @@ -0,0 +1,34 @@ +<!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>PutSFTP</title> + <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> + </head> + + <body> + <!-- Processor Documentation ================================================== --> + <p> + <strong>See Also:</strong> + </p> + <ul> + <li> + <a href="../org.apache.nifi.processors.standard.GetSFTP/index.html">GetSFTP</a> + </li> + </ul> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/0fa553ac/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PutSFTP/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PutSFTP/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PutSFTP/index.html deleted file mode 100644 index 8f30e7b..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PutSFTP/index.html +++ /dev/null @@ -1,281 +0,0 @@ -<!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>PutSFTP</title> - <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> - </head> - - <body> - <!-- Processor Documentation ================================================== --> - <h2>Description:</h2> - <p> - This processor sends FlowFiles via SFTP to an SFTP server. - </p> - <p> - <strong>Properties:</strong> - </p> - <p> - In the list below, the names of required properties appear in bold. - Any other properties (not in bold) are considered optional. If a - property has a default value, it is indicated. If a property supports - the use of the NiFi Expression Language (or simply, - "expression language"), that is also indicated. - </p> - <ul> - <li> - <strong>Hostname</strong> - <ul> - <li>The fully qualified hostname or IP address of the remote - system.</li> - <li>Default value: no default</li> - <li>Supports expression language: true</li> - </ul> - </li> - <li> - <strong>Port</strong> - <ul> - <li>The port that the remote system is listening on for file transfers.</li> - <li>Default value: 22</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li> - <strong>Username</strong> - <ul> - <li>The username for the user account.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li> - Password - <ul> - <li>The password for the user account.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li> - Private Key Path - <ul> - <li>The fully qualified path for the private key file.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li> - Private Key Passphrase - <ul> - <li>The password for the private key.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li> - Remote Path - <ul> - <li>The path on the remote system to which files should be transferred. If not specified, the user's home directory will be used. You may use expression language such as /aa/bb/${path}.</li> - <li>Default value: no default</li> - <li>Supports expression language: true</li> - </ul> - </li> - <li><strong>Create Directory</strong> - <ul> - <li>Specifies whether or not the remote directory should be created if it does not exist. Recommend setting to true when Remote Path uses expression language.</li> - <li>Default value: false</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li><strong>Batch Size</strong> - <ul> - <li>The maximum number of FlowFiles to send in a single connection.</li> - <li>Default value: 500</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li> - <strong>Connection Timeout</strong> - <ul> - <li>The amount of time to wait before timing out while creating a - connection. </li> - <li>Default value: 30 sec</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li> - <strong>Data Timeout</strong> - <ul> - <li>The amount of time to wait before timing out while transferring - data. </li> - <li>Default value: 30 sec</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li> - <strong>Conflict Resolution</strong> - <ul> - <li>Specifies what action the processor should take if a conflict - prevents it from delivering the files. Valid options are:</li> - <ul> - <li>replace</li> - <li>ignore</li> - <li>rename</li> - <li>reject</li> - <li>fail</li> - <li>NONE</li> - </ul> - <li>Default value: NONE</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li> - Reject Zero-Byte Files - <ul> - <li>A Boolean value (true/false), indicating whether to reject - files that have zero bytes of content rather than transferring - them.</li> - <li>Default value: true</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li> - Dot Rename - <ul> - <li>A Boolean value (true/false), indicating whether to prepend the - filename of the file with a dot (.) while the file is transferring - and remove the dot when the file is completely transferred.</li> - <li>Default value: true</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li>Temporary Filename - <ul> - <li>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. - </li> - <li>Default value: no default</li> - <li>Supports expression language: true</li> - </ul> - </li> - <li> - Host Key File - <ul> - <li>The local file path to the host key file; if not supplied, no - host key file will be used. </li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li>Last Modified Time - <ul> - <li>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.</li> - <li>Default value: no default</li> - <li>Supports expression language: true</li> - </ul> - </li> - <li>Permissions - <ul> - <li>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. - </li> - <li>Default value: no default</li> - <li>Supports expression language: true</li> - </ul> - </li> - <li>Remote Owner - <ul> - <li>Integer value representing the User ID to set on the file after transferring it. If not set, the - owner will not be changed. 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.</li> - <li>Default value: no default</li> - <li>Supports expression language: true</li> - </ul> - </li> - <li>Remote Group - <ul> - <li>Integer value representing the Group ID to set on the file after transferring it. If not set, the - group will not be changed. You may also use expression language such as ${file.group}. If the value is - invalid, the processor will not be invalid but will fail to change the group of the file.</li> - <li>Default value: no default</li> - <li>Supports expression language: true</li> - </ul> - </li> - <li> - <strong>Strict Host Key Checking</strong> - <ul> - <li>A Boolean value (true/false), indicating whether to apply - strict enforcement of host keys. </li> - <li>Default value: false</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li> - <strong>Use Compression</strong> - <ul> - <li>A Boolean value (true/false), indicating whether to use ZLIB - compression when transferring files.</li> - <li>Default value: false</li> - <li>Supports expression language: false</li> - </ul> - </li> - </ul> - - <p> - <strong>Relationships:</strong> - </p> - <ul> - <li> - failure - <ul> - <li>If FlowFiles fail to be transferred, then they follow this - relationship.</li> - </ul> - </li> - <li> - reject - <ul> - <li>If the property Reject Zero-Byte Files is set to true and - incoming FlowFiles meet this criteria, then they follow this - relationship.</li> - </ul> - </li> - <li> - success - <ul> - <li>If FlowFiles are successfully transferred, then they follow - this relationship.</li> - </ul> - </li> - </ul> - - <p> - <strong>See Also:</strong> - <ul> - <li> - <a href="../org.apache.nifi.processors.standard.GetSFTP/index.html">GetSFTP</a> - </li> - </ul> - </p> -</body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/0fa553ac/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ReplaceText/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ReplaceText/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ReplaceText/index.html deleted file mode 100644 index ffcf205..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ReplaceText/index.html +++ /dev/null @@ -1,91 +0,0 @@ -<!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>ReplaceText</title> - - <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> - </head> - - <body> - <!-- Processor Documentation ================================================== --> - <h2>Description:</h2> - <p> - This processor updates the content of a FlowFile by evaluating a regular expression (regex) against the content and replacing the section of content that matches the regular expression with an alternate, user-defined, value. - </p> - <p> - <strong>Properties:</strong> - </p> - <p> - In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. If a property has a default value, it is indicated. If a property supports the use of the NiFi Expression Language (or simply, "expression language"), that is also indicated. - </p> - <ul> - <li><strong>Regular Expression</strong> - <ul> - <li>The regular expression to use to evaluate the FlowFile content. While the Expression Language may be used here, the values returned by the Expression Language will be escaped. I.e., they will not be interpreted as Regular Expressions but will be interpreted as literal values. - For example, if you have an attribute named <code>X</code> with the value <code>H.*o</code> and want it to match against "Hello", you cannot do this by referencing <code>${X}</code>. Rather, a reference to <code>${X}</code> - will reference the exact literal <code>H.*o</code> - </li> - <li>Default value: (.*) </li> - <li>Supports expression language: true</li> - </ul></li> - <li><strong>Replacement Value</strong> - <ul> - <li>The value to replace matching content with. Back-references to Regular Expression capturing groups are supported, but back-references that reference capturing groups that do not exist in the regular expression are treated as literal values.</li> - <li>Default value: $1</li> - <li>Supports expression language: true</li> - </ul></li> - <li><strong>Character Set</strong> - <ul> - <li>The character set in which the file is encoded.</li> - <li>Default value: UTF-8</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Evaluation Mode</strong> - <ul> - <li>Evaluate the 'Regular Expression' against each line (Line-by-Line) or buffer the entire file into memory (Entire Text) and then evaluate the 'Regular Expression'.</li> - <li>Default value: Entire text</li> - <li>Supports expression language: false</li> - </ul></li> - <li>Maximum Buffer Size - <ul> - <li>Specifies the maximum amount of data to buffer (per file or per line, depending on the Evaluation Mode) in order to apply the regular expressions. If 'Entire Text' Mode is selected and the FlowFile is larger than this value, the FlowFile will be routed to 'failure'. - In 'Line-by-Line' Mode, if a single line is larger than this value, the FlowFile will be routed to 'failure'. A default value of 1 MB is provided, primarily for 'Entire Text' mode. In 'Line-by-Line' Mode, a value such as 8 KB or 16 KB is suggested. - This value is ignored and the buffer is not used if 'Regular Expression' is set to '.*' - </li> - <li>Default value: 1MB</li> - <li>Supports expression language: false</li> - </ul></li> - </ul> - - <p> - <strong>Relationships:</strong> - </p> - <ul> - <li>failure - <ul> - <li>If FlowFiles cannot be updated, then they follow this relationship.</li> - </ul></li> - <li>success - <ul> - <li>If FlowFiles are successfully updated, then they follow this relationship.</li> - </ul></li> - </ul> - - - </body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/0fa553ac/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ReplaceTextWithMapping/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ReplaceTextWithMapping/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ReplaceTextWithMapping/index.html deleted file mode 100644 index 1d2eb2c..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ReplaceTextWithMapping/index.html +++ /dev/null @@ -1,114 +0,0 @@ -<!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>ReplaceText</title> - - <link rel="stylesheet" href="../../css/component-usage.css" type="text/css"> - </head> - - <body> - <!-- Processor Documentation ================================================== --> - <h2>Description:</h2> - <p> - This processor updates the content of a FlowFile by evaluating a - regular - expression (regex) against the content and replacing the section of - content that matches a specified matching group of the - regular expression with an alternate, - user-defined, value provided in a mapping file. The mapping - file is formatted as one key/value pair per line, seperated by tabs. - </p> - <p> - <strong>Properties:</strong> - </p> - <p> - In the list below, the names of required properties appear in bold. - Any other properties (not in bold) are considered optional. If a - property has a default value, it is indicated. If a property supports - the use of the NiFi Expression Language (or simply, "expression - language"), that is also indicated. - </p> - <ul> - <li><strong>Regular Expression</strong> - <ul> - <li>The regular expression to use to evaluate the FlowFile - content.</li> - <li>Default value: (\\S+) </li> - <li>Supports expression language: true</li> - </ul> - </li> - <li><strong>Matching Group</strong> - <ul> - <li>The number of the matching group of the provided regex - to replace - with the corresponding value from the mapping file (if it exists).</li> - <li>Default value: 0</li> - <li>Supports expression language: true</li> - </ul> - </li> - <li><strong>Mapping File</strong> - <ul> - <li>The name of the file (including the full path) - containing the Mappings.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li><strong>Mapping File Refresh Interval</strong> - <ul> - <li>The polling interval in seconds to check for updates to - the mapping file.</li> - <li>Default value: 60s</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li><strong>Character Set</strong> - <ul> - <li>The character set in which the file is encoded.</li> - <li>Default value: UTF-8</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li><strong>Maximum Buffer Size</strong> - <ul> - <li>Specifies the maximum amount of data to buffer (per - file) in order to apply the regular expression. If a FlowFile is larger - than this value, then the FlowFile is routed to the failure - relationship.</li> - <li>Default value: 1MB</li> - <li>Supports expression language: false</li> - </ul> - </li> - </ul> - <p> - <strong>Relationships:</strong> - </p> - <ul> - <li>failure - <ul> - <li>If FlowFiles cannot be updated, then they follow this - relationship.</li> - </ul> - </li> - <li>success - <ul> - <li>If FlowFiles are successfully updated, then they follow - this relationship.</li> - </ul> - </li> - </ul> - </body></html> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/0fa553ac/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.RouteOnAttribute/additionalDetails.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.RouteOnAttribute/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.RouteOnAttribute/additionalDetails.html new file mode 100644 index 0000000..9bd3c38 --- /dev/null +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.RouteOnAttribute/additionalDetails.html @@ -0,0 +1,46 @@ +<!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>RouteOnAttribute</title> + + <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> + </head> + + <body> + <h2>Description:</h2> + <p> + This processor routes FlowFiles based on their attributes + using the NiFi Expression Language. Users add properties with + valid NiFi Expression Language Expressions as the values. Each Expression must + return a value of type Boolean (true or false). + </p> + <p> + Example: The goal is to route all files with filenames that start with ABC down a certain path. + Add a property with the following name and value: + </p> + <ul> + <li><strong>property name</strong>: ABC + </li> + <li><strong>property value</strong>: ${filename:startsWith('ABC')} + </li> + </ul> + <p> + In this example, all files with filenames that start with ABC will follow the ABC relationship. + </p> + </body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/0fa553ac/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.RouteOnAttribute/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.RouteOnAttribute/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.RouteOnAttribute/index.html deleted file mode 100644 index 5b7f820..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.RouteOnAttribute/index.html +++ /dev/null @@ -1,110 +0,0 @@ -<!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>RouteOnAttribute</title> - - <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> - </head> - - <body> - <h2>Description:</h2> - <p> - This processor routes FlowFiles based on their attributes - using the NiFi Expression Language. Users add properties with - valid NiFi Expression Language Expressions as the values. Each Expression must - return a value of type Boolean (true or false). - </p> - <p> - Example: The goal is to route all files with filenames that start with ABC down a certain path. - Add a property with the following name and value: - </p> - <ul> - <li><strong>property name</strong>: ABC - </li> - <li><strong>property value</strong>: ${filename:startsWith('ABC')} - </li> - </ul> - <p> - In this example, all files with filenames that start with ABC will follow the ABC relationship. - </p> - - <p> - <strong>Properties:</strong> - </p> - <p> - In the list below, the names of required properties appear - in bold. - </p> - - <ul> - <li><strong>Routing Strategy</strong> - <ul> - <li>Specifies how to determine which relationship to use when - evaluating the expression language. Options are: - <ul> - <li><b>Route to Property Name</b> - For each property that has been added, if its Expression evaluates to <code>true</code> - for a given FlowFile, that FlowFile will be routed to the Relationship whose name is defined by the property name. - If multiple properties' Expressions evaluate to <code>true</code>, a clone of the FlowFile will be created - for each relationship.</li> - - <li><b>Route to 'match' if all match</b> - If all configured Expressions evaluate to <code>true</code> - for a given FlowFile, that FlowFile will be routed to 'matched'; otherwise, the FlowFile will be - routed to 'unmatched'.</li> - - <li><b>Route to 'match' if any matches</b> - If any configured Expression evaluates to <code>true</code> - for a given FlowFile, that FlowFile will be routed to 'matched'; otherwise, the FlowFile will be - routed to 'unmatched'.</li> - </ul> - </li> - <li>Default value: Route to Property Name</li> - <li>Supports expression language: false</li> - </ul></li> - </ul> - - <p> - <strong>Relationships:</strong> - </p> - <ul> - <li>matched - <ul> - <li>If the Routing Strategy selected is either Route to 'match' - if all match or Route to 'match' if any matches, then this - relationship becomes available and FlowFiles meeting those - conditions follow this relationship.</li> - </ul> - </li> - <li>unmatched - <ul> - <li>FlowFiles that do not match any user-defined expression - will be routed to this relationship.</li> - </ul> - </li> - <li>user-added relationships - <ul> - <li>User-added properties result in new relationships; if a - FlowFile's attributes match the criteria specified in the - user-added properties, then it follows the associated - relationship(s).</li> - </ul> - </li> - </ul> - - - - </body> -</html>
