[nifi] branch main updated: NIFI-9756 Add documentation for framework-level retry in Processors and update processor tab images

[mt...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

mthomsen pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/nifi.git


The following commit(s) were added to refs/heads/main by this push:
     new 9782a51  NIFI-9756 Add documentation for framework-level retry in Processors and update processor tab images
9782a51 is described below

commit 9782a5156433f036079d930d9b92231764cd1cab
Author: Andrew Lim <an...@gmail.com>
AuthorDate: Fri Mar 4 15:01:54 2022 -0500

    NIFI-9756 Add documentation for framework-level retry in Processors and update processor tab images
    
    This closes #5837
    
    Signed-off-by: Mike Thomsen <mt...@apache.org>
---
 .../src/main/asciidoc/images/allow-weak-crypto.png | Bin 62111 -> 65019 bytes
 .../images/autocomplete-parameter-example.png      | Bin 173374 -> 123963 bytes
 .../src/main/asciidoc/images/comments-tab.png      | Bin 27732 -> 26526 bytes
 .../images/configure-parameter-on-the-fly.png      | Bin 131883 -> 112424 bytes
 ...onfigure-processor-with-version-information.png | Bin 61205 -> 59869 bytes
 .../images/convert-property-to-parameter.png       | Bin 171069 -> 134652 bytes
 .../asciidoc/images/edit-property-dropdown.png     | Bin 54487 -> 46811 bytes
 .../asciidoc/images/edit-property-textarea.png     | Bin 45199 -> 39620 bytes
 .../asciidoc/images/el-param-support-help-text.png | Bin 187659 -> 143979 bytes
 .../images/existing-parameter-selected.png         | Bin 165231 -> 127719 bytes
 .../images/existing-parameters-example.png         | Bin 103913 -> 85104 bytes
 .../asciidoc/images/new-parameter-referenced.png   | Bin 166341 -> 128579 bytes
 .../asciidoc/images/processor-cs-version-match.png | Bin 42501 -> 40647 bytes
 .../processor-cs-version-mismatch-config.png       | Bin 45439 -> 43638 bytes
 .../src/main/asciidoc/images/properties-tab.png    | Bin 36781 -> 33388 bytes
 .../reference-parameter-available-parameters.png   | Bin 83156 -> 60376 bytes
 .../asciidoc/images/reference-parameter-option.png | Bin 71003 -> 54408 bytes
 .../src/main/asciidoc/images/relationships-tab.png | Bin 0 -> 43445 bytes
 .../src/main/asciidoc/images/scheduling-tab.png    | Bin 54320 -> 43830 bytes
 .../src/main/asciidoc/images/settings-tab.png      | Bin 72140 -> 50039 bytes
 .../asciidoc/images/variable-putfile-property.png  | Bin 67481 -> 52102 bytes
 nifi-docs/src/main/asciidoc/user-guide.adoc        |  37 +++++++++++++++------
 22 files changed, 26 insertions(+), 11 deletions(-)

diff --git a/nifi-docs/src/main/asciidoc/images/allow-weak-crypto.png b/nifi-docs/src/main/asciidoc/images/allow-weak-crypto.png
index 5100152..137703c 100644
Binary files a/nifi-docs/src/main/asciidoc/images/allow-weak-crypto.png and b/nifi-docs/src/main/asciidoc/images/allow-weak-crypto.png differ
diff --git a/nifi-docs/src/main/asciidoc/images/autocomplete-parameter-example.png b/nifi-docs/src/main/asciidoc/images/autocomplete-parameter-example.png
index 99605d6..679e1e7 100644
Binary files a/nifi-docs/src/main/asciidoc/images/autocomplete-parameter-example.png and b/nifi-docs/src/main/asciidoc/images/autocomplete-parameter-example.png differ
diff --git a/nifi-docs/src/main/asciidoc/images/comments-tab.png b/nifi-docs/src/main/asciidoc/images/comments-tab.png
index 589d7e4..952074d 100644
Binary files a/nifi-docs/src/main/asciidoc/images/comments-tab.png and b/nifi-docs/src/main/asciidoc/images/comments-tab.png differ
diff --git a/nifi-docs/src/main/asciidoc/images/configure-parameter-on-the-fly.png b/nifi-docs/src/main/asciidoc/images/configure-parameter-on-the-fly.png
index cd2d1b9..d6e9506 100644
Binary files a/nifi-docs/src/main/asciidoc/images/configure-parameter-on-the-fly.png and b/nifi-docs/src/main/asciidoc/images/configure-parameter-on-the-fly.png differ
diff --git a/nifi-docs/src/main/asciidoc/images/configure-processor-with-version-information.png b/nifi-docs/src/main/asciidoc/images/configure-processor-with-version-information.png
index 23ed361..aadae02 100644
Binary files a/nifi-docs/src/main/asciidoc/images/configure-processor-with-version-information.png and b/nifi-docs/src/main/asciidoc/images/configure-processor-with-version-information.png differ
diff --git a/nifi-docs/src/main/asciidoc/images/convert-property-to-parameter.png b/nifi-docs/src/main/asciidoc/images/convert-property-to-parameter.png
index 693477c..cdca31c 100644
Binary files a/nifi-docs/src/main/asciidoc/images/convert-property-to-parameter.png and b/nifi-docs/src/main/asciidoc/images/convert-property-to-parameter.png differ
diff --git a/nifi-docs/src/main/asciidoc/images/edit-property-dropdown.png b/nifi-docs/src/main/asciidoc/images/edit-property-dropdown.png
index 2fd6f7d..4206aa6 100644
Binary files a/nifi-docs/src/main/asciidoc/images/edit-property-dropdown.png and b/nifi-docs/src/main/asciidoc/images/edit-property-dropdown.png differ
diff --git a/nifi-docs/src/main/asciidoc/images/edit-property-textarea.png b/nifi-docs/src/main/asciidoc/images/edit-property-textarea.png
index a40b5b7..54d18b7 100644
Binary files a/nifi-docs/src/main/asciidoc/images/edit-property-textarea.png and b/nifi-docs/src/main/asciidoc/images/edit-property-textarea.png differ
diff --git a/nifi-docs/src/main/asciidoc/images/el-param-support-help-text.png b/nifi-docs/src/main/asciidoc/images/el-param-support-help-text.png
index 2a341ed..c6a3f5f 100644
Binary files a/nifi-docs/src/main/asciidoc/images/el-param-support-help-text.png and b/nifi-docs/src/main/asciidoc/images/el-param-support-help-text.png differ
diff --git a/nifi-docs/src/main/asciidoc/images/existing-parameter-selected.png b/nifi-docs/src/main/asciidoc/images/existing-parameter-selected.png
index 172b7ea..dd7da6f 100644
Binary files a/nifi-docs/src/main/asciidoc/images/existing-parameter-selected.png and b/nifi-docs/src/main/asciidoc/images/existing-parameter-selected.png differ
diff --git a/nifi-docs/src/main/asciidoc/images/existing-parameters-example.png b/nifi-docs/src/main/asciidoc/images/existing-parameters-example.png
index fceb57c..d4b03aa 100644
Binary files a/nifi-docs/src/main/asciidoc/images/existing-parameters-example.png and b/nifi-docs/src/main/asciidoc/images/existing-parameters-example.png differ
diff --git a/nifi-docs/src/main/asciidoc/images/new-parameter-referenced.png b/nifi-docs/src/main/asciidoc/images/new-parameter-referenced.png
index 044b3c0..6d852ce 100644
Binary files a/nifi-docs/src/main/asciidoc/images/new-parameter-referenced.png and b/nifi-docs/src/main/asciidoc/images/new-parameter-referenced.png differ
diff --git a/nifi-docs/src/main/asciidoc/images/processor-cs-version-match.png b/nifi-docs/src/main/asciidoc/images/processor-cs-version-match.png
index 38fc816..8acfa0f 100644
Binary files a/nifi-docs/src/main/asciidoc/images/processor-cs-version-match.png and b/nifi-docs/src/main/asciidoc/images/processor-cs-version-match.png differ
diff --git a/nifi-docs/src/main/asciidoc/images/processor-cs-version-mismatch-config.png b/nifi-docs/src/main/asciidoc/images/processor-cs-version-mismatch-config.png
index 52755a6..ec8d346 100644
Binary files a/nifi-docs/src/main/asciidoc/images/processor-cs-version-mismatch-config.png and b/nifi-docs/src/main/asciidoc/images/processor-cs-version-mismatch-config.png differ
diff --git a/nifi-docs/src/main/asciidoc/images/properties-tab.png b/nifi-docs/src/main/asciidoc/images/properties-tab.png
index 86ae5f0..4730f6b 100644
Binary files a/nifi-docs/src/main/asciidoc/images/properties-tab.png and b/nifi-docs/src/main/asciidoc/images/properties-tab.png differ
diff --git a/nifi-docs/src/main/asciidoc/images/reference-parameter-available-parameters.png b/nifi-docs/src/main/asciidoc/images/reference-parameter-available-parameters.png
index 8b0c33c..a516d33 100644
Binary files a/nifi-docs/src/main/asciidoc/images/reference-parameter-available-parameters.png and b/nifi-docs/src/main/asciidoc/images/reference-parameter-available-parameters.png differ
diff --git a/nifi-docs/src/main/asciidoc/images/reference-parameter-option.png b/nifi-docs/src/main/asciidoc/images/reference-parameter-option.png
index 1706967..ceec66f 100644
Binary files a/nifi-docs/src/main/asciidoc/images/reference-parameter-option.png and b/nifi-docs/src/main/asciidoc/images/reference-parameter-option.png differ
diff --git a/nifi-docs/src/main/asciidoc/images/relationships-tab.png b/nifi-docs/src/main/asciidoc/images/relationships-tab.png
new file mode 100644
index 0000000..825aa86
Binary files /dev/null and b/nifi-docs/src/main/asciidoc/images/relationships-tab.png differ
diff --git a/nifi-docs/src/main/asciidoc/images/scheduling-tab.png b/nifi-docs/src/main/asciidoc/images/scheduling-tab.png
index d82c851..746e9f7 100644
Binary files a/nifi-docs/src/main/asciidoc/images/scheduling-tab.png and b/nifi-docs/src/main/asciidoc/images/scheduling-tab.png differ
diff --git a/nifi-docs/src/main/asciidoc/images/settings-tab.png b/nifi-docs/src/main/asciidoc/images/settings-tab.png
index 77000df..ad9a1c3 100644
Binary files a/nifi-docs/src/main/asciidoc/images/settings-tab.png and b/nifi-docs/src/main/asciidoc/images/settings-tab.png differ
diff --git a/nifi-docs/src/main/asciidoc/images/variable-putfile-property.png b/nifi-docs/src/main/asciidoc/images/variable-putfile-property.png
index 5bb15ac..5cbe044 100644
Binary files a/nifi-docs/src/main/asciidoc/images/variable-putfile-property.png and b/nifi-docs/src/main/asciidoc/images/variable-putfile-property.png differ
diff --git a/nifi-docs/src/main/asciidoc/user-guide.adoc b/nifi-docs/src/main/asciidoc/user-guide.adoc
index 7f9be1d..3024878 100644
--- a/nifi-docs/src/main/asciidoc/user-guide.adoc
+++ b/nifi-docs/src/main/asciidoc/user-guide.adoc
@@ -550,17 +550,6 @@ to its log, the Processor also will generate a Bulletin. This setting indicates
 shown in the User Interface. By default, the Bulletin level is set to `WARN`, which means it will display all warning and error-level
 bulletins.
 
-The right-hand side of the Settings tab contains an 'Automatically Terminate Relationships' section. Each of the Relationships that is
-defined by the Processor is listed here, along with its description. In order for a Processor to be considered valid and
-able to run, each Relationship defined by the Processor must be either connected to a downstream component or auto-terminated.
-If a Relationship is auto-terminated, any FlowFile that is routed to that Relationship will be removed from the flow and
-its processing considered complete. Any Relationship that is already connected to a downstream component cannot be auto-terminated.
-The Relationship must first be removed from any Connection that uses it. Additionally, for any Relationship that is selected to be
-auto-terminated, the auto-termination status will be cleared (turned off) if the Relationship is added to a Connection.
-
-
-
-
 ==== Scheduling Tab
 
 The second tab in the Processor Configuration dialog is the Scheduling Tab:
@@ -714,6 +703,32 @@ Some processors have properties that refer to other components, such as Controll
 
 image:create-service-ssl-context.png["Create Service"]
 
+==== Relationships Tab
+
+The Relationships tab contains an 'Automatically Terminate / Retry Relationships' section. Each of the Relationships that is defined by the Processor is listed here, along with its description.
+
+image::relationships-tab.png["Relationships Tab"]
+
+===== Automatically Terminate
+In order for a Processor to be considered valid and able to run, each Relationship defined by the Processor must be either connected to a downstream component or auto-terminated. If a Relationship is auto-terminated, any FlowFile that is routed to that Relationship will be removed from the flow and its processing considered complete. Any Relationship that is already connected to a downstream component cannot be auto-terminated. The Relationship must first be removed from any Connection t [...]
+
+===== Automatically Retry
+Users can also configure whether or not FlowFiles routed to a given Relationship should be retried.
+
+====== Number of Retry Attempts
+For relationships set to retry, this number indicates how many times a FlowFile will attempt to reprocess before it is routed elsewhere.
+
+====== Retry Back Off Policy
+When a FlowFile is to be retried, the user can configure the backoff policy with two options:
+
+* Penalize - Retry attempts will occur in time, but the processor will continue to process other FlowFiles.
+* Yield - No other FlowFile processing will occur until all retry attempts have been made.
+
+====== Retry Maximum Back Off Period
+Initial retries are based on the Penalty/Yield Duration time specified in the Settings tab. The duration time is repeatedly doubled for every subsequent retry attempt. This number indicates the maximum allowable time period before another retry attempt occurs.
+
+NOTE: If both terminate and retry are selected, any retry logic will happen first, then auto-termination.
+
 ==== Comments Tab
 
 The last tab in the Processor configuration dialog is the Comments tab. This tab simply provides an area for users to include