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 51001526ef..137703c1a0 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 99605d666c..679e1e7cb8 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 589d7e4d68..952074d813 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 cd2d1b972b..d6e9506114 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 23ed361fc6..aadae02c28 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 693477c7a3..cdca31c25e 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 2fd6f7d55c..4206aa6ce5 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 a40b5b76c9..54d18b7b8b 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 2a341ed1e6..c6a3f5f3b3 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 172b7ea5fd..dd7da6ff0d 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 fceb57c6fa..d4b03aad32 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 044b3c0f3b..6d852ce078 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 38fc81601d..8acfa0f033 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 52755a6902..ec8d346bdb 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 86ae5f0a11..4730f6b576 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 8b0c33c41f..a516d33fcb 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 170696788b..ceec66fed9 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 0000000000..825aa861a5 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 d82c8511e0..746e9f71f8 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 77000df956..ad9a1c3076 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 5bb15acf9b..5cbe044d83 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 7f9be1d073..3024878c2c 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 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. + +===== 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