10.82. Execute Process

Group (Subgroup)

Core (Misc)

Description

This filter allows the user to execute any application, program, shell script or any other executable program on the computer system. Any output can be found in the user specified log file.

The Command Line Arguments parameter should contain the absolute path to the program you wish to execute as well as any arguments that program requires. The formatting of this should follow the same general rules that you would follow when executing the command from a terminal. The following examples show how various commands should be formatted in different scenarios;

Simple directory listing (for Mac/Linux users)

/bin/ls

Simple command with arguments (for Windows users)

C:/Applications/DREAM3D-6.6.332/nxrunner.exe C:/Applications/DREAM3D/DREAM3D-6.6.332/Data/MyPipeline.json

For a command with spaces in the path

“C:/Program Files/DREAM3D-6.6.332/nxrunner.exe” “C:/Program Files/DREAM3D-6.6.332/PrebuiltPipelines/Workshop/EBSD Reconstruction/(01) SmallIN100 Archive.json”

The path to the executable should be given as an absolute path; relative paths and shell built-ins that are resolved by a particular shell are not reliable across platforms.

Blocking and Timeout

  • Should Block: When enabled, the Filter waits for the launched process to finish (or to start, on platforms where that distinction applies) before the pipeline continues. When disabled, the process is launched and the pipeline moves on without waiting.

  • Timeout (ms): Only applies when Should Block is enabled. It is the maximum time, in milliseconds, that the Filter will wait for the command before giving up.

Required Input Sources

None – this Filter launches an external program and does not consume any DataStructure objects.

Input Parameter(s)

Parameter Name

Parameter Type

Parameter Notes

Description

Command Line Arguments

String

The complete command to execute.

Should Block

Bool

Whether to block the process while the command executes or not

Timeout (ms)

Scalar Value

Int32

The amount of time to wait for the command to start/finish when blocking is selected

Output Log File

FileSystemPath

The log file where the output from the process will be stored

Example Pipelines

ExecuteProcess

DREAM3D-NX Help

If you need help, need to file a bug report or want to request a new feature, please head over to the DREAM3DNX-Issues GitHub site where the community of DREAM3D-NX users can help answer your questions.