UpdateAttribute

Description:

Updates the Attributes for a FlowFile by using the Attribute Expression Language and/or deletes the attributes based on a regular expression

Additional Details...

Tags:

attributes, modification, update, delete, Attribute Expression Language, state

Properties:

In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.

NameDefault ValueAllowable ValuesDescription
Delete Attributes ExpressionRegular expression for attributes to be deleted from FlowFiles. Existing attributes that match will be deleted regardless of whether they are updated by this processor.
Supports Expression Language: true
Store StateDo not store state
  • Do not store state
  • Store state locally
Select whether or not state will be stored. Selecting 'Stateless' will offer the default functionality of purely updating the attributes on a FlowFile in a stateless manner. Selecting a stateful option will not only store the attributes on the FlowFile but also in the Processors state. See the 'Stateful Usage' topic of the 'Additional Details' section of this processor's documentation for more information
Stateful Variables Initial ValueIf using state to set/reference variables then this value is used to set the initial value of the stateful variable. This will only be used in the @OnScheduled method when state does not contain a value for the variable. This is required if running statefully but can be empty if needed.

Dynamic Properties:

Dynamic Properties allow the user to specify both the name and value of a property.

NameValueDescription
A FlowFile attribute to updateThe value to set it toUpdates a FlowFile attribute specified by the Dynamic Property's key with the value specified by the Dynamic Property's value
Supports Expression Language: true

Relationships:

NameDescription
successAll successful FlowFiles are routed to this relationship

Reads Attributes:

None specified.

Writes Attributes:

NameDescription
See additional detailsThis processor may write or remove zero or more attributes as described in additional details

State management:

ScopeDescription
LOCALGives the option to store values not only on the FlowFile but as stateful variables to be referenced in a recursive manner.

Restricted:

This component is not restricted.

Input requirement:

This component requires an incoming relationship.