NIFI-907: Initial commit of core attributes in doc Signed-off-by: Matt Gilman <[email protected]>
Project: http://git-wip-us.apache.org/repos/asf/nifi/repo Commit: http://git-wip-us.apache.org/repos/asf/nifi/commit/690e674a Tree: http://git-wip-us.apache.org/repos/asf/nifi/tree/690e674a Diff: http://git-wip-us.apache.org/repos/asf/nifi/diff/690e674a Branch: refs/heads/master Commit: 690e674a0d5c578960aa24506bfc9503be295cb8 Parents: 3b675e9 Author: Joseph Percivall <[email protected]> Authored: Tue Sep 8 16:38:14 2015 -0400 Committer: Matt Gilman <[email protected]> Committed: Wed Sep 9 13:45:56 2015 -0400 ---------------------------------------------------------------------- nifi-docs/src/main/asciidoc/developer-guide.adoc | 19 +++++++++++++++++++ .../main/asciidoc/expression-language-guide.adoc | 3 ++- 2 files changed, 21 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/nifi/blob/690e674a/nifi-docs/src/main/asciidoc/developer-guide.adoc ---------------------------------------------------------------------- diff --git a/nifi-docs/src/main/asciidoc/developer-guide.adoc b/nifi-docs/src/main/asciidoc/developer-guide.adoc index 1ecbba2..5df440a 100644 --- a/nifi-docs/src/main/asciidoc/developer-guide.adoc +++ b/nifi-docs/src/main/asciidoc/developer-guide.adoc @@ -126,6 +126,25 @@ flow-specific values. While the contents and attributes of a FlowFile can change, the FlowFile object is immutable. Modifications to a FlowFile are made possible by the ProcessSession. +The core attributes for FlowFiles are defined in the `org.apache.nifi.flowfile.attributes.CoreAttributes` enum. +The most common attributes you'll see are filename, path and uuid. + +- Filename: The filename of the FlowFile. The filename should not contain any directory structure. + +- UUID: A unique universally unique identifier (UUID) assigned to this FlowFile + +- Path: The FlowFile's path indicates the relative directory to which a FlowFile belongs and does not contain the filename + +- Absolute Path: The FlowFile's absolute path indicates the absolute directory to which a FlowFile belongs and does not contain the filename + +- Priority: A numeric value indicating the FlowFile priority + +- MIME Type: The MIME Type of this FlowFile + +- Discard Reason: Specifies the reason that a FlowFile is being discarded + +- Alternative Identifier: Indicates an identifier other than the FlowFile's UUID that is known to refer to this FlowFile. + [[process_session]] ==== ProcessSession The ProcessSession, often referred to as simply a "session," provides http://git-wip-us.apache.org/repos/asf/nifi/blob/690e674a/nifi-docs/src/main/asciidoc/expression-language-guide.adoc ---------------------------------------------------------------------- diff --git a/nifi-docs/src/main/asciidoc/expression-language-guide.adoc b/nifi-docs/src/main/asciidoc/expression-language-guide.adoc index af0ee02..7d06c1c 100644 --- a/nifi-docs/src/main/asciidoc/expression-language-guide.adoc +++ b/nifi-docs/src/main/asciidoc/expression-language-guide.adoc @@ -38,7 +38,8 @@ a local file system, the FlowFile would have an attribute called `filename` that reflected the name of the file on the file system. Additionally, the FlowFile will have a `path` attribute that reflects the directory on the file system that this file lived in. The FlowFile will also have an attribute named `uuid`, which is a -unique identifier for this FlowFile. +unique identifier for this FlowFile. For complete listing of the core attributes +check out the FlowFile section of the link:developer-guide.html#flow[Developer's Guide] However, placing these attributes on a FlowFile do not provide much benefit if the user is unable to make use of them. The NiFi Expression Language provides
