Plug-in Documentation

Shell for IBM UrbanCode Build

Overview

The Shell plug-in includes steps to run custom shell scripts during the deployment process.

Compatibility

This plug-in requires IBM UrbanCode Build version 6.1 or later.

The steps in this plug-in run on all supported platforms.

Installation

No special steps are required for installation. See Installing plug-ins in UrbanCode Build.

History

Version 5

This version includes translated steps and properties.

Version 4

The duplicate directory offset property was removed from this release.

Version 3

This release includes a fix for a defect related to the name of the xargs step.

Steps

Process steps in the Shell plug-in

Shell

Run a shell or batch script.

Input properties for the
Shell step
Name Type Description Required
Daemon Boolean Select to run the command in the background while permitting the step to complete immediately. The output is not captured if the command is running as a daemon. No
Interpreter String Optionally specify the interpreter to use to evaluate the command.
If left blank, the .bat file interpreter on Microsoft Windows and the .com file interpreter on VMS are used. On other systems the shell specified by the air/shell agent variable is used, if the variable is present. UNIX and Linux systems can override this setting by starting the script with a #! sequence.
No
Output File String Set this value only if Daemon is selected. Enter the path of a file
to direct command output to. Leave blank to discard the output. The output is not captured if an output file is specified.
No
Shell Script String Enter the script code to run. Yes

Shell (with xargs)

Run a shell or batch script a number of times equal to a multi-valued input.

Input properties for the
Shell (with xargs) step
Name Type Description Required
Daemon Boolean Select to run the command in the background while permitting the step to complete immediately. The output is not captured if the command is running as a daemon. No
Interpreter String Optionally specify the interpreter to use to evaluate the command.
If left blank, the .bat file interpreter on Microsoft Windows and the .com file interpreter on VMS are used. On other systems the shell specified by the air/shell agent variable is used, if the variable is present. UNIX and Linux systems can override this setting by starting the script with a #! sequence.
No
Once Per Arg Boolean Run the script once per argument in xargs. No
Output File String Enter the path of a file to direct command output to. Leave blank to discard the output. The output is not captured if an output file is specified. No
Shell Script String Enter the script code to run. Yes
xargs String The comma-separated values to use as input to the script. The values are passed as input to the script. Yes