Execute Process task

Applies to: SQL Server SSIS Integration Runtime in Azure Data Factory

The Execute Process task runs an application or batch file as part of a SQL Server Integration Services package workflow. Although you can use the Execute Process task to open any standard application, such as Microsoft Excel or Microsoft Word, you typically use it to run business applications or batch files that work against a data source. For example, you can use the Execute Process task to expand a compressed text file. Then the package can use the text file as a data source for the data flow in the package. As another example, you can use the Execute Process task to run a custom Visual Basic application that generates a daily sales report. Then you can attach the report to a Send Mail task and forward the report to a distribution list.

Integration Services includes other tasks that perform workflow operations such as executing packages. For more information, see Execute Package Task.

Custom log entries available on the Execute Process task

The following table lists the custom log entries for the Execute Process task. For more information, see Integration Services (SSIS) Logging.

Configuration of the Execute Process task

You can set properties through SSIS Designer or programmatically.

For more information about how to set these properties in SSIS Designer, see Add or Delete a Task or a Container in a Control Flow.

Property settings

When the Execute Process task runs a custom application, the task provides input to the application through one or both of the following methods:

• A variable that you specify in the StandardInputVariable property setting. For more information about variables, see Integration Services (SSIS) Variables and Integration Services (SSIS) Variables.

• An argument that you specify in the Arguments property setting. (For example, if the task opens a document in Word, the argument can name the .doc file.)

To pass multiple arguments to a custom application in one Execute Process task, use spaces to delimit the arguments. An argument can't include a space; otherwise, the task doesn't run. You can use an expression to pass a variable value as the argument. In the following example, the expression passes two variable values as arguments, and uses a space to delimit the arguments:

@variable1 + " " + @variable2

You can use an expression to set various Execute Process task properties.

When you use the StandardInputVariable property to configure the Execute Process task to provide input, call the Console.ReadLine method from the application to read the input. For more information, see Console.ReadLine Method.

When you use the Arguments property to configure the Execute Process task to provide input, do one of the following steps to obtain the arguments:

• If you use Microsoft Visual Basic to write the application, set the My.Application.CommandLineArgs property. The following example sets the My.Application.CommandLineArgs property is to retrieve two arguments:

  Dim variable1 As String = My.Application.CommandLineArgs.Item(0)
  Dim variable2 As String = My.Application.CommandLineArgs.Item(1)
  

  For more information, see ConsoleApplicationBase.CommandLineArgs Property.

• If you use Microsoft Visual C# to write the application, use the Main method.

  For more information, see Command-Line Arguments (C# Programming Guide).

The Execute Process task also includes the StandardOutputVariable and StandardErrorVariable properties for specifying the variables that consume the standard output and error output of the application, respectively.

Additionally, you can configure the Execute Process task to specify a working directory, a time-out period, or a value to indicate that the executable ran successfully. The task can also be configured to fail, if the return code of the executable doesn't match the value that indicates success, or if the executable isn't found at the specified location.

Programmatic configuration of the Execute Process task

For more information about programmatically setting these properties, see ExecuteProcess.

Execute Process Task Editor (General page)

Use the General page of the Execute Process Task Editor dialog box to name and describe the Execute Process task.

Options

Name
Provide a unique name for the Execute Process task. This name is used as the label in the task icon.

Description
Type a description of the Execute Process task.

Execute Process Task Editor (Process page)

Use the Process page of the Execute Process Task Editor dialog box to configure the options that execute the process. These options include the executable to run, its location, command prompt arguments, and the variables that provide input and capture output.

Options

RequireFullFileName
Indicate whether the task should fail if the executable isn't found at the specified location.

Executable
Type the name of the executable to run.

Arguments
Provide command prompt arguments.

WorkingDirectory
Type the path of the folder that contains the executable, or select the browse button (...) and locate the folder.

StandardInputVariable
Select a variable to provide the input to the process, or select <New variable...> to create a new variable:

Related Topics: Integration Services (SSIS) Variables

StandardOutputVariable
Select a variable to capture the output of the process, or select <New variable...> to create a new variable.

StandardErrorVariable
Select a variable to capture the error output of the processor, or select <New variable...> to create a new variable.

FailTaskIfReturnCodeIsNotSuccessValue
Indicate whether the task fails if the process exit code is different from the value specified in SuccessValue.

SuccessValue
Specify the value returned by the executable to indicate success. By default this value is set to 0.

TimeOut
Specify the number of seconds that the process can run. A value of 0 indicates that no time-out value is used, and the process runs until it completes or until an error occurs.

TerminateProcessAfterTimeOut
Indicate whether the process is forced to end after the time-out period specified by the TimeOut option. This option is available only if TimeOut isn't 0.

WindowStyle
Specify the window style in which to run the process.

Related content

• Integration Services Tasks
• Control Flow