From b1f971335a464f8de34d4f360327f1c9e5e02bbe Mon Sep 17 00:00:00 2001 From: Aldrin Piri Date: Sun, 1 Mar 2015 00:13:22 -0500 Subject: [PATCH] Adding processor documentation for EvaluateJsonPath and SplitJson --- .../index.html | 150 ++++++++++++++++++ .../index.html | 79 +++++++++ 2 files changed, 229 insertions(+) create mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EvaluateJsonPath/index.html create mode 100644 nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.SplitJson/index.html diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EvaluateJsonPath/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EvaluateJsonPath/index.html new file mode 100644 index 0000000000..055a794b01 --- /dev/null +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EvaluateJsonPath/index.html @@ -0,0 +1,150 @@ + + + + + + EvaluateJsonPath + + + + + +

Description:

+ +

+ Evaluates one or more JsonPath expressions against the content of a FlowFile. The results of those expressions are + assigned to FlowFile Attributes or are written to the content of the FlowFile itself, depending on configuration of + the Processor. JsonPaths are entered by adding user-defined properties; the name of the property maps to the + Attribute Name into which the result will be placed (if the Destination is flowfile-attribute; otherwise, the + property name is ignored). The value of the property must be a valid JsonPath expression. If the JsonPath evaluates + to a JSON array or JSON object and the Return Type is set to 'scalar' the FlowFile will be unmodified and will be + routed to failure. A Return Type of JSON can return scalar values if the provided JsonPath evaluates to the + specified value and will be routed as a match. If Destination is 'flowfile-content' and the JsonPath does not + evaluate to a defined path, the FlowFile will be routed to 'unmatched' without having its contents modified. If + Destination is flowfile-attribute and the expression matches nothing, attributes will be created with empty + strings as the value, and the FlowFile will always be routed to 'matched.' + +

+ +

+ 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.SplitJson/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.SplitJson/index.html new file mode 100644 index 0000000000..6fc8e6145a --- /dev/null +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.SplitJson/index.html @@ -0,0 +1,79 @@ + + + + + + SplitJson + + + + + + +

Description:

+ +

+ This processor splits a JSON File into multiple, separate FlowFiles for an array element specified by a JsonPath + expression. + Each generated FlowFile is comprised of an element of the specified array and transferred to relationship 'split,' + with the original file transferred to the 'original' relationship. If the specified JsonPath is not found or + does not evaluate to an array element, the original file is routed to 'failure' and no files are generated. +

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

+ + + +