Run Command Line Program On File
  • 11 Jan 2023
  • 1 Minute to read
  • Dark
    Light

Run Command Line Program On File

  • Dark
    Light

Article Summary


Step Details

Introduced in Version3.0.0
Last Modified in Version---
LocationFile Management

The Run Command Line Program on File step utilizes a file as an input and is used to execute a batch file within a Flow, similar to the Run Command step. Though the step requires a file as an input, the step does not require the file to be utilized by any commands within the batch file. The full file path to the batch file will need to be entered into the Command input.



Properties

Inputs

PropertyDescriptionData Type
FileThe file which can be passed as a parameter to the command file.FileData
Working DirectoryThe path to the fileList of String

Outputs

PropertyDescriptionData Type
ErrorCode

Command Error OutputOutputs errors found when executing the commandString

Command OutputOutputs the command String

Return CodeOutputs the return codeString

Setup

PropertyDescriptionData Type
CommandThe absolute file path of the command file (C:\Examples\Test.bat)---
ParameterStringOptional setting used to pass parameters to the command file---
UseShellExecuteDetermines whether to use the system shell to start the processBoolean
LoadFileOnCompletionLoads the file after completion of the stepBoolean


Common Errors

Could not find command

A common error when utilizing the step would be having an incomplete file path to the command file. Ensure that the full file path to the command file is complete and includes the file extension

Exception Stack Trace: DecisionsFramework.Design.Flow.ErrorRunningFlowStep: Error running step Run Command Line Program On File 1[RunCommandOnFile] in flow [Testing Flow]: could not find command: C:\Examples\Test.ext ---> DecisionsFramework.LoggedException: could not find command: C:\Examples\Test.ext
   at DecisionsFramework.Design.Flow.CoreSteps.StandardSteps.AbstractRunFileCommand.Run(StepStartData data)
   at DecisionsFramework.Design.Flow.FlowStep.RunStepInternal(String flowTrackingID, String stepTrackingID, KeyValuePairDataStructure[] stepRunDataValues, AbstractFlowTrackingData trackingData)
   at DecisionsFramework.Design.Flow.FlowStep.Start(String flowTrackingID, String stepTrackingID, FlowStateData data, AbstractFlowTrackingData trackingData, RunningStepData currentStepData) 
   --- End of inner exception stack trace ---




Related Information

Forum Posts:
Changing Working Directory On Run Command Step


Was this article helpful?

What's Next