Skip to main content

ReplaceTextWithMapping

Description

Updates the content of a FlowFile by evaluating a Regular Expression against it and replacing the section of the content that matches the Regular Expression with some alternate value provided in a mapping file.

Tags

Change, Mapping, Modify, Regex, Regular Expression, Replace, Text, Update

Properties

In the list below required Properties are shown with an asterisk (*). Other properties are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.

Display NameAPI NameDefault ValueAllowable ValuesDescription
Regular Expression *Regular Expression\S+The Regular Expression to search for in the FlowFile content

Supports Expression Language, using FlowFile attributes and Environment variables.
Matching Group *Matching Group0The number of the matching group of the provided regex to replace with the corresponding value from the mapping file (if it exists).

Supports Expression Language, using Environment variables.
Mapping File *Mapping FileThe name of the file (including the full path) containing the Mappings.
Mapping File Refresh Interval *Mapping File Refresh Interval60sThe polling interval to check for updates to the mapping file. The default is 60s.
Character Set *Character SetUTF-8The Character Set in which the file is encoded
Maximum Buffer Size *Maximum Buffer Size1 MBSpecifies the maximum amount of data to buffer (per file) in order to apply the regular expressions. If a FlowFile is larger than this value, the FlowFile will be routed to 'failure'

Dynamic Properties

This component does not support dynamic properties.

Relationships

NameDescription
failureFlowFiles that could not be updated are routed to this relationship
successFlowFiles that have been successfully updated are routed to this relationship, as well as FlowFiles whose content does not match the given Regular Expression

Reads Attributes

This processor does not read attributes.

Writes Attributes

This processor does not write attributes.

State Management

This component does not store state.

Restricted

This component is not restricted.

Input Requirement

This component requires an incoming relationship.

System Resource Considerations

This component does not specify system resource considerations.

See Also