RunExternalProcessCommand Object


Description:

Runs an external process from within the sequencer.

Can be used with Command Sequencer: Yes

GUI Command Name: Basic: Run External Process

Parents: Sequencer

RunExternalProcessCommand Writable Attributes

Attribute Description
Common Writable Attributes ErrorOnFailure
Arguments

Arguments to append to command string when executed.

Type: string

Default: "" (empty string)

CommandLine

Command line string to evaluate in new process.

Type: string

Default: "" (empty string)

ExecutionMode

Which execution mode to use for new process.

Type: enum

Default: BACKGROUND

Possible Values:

Value Description
BACKGROUND

Executes new process in the background. Sequencer will not block on this command.

BLOCKING

Executes process in blocking mode, which means that sequencer will block on this command until the process is complete.

InsertTime

Whether the execution time should be appended to the command line as an argument (-reftime).

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Appends -reftime + start time (in seconds) to the command line (ex. -reftime 145).

FALSE

Does not append -reftime to command line.

TimeoutOption

Configures what action to take when process timeout occurs.

Type: enum

Default: TERMINATE_PROCESS

Possible Values:

Value Description
TERMINATE_PROCESS

Terminates process and returns execution back to sequencer.

PROMPT_USER

Prompts user on what he would like to do.

UseTimeout

When a process is running in Blocking mode, indicates if process timeout after specified amount of time.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Process will timeout and execute selected TimeoutOption after specified amount of time.

FALSE

Process will not timeout.

WaitTime

Amount of time in seconds to wait before process timeout occurs.

Type: double

Default: 0

WorkingDir

Working directory to execute process in.

Type: string

Default: "" (empty string)

RunExternalProcessCommand Read-Only Attributes

Read-Only Attribute Description
Common Read-Only Attributes PassFailState