RetryFlowFile

RetryFlowFile 2.0.0

Bundle: org.apache.nifi | nifi-standard-nar
Description: FlowFiles passed to this Processor have a 'Retry Attribute' value checked against a configured 'Maximum Retries' value. If the current attribute value is below the configured maximum, the FlowFile is passed to a retry relationship. The FlowFile may or may not be penalized in that condition. If the FlowFile's attribute value exceeds the configured maximum, the FlowFile will be passed to a 'retries_exceeded' relationship. WARNING: If the incoming FlowFile has a non-numeric value in the configured 'Retry Attribute' attribute, it will be reset to '1'. You may choose to fail the FlowFile instead of performing the reset. Additional dynamic properties can be defined for any attributes you wish to add to the FlowFiles transferred to 'retries_exceeded'. These attributes support attribute expression language.
Tags: FlowFile, Retry
Input Requirement: REQUIRED
Supports Sensitive Dynamic Properties: false

Properties

Fail on Non-numerical Overwrite
If the FlowFile already has the attribute defined in 'Retry Attribute' that is *not* a number, fail the FlowFile instead of resetting that value to '1'
Display Name

Fail on Non-numerical Overwrite

Description

If the FlowFile already has the attribute defined in 'Retry Attribute' that is *not* a number, fail the FlowFile instead of resetting that value to '1'

API Name

Fail on Non-numerical Overwrite

Default Value

false

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Maximum Retries
The maximum number of times a FlowFile can be retried before being passed to the 'retries_exceeded' relationship

Display Name

Maximum Retries

Description

The maximum number of times a FlowFile can be retried before being passed to the 'retries_exceeded' relationship

API Name

maximum-retries

Default Value

3

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

true
Penalize Retries
If set to 'true', this Processor will penalize input FlowFiles before passing them to the 'retry' relationship. This does not apply to the 'retries_exceeded' relationship.
Display Name

Penalize Retries

Description

If set to 'true', this Processor will penalize input FlowFiles before passing them to the 'retry' relationship. This does not apply to the 'retries_exceeded' relationship.

API Name

penalize-retries

Default Value

true

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Retry Attribute
The name of the attribute that contains the current retry count for the FlowFile. WARNING: If the name matches an attribute already on the FlowFile that does not contain a numerical value, the processor will either overwrite that attribute with '1' or fail based on configuration.

Display Name

Retry Attribute

Description

The name of the attribute that contains the current retry count for the FlowFile. WARNING: If the name matches an attribute already on the FlowFile that does not contain a numerical value, the processor will either overwrite that attribute with '1' or fail based on configuration.

API Name

retry-attribute

Default Value

flowfile.retries

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

true
Reuse Mode
Defines how the Processor behaves if the retry FlowFile has a different retry UUID than the instance that received the FlowFile. This generally means that the attribute was not reset after being successfully retried by a previous instance of this processor.
Display Name

Reuse Mode

Description

Defines how the Processor behaves if the retry FlowFile has a different retry UUID than the instance that received the FlowFile. This generally means that the attribute was not reset after being successfully retried by a previous instance of this processor.

API Name

reuse-mode

Default Value

fail

Allowable Values
- Fail on Reuse
- Warn on Reuse
- Reset Reuse
Expression Language Scope

Not Supported

Sensitive

false

Required

true

Dynamic Properties

Exceeded FlowFile Attribute Key
One or more dynamic properties can be used to add attributes to FlowFiles passed to the 'retries_exceeded' relationship

Name

Exceeded FlowFile Attribute Key

Description

One or more dynamic properties can be used to add attributes to FlowFiles passed to the 'retries_exceeded' relationship

Value

The value of the attribute added to the FlowFile

Expression Language Scope

FLOWFILE_ATTRIBUTES

Relationships

Name	Description
failure	The processor is configured such that a non-numerical value on 'Retry Attribute' results in a failure instead of resetting that value to '1'. This will immediately terminate the limited feedback loop. Might also include when 'Maximum Retries' contains attribute expression language that does not resolve to an Integer.
retry	Input FlowFile has not exceeded the configured maximum retry count, pass this relationship back to the input Processor to create a limited feedback loop.
retries_exceeded	Input FlowFile has exceeded the configured maximum retry count, do not pass this relationship back to the input Processor to terminate the limited feedback loop.

Reads Attributes

Name	Description
Retry Attribute	Will read the attribute or attribute expression language result as defined in 'Retry Attribute'

Writes Attributes

Name	Description
Retry Attribute	User defined retry attribute is updated with the current retry count
Retry Attribute .uuid	User defined retry attribute with .uuid that determines what processor retried the FlowFile last