From 0fa553ac0265f96cb5c2a5f42bc760aa0c65b590 Mon Sep 17 00:00:00 2001 From: danbress Date: Sat, 31 Jan 2015 12:56:25 -0500 Subject: [PATCH] NIFI-280 - Modifing existing existing documentation removing index.html and renaming to additionalDetails.html if there is relevent information --- .../{index.html => additionalDetails.html} | 35 -- .../additionalDetails.html | 57 +++ .../index.html | 162 -------- .../additionalDetails.html | 32 ++ .../index.html | 150 -------- .../additionalDetails.html | 51 +++ .../index.html | 159 -------- .../additionalDetails.html | 78 ++++ .../index.html | 173 --------- .../additionalDetails.html} | 43 +-- .../index.html | 189 ---------- .../index.html | 63 ---- .../additionalDetails.html | 68 ++++ .../index.html | 166 --------- .../index.html | 116 ------ .../index.html | 65 ---- .../additionalDetails.html | 58 +++ .../index.html | 147 -------- .../{index.html => additionalDetails.html} | 46 --- .../index.html | 97 ----- .../index.html | 160 -------- .../additionalDetails.html | 34 ++ .../index.html | 135 ------- .../additionalDetails.html | 161 ++++++++ .../index.html | 311 ---------------- .../additionalDetails.html | 57 +++ .../index.html | 111 ------ .../index.html | 64 ---- .../additionalDetails.html | 74 ++++ .../index.html | 227 ------------ .../additionalDetails.html | 79 ++++ .../index.html | 186 ---------- .../additionalDetails.html | 45 +++ .../index.html | 143 -------- .../index.html | 118 ------ .../index.html | 122 ------ .../additionalDetails.html | 80 ++++ .../index.html | 250 ------------- .../additionalDetails.html | 35 ++ .../index.html | 88 ----- .../additionalDetails.html | 35 ++ .../index.html | 89 ----- .../{index.html => additionalDetails.html} | 42 +-- .../additionalDetails.html | 64 ++++ .../index.html | 181 --------- .../index.html | 86 ----- .../index.html | 144 -------- .../index.html | 80 ---- .../additionalDetails.html | 115 ++++++ .../index.html | 347 ------------------ .../index.html | 64 ---- .../additionalDetails.html | 49 +++ .../index.html | 143 -------- .../additionalDetails.html | 48 +++ .../index.html | 187 ---------- .../index.html | 114 ------ .../additionalDetails.html | 66 ++++ .../index.html | 283 -------------- .../index.html | 109 ------ .../index.html | 152 -------- .../additionalDetails.html | 34 ++ .../index.html | 281 -------------- .../index.html | 91 ----- .../index.html | 114 ------ .../additionalDetails.html | 46 +++ .../index.html | 110 ------ .../index.html | 82 ----- .../index.html | 85 ----- .../additionalDetails.html | 45 +++ .../index.html | 100 ----- .../{index.html => additionalDetails.html} | 43 +-- .../{index.html => additionalDetails.html} | 42 +-- .../{index.html => additionalDetails.html} | 51 +-- .../index.html | 64 ---- .../index.html | 63 ---- .../{index.html => additionalDetails.html} | 61 +-- .../{index.html => additionalDetails.html} | 15 - .../index.html | 58 --- .../index.html | 77 ---- .../{index.html => additionalDetails.html} | 24 -- .../{index.html => additionalDetails.html} | 46 --- .../{index.html => additionalDetails.html} | 20 - .../{index.html => additionalDetails.html} | 50 --- .../{index.html => additionalDetails.html} | 14 - .../{index.html => additionalDetails.html} | 0 85 files changed, 1434 insertions(+), 7015 deletions(-) rename nifi/nifi-nar-bundles/nifi-hadoop-bundle/nifi-hdfs-processors/src/main/resources/docs/org.apache.nifi.processors.hadoop.CreateHadoopSequenceFile/{index.html => additionalDetails.html} (68%) create mode 100644 nifi/nifi-nar-bundles/nifi-hadoop-bundle/nifi-hdfs-processors/src/main/resources/docs/org.apache.nifi.processors.hadoop.GetHDFS/additionalDetails.html delete mode 100644 nifi/nifi-nar-bundles/nifi-hadoop-bundle/nifi-hdfs-processors/src/main/resources/docs/org.apache.nifi.processors.hadoop.GetHDFS/index.html create mode 100644 nifi/nifi-nar-bundles/nifi-hadoop-bundle/nifi-hdfs-processors/src/main/resources/docs/org.apache.nifi.processors.hadoop.GetHDFSSequenceFile/additionalDetails.html delete mode 100644 nifi/nifi-nar-bundles/nifi-hadoop-bundle/nifi-hdfs-processors/src/main/resources/docs/org.apache.nifi.processors.hadoop.GetHDFSSequenceFile/index.html create mode 100644 nifi/nifi-nar-bundles/nifi-hadoop-bundle/nifi-hdfs-processors/src/main/resources/docs/org.apache.nifi.processors.hadoop.PutHDFS/additionalDetails.html delete mode 100644 nifi/nifi-nar-bundles/nifi-hadoop-bundle/nifi-hdfs-processors/src/main/resources/docs/org.apache.nifi.processors.hadoop.PutHDFS/index.html create mode 100644 nifi/nifi-nar-bundles/nifi-kafka-bundle/nifi-kafka-processors/src/main/resources/docs/org.apache.nifi.processors.kafka.GetKafka/additionalDetails.html delete mode 100644 nifi/nifi-nar-bundles/nifi-kafka-bundle/nifi-kafka-processors/src/main/resources/docs/org.apache.nifi.processors.kafka.GetKafka/index.html rename nifi/nifi-nar-bundles/{nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ValidateXml/index.html => nifi-kafka-bundle/nifi-kafka-processors/src/main/resources/docs/org.apache.nifi.processors.kafka.PutKafka/additionalDetails.html} (50%) delete mode 100644 nifi/nifi-nar-bundles/nifi-kafka-bundle/nifi-kafka-processors/src/main/resources/docs/org.apache.nifi.processors.kafka.PutKafka/index.html delete mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.Base64EncodeContent/index.html create mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.CompressContent/additionalDetails.html delete mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.CompressContent/index.html delete mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ControlRate/index.html delete mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ConvertCharacterSet/index.html create mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.DetectDuplicate/additionalDetails.html delete mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.DetectDuplicate/index.html rename nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.DistributeLoad/{index.html => additionalDetails.html} (54%) delete mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EncryptContent/index.html delete mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EvaluateRegularExpression/index.html create mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EvaluateXPath/additionalDetails.html delete mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EvaluateXPath/index.html create mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EvaluateXQuery/additionalDetails.html delete mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EvaluateXQuery/index.html create mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ExecuteStreamCommand/additionalDetails.html delete mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ExecuteStreamCommand/index.html delete mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GenerateFlowFile/index.html create mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetFTP/additionalDetails.html delete mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetFTP/index.html create mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetFile/additionalDetails.html delete mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetFile/index.html create mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetHTTP/additionalDetails.html delete mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetHTTP/index.html delete mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetJMSQueue/index.html delete mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetJMSTopic/index.html create mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetSFTP/additionalDetails.html delete mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetSFTP/index.html create mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.HashAttribute/additionalDetails.html delete mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.HashAttribute/index.html create mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.HashContent/additionalDetails.html delete mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.HashContent/index.html rename nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.IdentifyMimeType/{index.html => additionalDetails.html} (73%) create mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.InvokeHTTP/additionalDetails.html delete mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.InvokeHTTP/index.html delete mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ListenHTTP/index.html delete mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ListenUDP/index.html delete mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.LogAttribute/index.html create mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.MergeContent/additionalDetails.html delete mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.MergeContent/index.html delete mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ModifyBytes/index.html create mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.MonitorActivity/additionalDetails.html delete mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.MonitorActivity/index.html create mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PostHTTP/additionalDetails.html delete mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PostHTTP/index.html delete mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PutEmail/index.html create mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PutFTP/additionalDetails.html delete mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PutFTP/index.html delete mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PutFile/index.html delete mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PutJMS/index.html create mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PutSFTP/additionalDetails.html delete mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PutSFTP/index.html delete mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ReplaceText/index.html delete mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ReplaceTextWithMapping/index.html create mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.RouteOnAttribute/additionalDetails.html delete mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.RouteOnAttribute/index.html delete mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.RouteOnContent/index.html delete mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ScanAttribute/index.html create mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ScanContent/additionalDetails.html delete mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ScanContent/index.html rename nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.SegmentContent/{index.html => additionalDetails.html} (68%) rename nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.SplitContent/{index.html => additionalDetails.html} (60%) rename nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.SplitText/{index.html => additionalDetails.html} (54%) delete mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.SplitXml/index.html delete mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.TransformXml/index.html rename nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.UnpackContent/{index.html => additionalDetails.html} (66%) rename nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-reporting-tasks/src/main/resources/docs/org.apache.nifi.controller.ControllerStatusReportingTask/{index.html => additionalDetails.html} (87%) delete mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-reporting-tasks/src/main/resources/docs/org.apache.nifi.controller.MonitorDiskUsage/index.html delete mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-reporting-tasks/src/main/resources/docs/org.apache.nifi.controller.MonitorMemory/index.html rename nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-reporting-tasks/src/main/resources/docs/org.apache.nifi.reporting.ganglia.StandardGangliaReporter/{index.html => additionalDetails.html} (76%) rename nifi/nifi-nar-bundles/nifi-standard-services/nifi-distributed-cache-services-bundle/nifi-distributed-cache-client-service/src/main/resources/docs/org.apache.nifi.distributed.cache.client.DistributedMapCacheClientService/{index.html => additionalDetails.html} (57%) rename nifi/nifi-nar-bundles/nifi-standard-services/nifi-distributed-cache-services-bundle/nifi-distributed-cache-client-service/src/main/resources/docs/org.apache.nifi.distributed.cache.client.DistributedSetCacheClientService/{index.html => additionalDetails.html} (70%) mode change 100755 => 100644 rename nifi/nifi-nar-bundles/nifi-standard-services/nifi-distributed-cache-services-bundle/nifi-distributed-cache-server/src/main/resources/docs/org.apache.nifi.distributed.cache.server.map.DistributedMapCacheServer/{index.html => additionalDetails.html} (54%) rename nifi/nifi-nar-bundles/nifi-standard-services/nifi-ssl-context-bundle/nifi-ssl-context-service/src/main/resources/docs/org.apache.nifi.ssl.StandardSSLContextService/{index.html => additionalDetails.html} (77%) rename nifi/nifi-nar-bundles/nifi-update-attribute-bundle/nifi-update-attribute-processor/src/main/resources/docs/org.apache.nifi.processors.attributes.UpdateAttribute/{index.html => additionalDetails.html} (100%) diff --git a/nifi/nifi-nar-bundles/nifi-hadoop-bundle/nifi-hdfs-processors/src/main/resources/docs/org.apache.nifi.processors.hadoop.CreateHadoopSequenceFile/index.html b/nifi/nifi-nar-bundles/nifi-hadoop-bundle/nifi-hdfs-processors/src/main/resources/docs/org.apache.nifi.processors.hadoop.CreateHadoopSequenceFile/additionalDetails.html similarity index 68% rename from nifi/nifi-nar-bundles/nifi-hadoop-bundle/nifi-hdfs-processors/src/main/resources/docs/org.apache.nifi.processors.hadoop.CreateHadoopSequenceFile/index.html rename to nifi/nifi-nar-bundles/nifi-hadoop-bundle/nifi-hdfs-processors/src/main/resources/docs/org.apache.nifi.processors.hadoop.CreateHadoopSequenceFile/additionalDetails.html index ff1709ebdd..d9403822b8 100644 --- a/nifi/nifi-nar-bundles/nifi-hadoop-bundle/nifi-hdfs-processors/src/main/resources/docs/org.apache.nifi.processors.hadoop.CreateHadoopSequenceFile/index.html +++ b/nifi/nifi-nar-bundles/nifi-hadoop-bundle/nifi-hdfs-processors/src/main/resources/docs/org.apache.nifi.processors.hadoop.CreateHadoopSequenceFile/additionalDetails.html @@ -43,41 +43,6 @@ NOTE: The value portion of a key/value pair is loaded into memory. While there is a max size limit of 2GB, this could cause memory issues if there are too many concurrent tasks and the flow file sizes are large. -

Properties:

-

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.

- - -

Relationships:

- -

See Also:

diff --git a/nifi/nifi-nar-bundles/nifi-hadoop-bundle/nifi-hdfs-processors/src/main/resources/docs/org.apache.nifi.processors.hadoop.GetHDFS/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-hadoop-bundle/nifi-hdfs-processors/src/main/resources/docs/org.apache.nifi.processors.hadoop.GetHDFS/additionalDetails.html new file mode 100644 index 0000000000..0060c2c1f6 --- /dev/null +++ b/nifi/nifi-nar-bundles/nifi-hadoop-bundle/nifi-hdfs-processors/src/main/resources/docs/org.apache.nifi.processors.hadoop.GetHDFS/additionalDetails.html @@ -0,0 +1,57 @@ + + + + + + GetHDFS + + + + + +

+ Modifies Attributes: +

+ + + + + + + + + + + + + + + + + +
Attribute NameDescription
filenameThe name of the file that was read from HDFS.
pathThe path is set to the relative path of the file's directory on HDFS. For example, if the Directory + property is set to /tmp, then files picked up from /tmp will have the path attribute set to + "./". If the Recurse Subdirectories property is set to true + and a file is picked up from /tmp/abc/1/2/3, then the path attribute will be set to "abc/1/2/3". +
+

+ See Also: +

+ + + diff --git a/nifi/nifi-nar-bundles/nifi-hadoop-bundle/nifi-hdfs-processors/src/main/resources/docs/org.apache.nifi.processors.hadoop.GetHDFS/index.html b/nifi/nifi-nar-bundles/nifi-hadoop-bundle/nifi-hdfs-processors/src/main/resources/docs/org.apache.nifi.processors.hadoop.GetHDFS/index.html deleted file mode 100644 index 162e7a1417..0000000000 --- a/nifi/nifi-nar-bundles/nifi-hadoop-bundle/nifi-hdfs-processors/src/main/resources/docs/org.apache.nifi.processors.hadoop.GetHDFS/index.html +++ /dev/null @@ -1,162 +0,0 @@ - - - - - - GetHDFS - - - - - - -

Description:

-

This processor reads files from an HDFS cluster into NiFi FlowFiles.

- -

- Modifies Attributes: -

- - - - - - - - - - - - - - - - - -
Attribute NameDescription
filenameThe name of the file that was read from HDFS.
pathThe path is set to the relative path of the file's directory on HDFS. For example, if the Directory - property is set to /tmp, then files picked up from /tmp will have the path attribute set to - "./". If the Recurse Subdirectories property is set to true - and a file is picked up from /tmp/abc/1/2/3, then the path attribute will be set to "abc/1/2/3". -
- -

Properties:

-

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.

- - -

Relationships:

- - -

- See Also: -

- - - diff --git a/nifi/nifi-nar-bundles/nifi-hadoop-bundle/nifi-hdfs-processors/src/main/resources/docs/org.apache.nifi.processors.hadoop.GetHDFSSequenceFile/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-hadoop-bundle/nifi-hdfs-processors/src/main/resources/docs/org.apache.nifi.processors.hadoop.GetHDFSSequenceFile/additionalDetails.html new file mode 100644 index 0000000000..ca0b7cdfbe --- /dev/null +++ b/nifi/nifi-nar-bundles/nifi-hadoop-bundle/nifi-hdfs-processors/src/main/resources/docs/org.apache.nifi.processors.hadoop.GetHDFSSequenceFile/additionalDetails.html @@ -0,0 +1,32 @@ + + + + + + GetHDFSSequenceFile + + + + + +

+ See Also: +

+ + + diff --git a/nifi/nifi-nar-bundles/nifi-hadoop-bundle/nifi-hdfs-processors/src/main/resources/docs/org.apache.nifi.processors.hadoop.GetHDFSSequenceFile/index.html b/nifi/nifi-nar-bundles/nifi-hadoop-bundle/nifi-hdfs-processors/src/main/resources/docs/org.apache.nifi.processors.hadoop.GetHDFSSequenceFile/index.html deleted file mode 100644 index 71f5fa7f4a..0000000000 --- a/nifi/nifi-nar-bundles/nifi-hadoop-bundle/nifi-hdfs-processors/src/main/resources/docs/org.apache.nifi.processors.hadoop.GetHDFSSequenceFile/index.html +++ /dev/null @@ -1,150 +0,0 @@ - - - - - - GetHDFSSequenceFile - - - - - - -

Description:

-

This processor is used to pull files from HDFS. The files being pulled in MUST be SequenceFile - formatted files. The processor creates a flow file for each key/value entry in the ingested SequenceFile. - The created flow file's content depends on the value of the optional configuration property FlowFile Content. Currently, - there are two choices: VALUE ONLY and KEY VALUE PAIR. With the prior, only the SequenceFile value element is - written to the flow file contents. With the latter, the SequenceFile key and value are written to the flow file - contents as serialized objects; the format is key length (int), key(String), value length(int), value(bytes). The default is - VALUE ONLY.

- NOTE: This processor loads the entire value entry into memory. While the size limit for a value entry is 2GB, this will cause - memory problems if there are too many concurrent tasks and the data being ingested is large. - -

Properties:

-

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.

- - -

Relationships:

- - -

- See Also: -

- - - diff --git a/nifi/nifi-nar-bundles/nifi-hadoop-bundle/nifi-hdfs-processors/src/main/resources/docs/org.apache.nifi.processors.hadoop.PutHDFS/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-hadoop-bundle/nifi-hdfs-processors/src/main/resources/docs/org.apache.nifi.processors.hadoop.PutHDFS/additionalDetails.html new file mode 100644 index 0000000000..1a02d1085c --- /dev/null +++ b/nifi/nifi-nar-bundles/nifi-hadoop-bundle/nifi-hdfs-processors/src/main/resources/docs/org.apache.nifi.processors.hadoop.PutHDFS/additionalDetails.html @@ -0,0 +1,51 @@ + + + + + + PutHDFS + + + + + + +

+ Uses Attributes: +

+ + + + + + + + + + + + + +
Attribute NameDescription
filenameThe name of the file written to HDFS comes from the value of this attribute.
+ +

+ See Also: +

+ + + diff --git a/nifi/nifi-nar-bundles/nifi-hadoop-bundle/nifi-hdfs-processors/src/main/resources/docs/org.apache.nifi.processors.hadoop.PutHDFS/index.html b/nifi/nifi-nar-bundles/nifi-hadoop-bundle/nifi-hdfs-processors/src/main/resources/docs/org.apache.nifi.processors.hadoop.PutHDFS/index.html deleted file mode 100644 index cacdd721cb..0000000000 --- a/nifi/nifi-nar-bundles/nifi-hadoop-bundle/nifi-hdfs-processors/src/main/resources/docs/org.apache.nifi.processors.hadoop.PutHDFS/index.html +++ /dev/null @@ -1,159 +0,0 @@ - - - - - - PutHDFS - - - - - - -

Description:

-

- This processor writes FlowFiles to an HDFS cluster. It will create directories in which to store files as - needed based on the Directory property. -

- -

- When files are written to HDFS, the file's owner is the user identity of the NiFi process, the file's group is the - group of the parent directory, and the read/write/execute permissions use the default umask. The owner can be - overridden using the Remote Owner property, the group can be overridden using the Remote Group - property, and the read/write/execute permissions can be overridden using the Permissions umask property. -

-

NOTE: This processor can change owner or group only if the user identity of the NiFi process has super user - privilege in HDFS to do so.

-

- NOTE: The Permissions umask property cannot add execute permissions to regular files. -

- -

- Uses Attributes: -

- - - - - - - - - - - - - -
Attribute NameDescription
filenameThe name of the file written to HDFS comes from the value of this attribute.
- -

Properties:

-

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.

- - -

Relationships:

- - -

- See Also: -

- - - diff --git a/nifi/nifi-nar-bundles/nifi-kafka-bundle/nifi-kafka-processors/src/main/resources/docs/org.apache.nifi.processors.kafka.GetKafka/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-kafka-bundle/nifi-kafka-processors/src/main/resources/docs/org.apache.nifi.processors.kafka.GetKafka/additionalDetails.html new file mode 100644 index 0000000000..daee6ee711 --- /dev/null +++ b/nifi/nifi-nar-bundles/nifi-kafka-bundle/nifi-kafka-processors/src/main/resources/docs/org.apache.nifi.processors.kafka.GetKafka/additionalDetails.html @@ -0,0 +1,78 @@ + + + + + + GetKafka + + + + + +

Description:

+

+ This Processors polls Apache Kafka + for data. When a message is received from Kafka, this Processor emits a FlowFile + where the content of the FlowFile is the value of the Kafka message. If the + message has a key associated with it, an attribute named kafka.key + will be added to the FlowFile, with the value being the UTF-8 Encoded value + of the Message's Key. +

+

+ Kafka supports the notion of a Consumer Group when pulling messages in order to + provide scalability while still offering a publish-subscribe interface. Each + Consumer Group must have a unique identifier. The Consumer Group identifier that + is used by NiFi is the UUID of the Processor. This means that all of the nodes + within a cluster will use the same Consumer Group Identifier so that they do + not receive duplicate data but multiple GetKafka Processors can be used to pull + from multiple Topics, as each Processor will receive a different Processor UUID + and therefore a different Consumer Group Identifier. +

+ +

+ Modifies Attributes: +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Attribute NameDescription
kafka.topicThe name of the Kafka Topic from which the message was received
kafka.keyThe key of the Kafka message, if it exists and batch size is 1. If the message does not have a key, + or if the batch size is greater than 1, this attribute will not be added.
kafka.partitionThe partition of the Kafka Topic from which the message was received. This attribute is added only + if the batch size is 1.
kafka.offsetThe offset of the message within the Kafka partition. This attribute is added only + if the batch size is 1.
+ + diff --git a/nifi/nifi-nar-bundles/nifi-kafka-bundle/nifi-kafka-processors/src/main/resources/docs/org.apache.nifi.processors.kafka.GetKafka/index.html b/nifi/nifi-nar-bundles/nifi-kafka-bundle/nifi-kafka-processors/src/main/resources/docs/org.apache.nifi.processors.kafka.GetKafka/index.html deleted file mode 100644 index 279dd759f4..0000000000 --- a/nifi/nifi-nar-bundles/nifi-kafka-bundle/nifi-kafka-processors/src/main/resources/docs/org.apache.nifi.processors.kafka.GetKafka/index.html +++ /dev/null @@ -1,173 +0,0 @@ - - - - - - GetKafka - - - - - -

Description:

-

- This Processors polls Apache Kafka - for data. When a message is received from Kafka, this Processor emits a FlowFile - where the content of the FlowFile is the value of the Kafka message. If the - message has a key associated with it, an attribute named kafka.key - will be added to the FlowFile, with the value being the UTF-8 Encoded value - of the Message's Key. -

-

- Kafka supports the notion of a Consumer Group when pulling messages in order to - provide scalability while still offering a publish-subscribe interface. Each - Consumer Group must have a unique identifier. The Consumer Group identifier that - is used by NiFi is the UUID of the Processor. This means that all of the nodes - within a cluster will use the same Consumer Group Identifier so that they do - not receive duplicate data but multiple GetKafka Processors can be used to pull - from multiple Topics, as each Processor will receive a different Processor UUID - and therefore a different Consumer Group Identifier. -

- -

- Modifies Attributes: -

- - - - - - - - - - - - - - - - - - - - - - - - - -
Attribute NameDescription
kafka.topicThe name of the Kafka Topic from which the message was received
kafka.keyThe key of the Kafka message, if it exists and batch size is 1. If the message does not have a key, - or if the batch size is greater than 1, this attribute will not be added.
kafka.partitionThe partition of the Kafka Topic from which the message was received. This attribute is added only - if the batch size is 1.
kafka.offsetThe offset of the message within the Kafka partition. This attribute is added only - if the batch size is 1.
- - -

- Properties: -

-

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.

- -

- Relationships: -

- - - - 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-kafka-bundle/nifi-kafka-processors/src/main/resources/docs/org.apache.nifi.processors.kafka.PutKafka/additionalDetails.html similarity index 50% rename from nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ValidateXml/index.html rename to nifi/nifi-nar-bundles/nifi-kafka-bundle/nifi-kafka-processors/src/main/resources/docs/org.apache.nifi.processors.kafka.PutKafka/additionalDetails.html index d4db3cb4aa..04d9463ed6 100644 --- 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-kafka-bundle/nifi-kafka-processors/src/main/resources/docs/org.apache.nifi.processors.kafka.PutKafka/additionalDetails.html @@ -16,8 +16,7 @@ --> - ValidateXml - + PutKafka @@ -25,32 +24,22 @@

Description:

- This processor validates the contents of FlowFiles against a user-specified XML schema file. -

- - Properties: + This Processors puts the contents of a FlowFile to a Topic in + Apache Kafka. The full contents of + a FlowFile becomes the contents of a single message in Kafka. + This message is optionally assigned a key by using the + <Kafka Key> Property.

-

- 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. -

- - -

- Relationships: -

- +

+ The Processor allows the user to configure an optional Message Delimiter that + can be used to send many messages per FlowFile. For example, a \n could be used + to indicate that the contents of the FlowFile should be used to send one message + per line of text. If the property is not set, the entire contents of the FlowFile + will be sent as a single message. When using the delimiter, if some messages are + successfully sent but other messages fail to send, the FlowFile will be FORKed into + two child FlowFiles, with the successfully sent messages being routed to 'success' + and the messages that could not be sent going to 'failure'. +

diff --git a/nifi/nifi-nar-bundles/nifi-kafka-bundle/nifi-kafka-processors/src/main/resources/docs/org.apache.nifi.processors.kafka.PutKafka/index.html b/nifi/nifi-nar-bundles/nifi-kafka-bundle/nifi-kafka-processors/src/main/resources/docs/org.apache.nifi.processors.kafka.PutKafka/index.html deleted file mode 100644 index 29b7c176f5..0000000000 --- a/nifi/nifi-nar-bundles/nifi-kafka-bundle/nifi-kafka-processors/src/main/resources/docs/org.apache.nifi.processors.kafka.PutKafka/index.html +++ /dev/null @@ -1,189 +0,0 @@ - - - - - - PutKafka - - - - - -

Description:

-

- This Processors puts the contents of a FlowFile to a Topic in - Apache Kafka. The full contents of - a FlowFile becomes the contents of a single message in Kafka. - This message is optionally assigned a key by using the - <Kafka Key> Property. -

- -

- The Processor allows the user to configure an optional Message Delimiter that - can be used to send many messages per FlowFile. For example, a \n could be used - to indicate that the contents of the FlowFile should be used to send one message - per line of text. If the property is not set, the entire contents of the FlowFile - will be sent as a single message. When using the delimiter, if some messages are - successfully sent but other messages fail to send, the FlowFile will be FORKed into - two child FlowFiles, with the successfully sent messages being routed to 'success' - and the messages that could not be sent going to 'failure'. -

- -

- Properties: -

-

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.

- - - -

- Relationships: -

- - - - diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.Base64EncodeContent/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.Base64EncodeContent/index.html deleted file mode 100644 index c6a4b4d3ba..0000000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.Base64EncodeContent/index.html +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - EncodeContent - - - - - -

Description:

-

- This processor base64 encodes FlowFile content, or decodes FlowFile content from base64. -

- Properties: -

-

- 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. -

- - -

- Relationships: -

- - - - - diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.CompressContent/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.CompressContent/additionalDetails.html new file mode 100644 index 0000000000..4339e32c05 --- /dev/null +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.CompressContent/additionalDetails.html @@ -0,0 +1,68 @@ + + + + + + CompressContent + + + + + + + + +

+ Uses Attributes: +

+ + + + + + + + + + + + + +
Attribute NameDescription
mime.typeIf the Compression Format is set to use mime.type attribute, + this attribute is used to determine the compression type. Otherwise, this attribute is ignored.
+ +

+ Modifies Attributes: +

+ + + + + + + + + + + + + +
Attribute NameDescription
mime.typeIf the Mode property is set to compress, the appropriate MIME Type is set. If the + Mode property is set to decompress and the file is successfully decompressed, + this attribute is removed, as the MIME Type is no longer known. +
+ + diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.CompressContent/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.CompressContent/index.html deleted file mode 100644 index aa5251ded5..0000000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.CompressContent/index.html +++ /dev/null @@ -1,166 +0,0 @@ - - - - - - CompressContent - - - - - - - -

Description:

-

-

- This processor compresses and decompresses the contents of - FlowFiles using a user-specified compression algorithm. -

- -

- Uses Attributes: -

- - - - - - - - - - - - - -
Attribute NameDescription
mime.typeIf the Compression Format is set to use mime.type attribute, - this attribute is used to determine the compression type. Otherwise, this attribute is ignored.
- -

- Modifies Attributes: -

- - - - - - - - - - - - - -
Attribute NameDescription
mime.typeIf the Mode property is set to compress, the appropriate MIME Type is set. If the - Mode property is set to decompress and the file is successfully decompressed, - this attribute is removed, as the MIME Type is no longer known. -
- -

- Properties: -

-

- 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. -

- - -

- Relationships: -

- - - - diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ControlRate/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ControlRate/index.html deleted file mode 100644 index cbe1088ad2..0000000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ControlRate/index.html +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - ControlRate - - - - - - - -

Description:

-

This processor controls the rate at which data is - transferred to follow-on processors. -

- -

- Properties: -

-

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.

- - -

- Relationships: -

- - - - - - - - - - - - diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ConvertCharacterSet/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ConvertCharacterSet/index.html deleted file mode 100644 index 9a888151e4..0000000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ConvertCharacterSet/index.html +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - ConvertCharacterSet - - - - - -

Description:

-

This processor converts a FlowFile's content from one - character set to another.

-

- Properties: -

-

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.

- - -

- Relationships: -

- - - - - diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.DetectDuplicate/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.DetectDuplicate/additionalDetails.html new file mode 100644 index 0000000000..c0b65b9167 --- /dev/null +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.DetectDuplicate/additionalDetails.html @@ -0,0 +1,58 @@ + + + + + + DetectDuplicate + + + + + + +

+ Modifies Attributes: +

+ + + + + + + + + + + + + +
Attribute NameDescription
original.flowfile.descriptionAll FlowFiles routed to the duplicate + relationship will have an attribute added named original.flowfile.description. + The value of this attribute is determined by the attributes of the + original copy of the data and by the FlowFile Description property +
+ +

+ See Also: +

+ + + + + diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.DetectDuplicate/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.DetectDuplicate/index.html deleted file mode 100644 index 87e066c91d..0000000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.DetectDuplicate/index.html +++ /dev/null @@ -1,147 +0,0 @@ - - - - - - DetectDuplicate - - - - - -

Description:

-

This processor detects duplicate data by examining flow file attributes, - thus allowing the user to configure what it means for two FlowFiles to be - considered "duplicates". This processor does not read the contents of a - flow file, and is typically preceded by another processor which computes a - value based on the flow file content and adds that value to the flow file's - attributes; e.g. HashContent. Because this Processor needs to be able - to work within a NiFi cluster, it makes use of a distributed cache service to - determine whether or not the data has been seen previously.

- -

- If the processor is to be run on a standalone instance of - NiFi, that instance should have both a - DistributedMapCacheClient and a DistributedMapCacheServer configured - in its controller-services.xml file. -

- -

- Modifies Attributes: -

- - - - - - - - - - - - - -
Attribute NameDescription
original.flowfile.descriptionAll FlowFiles routed to the duplicate - relationship will have an attribute added named original.flowfile.description. - The value of this attribute is determined by the attributes of the - original copy of the data and by the FlowFile Description property -
- -

- Properties: -

-

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.

- - -

- Relationships: -

- - - -

- See Also: -

- - - - - diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.DistributeLoad/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.DistributeLoad/additionalDetails.html similarity index 54% rename from nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.DistributeLoad/index.html rename to nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.DistributeLoad/additionalDetails.html index f1ca056d68..0c16e4fc7f 100644 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.DistributeLoad/index.html +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.DistributeLoad/additionalDetails.html @@ -34,58 +34,12 @@ FlowFiles in each iteration instead of 1. All other relationships will receive 1 FlowFile in each iteration.

Properties: -

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.

-

Relationships:

diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EncryptContent/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EncryptContent/index.html deleted file mode 100644 index ed49aaa80b..0000000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EncryptContent/index.html +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - EncryptContent - - - - - -

Description:

-

- This processor encrypts or decrypts FlowFiles. -

- Properties: -

-

- 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. -

- - -

- Relationships: -

- - - - - diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EvaluateRegularExpression/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EvaluateRegularExpression/index.html deleted file mode 100644 index 87a99dbe2f..0000000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EvaluateRegularExpression/index.html +++ /dev/null @@ -1,160 +0,0 @@ - - - - - - EvaluateRegularExpression - - - - - -

Description:

-

- This processor evaluates one or more Regular Expressions against the content of a FlowFile. - The results of those Regular Expressions are assigned to FlowFile Attributes. - Regular Expressions are entered by adding user-defined properties; - the name of the property maps to the Attribute Name into which the result will be placed. - The value of the property must be a valid Regular Expressions with exactly one capturing group. - If the Regular Expression matches more than once, only the first match will be used. - If any provided Regular Expression matches, the FlowFile(s) will be routed to 'matched'. - If no provided Regular Expression matches, the FlowFile will be routed to 'unmatched' and no attributes will be applied to the FlowFile. - -

- Properties: -

-

- 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. -

- -

- Modifies Attributes: -

-

- This processor adds user-defined attributes. -

- - - -

- Relationships: -

- -

- - diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EvaluateXPath/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EvaluateXPath/additionalDetails.html new file mode 100644 index 0000000000..5fe58a5b26 --- /dev/null +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EvaluateXPath/additionalDetails.html @@ -0,0 +1,34 @@ + + + + + + EvaluateXPath + + + + + + +

+ Modifies Attributes: +

+

+ This processor adds user-defined attributes if the <Destination> property is set to + flowfile-attribute. +

+ + diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EvaluateXPath/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EvaluateXPath/index.html deleted file mode 100644 index e1f0fa9040..0000000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EvaluateXPath/index.html +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - EvaluateXPath - - - - - -

Description:

-

- This processor evaluates one or more XPaths against the content - of FlowFiles. The results of those XPaths are assigned to FlowFile - attributes or are written to the content of the FlowFile itself, - depending on how the user configures the Destination and Return Type properties in the - processor. XPaths are entered by adding user-defined properties; the - name of each user-added property maps to the attribute name into - which the result should be placed. The value of the property must be - a valid XPath expression. -

- Properties: -

-

- 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. -

- -

- Modifies Attributes: -

-

- This processor adds user-defined attributes if the <Destination> property is set to - flowfile-attribute. -

- - - - -

- Relationships: -

- -

- - diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EvaluateXQuery/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EvaluateXQuery/additionalDetails.html new file mode 100644 index 0000000000..3d120a45b7 --- /dev/null +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EvaluateXQuery/additionalDetails.html @@ -0,0 +1,161 @@ + + + + + +EvaluateXQuery + + + + + + + + + +

+ Modifies Attributes: +

+ +

+ This processor adds user-defined attributes if the <Destination> + property is set to + flowfile-attribute + . +

+ + +

+ Examples: +

+ +

This processor produces one attribute or FlowFile per + XQueryResult. If only one attribute or FlowFile is desired, the + following examples demonstrate how this can be achieved using the + XQuery language. The examples below reference the following sample + XML:

+ + 
+		
+  <?xml version="1.0" encoding="UTF-8"?>
+  <?xml-stylesheet type="text/xsl" href="foo.xsl"?>
+  <ns:fruitbasket xmlns:ns="http://namespace/1">
+    <fruit taste="crisp">    
+      <!-- Apples are my favorite-->   
+      <name>apple</name>   
+      <color>red</color>  
+    </fruit>  
+    <fruit>   
+      <name>apple</name>   
+      <color>green</color>  
+    </fruit>  
+    <fruit>   
+      <name>banana</name>   
+      <color>yellow</color>  
+    </fruit>  
+    <fruit taste="sweet">   
+      <name>orange</name>   
+      <color>orange</color>  
+    </fruit>  
+    <fruit>   
+      <name>blueberry</name>   
+      <color>blue</color>  
+    </fruit>  
+      <fruit taste="tart">   
+      <name>raspberry</name>   
+      <color>red</color>  
+    </fruit>  
+    <fruit>   
+      <name>none</name>    
+      <color/>  
+    </fruit>
+  </ns:fruitbasket>
+
+
+ +

+

+ + diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EvaluateXQuery/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EvaluateXQuery/index.html deleted file mode 100644 index 7db8cba34b..0000000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EvaluateXQuery/index.html +++ /dev/null @@ -1,311 +0,0 @@ - - - - - - EvaluateXQuery - - - - - - - -

Description:

- -

This processor evaluates one or more XQueries against the - content of FlowFiles. The results of those XQueries are assigned to - FlowFile attributes or are written to the content of the FlowFile - itself, depending on how the user configures the Destination property - in the processor. One attribute or FlowFile is produced for each XQuery - result. Each produced FlowFile will carry the attributes of the input - FlowFile. See the "Examples" section for details on how - multiple results can be wrapped or concatenated. XQueries are - entered by adding user-defined - properties; the name of each user-added property maps to the attribute - name into which the result should be placed. The value of the property - must be a valid XQuery expression.

- -

Properties:

- -

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.

- -

Modifies Attributes:

- -

This processor adds user-defined attributes if the - <Destination> property is set to flowfile-attribute - .

- - - -

Relationships:

- - - -

Examples:

- -

This processor produces one attribute or FlowFile per - XQueryResult. If only one attribute or FlowFile is desired, the following - examples demonstrate how this can be achieved using the XQuery - language. The examples below reference the following sample XML:

- - 

-  <?xml version="1.0" encoding="UTF-8"?>
-  <?xml-stylesheet type="text/xsl" href="foo.xsl"?>
-  <ns:fruitbasket xmlns:ns="http://namespace/1">
-    <fruit taste="crisp">    
-      <!-- Apples are my favorite-->   
-      <name>apple</name>   
-      <color>red</color>  
-    </fruit>  
-    <fruit>   
-      <name>apple</name>   
-      <color>green</color>  
-    </fruit>  
-    <fruit>   
-      <name>banana</name>   
-      <color>yellow</color>  
-    </fruit>  
-    <fruit taste="sweet">   
-      <name>orange</name>   
-      <color>orange</color>  
-    </fruit>  
-    <fruit>   
-      <name>blueberry</name>   
-      <color>blue</color>  
-    </fruit>  
-      <fruit taste="tart">   
-      <name>raspberry</name>   
-      <color>red</color>  
-    </fruit>  
-    <fruit>   
-      <name>none</name>    
-      <color/>  
-    </fruit>
-  </ns:fruitbasket>
-
- -

-

-

- - diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ExecuteStreamCommand/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ExecuteStreamCommand/additionalDetails.html new file mode 100644 index 0000000000..0aa703b673 --- /dev/null +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ExecuteStreamCommand/additionalDetails.html @@ -0,0 +1,57 @@ + + + + + + ExecuteStreamCommand + + + + + + + +

+ Creates Attributes: +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Attribute NameDescription
execution.commandThe name of the command executed to create the new FlowFile
execution.command.argsThe semi-colon delimited list of arguments
execution.statusThe exit status code returned from executing the command
execution.errorAny error messages returned from executing the command
+ + diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ExecuteStreamCommand/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ExecuteStreamCommand/index.html deleted file mode 100644 index 94d0f03fb7..0000000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ExecuteStreamCommand/index.html +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - ExecuteStreamCommand - - - - - - -

Description:

-

This processor executes an external command on the contents of a FlowFile, and creates a new FlowFile with the - results of the command.

-

- Creates Attributes: -

- - - - - - - - - - - - - - - - - - - - - - - - - -
Attribute NameDescription
execution.commandThe name of the command executed to create the new FlowFile
execution.command.argsThe semi-colon delimited list of arguments
execution.statusThe exit status code returned from executing the command
execution.errorAny error messages returned from executing the command
-

- Properties: -

-

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.

- - -

- Relationships: -

- - - diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GenerateFlowFile/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GenerateFlowFile/index.html deleted file mode 100644 index ef1f26b539..0000000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GenerateFlowFile/index.html +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - GenerateFlowFile - - - - - -

Description:

-

- This processor creates FlowFiles of random data to be used for load testing purposes. -

-

- Properties: -

-

- 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. -

- - -

- Relationships: -

- - - - - - - diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetFTP/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetFTP/additionalDetails.html new file mode 100644 index 0000000000..92d69fd1c0 --- /dev/null +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetFTP/additionalDetails.html @@ -0,0 +1,74 @@ + + + + + + GetFTP + + + + + + +

+ Modifies Attributes: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Attribute NameDescription
filenameThe filename is set to the name of the file on the remote server
pathThe path is set to the path of the file's + directory on the remote server. For example, if the <Remote Path> + property is set to /tmp, files picked up from /tmp + will have the path attribute set to /tmp. If the + <Search Recursively> property is set to true + and a file is picked up from /tmp/abc/1/2/3, then the path + attribute will be set to /tmp/abc/1/2/3
file.lastModifiedTimeThe date and time that the source file was last modified.
file.ownerThe numeric owner id of the source file.
file.groupThe numeric group id of the source file.
file.permissionsThe read/write/execute permissions of the source file.
absolute.pathThe full/absolute path from where a file was picked up. The current 'path' attribute is still populated, but may be a relative path.
+ + diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetFTP/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetFTP/index.html deleted file mode 100644 index e5d3af9cee..0000000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetFTP/index.html +++ /dev/null @@ -1,227 +0,0 @@ - - - - - - GetFTP - - - - - -

Description:

-

This processor fetches files from an FTP server and creates - FlowFiles from them.

- -

- Modifies Attributes: -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Attribute NameDescription
filenameThe filename is set to the name of the file on the remote server
pathThe path is set to the path of the file's - directory on the remote server. For example, if the <Remote Path> - property is set to /tmp, files picked up from /tmp - will have the path attribute set to /tmp. If the - <Search Recursively> property is set to true - and a file is picked up from /tmp/abc/1/2/3, then the path - attribute will be set to /tmp/abc/1/2/3
file.lastModifiedTimeThe date and time that the source file was last modified.
file.ownerThe numeric owner id of the source file.
file.groupThe numeric group id of the source file.
file.permissionsThe read/write/execute permissions of the source file.
absolute.pathThe full/absolute path from where a file was picked up. The current 'path' attribute is still populated, but may be a relative path.
- -

- Properties: -

-

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.

- -

- Relationships: -

- - - - - diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetFile/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetFile/additionalDetails.html new file mode 100644 index 0000000000..76046c6485 --- /dev/null +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetFile/additionalDetails.html @@ -0,0 +1,79 @@ + + + + + + GetFile + + + + + + +

+ Modifies Attributes: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Attribute NameDescription
filenameThe filename is set to the name of the file on disk
pathThe path is set to the relative path of the file's directory on disk. For example, if the <Input Directory> + property is set to /tmp, files picked up from /tmp will have the path attribute set to ./. + If the <Recurse Subdirectories> property is set to true and a file is picked up + from /tmp/abc/1/2/3, then the path attribute will be set to abc/1/2/3 +
file.creationTimeThe date and time that the file was created. May not work on all file systems
file.lastModifiedTimeThe date and time that the file was last modified. May not work on all file systems
file.lastAccessTimeThe date and time that the file was last accessed. May not work on all file systems
file.ownerThe owner of the file. May not work on all file systems
file.groupThe group owner of the file. May not work on all file systems
file.permissionsThe read/write/execute permissions of the file. May not work on all file systems
absolute.pathThe full/absolute path from where a file was picked up. The current 'path' attribute is still populated, but may be a relative path.
+ + diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetFile/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetFile/index.html deleted file mode 100644 index 9faa12883b..0000000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetFile/index.html +++ /dev/null @@ -1,186 +0,0 @@ - - - - - - GetFile - - - - - -

Description:

-

This processor obtains FlowFiles from a local directory. NiFi will need at least read permissions on the files it will pull otherwise it will ignore them.

- -

- Modifies Attributes: -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Attribute NameDescription
filenameThe filename is set to the name of the file on disk
pathThe path is set to the relative path of the file's directory on disk. For example, if the <Input Directory> - property is set to /tmp, files picked up from /tmp will have the path attribute set to ./. - If the <Recurse Subdirectories> property is set to true and a file is picked up - from /tmp/abc/1/2/3, then the path attribute will be set to abc/1/2/3 -
file.creationTimeThe date and time that the file was created. May not work on all file systems
file.lastModifiedTimeThe date and time that the file was last modified. May not work on all file systems
file.lastAccessTimeThe date and time that the file was last accessed. May not work on all file systems
file.ownerThe owner of the file. May not work on all file systems
file.groupThe group owner of the file. May not work on all file systems
file.permissionsThe read/write/execute permissions of the file. May not work on all file systems
absolute.pathThe full/absolute path from where a file was picked up. The current 'path' attribute is still populated, but may be a relative path.
- -

- Properties: -

-

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.

- -

- Relationships: -

- - - - diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetHTTP/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetHTTP/additionalDetails.html new file mode 100644 index 0000000000..94f639bf67 --- /dev/null +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetHTTP/additionalDetails.html @@ -0,0 +1,45 @@ + + + + + + GetHTTP + + + + + +

Description:

+ +

+ Modifies Attributes: +

+ + + + + + + + + + + + + +
Attribute NameDescription
filenameThe filename is set to the name of the file on the remote server
+ + diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetHTTP/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetHTTP/index.html deleted file mode 100644 index 37eb4796e3..0000000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetHTTP/index.html +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - GetHTTP - - - - - -

Description:

-

This processor fetches files via HTTP and creates FlowFiles - from them. -

- -

- Modifies Attributes: -

- - - - - - - - - - - - - -
Attribute NameDescription
filenameThe filename is set to the name of the file on the remote server
- -

- Properties: -

-

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.

- -

- Relationships: -

- - - - - diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetJMSQueue/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetJMSQueue/index.html deleted file mode 100644 index bcbf0dd540..0000000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetJMSQueue/index.html +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - GetJMSQueue - - - - - -

Description:

-

- This processor pulls messages from a JMS Queue, creating a FlowFile for each JMS message or bundle of messages, as configured. -

-

- Properties: -

-

- 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. -

- -

- Relationships: -

- - - - - diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetJMSTopic/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetJMSTopic/index.html deleted file mode 100644 index 3496df8273..0000000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetJMSTopic/index.html +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - GetJMSTopic - - - - - -

Description:

-

- This processor pulls messages from a JMS Topic, creating a FlowFile for each JMS message or bundle of messages, as configured. -

-

- Properties: -

-

- 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. -

- -

- Relationships: -

- - - - diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetSFTP/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetSFTP/additionalDetails.html new file mode 100644 index 0000000000..8cb65261c9 --- /dev/null +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetSFTP/additionalDetails.html @@ -0,0 +1,80 @@ + + + + + + GetSFTP + + + + + + + +

+ Modifies Attributes: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Attribute NameDescription
filenameThe filename is set to the name of the file on the remote server
pathThe path is set to the path of the file's + directory on the remote server. For example, if the <Remote Path> + property is set to /tmp, files picked up from /tmp + will have the path attribute set to /tmp. If the + <Search Recursively> property is set to true + and a file is picked up from /tmp/abc/1/2/3, then the path + attribute will be set to /tmp/abc/1/2/3
file.lastModifiedTimeThe date and time that the source file was last modified.
file.ownerThe numeric owner id of the source file.
file.groupThe numeric group id of the source file.
file.permissionsThe read/write/execute permissions of the source file.
absolute.pathThe full/absolute path from where a file was picked up. The current 'path' attribute is still populated, but may be a relative path.
+

+ See Also: +

+ + diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetSFTP/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetSFTP/index.html deleted file mode 100644 index 708f5a35bc..0000000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetSFTP/index.html +++ /dev/null @@ -1,250 +0,0 @@ - - - - - - GetSFTP - - - - - - -

Description:

-

This processor pulls files from an SFTP server and creates - FlowFiles to encapsulate them. -

- -

- Modifies Attributes: -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Attribute NameDescription
filenameThe filename is set to the name of the file on the remote server
pathThe path is set to the path of the file's - directory on the remote server. For example, if the <Remote Path> - property is set to /tmp, files picked up from /tmp - will have the path attribute set to /tmp. If the - <Search Recursively> property is set to true - and a file is picked up from /tmp/abc/1/2/3, then the path - attribute will be set to /tmp/abc/1/2/3
file.lastModifiedTimeThe date and time that the source file was last modified.
file.ownerThe numeric owner id of the source file.
file.groupThe numeric group id of the source file.
file.permissionsThe read/write/execute permissions of the source file.
absolute.pathThe full/absolute path from where a file was picked up. The current 'path' attribute is still populated, but may be a relative path.
- -

- Properties: -

-

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.

- - -

- Relationships: -

- - -

- See Also: -

-

- - diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.HashAttribute/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.HashAttribute/additionalDetails.html new file mode 100644 index 0000000000..165568c5a4 --- /dev/null +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.HashAttribute/additionalDetails.html @@ -0,0 +1,35 @@ + + + + + + HashAttribute + + + + + + + +

+ Modifies Attributes: +

+

+ This Processor adds an attribute whose value is the result of Hashing the existing FlowFile attributes. + The name of this attribute is specified by the <Hash Value Attribute Key> property. +

+ + diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.HashAttribute/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.HashAttribute/index.html deleted file mode 100644 index a2d4fd2b52..0000000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.HashAttribute/index.html +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - HashAttribute - - - - - -

Description:

-

This processor hashes together the key/value pairs of - several FlowFile attributes and adds the hash as a new attribute. The - user may add optional properties such that the name of each property - is the name of a FlowFile attribute to consider and the value of the - property is a regular expression that, if matched by the attribute - value, causes that attribute to be used as part of the hash. If the - regular expression contains a capturing group, only the value of the - capturing group is used. -

- -

- Modifies Attributes: -

-

- This Processor adds an attribute whose value is the result of Hashing the existing FlowFile attributes. - The name of this attribute is specified by the <Hash Value Attribute Key> property. -

- -

- Properties: -

-

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.

- - -

- Relationships: -

- - - - - diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.HashContent/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.HashContent/additionalDetails.html new file mode 100644 index 0000000000..8a3d1cbd7f --- /dev/null +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.HashContent/additionalDetails.html @@ -0,0 +1,35 @@ + + + + + + HashContent + + + + + + + +

+ Modifies Attributes: +

+

+ This Processor adds an attribute whose value is the result of Hashing the existing FlowFile attributes. + The name of this attribute is specified by the <Hash Attribute Name> property. +

+ + diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.HashContent/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.HashContent/index.html deleted file mode 100644 index a14265f092..0000000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.HashContent/index.html +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - HashContent - - - - - -

Description:

-

- This processor calculates a hash value for the content of a - FlowFile and puts the hash value on the FlowFile as an attribute whose - name is determined by the Hash Attribute Name - property. -

- -

- Modifies Attributes: -

-

- This Processor adds an attribute whose value is the result of Hashing the existing FlowFile attributes. - The name of this attribute is specified by the <Hash Attribute Name> property. -

- - -

- Properties: -

-

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.

- - - -

- Relationships: -

- - - - - diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.IdentifyMimeType/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.IdentifyMimeType/additionalDetails.html similarity index 73% rename from nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.IdentifyMimeType/index.html rename to nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.IdentifyMimeType/additionalDetails.html index 120b69cd84..1fb55667f7 100644 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.IdentifyMimeType/index.html +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.IdentifyMimeType/additionalDetails.html @@ -42,6 +42,7 @@

The following MIME Types are detected: +

-

+

Modifies Attributes: @@ -93,44 +94,5 @@ - -

- Properties: -

-

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.

- - - -

- Relationships: -

- - diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.InvokeHTTP/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.InvokeHTTP/additionalDetails.html new file mode 100644 index 0000000000..f7f06a047b --- /dev/null +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.InvokeHTTP/additionalDetails.html @@ -0,0 +1,64 @@ + + + + + + InvokeHTTP - a swiss army http client processor + + + + + +

+ Adds Attributes: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Attribute NameDescription
invokehttp.status.codeThe status code that is returned.
invokehttp.status.messageThe status message that is returned.
invokehttp.response.bodyThe response body.
invokehttp.request.urlThe request URL.
invokehttp.tx.idThe transaction ID that is returned after reading the response.
invokehttp.remote.dnThe DN of the remote server.
+ + diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.InvokeHTTP/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.InvokeHTTP/index.html deleted file mode 100644 index 2907034bfa..0000000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.InvokeHTTP/index.html +++ /dev/null @@ -1,181 +0,0 @@ - - - - - - InvokeHTTP - a swiss army http client processor - - - - -

Description:

-

- Making requests to remote HTTP servers. Supporting common HTTP methods. - Storing results as new flowfiles upon success. Routing to failure on error. -

-

- An HTTP client processor that converts FlowFile attributes to HTTP headers with configurable HTTP method, URL, etc. -

- -

- Adds Attributes: -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Attribute NameDescription
invokehttp.status.codeThe status code that is returned.
invokehttp.status.messageThe status message that is returned.
invokehttp.response.bodyThe response body.
invokehttp.request.urlThe request URL.
invokehttp.tx.idThe transaction ID that is returned after reading the response.
invokehttp.remote.dnThe DN of the remote server.
- -

- Properties: -

- -

- Relationships: -

- - - - diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ListenHTTP/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ListenHTTP/index.html deleted file mode 100644 index 49e85cc825..0000000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ListenHTTP/index.html +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - ListenHTTP - - - - - -

Description:

-

- This processor starts an HTTP service that is used to receive FlowFiles from remote sources. The URL of the service is http://{hostname}:{port}/contentListener. -

-

- Properties: -

-

- 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. -

- - -

- Relationships: -

- - - - - diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ListenUDP/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ListenUDP/index.html deleted file mode 100644 index c50e79d651..0000000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ListenUDP/index.html +++ /dev/null @@ -1,144 +0,0 @@ - - - - - - ListenUDP - - - - - - -

Description:

-

- This processor listens for Datagram Packets on a given port and concatenates the contents of - those packets together generating FlowFiles roughly as often as the internal buffer fills up or until - no more data is currently available. -

-

- Properties: -

-

- 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. -

- - -

- Relationships: -

- - - - diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.LogAttribute/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.LogAttribute/index.html deleted file mode 100644 index 33ab03cad3..0000000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.LogAttribute/index.html +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - LogAttribute - - - - - - -

Description:

-

- This processor reads the attributes on incoming FlowFiles and prints those attributes and their values to the log at the logging level specified by the user.

-

- Properties: -

-

- 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. -

- - -

- Relationships: -

- - - - - - diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.MergeContent/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.MergeContent/additionalDetails.html new file mode 100644 index 0000000000..68f70076be --- /dev/null +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.MergeContent/additionalDetails.html @@ -0,0 +1,115 @@ + + + + + + MergeContent + + + + + + + +

+ Uses Attributes: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Attribute NameDescription
fragment.identifierApplicable only if the <Merge Strategy> property is set to Defragment. + All FlowFiles with the same value for this attribute will be bundled together. +
fragment.indexApplicable only if the <Merge Strategy> property is set to Defragment. + This attribute must be present on all FlowFiles with the same value for the fragment.identifier + attribute and must be a unique integer between 0 and the value of the fragment.count attribute. + This attribute indicates the order in which the fragments should be assembled. +
fragment.countApplicable only if the <Merge Strategy> property is set to Defragment. + This attribute must be present on all FlowFiles with the same value for the fragment.identifier + attribute. All FlowFiles in the same bundle must have the same value for this attribute. The value of + this attribute indicates how many FlowFiles should be expected in the given bundle. +
segment.original.filenameApplicable only if the <Merge Strategy> property is set to Defragment. + This attribute must be present on all FlowFiles with the same value for the fragment.identifier + attribute. All FlowFiles in the same bundle must have the same value for this attribute. The value of + this attribute will be used for the filename of the completed merged FlowFile. +
tar.permissionsApplicable only if the <Merge Format> property is set to TAR. + The value of this attribute must be 3 characters; each character must be in the range 0 to 7 (inclusive) + and indicates the file permissions that should be used for the FlowFile's TAR entry. If this attribute + is missing or has an invalid value, the default value of 644 will be used. +
+ +

+ Modifies Attributes: +

+ + + + + + + + + + + + + + + + + + + + + +
Attribute NameDescription
filenameWhen more than 1 file is merged, the filename comes from the segment.original.filename attribute. + If that attribute does not exist in the source FlowFiles, then the filename is set to the number of + nanoseconds matching system time. Then a filename extension may be applied: +
    +
  • if Merge Format is TAR, then the filename will be appended with .tar
    • +
  • if Merge Format is ZIP, then the filename will be appended with .zip
    • +
  • if Merge Format is FlowFileStream, then the filename will be appended with .pkg
    • +
+
merge.countThe number of FlowFiles that were merged into this bundle.
merge.bin.ageThe age of the bin, in milliseconds, when it was merged and output. Effectively this is the + greatest amount of time that any FlowFile in this bundle remained waiting in this processor before it + was output.
+ + diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.MergeContent/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.MergeContent/index.html deleted file mode 100644 index 3e02b816f8..0000000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.MergeContent/index.html +++ /dev/null @@ -1,347 +0,0 @@ - - - - - - MergeContent - - - - - - -

Description:

-

This processor merges a group of FlowFiles together into a - "Bundle" based on a user-defined strategy and packages them into a - single FlowFile. It is recommended that the processor be configured - with only a single incoming connection, as groups of FlowFiles will - not be created from FlowFiles in different connections. This processor - updates the mime.type attribute as appropriate. After files have been merged by this processor, they can be - unpackaged later using the UnpackContent processor.

- -

- Uses Attributes: -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Attribute NameDescription
fragment.identifierApplicable only if the <Merge Strategy> property is set to Defragment. - All FlowFiles with the same value for this attribute will be bundled together. -
fragment.indexApplicable only if the <Merge Strategy> property is set to Defragment. - This attribute must be present on all FlowFiles with the same value for the fragment.identifier - attribute and must be a unique integer between 0 and the value of the fragment.count attribute. - This attribute indicates the order in which the fragments should be assembled. -
fragment.countApplicable only if the <Merge Strategy> property is set to Defragment. - This attribute must be present on all FlowFiles with the same value for the fragment.identifier - attribute. All FlowFiles in the same bundle must have the same value for this attribute. The value of - this attribute indicates how many FlowFiles should be expected in the given bundle. -
segment.original.filenameApplicable only if the <Merge Strategy> property is set to Defragment. - This attribute must be present on all FlowFiles with the same value for the fragment.identifier - attribute. All FlowFiles in the same bundle must have the same value for this attribute. The value of - this attribute will be used for the filename of the completed merged FlowFile. -
tar.permissionsApplicable only if the <Merge Format> property is set to TAR. - The value of this attribute must be 3 characters; each character must be in the range 0 to 7 (inclusive) - and indicates the file permissions that should be used for the FlowFile's TAR entry. If this attribute - is missing or has an invalid value, the default value of 644 will be used. -
- -

- Modifies Attributes: -

- - - - - - - - - - - - - - - - - - - - - -
Attribute NameDescription
filenameWhen more than 1 file is merged, the filename comes from the segment.original.filename attribute. - If that attribute does not exist in the source FlowFiles, then the filename is set to the number of - nanoseconds matching system time. Then a filename extension may be applied: -
    -
  • if Merge Format is TAR, then the filename will be appended with .tar
    • -
  • if Merge Format is ZIP, then the filename will be appended with .zip
    • -
  • if Merge Format is FlowFileStream, then the filename will be appended with .pkg
    • -
-
merge.countThe number of FlowFiles that were merged into this bundle.
merge.bin.ageThe age of the bin, in milliseconds, when it was merged and output. Effectively this is the - greatest amount of time that any FlowFile in this bundle remained waiting in this processor before it - was output.
- -

- Properties: -

-

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.

- - -

- Relationships: -

- - - diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ModifyBytes/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ModifyBytes/index.html deleted file mode 100644 index 285814c5c2..0000000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ModifyBytes/index.html +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - ModifyBytes - - - - - - -

Description:

-

- This processor updates the content of a FlowFile by removing bytes from start or end of a file. -

-

- Properties: -

-

- 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. -

- - -

- Relationships: -

- - - diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.MonitorActivity/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.MonitorActivity/additionalDetails.html new file mode 100644 index 0000000000..e05db70d4f --- /dev/null +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.MonitorActivity/additionalDetails.html @@ -0,0 +1,49 @@ + + + + + + MonitorActivity + + + + + + + +

+ Modifies Attributes: +

+ + + + + + + + + + + + + + + + + +
Attribute NameDescription
inactivityStartMillisThe time at which Inactivity began, in the form of milliseconds since Epoch.
inactivityDurationMillisThe number of milliseconds that the inactivity has spanned.
+ + diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.MonitorActivity/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.MonitorActivity/index.html deleted file mode 100644 index d57c640a60..0000000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.MonitorActivity/index.html +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - MonitorActivity - - - - - - -

Description:

-

This processor monitors its point in the dataflow for - activity and sends a notice when there is a lack of data flowing - through it for some user-specified amount of time; it then sends - another notice when the flow of data resumes.

- -

- Modifies Attributes: -

- - - - - - - - - - - - - - - - - -
Attribute NameDescription
inactivityStartMillisThe time at which Inactivity began, in the form of milliseconds since Epoch.
inactivityDurationMillisThe number of milliseconds that the inactivity has spanned.
- -

- Properties: -

-

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.

- - -

- Relationships: -

- - - - - diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PostHTTP/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PostHTTP/additionalDetails.html new file mode 100644 index 0000000000..5ba60fac82 --- /dev/null +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PostHTTP/additionalDetails.html @@ -0,0 +1,48 @@ + + + + + + PostHTTP + + + + + + + + + +

+ Uses Attributes: +

+ + + + + + + + + + + + + +
Attribute NameDescription
mime.typeIf not sending data as a FlowFile, the mime.type attribute will be used to set the HTTP Header for Content-Type.
+ + + 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 b32a5869fa..0000000000 --- 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 @@ - - - - - - PostHTTP - - - - - - - - -

Description:

-

This processor performs an HTTP post with the content of - each incoming FlowFile. -

- -

- Uses Attributes: -

- - - - - - - - - - - - - -
Attribute NameDescription
mime.typeIf not sending data as a FlowFile, the mime.type attribute will be used to set the HTTP Header for Content-Type.
- -

- Properties: -

-

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.

- - -

- Relationships: -

- - - - 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 1160dbafc3..0000000000 --- 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 @@ - - - - - - PutEmail - - - - - - -

Description:

-

- This processor sends an e-mail to configured recipients for each incoming FlowFile.

-

- Properties: -

-

- 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. -

- -

- Relationships: -

- - - - - 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 0000000000..fbece63817 --- /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 @@ + + + + + + PutFTP + + + + + + +

+ Optional User-Defined Properties: +

+ + + 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 2edee6a4a1..0000000000 --- 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 @@ - - - - - - PutFTP - - - - - -

Description:

-

- This processor sends FlowFiles via FTP to an FTP server. -

-

- Properties: -

-

- 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. -

- -

- Optional User-Defined Properties: -

-

-

-

- -

- Relationships: -

- - - 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 bdb40d67b0..0000000000 --- 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 @@ - - - - - - PutFile - - - - - - -

Description:

-

- This processor writes FlowFiles to the local file system.

-

- Properties: -

-

- 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. -

- -

- Relationships: -

- - - - 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 387d03c9b5..0000000000 --- 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 @@ - - - - - - PutJMS - - - - - - -

Description:

-

- This processor creates a JMS message from the contents of a FlowFile and sends the message to a JMS server.

-

- Properties: -

-

- 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. -

- -

- Relationships: -

- - - - - 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 0000000000..656e150ebc --- /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 @@ + + + + + + PutSFTP + + + + + +

+ See Also: +

+ + + 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 8f30e7beb2..0000000000 --- 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 @@ - - - - - - PutSFTP - - - - - -

Description:

-

- This processor sends FlowFiles via SFTP to an SFTP server. -

-

- Properties: -

-

- 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. -

- - -

- Relationships: -

- - -

- See Also: -

-

- - 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 ffcf205e02..0000000000 --- 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 @@ - - - - - - ReplaceText - - - - - - -

Description:

-

- 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. -

-

- Properties: -

-

- 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. -

- - -

- Relationships: -

- - - - - 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 1d2eb2cd00..0000000000 --- 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 @@ - - - - - ReplaceText - - - - - - -

Description:

-

- 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. -

-

- Properties: -

-

- 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. -

- -

- Relationships: -

- - 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 0000000000..9bd3c383f9 --- /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 @@ + + + + + + RouteOnAttribute + + + + + +

Description:

+

+ 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). +

+

+ 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: +

+ +

+ In this example, all files with filenames that start with ABC will follow the ABC relationship. +

+ + 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 5b7f820bb7..0000000000 --- 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 @@ - - - - - - RouteOnAttribute - - - - - -

Description:

-

- 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). -

-

- 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: -

- -

- In this example, all files with filenames that start with ABC will follow the ABC relationship. -

- -

- Properties: -

-

- In the list below, the names of required properties appear - in bold. -

- - - -

- Relationships: -

- - - - - - 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 039a142b1d..0000000000 --- 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 @@ - - - - - - RouteOnContent - - - - - - -

Description:

-

- 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. -

- - Properties: -

-

- 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. -

- - -

- Relationships: -

- - - - - 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 3c4317faa0..0000000000 --- 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 @@ - - - - - - ScanAttribute - - - - - - -

Description:

-

- This processor scans the specified attributes of FlowFiles, checking to see if any of their values are present within the specified dictionary of terms. -

- - Properties: -

-

- 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. -

- - -

- Relationships: -

- - - - 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 0000000000..5be4580fa5 --- /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 @@ + + + + + + ScanContent + + + + + + + +

+ Modifies Attributes: +

+ + + + + + + + + + + + + +
Attribute NameDescription
matching.termThe 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.
+ + 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 aa49861023..0000000000 --- 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 @@ - - - - - - ScanContent - - - - - - -

Description:

-

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. -

- -

- Modifies Attributes: -

- - - - - - - - - - - - - -
Attribute NameDescription
matching.termThe 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.
- -

- Properties: -

-

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.

- - -

- Relationships: -

- - - - - 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/additionalDetails.html similarity index 68% rename from nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.SegmentContent/index.html rename to nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.SegmentContent/additionalDetails.html index d969fd9443..9e71b83dc6 100644 --- 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/additionalDetails.html @@ -23,10 +23,7 @@ -

Description:

-

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.

- +

Adds or Modifies Attributes:

@@ -74,44 +71,6 @@ - -

- Properties: -

-

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.

- - -

- Relationships: -

- -

See Also:

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/additionalDetails.html similarity index 60% rename from nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.SplitContent/index.html rename to nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.SplitContent/additionalDetails.html index 98e726091c..fec022f762 100644 --- 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/additionalDetails.html @@ -23,11 +23,7 @@ -

Description:

-

- This processor splits incoming FlowFiles by a specified byte sequence. -

- +

Modifies Attributes:

@@ -60,42 +56,6 @@ - -

- Properties: -

-

- 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. -

- - -

- Relationships: -

- -

See Also:

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/additionalDetails.html similarity index 54% rename from nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.SplitText/index.html rename to nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.SplitText/additionalDetails.html index 3e999abece..b5588ac18f 100644 --- 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/additionalDetails.html @@ -23,11 +23,7 @@ -

Description:

-

- This processor splits a text file into multiple smaller text files on line boundaries, each having up to a configured number of lines. -

- +

Modifies Attributes:

@@ -65,51 +61,6 @@ -

- Properties: -

-

- 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. -

- - -

- Relationships: -

- -

See Also:

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 87700fff76..0000000000 --- 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 @@ - - - - - - SplitXML - - - - - - -

Description:

-

- This processor splits an XML file into multiple separate FlowFiles, each comprising a child or descendant of the original root element. -

- - Properties: -

-

- 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. -

- - -

- Relationships: -

- - - - 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 2b08d8bef2..0000000000 --- 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 @@ - - - - - - TransformXml - - - - - - -

Description:

-

- This processor transforms the contents of FlowFiles based on a user-specified XSLT stylesheet file. XSL versions 1.0 and 2.0 are supported. -

- - Properties: -

-

- 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. - -

- - - Note that this processor passes all dynamic properties to the transformer, so therefore they will be available for use in the stylesheet. - -

- Relationships: -

- - - - 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/additionalDetails.html similarity index 66% rename from nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.UnpackContent/index.html rename to nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.UnpackContent/additionalDetails.html index b3a522e50f..912be354a8 100644 --- 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/additionalDetails.html @@ -23,12 +23,7 @@ -

Description:

-

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. -

- +

Uses Attributes:

@@ -99,59 +94,7 @@ - -

- Properties: -

-

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.

- - -

- Relationships: -

- - +

See Also:

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/additionalDetails.html similarity index 87% rename from nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-reporting-tasks/src/main/resources/docs/org.apache.nifi.controller.ControllerStatusReportingTask/index.html rename to nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-reporting-tasks/src/main/resources/docs/org.apache.nifi.controller.ControllerStatusReportingTask/additionalDetails.html index 656cf40baa..dd7cd5974f 100644 --- 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/additionalDetails.html @@ -66,20 +66,5 @@ org.apache.nifi.controller.ControllerStatusReportingTask.Processors and org.apache.nifi.controller.ControllerStatusReportingTask.Connections, respectively.

- -

- Properties: -

- - - 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 e02b6493c4..0000000000 --- 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 @@ - - - - - - MonitorDiskUsage - - - - -

Description:

- -

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.

- -

- Properties: -

- - - - - diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-reporting-tasks/src/main/resources/docs/org.apache.nifi.controller.MonitorMemory/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-reporting-tasks/src/main/resources/docs/org.apache.nifi.controller.MonitorMemory/index.html deleted file mode 100644 index 08ec0bff16..0000000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-reporting-tasks/src/main/resources/docs/org.apache.nifi.controller.MonitorMemory/index.html +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - MonitorMemory - - - - -

Description:

- -

Reporting Task that checks how much Java Heap Space is - available after Full Garbage Collections. When the heap exceeds a - specified threshold immediatley following a Full Garbage Collection, - this Reporting Task will create a WARNING level log message and create - a System-Level bulletin to notify the user.

- -

- Properties: -

- - - - - diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-reporting-tasks/src/main/resources/docs/org.apache.nifi.reporting.ganglia.StandardGangliaReporter/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-reporting-tasks/src/main/resources/docs/org.apache.nifi.reporting.ganglia.StandardGangliaReporter/additionalDetails.html similarity index 76% rename from nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-reporting-tasks/src/main/resources/docs/org.apache.nifi.reporting.ganglia.StandardGangliaReporter/index.html rename to nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-reporting-tasks/src/main/resources/docs/org.apache.nifi.reporting.ganglia.StandardGangliaReporter/additionalDetails.html index 48df9a6ee2..9818592ba1 100644 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-reporting-tasks/src/main/resources/docs/org.apache.nifi.reporting.ganglia.StandardGangliaReporter/index.html +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-reporting-tasks/src/main/resources/docs/org.apache.nifi.reporting.ganglia.StandardGangliaReporter/additionalDetails.html @@ -37,29 +37,5 @@
  • Bytes Queued: The total number of bytes allocated by the FlowFiles that are currently queued on the system at the point in time at which the Reporting Task is run
  • Active Threads: The number of threads actively running at the point in time at which the Reporting Task is run
    • - -

    - Properties: -

    - - - diff --git a/nifi/nifi-nar-bundles/nifi-standard-services/nifi-distributed-cache-services-bundle/nifi-distributed-cache-client-service/src/main/resources/docs/org.apache.nifi.distributed.cache.client.DistributedMapCacheClientService/index.html b/nifi/nifi-nar-bundles/nifi-standard-services/nifi-distributed-cache-services-bundle/nifi-distributed-cache-client-service/src/main/resources/docs/org.apache.nifi.distributed.cache.client.DistributedMapCacheClientService/additionalDetails.html similarity index 57% rename from nifi/nifi-nar-bundles/nifi-standard-services/nifi-distributed-cache-services-bundle/nifi-distributed-cache-client-service/src/main/resources/docs/org.apache.nifi.distributed.cache.client.DistributedMapCacheClientService/index.html rename to nifi/nifi-nar-bundles/nifi-standard-services/nifi-distributed-cache-services-bundle/nifi-distributed-cache-client-service/src/main/resources/docs/org.apache.nifi.distributed.cache.client.DistributedMapCacheClientService/additionalDetails.html index 3e5197a5ff..a3bc60f043 100644 --- a/nifi/nifi-nar-bundles/nifi-standard-services/nifi-distributed-cache-services-bundle/nifi-distributed-cache-client-service/src/main/resources/docs/org.apache.nifi.distributed.cache.client.DistributedMapCacheClientService/index.html +++ b/nifi/nifi-nar-bundles/nifi-standard-services/nifi-distributed-cache-services-bundle/nifi-distributed-cache-client-service/src/main/resources/docs/org.apache.nifi.distributed.cache.client.DistributedMapCacheClientService/additionalDetails.html @@ -21,52 +21,6 @@ -

    Description:

    - -

    A Controller Service that can be used to communicate with a - Distributed Map Cache Server.

    - - - -

    - Properties: -

    -

    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.

    - - -

    Below is an example of how to create a client connection to your distributed map cache server. Note that the identifier in this example is cache-client. If you are using this template diff --git a/nifi/nifi-nar-bundles/nifi-standard-services/nifi-distributed-cache-services-bundle/nifi-distributed-cache-client-service/src/main/resources/docs/org.apache.nifi.distributed.cache.client.DistributedSetCacheClientService/index.html b/nifi/nifi-nar-bundles/nifi-standard-services/nifi-distributed-cache-services-bundle/nifi-distributed-cache-client-service/src/main/resources/docs/org.apache.nifi.distributed.cache.client.DistributedSetCacheClientService/additionalDetails.html old mode 100755 new mode 100644 similarity index 70% rename from nifi/nifi-nar-bundles/nifi-standard-services/nifi-distributed-cache-services-bundle/nifi-distributed-cache-client-service/src/main/resources/docs/org.apache.nifi.distributed.cache.client.DistributedSetCacheClientService/index.html rename to nifi/nifi-nar-bundles/nifi-standard-services/nifi-distributed-cache-services-bundle/nifi-distributed-cache-client-service/src/main/resources/docs/org.apache.nifi.distributed.cache.client.DistributedSetCacheClientService/additionalDetails.html index ed1801c893..fa1bf42100 --- a/nifi/nifi-nar-bundles/nifi-standard-services/nifi-distributed-cache-services-bundle/nifi-distributed-cache-client-service/src/main/resources/docs/org.apache.nifi.distributed.cache.client.DistributedSetCacheClientService/index.html +++ b/nifi/nifi-nar-bundles/nifi-standard-services/nifi-distributed-cache-services-bundle/nifi-distributed-cache-client-service/src/main/resources/docs/org.apache.nifi.distributed.cache.client.DistributedSetCacheClientService/additionalDetails.html @@ -21,26 +21,6 @@ -

    Description:

    - -

    A Controller Service that can be used to communicate with a - Distributed Set Cache Server.

    - - - -

    - Properties: -

    -

    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.

    - - - - See Also: