Skip to main content
Feedback

Program Command step

The Program Command step enables database and system-level commands to be executed as part of the process flow. There are three types of commands available: SQL statements, stored procedures, and system commands.

Program Command icon

Often, commands use dynamic runtime values in their calls. In these cases, you can use parameters to provide values such as data from a document field, the current system date/time, a static value, the results of a database query, or several other types of values. You can use multiple parameters when creating a Program Command step. The placeholder number or position corresponds to the order of the parameters defined at the bottom of the dialog.

note

For security reasons, you cannot use the Program Command step in processes deployed to a Boomi Runtime cloud.

Program Command step

  1. Add the Program Command step to the process to open the dialog.

  2. Enter the display name to describe the step. If you enter the name, it appears in addition to the label which is determined by how you set the Type field.

  3. Select a Program Command step type. All Program Command step types display unique properties. If you select:

    • SQL Statement — Executes a database SQL action (INSERT, UPDATE, DELETE). Queries are not supported in the Program Command step because no database profile identifies the response's record structure. Use the Database Connector in mid-process to perform a database read.

    • Stored Procedure — Executes a database stored procedure. The Program Command step will not be able to process any stored procedure returns as structured data through the process flow.

    • System Command — Executes a command line program or script (e.g., *.exe, *.bat, *.jar, *.java files) that does not require user interaction. See the Command field below for more information.

  4. Select Run once per execution to prevent executions with more than one document from repeatedly calling the defined command. It should only be used in scenarios where you do not need to reference inbound document data to execute the command.

  5. Select the Connection to choose an existing Database Connection component or to create a new one against which you will execute the SQL statement or stored procedure.

  6. Enter the actual SQL statement to execute in the SQL field. You can use placeholders ("?") to insert variables.

  7. Enter the Procedure Name which is the name of the database stored procedure to invoke. Use the variables at the bottom to provide the appropriate input variables as defined by the stored procedure definition.

  8. Enter the Command which is the name of the command line program or script to invoke, including the full path to its location.

    • No matter where the program or script is located, its runtime execution context is the Runtime’s root directory. If your program or script contains relative file or directory references, you need to add a “cd” command within the program or script to reset the execution context.

    • You can use the following syntax to create a placeholder, starting at 1. This allows you to dynamically set the path or script input variables, e.g., C:\test\example\example.bat12.

  9. Enter one or more values in the Variables field to insert into the command. For more information, refer to Parameter Values.

On this Page