Skip to Content

Run Command on File

Introduction

The Run Command on File plugin runs a specific command, once for each input file.

This plugin can be associated only with Private Agent Groups and is not available on the Jitterbit Cloud Agent Groups.

Important

Plugins provided by Jitterbit are deprecated. See Deprecation and Support in Plugins.

Download and Add the Plugin

The Run Command on File plugin is a standard Jitterbit plugin that is already available in the Management Console Plugins page and does not need to be downloaded or added to the organization.

If directed by Jitterbit Support, this plugin can be downloaded at the link provided below and added to the organization (see Add New Plugins in Customizations > Plug-ins).

Associate the Plugin with an Agent Group

The Run Command on File plugin must be associated with a Private Agent Group to make the plugin available on all agents in the group (see Associate Agent Groups in Customizations > Plug-ins).

The plugin is listed in the Management Console Plugins page with a display name of Jitterbit - Run Command on File.

Set Variables and Use the Plugin in a Project

Refer to these topics for information about using plugins in a project:

The Run Command on File plugin uses these variables:

Name Type Required Description
Command String Required The command (executable) to run. This command cannot have a user interface and cannot wait for user input. If it does wait for input, the plugin will hang indefinitely.
CommandArg String Required

This is the argument that is passed to the executable. The string "%fin" will be replaced with the name of the incoming file and "%fout" will be replaced by the name of the outgoing file.

For example, the command line '--compress -i "%fin" -o "%fout"' will be executed as '--compress -i "/tmp/input.txt" -o "/tmp/output.txt"' if the files happen to be located in /tmp. The agent determines where the files are located; you specify only where in the command line the input and output file names go.

Note that "%relfin" and "%relfout" should be used if only the leaf of the filename should be used.
OutputExtension String Optional If an extension is added to the output file, set it here. For example, if your command automatically adds .ext to the output file specified in the command, set this data element to ".ext". This can also be used for commands that just take an input file but append an extension to it, such as gzip.