ExecuteProcess

ExecuteProcess 2.0.0

Bundle: org.apache.nifi | nifi-standard-nar
Description: Runs an operating system command specified by the user and writes the output of that command to a FlowFile. If the command is expected to be long-running, the Processor can output the partial data on a specified interval. When this option is used, the output is expected to be in textual format, as it typically does not make sense to split binary data on arbitrary time-based intervals.
Tags: command, external, invoke, process, script, source
Input Requirement: FORBIDDEN
Supports Sensitive Dynamic Properties: false

Properties

Argument Delimiter
Delimiter to use to separate arguments for a command [default: space]. Must be a single character.

Display Name

Argument Delimiter

Description

Delimiter to use to separate arguments for a command [default: space]. Must be a single character.

API Name

Argument Delimiter

Default Value

Expression Language Scope

Not Supported

Sensitive

false

Required

true
Batch Duration
If the process is expected to be long-running and produce textual output, a batch duration can be specified so that the output will be captured for this amount of time and a FlowFile will then be sent out with the results and a new FlowFile will be started, rather than waiting for the process to finish before sending out the results

Display Name

Batch Duration

Description

If the process is expected to be long-running and produce textual output, a batch duration can be specified so that the output will be captured for this amount of time and a FlowFile will then be sent out with the results and a new FlowFile will be started, rather than waiting for the process to finish before sending out the results

API Name

Batch Duration

Expression Language Scope

Not Supported

Sensitive

false

Required

false
Command
Specifies the command to be executed; if just the name of an executable is provided, it must be in the user's environment PATH.

Display Name

Command

Description

Specifies the command to be executed; if just the name of an executable is provided, it must be in the user's environment PATH.

API Name

Command

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

true
Command Arguments
The arguments to supply to the executable delimited by white space. White space can be escaped by enclosing it in double-quotes.

Display Name

Command Arguments

Description

The arguments to supply to the executable delimited by white space. White space can be escaped by enclosing it in double-quotes.

API Name

Command Arguments

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false
Output MIME Type
Specifies the value to set for the "mime.type" attribute. This property is ignored if 'Batch Duration' is set.

Display Name

Output MIME Type

Description

Specifies the value to set for the "mime.type" attribute. This property is ignored if 'Batch Duration' is set.

API Name

Output MIME type

Expression Language Scope

Not Supported

Sensitive

false

Required

false
Redirect Error Stream
If true will redirect any error stream output of the process to the output stream. This is particularly helpful for processes which write extensively to the error stream or for troubleshooting.
Display Name

Redirect Error Stream

Description

If true will redirect any error stream output of the process to the output stream. This is particularly helpful for processes which write extensively to the error stream or for troubleshooting.

API Name

Redirect Error Stream

Default Value

false

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

false
Working Directory
The directory to use as the current working directory when executing the command

Display Name

Working Directory

Description

The directory to use as the current working directory when executing the command

API Name

Working Directory

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false

Dynamic Properties

An environment variable name
These environment variables are passed to the process spawned by this Processor

Name

An environment variable name

Description

These environment variables are passed to the process spawned by this Processor

Value

An environment variable value

Expression Language Scope

NONE

Restrictions

Required Permission	Explanation
execute code	Provides operator the ability to execute arbitrary code assuming all permissions that NiFi has.

Relationships

Name	Description
success	All created FlowFiles are routed to this relationship

Writes Attributes

Name	Description
command	Executed command
command.arguments	Arguments of the command
mime.type	Sets the MIME type of the output if the 'Output MIME Type' property is set and 'Batch Duration' is not set