Description:
This processor executes an external command on the contents of a FlowFile, and creates a new FlowFile with the
results of the command.
Creates Attributes:
Attribute Name |
Description |
execution.command |
The name of the command executed to create the new FlowFile |
execution.command.args |
The semi-colon delimited list of arguments |
execution.status |
The exit status code returned from executing the command |
execution.error |
Any error messages returned from executing the command |
Properties:
In the list below, the names of required properties appear
in bold. Any other properties (not in bold) are considered optional.
If a property has a default value, it is indicated. If a property
supports the use of the NiFi Expression Language (or simply,
"expression language"), that is also indicated.
- Command Path
- Specifies the command to be executed; if just the name of an executable is provided, it must be in the user's
environment PATH.
- Default value: none
- Supports expression language: true
- Command Arguments
- The arguments to supply to the executable delimited by the ';' character. Each argument may be an Expression Language
statement.
- Default value: none
- Supports expression language: true
- Working Directory
- The directory to use as the current working directory when executing the command. If the directory does not exist,
then the process's current working directory will be used.
- Default value: none (which means whatever NiFi's current working directory is...probably the root of the NiFi
installation directory.)
- Supports expression language: true
Relationships:
- original
- The destination path for the original incoming FlowFile. This FlowFile will have the created attributes listed above.
- output-stream
- The destination path for the FlowFile created from the command's output. This FlowFile will have the created attributes listed above.