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.RouteOnContent/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.RouteOnContent/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.RouteOnContent/index.html deleted file mode 100644 index 039a142..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.RouteOnContent/index.html +++ /dev/null @@ -1,82 +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>RouteOnContent</title> - - <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> - </head> - - <body> - <!-- Processor Documentation ================================================== --> - <h2>Description:</h2> - <p> - This processor applies user-added regular expressions to the content of a FlowFile and routes a copy of the FlowFile to each destination whose regular expression matches. The user adds properties where the name is the relationship that the FlowFile should follow if it matches the regular expression, which is defined as the property's value. User-defined properties do support the NiFi Expression Language, but in such cases, the results are interpreted as literal values, not regular expressions. - <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>Match Requirement</strong> - <ul> - <li>Specifies whether the entire content of the FlowFile must match the regular expression exactly, or if any part of the content (up to a certain point) can contain the regular expression in order to be considered a match. Available options: - <ul> - <li>content must match exactly</li> - <li>content must contain match</li> - </ul></li> - <li>Default value: content must match exactly</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>Content Buffer Size</strong> - <ul> - <li>Specifies the maximum amount of data to buffer in order to apply the regular expressions. If the size of the FlowFile exceeds this value, any amount of this value is ignored. </li> - <li>Default value: 1 MB</li> - <li>Supports expression language: false</li> - </ul></li> - <li>User-Defined Properties - <ul> - <li>Users add properties with regular expressions (see the description above).</li> - <li>User-defined properties do support the NiFi Expression Language, but in such cases, the results are interpreted as literal values, not regular expressions.</li> - </ul></li> - </ul> - - <p> - <strong>Relationships:</strong> - </p> - <ul> - <li>unmatched - <ul> - <li>FlowFiles that do not match any user-defined criteria follow this relationship.</li> - </ul></li> - <li>user-defined relationships - <ul> - <li>User-added properties result in new relationships; if a FlowFile's content matches the criteria specified in the user-added properties, then it follows the associated relationship(s).</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.ScanAttribute/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ScanAttribute/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ScanAttribute/index.html deleted file mode 100644 index 3c4317f..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ScanAttribute/index.html +++ /dev/null @@ -1,85 +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>ScanAttribute</title> - - <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> - </head> - - <body> - <!-- Processor Documentation ================================================== --> - <h2>Description:</h2> - <p> - This processor scans the specified attributes of FlowFiles, checking to see if any of their values are present within the specified dictionary of terms. - <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>Dictionary File</strong> - <ul> - <li>The local file path to a new-line-delimited text file that includes terms that should trigger a match. Empty lines are ignored.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Attribute Pattern</strong> - <ul> - <li>A Java regular expression that specifies the names of attributes whose values will be matched against the terms in the dictionary file.</li> - <li>Default value: .*</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Match Criteria</strong> - <ul> - <li>If set to "All Must Match", then FlowFiles will be routed to the matched relationship only if all specified attributes' values are found in the dictionary file. If set to "At Least 1 Must Match", then FlowFiles will be routed to "matched" if any attribute specified is found in the dictionary file. </li> - <li>Default value: At Least 1 Must Match</li> - <li>Supports expression language: false</li> - </ul></li> - <!-- - <li><strong>Attribute Value Match Criteria</strong> - <ul> - <li>If set to "All of the Value", a dictionary value needs to match the complete attribute value. If set to "Part of the Value", the dictionary value match part of the attribute value. </li> - <li>Default value: Match All of the Value</li> - <li>Supports expression language: false</li> - </ul></li> - --> - <li>Dictionary Filter Pattern - <ul> - <li>A Java regular expression that will be applied to each line in the dictionary file. If the regular expression does not match the line, then the line will not be included in the list of terms to search for. If a Matching Group is specified, only the portion of the term that matches that Matching Group will be used instead of the entire term. If not specified, all terms in the dictionary will be used and each term will consist of the text of the entire line in the file.</li> - <li>Supports expression language: false</li> - </ul></li> - </ul> - - <p> - <strong>Relationships:</strong> - </p> - <ul> - <li>matched - <ul> - <li>FlowFiles whose attributes are found in the dictionary file follow this relationship.</li> - </ul></li> - <li>unmatched - <ul> - <li>FlowFiles whose attributes are not found in the dictionary file 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.ScanContent/additionalDetails.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ScanContent/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ScanContent/additionalDetails.html new file mode 100644 index 0000000..5be4580 --- /dev/null +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ScanContent/additionalDetails.html @@ -0,0 +1,45 @@ +<!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>ScanContent</title> + + <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> + </head> + + <body> + <!-- Processor Documentation ================================================== --> + + <p> + <strong>Modifies Attributes:</strong> + </p> + <table border="1"> + <thead> + <tr> + <th>Attribute Name</th> + <th>Description</th> + </tr> + </thead> + <tbody> + <tr> + <td>matching.term</td> + <td>The term that caused the Processor to route the FlowFile to the 'matched' relationship; if FlowFile is routed to the 'unmatched' relationship, this attribute is not added.</td> + </tr> + </tbody> + </table> + </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.ScanContent/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ScanContent/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ScanContent/index.html deleted file mode 100644 index aa49861..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ScanContent/index.html +++ /dev/null @@ -1,100 +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>ScanContent</title> - - <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> - </head> - - <body> - <!-- Processor Documentation ================================================== --> - <h2>Description:</h2> - <p>This processor scans the content of FlowFiles for terms that - are found in a user-supplied dictionary file. If a term is matched, - the UTF-8 encoded version of the term is added to the FlowFile using - the matching.term attribute. This allows for follow-on processors to - use the value of the matching.term attribute to make routing decisions - and so forth. - </p> - - <p> - <strong>Modifies Attributes:</strong> - </p> - <table border="1"> - <thead> - <tr> - <th>Attribute Name</th> - <th>Description</th> - </tr> - </thead> - <tbody> - <tr> - <td>matching.term</td> - <td>The term that caused the Processor to route the FlowFile to the 'matched' relationship; if FlowFile is routed to the 'unmatched' relationship, this attribute is not added.</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>Dictionary File</strong> - <ul> - <li>The local file path and filename for the dictionary file.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Dictionary Encoding</strong> - <ul> - <li>Indicates how the dictionary file is encoded. If the - default value text is used, the dictionary terms are expected to be - new-line delimited and UTF-8 encoded. If the value binary is used, - the dictionary terms are expected to be denoted by a 4-byte integer - indicating the term length, followed by the term itself.</li> - <li>Default value: text</li> - <li>Supports expression language: false</li> - </ul></li> - </ul> - - <p> - <strong>Relationships:</strong> - </p> - <ul> - <li>matched - <ul> - <li>If FlowFiles match at least one term in the dictionary - file, then they follow this relationship.</li> - </ul> - </li> - <li>unmatched - <ul> - <li>If FlowFiles do not match any term in the dictionary file, - 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.SegmentContent/additionalDetails.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.SegmentContent/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.SegmentContent/additionalDetails.html new file mode 100644 index 0000000..9e71b83 --- /dev/null +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.SegmentContent/additionalDetails.html @@ -0,0 +1,82 @@ +<!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>SegmentContent</title> + + <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> + </head> + + <body> + <!-- Processor Documentation ================================================== --> + + <p> + <strong>Adds or Modifies Attributes:</strong> + </p> + <table border="1"> + <thead> + <tr> + <th>Attribute Name</th> + <th>Description</th> + </tr> + </thead> + <tbody> + <tr> + <td>segment.identifier</td> + <td>All segments produced from the same parent FlowFile will have the same randomly generated UUID added for this attribute. This attribute is added to maintain backward compatibility, but the fragment.identifier is preferred, as it is designed to work in conjunction with the MergeContent Processor.</td> + </tr> + <tr> + <td>segment.index</td> + <td>A one-up number that indicates the ordering of the segments that were created from a single parent FlowFile. This attribute is added to maintain backward compatibility, but the fragment.index is preferred, as it is designed to work in conjunction with the MergeContent Processor.</td> + </tr> + <tr> + <td>segment.count</td> + <td>The number of segments generated from the parent FlowFile. This attribute is added to maintain backward compatibility, but the fragment.count is preferred, as it is designed to work in conjunction with the MergeContent Processor.</td> + </tr> + + <tr> + <td>fragment.identifier</td> + <td>All segments produced from the same parent FlowFile will have the same randomly generated UUID added for this attribute.</td> + </tr> + <tr> + <td>fragment.index</td> + <td>A one-up number that indicates the ordering of the segments that were created from a single parent FlowFile.</td> + </tr> + <tr> + <td>fragment.count</td> + <td>The number of segments generated from the parent FlowFile.</td> + </tr> + + <tr> + <td>segment.original.filename</td> + <td>The filename of the parent FlowFile</td> + </tr> + <tr> + <td>filename</td> + <td>The filename will be updated to include the parent's filename, the segment index, and the segment count.</td> + </tr> + </tbody> + </table> + <p> + <strong>See Also:</strong> + </p> + <ul> + <li><a href="../org.apache.nifi.processors.standard.MergeContent/index.html">MergeContent</a> - can defragment FlowFiles + that have been segmented.</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.SegmentContent/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.SegmentContent/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.SegmentContent/index.html deleted file mode 100644 index d969fd9..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.SegmentContent/index.html +++ /dev/null @@ -1,123 +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>SegmentContent</title> - - <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> - </head> - - <body> - <!-- Processor Documentation ================================================== --> - <h2>Description:</h2> - <p>This processor segments a FlowFile into multiple smaller segments on byte boundaries. Each segment is given attributes that can - then be used by the MergeContent processor to reconstruct the original FlowFile.</p> - - <p> - <strong>Adds or Modifies Attributes:</strong> - </p> - <table border="1"> - <thead> - <tr> - <th>Attribute Name</th> - <th>Description</th> - </tr> - </thead> - <tbody> - <tr> - <td>segment.identifier</td> - <td>All segments produced from the same parent FlowFile will have the same randomly generated UUID added for this attribute. This attribute is added to maintain backward compatibility, but the fragment.identifier is preferred, as it is designed to work in conjunction with the MergeContent Processor.</td> - </tr> - <tr> - <td>segment.index</td> - <td>A one-up number that indicates the ordering of the segments that were created from a single parent FlowFile. This attribute is added to maintain backward compatibility, but the fragment.index is preferred, as it is designed to work in conjunction with the MergeContent Processor.</td> - </tr> - <tr> - <td>segment.count</td> - <td>The number of segments generated from the parent FlowFile. This attribute is added to maintain backward compatibility, but the fragment.count is preferred, as it is designed to work in conjunction with the MergeContent Processor.</td> - </tr> - - <tr> - <td>fragment.identifier</td> - <td>All segments produced from the same parent FlowFile will have the same randomly generated UUID added for this attribute.</td> - </tr> - <tr> - <td>fragment.index</td> - <td>A one-up number that indicates the ordering of the segments that were created from a single parent FlowFile.</td> - </tr> - <tr> - <td>fragment.count</td> - <td>The number of segments generated from the parent FlowFile.</td> - </tr> - - <tr> - <td>segment.original.filename</td> - <td>The filename of the parent FlowFile</td> - </tr> - <tr> - <td>filename</td> - <td>The filename will be updated to include the parent's filename, the segment index, and the segment count.</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>Segment Size</strong> - <ul> - <li>The maximum data size for each segment. The value must be a - non-negative integer followed by a supported Data Unit, such as B, - KB, MB, GB, or TB. Example: 1 MB.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul></li> - </ul> - - <p> - <strong>Relationships:</strong> - </p> - <ul> - <li>original - <ul> - <li>The original FlowFile will be sent to this relationship.</li> - </ul> - </li> - <li>segments - <ul> - <li>All segments will be sent to this relationship. If the file - was small enough that it was not segmented, then a copy of the - original is sent to this relationship as well as original.</li> - </ul> - </li> - </ul> - - <p> - <strong>See Also:</strong> - </p> - <ul> - <li><a href="../org.apache.nifi.processors.standard.MergeContent/index.html">MergeContent</a> - can defragment FlowFiles - that have been segmented.</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.SplitContent/additionalDetails.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.SplitContent/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.SplitContent/additionalDetails.html new file mode 100644 index 0000000..fec022f --- /dev/null +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.SplitContent/additionalDetails.html @@ -0,0 +1,67 @@ +<!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>SplitContent</title> + + <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> + </head> + + <body> + <!-- Processor Documentation ================================================== --> + + <p> + <strong>Modifies Attributes:</strong> + </p> + <table border="1"> + <thead> + <tr> + <th>Attribute Name</th> + <th>Description</th> + </tr> + </thead> + <tbody> + <tr> + <td>fragment.identifier</td> + <td>All split FlowFiles produced from the same parent FlowFile will have the same randomly generated + UUID added for this attribute.</td> + </tr> + <tr> + <td>fragment.index</td> + <td>A one-up number that indicates the ordering of the split FlowFiles that were created from a + single parent FlowFile.</td> + </tr> + <tr> + <td>fragment.count</td> + <td>The number of split FlowFiles generated from the parent FlowFile.</td> + </tr> + <tr> + <td>segment.original.filename</td> + <td>The filename of the parent FlowFile. + </td> + </tr> + </tbody> + </table> + <p> + <strong>See Also:</strong> + </p> + <ul> + <li><a href="../org.apache.nifi.processors.standard.MergeContent/index.html">MergeContent</a> - can defragment FlowFiles + that have been split if <em>Keep Byte Sequence</em> is set to true.</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.SplitContent/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.SplitContent/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.SplitContent/index.html deleted file mode 100644 index 98e7260..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.SplitContent/index.html +++ /dev/null @@ -1,107 +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>SplitContent</title> - - <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> - </head> - - <body> - <!-- Processor Documentation ================================================== --> - <h2>Description:</h2> - <p> - This processor splits incoming FlowFiles by a specified byte sequence. - </p> - - <p> - <strong>Modifies Attributes:</strong> - </p> - <table border="1"> - <thead> - <tr> - <th>Attribute Name</th> - <th>Description</th> - </tr> - </thead> - <tbody> - <tr> - <td>fragment.identifier</td> - <td>All split FlowFiles produced from the same parent FlowFile will have the same randomly generated - UUID added for this attribute.</td> - </tr> - <tr> - <td>fragment.index</td> - <td>A one-up number that indicates the ordering of the split FlowFiles that were created from a - single parent FlowFile.</td> - </tr> - <tr> - <td>fragment.count</td> - <td>The number of split FlowFiles generated from the parent FlowFile.</td> - </tr> - <tr> - <td>segment.original.filename</td> - <td>The filename of the parent FlowFile. - </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>Byte Sequence</strong> - <ul> - <li>A hex representation of bytes to look for and upon which to split the source file into separate files. This value must be a valid hex string.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Keep Byte Sequence</strong> - <ul> - <li>A Boolean value (true/false), indicating whether the byte sequence should be included at the end of each split. </li> - <li>Default value: false</li> - <li>Supports expression language: false</li> - </ul></li> - </ul> - - <p> - <strong>Relationships:</strong> - </p> - <ul> - <li>original - <ul> - <li>A copy of the original FlowFile follows this relationship.</li> - </ul></li> - <li>splits - <ul> - <li>The resulting split files that are produced by this processor follow this relationship.</li> - </ul></li> - </ul> - - <p> - <strong>See Also:</strong> - </p> - <ul> - <li><a href="../org.apache.nifi.processors.standard.MergeContent/index.html">MergeContent</a> - can defragment FlowFiles - that have been split if <em>Keep Byte Sequence</em> is set to true.</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.SplitText/additionalDetails.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.SplitText/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.SplitText/additionalDetails.html new file mode 100644 index 0000000..b5588ac --- /dev/null +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.SplitText/additionalDetails.html @@ -0,0 +1,72 @@ +<!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>SplitText</title> + + <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> + </head> + + <body> + <!-- Processor Documentation ================================================== --> + + <p> + <strong>Modifies Attributes:</strong> + </p> + <table border="1"> + <thead> + <tr> + <th>Attribute Name</th> + <th>Description</th> + </tr> + </thead> + <tbody> + <tr> + <td>text.line.count</td> + <td>The number of lines of text from the original FlowFile that were copied to this FlowFile.</td> + </tr> + <tr> + <td>fragment.identifier</td> + <td>All split FlowFiles produced from the same parent FlowFile will have the same randomly generated + UUID added for this attribute.</td> + </tr> + <tr> + <td>fragment.index</td> + <td>A one-up number that indicates the ordering of the split FlowFiles that were created from a + single parent FlowFile.</td> + </tr> + <tr> + <td>fragment.count</td> + <td>The number of split FlowFiles generated from the parent FlowFile.</td> + </tr> + <tr> + <td>segment.original.filename</td> + <td>The filename of the parent FlowFile. + </td> + </tr> + </tbody> + </table> + + <p> + <strong>See Also:</strong> + </p> + <ul> + <li><a href="../org.apache.nifi.processors.standard.MergeContent/index.html">MergeContent</a> - can defragment FlowFiles + that have been split if <em>Remove Trailing Newlines</em> is set to false and <em>Header Line Count</em> is set to 0.</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.SplitText/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.SplitText/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.SplitText/index.html deleted file mode 100644 index 3e999ab..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.SplitText/index.html +++ /dev/null @@ -1,121 +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>SplitText</title> - - <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> - </head> - - <body> - <!-- Processor Documentation ================================================== --> - <h2>Description:</h2> - <p> - This processor splits a text file into multiple smaller text files on line boundaries, each having up to a configured number of lines. - </p> - - <p> - <strong>Modifies Attributes:</strong> - </p> - <table border="1"> - <thead> - <tr> - <th>Attribute Name</th> - <th>Description</th> - </tr> - </thead> - <tbody> - <tr> - <td>text.line.count</td> - <td>The number of lines of text from the original FlowFile that were copied to this FlowFile.</td> - </tr> - <tr> - <td>fragment.identifier</td> - <td>All split FlowFiles produced from the same parent FlowFile will have the same randomly generated - UUID added for this attribute.</td> - </tr> - <tr> - <td>fragment.index</td> - <td>A one-up number that indicates the ordering of the split FlowFiles that were created from a - single parent FlowFile.</td> - </tr> - <tr> - <td>fragment.count</td> - <td>The number of split FlowFiles generated from the parent FlowFile.</td> - </tr> - <tr> - <td>segment.original.filename</td> - <td>The filename of the parent FlowFile. - </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>Line Split Count</strong> - <ul> - <li>The number of lines to be included in each split file. The value must be a non-negative integer.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Header Line Count</strong> - <ul> - <li>The number of lines that should be considered part of a header on each split file.</li> - <li>Default value: 0</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Remove Trailing Newlines</strong> - <ul> - <li>Whether to remove newlines at the end of each split file. This should be false if you intend to merge the split files later.</li> - <li>Default value: true</li> - <li>Supports expression language: false</li> - </ul></li> - </ul> - - <p> - <strong>Relationships:</strong> - </p> - <ul> - <li>failure - <ul> - <li>If FlowFiles cannot be split for some reason, the original file follows this relationship and does not follow the original relationship.</li> - </ul></li> - <li>original - <ul> - <li>If FlowFiles are successfully split into one or more files, a copy of the original file follows this relationship.</li> - </ul></li> - <li>splits - <ul> - <li>If FlowFiles are successfully split into one or more files, those split files follow this relationship.</li> - </ul></li> - </ul> - - <p> - <strong>See Also:</strong> - </p> - <ul> - <li><a href="../org.apache.nifi.processors.standard.MergeContent/index.html">MergeContent</a> - can defragment FlowFiles - that have been split if <em>Remove Trailing Newlines</em> is set to false and <em>Header Line Count</em> is set to 0.</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.SplitXml/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.SplitXml/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.SplitXml/index.html deleted file mode 100644 index 87700ff..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.SplitXml/index.html +++ /dev/null @@ -1,64 +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>SplitXML</title> - - <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> - </head> - - <body> - <!-- Processor Documentation ================================================== --> - <h2>Description:</h2> - <p> - This processor splits an XML file into multiple separate FlowFiles, each comprising a child or descendant of the original root element. - <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>Line Depth</strong> - <ul> - <li>The XML-nesting depth at which to start splitting the XML fragments. A depth of 1 means to split the root's children; whereas a depth of 2 means to split the root's children's children, and so forth.</li> - <li>Default value: 1</li> - <li>Supports expression language: false</li> - </ul></li> - </ul> - - <p> - <strong>Relationships:</strong> - </p> - <ul> - <li>failure - <ul> - <li>If a FlowFile fails processing for any reason (for example, if the FlowFile is not valid XML), then it follows this relationship and does not go down the original relationship.</li> - </ul></li> - <li>original - <ul> - <li>If FlowFiles are successfully split, a copy of the original FlowFile follows this relationship.</li> - </ul></li> - <li>splits - <ul> - <li>If FlowFiles are successfully split into one or more files, those split files 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.TransformXml/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.TransformXml/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.TransformXml/index.html deleted file mode 100644 index 2b08d8b..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.TransformXml/index.html +++ /dev/null @@ -1,63 +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>TransformXml</title> - - <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> - </head> - - <body> - <!-- Processor Documentation ================================================== --> - <h2>Description:</h2> - <p> - This processor transforms the contents of FlowFiles based on a user-specified XSLT stylesheet file. XSL versions 1.0 and 2.0 are supported. - <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>XSLT File</strong> - <ul> - <li>The local file path to the XLST file to be used for transformation.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul></li> - </ul> - - Note that this processor passes all dynamic properties to the transformer, so therefore they will be available for use in the stylesheet. - - <p> - <strong>Relationships:</strong> - </p> - <ul> - <li>success - <ul> - <li>If the FlowFile content is successfully transformed by the XSLT transformer, then the FlowFile follows this relationship.</li> - </ul></li> - <li>failure - <ul> - <li>If the FlowFiles content fails to be transformed by the XSLT transformer, 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.UnpackContent/additionalDetails.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.UnpackContent/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.UnpackContent/additionalDetails.html new file mode 100644 index 0000000..912be35 --- /dev/null +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.UnpackContent/additionalDetails.html @@ -0,0 +1,106 @@ +<!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>UnpackContent</title> + + <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> + </head> + + <body> + <!-- Processor Documentation ================================================== --> + + <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 the <Packaging Format> property is set to <code>use mime.type attribute</code>, + this attribute is used to determine the FlowFile's MIME Type. + In this case, if the attribute is set to <code>application/tar</code>, the TAR Packaging Format will be used. + If the attribute is set to <code>application/zip</code>, the ZIP Packaging Format will be used. + If the attribute is set to <code>application/flowfile-v3</code> or <code>application/flowfile-v2</code> or <code>application/flowfile-v1</code>, + the appropriate FlowFile Packaging Format will be used. + If this attribute is missing, the FlowFile will be routed to 'failure'. + Otherwise, if the attribute's value is not one of those mentioned above, the FlowFile will be + routed to 'success' without being unpacked. + </td> + </tr> + </tbody> + </table> + + <p> + <strong>Modifies 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 the FlowFile is successfully unpacked, its MIME Type is no longer known, so the + mime.type attribute is set to <code>application/octet-stream</code>. + </td> + </tr> + <tr> + <td>fragment.identifier</td> + <td>All unpacked FlowFiles produced from the same parent FlowFile will have the same randomly generated + UUID added for this attribute.</td> + </tr> + <tr> + <td>fragment.index</td> + <td>A one-up number that indicates the ordering of the unpacked FlowFiles that were created from a + single parent FlowFile.</td> + </tr> + <tr> + <td>fragment.count</td> + <td>The number of unpacked FlowFiles generated from the parent FlowFile.</td> + </tr> + + <tr> + <td>segment.original.filename</td> + <td>The filename of the parent FlowFile. Extensions of .tar, .zip or .pkg are removed because the <a + href="../org.apache.nifi.processors.standard.MergeContent/index.html">MergeContent</a> processor automatically adds + those extensions if it is used to rebuild the original FlowFile. + </td> + </tr> + </tbody> + </table> + + <p> + <strong>See Also:</strong> + </p> + <ul> + <li><a href="../org.apache.nifi.processors.standard.MergeContent/index.html">MergeContent</a> - can repackage FlowFiles + that have been unpacked.</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.UnpackContent/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.UnpackContent/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.UnpackContent/index.html deleted file mode 100644 index b3a522e..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.UnpackContent/index.html +++ /dev/null @@ -1,163 +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>UnpackContent</title> - - <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> - </head> - - <body> - <!-- Processor Documentation ================================================== --> - <h2>Description:</h2> - <p>This processor unpacks the content of FlowFiles that have - been packaged with one of several different packaging formats, - emitting one to many FlowFiles for each input FlowFile. - </p> - - <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 the <Packaging Format> property is set to <code>use mime.type attribute</code>, - this attribute is used to determine the FlowFile's MIME Type. - In this case, if the attribute is set to <code>application/tar</code>, the TAR Packaging Format will be used. - If the attribute is set to <code>application/zip</code>, the ZIP Packaging Format will be used. - If the attribute is set to <code>application/flowfile-v3</code> or <code>application/flowfile-v2</code> or <code>application/flowfile-v1</code>, - the appropriate FlowFile Packaging Format will be used. - If this attribute is missing, the FlowFile will be routed to 'failure'. - Otherwise, if the attribute's value is not one of those mentioned above, the FlowFile will be - routed to 'success' without being unpacked. - </td> - </tr> - </tbody> - </table> - - <p> - <strong>Modifies 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 the FlowFile is successfully unpacked, its MIME Type is no longer known, so the - mime.type attribute is set to <code>application/octet-stream</code>. - </td> - </tr> - <tr> - <td>fragment.identifier</td> - <td>All unpacked FlowFiles produced from the same parent FlowFile will have the same randomly generated - UUID added for this attribute.</td> - </tr> - <tr> - <td>fragment.index</td> - <td>A one-up number that indicates the ordering of the unpacked FlowFiles that were created from a - single parent FlowFile.</td> - </tr> - <tr> - <td>fragment.count</td> - <td>The number of unpacked FlowFiles generated from the parent FlowFile.</td> - </tr> - - <tr> - <td>segment.original.filename</td> - <td>The filename of the parent FlowFile. Extensions of .tar, .zip or .pkg are removed because the <a - href="../org.apache.nifi.processors.standard.MergeContent/index.html">MergeContent</a> processor automatically adds - those extensions if it is used to rebuild the original FlowFile. - </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>Packaging Format</strong> - <ul> - <li>The packaging format used to create incoming FlowFiles. - Valid options include: - <ul> - <li>use mime.type attribute</li> - <li>tar</li> - <li>zip</li> - <li>flowfile-stream-v3</li> - <li>flowfile-stream-v2</li> - <li>flowfile-tar-v1</li> - </ul> - </li> - <li>Default value: use mime.type attribute</li> - <li>Supports expression language: false</li> - </ul></li> - </ul> - - <p> - <strong>Relationships:</strong> - </p> - <ul> - <li>failure - <ul> - <li>If FlowFiles cannot be unpacked for some reason, the - original copy follows this relationship and does not go down the - original relationship.</li> - </ul> - </li> - <li>original - <ul> - <li>If FlowFiles are successfully unpacked, then a copy of each - original incoming FlowFile follows this relationship.</li> - </ul> - </li> - <li>success - <ul> - <li>If FlowFiles are successfully unpacked, then the unpacked - FlowFiles that are generated follow this relationship.</li> - </ul> - </li> - </ul> - - <p> - <strong>See Also:</strong> - </p> - <ul> - <li><a href="../org.apache.nifi.processors.standard.MergeContent/index.html">MergeContent</a> - can repackage FlowFiles - that have been unpacked.</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.ValidateXml/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ValidateXml/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ValidateXml/index.html deleted file mode 100644 index d4db3cb..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ValidateXml/index.html +++ /dev/null @@ -1,56 +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>ValidateXml</title> - - <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> - </head> - - <body> - <!-- Processor Documentation ================================================== --> - <h2>Description:</h2> - <p> - This processor validates the contents of FlowFiles against a user-specified XML schema file. - <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>Schema File</strong> - <ul> - <li>The local file path to the schema file to be used for validation.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul></li> - </ul> - - <p> - <strong>Relationships:</strong> - </p> - <ul> - <li>valid - <ul> - <li>If FlowFiles are successfully validated against the schema, 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-reporting-tasks/src/main/resources/docs/org.apache.nifi.controller.ControllerStatusReportingTask/additionalDetails.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-reporting-tasks/src/main/resources/docs/org.apache.nifi.controller.ControllerStatusReportingTask/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-reporting-tasks/src/main/resources/docs/org.apache.nifi.controller.ControllerStatusReportingTask/additionalDetails.html new file mode 100644 index 0000000..dd7cd59 --- /dev/null +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-reporting-tasks/src/main/resources/docs/org.apache.nifi.controller.ControllerStatusReportingTask/additionalDetails.html @@ -0,0 +1,70 @@ +<!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>ControllerStatusReportingTask</title> + <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> + </head> + + <body> + <h2>Description:</h2> + + <p> + Reporting Task that creates a log message for each Processor and each Connection in the flow. + + For Processors, the following information is included (sorted by descending Processing Timing): + </p> + <ul> + <li>Processor Name</li> + <li>Processor ID</li> + <li>Processor Type</li> + <li>Run Status</li> + <li>Flow Files In (5 mins)</li> + <li>FlowFiles Out (5 mins)</li> + <li>Bytes Read from Disk (5 mins)</li> + <li>Bytes Written to Disk (5 mins)</li> + <li>Number of Tasks Completed (5 mins)</li> + <li>Processing Time (5 mins)</li> + </ul> + + <p> + For Connections, the following information is included (sorted by descending size of queued FlowFiles): + </p> + <ul> + <li>Connection Name</li> + <li>Connection ID</li> + <li>Source Component Name</li> + <li>Destination Component Name</li> + <li>Flow Files In (5 mins)</li> + <li>FlowFiles Out (5 mins)</li> + <li>FlowFiles Queued</li> + </ul> + + <p> + If may be convenient to redirect the logging output of this ReportingTask to a separate log file than the typical application log. + This can be accomplished by modified the logback.xml file in the NiFi conf/ directory such that a logger with the name + <code>org.apache.nifi.controller.ControllerStatusReportingTask</code> is configured to write to a separate log. + </p> + + <p> + Additionally, it may be convenient to disable logging for Processors or for Connections or to split them into separate log files. This + can be accomplished by using the loggers named + <code>org.apache.nifi.controller.ControllerStatusReportingTask.Processors</code> and + <code>org.apache.nifi.controller.ControllerStatusReportingTask.Connections</code>, respectively. + </p> + </body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/0fa553ac/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-reporting-tasks/src/main/resources/docs/org.apache.nifi.controller.ControllerStatusReportingTask/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-reporting-tasks/src/main/resources/docs/org.apache.nifi.controller.ControllerStatusReportingTask/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-reporting-tasks/src/main/resources/docs/org.apache.nifi.controller.ControllerStatusReportingTask/index.html deleted file mode 100644 index 656cf40..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-reporting-tasks/src/main/resources/docs/org.apache.nifi.controller.ControllerStatusReportingTask/index.html +++ /dev/null @@ -1,85 +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>ControllerStatusReportingTask</title> - <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> - </head> - - <body> - <h2>Description:</h2> - - <p> - Reporting Task that creates a log message for each Processor and each Connection in the flow. - - For Processors, the following information is included (sorted by descending Processing Timing): - </p> - <ul> - <li>Processor Name</li> - <li>Processor ID</li> - <li>Processor Type</li> - <li>Run Status</li> - <li>Flow Files In (5 mins)</li> - <li>FlowFiles Out (5 mins)</li> - <li>Bytes Read from Disk (5 mins)</li> - <li>Bytes Written to Disk (5 mins)</li> - <li>Number of Tasks Completed (5 mins)</li> - <li>Processing Time (5 mins)</li> - </ul> - - <p> - For Connections, the following information is included (sorted by descending size of queued FlowFiles): - </p> - <ul> - <li>Connection Name</li> - <li>Connection ID</li> - <li>Source Component Name</li> - <li>Destination Component Name</li> - <li>Flow Files In (5 mins)</li> - <li>FlowFiles Out (5 mins)</li> - <li>FlowFiles Queued</li> - </ul> - - <p> - If may be convenient to redirect the logging output of this ReportingTask to a separate log file than the typical application log. - This can be accomplished by modified the logback.xml file in the NiFi conf/ directory such that a logger with the name - <code>org.apache.nifi.controller.ControllerStatusReportingTask</code> is configured to write to a separate log. - </p> - - <p> - Additionally, it may be convenient to disable logging for Processors or for Connections or to split them into separate log files. This - can be accomplished by using the loggers named - <code>org.apache.nifi.controller.ControllerStatusReportingTask.Processors</code> and - <code>org.apache.nifi.controller.ControllerStatusReportingTask.Connections</code>, respectively. - </p> - - <p> - <strong>Properties:</strong> - </p> - - <ul> - <li><strong>Show Deltas</strong> - <ul> - <li>Boolean value indicating whether or not the table should display the deltas for values between successive iterations - <li>Default value: true</li> - <li>Supports expression language: false</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-reporting-tasks/src/main/resources/docs/org.apache.nifi.controller.MonitorDiskUsage/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-reporting-tasks/src/main/resources/docs/org.apache.nifi.controller.MonitorDiskUsage/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-reporting-tasks/src/main/resources/docs/org.apache.nifi.controller.MonitorDiskUsage/index.html deleted file mode 100644 index e02b649..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-reporting-tasks/src/main/resources/docs/org.apache.nifi.controller.MonitorDiskUsage/index.html +++ /dev/null @@ -1,58 +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>MonitorDiskUsage</title> - <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> - </head> - - <body> - <h2>Description:</h2> - - <p>Reporting Task that checks how much Disk Space is - available in the Content Repository and the FlowFile Repository. When the amount of available disk space drops below a - specified threshold, this Reporting Task will create a WARNING level log message and create - a System-Level bulletin to notify the user.</p> - - <p> - <strong>Properties:</strong> - </p> - - <ul> - <li><strong>Content Repository Threshold</strong> - <ul> - <li>The threshold at which a bulletin will be generated to indicate that the disk usage of the Content Repository is of concern. - The value must be a percentage (e.g., 80%). If multiple directories are configured for the Content Repository, a warning - will be generated for each directory that exceeds the configured limit</li> - <li>Required: true</li> - <li>Default value: 80%</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li><strong>FlowFile Repository Threshold</strong> - <ul> - <li>The threshold at which a bulletin will be generated to indicate that the disk usage of the FlowFile Repository is of concern. - The value must be a percentage (e.g., 80%).</li> - <li>Required: true</li> - <li>Default value: 80%</li> - <li>Supports expression language: false</li> - </ul> - </li> - </ul> - - </body> -</html>
