Step Properties Dialog

Top  Previous  Next

The Step Properties dialog is used to add new steps to a project or modify existing steps. For new steps, it is accessed by double-clicking an action on the Actions pane or by choosing Insert on the Edit menu.  For an existing step, it is accessed from the Properties button on the toolbar, the Properties item on the View menu.  Multiple steps can be selected and edited simultaneously.  If all steps have the same action, all the property tabs will be displayed, otherwise only the General tab will be available.  All properties that are modified will be updated in all selected steps (the initial dialog will show the properties of the first selected step).

 

Step

 

The step action is displayed in the dialog caption.  Each step contains a General tab for standard properties and may contain additional tabs specific to the action for that step.

 

Fields on the General Tab

 

Name: Used to identify the step when building (required).

 

Description: A description of the step (optional).  It will also be displayed in a tool tip in the main window when the mouse is over the Step Name column.

 

Conditional Build Rule

 

This section is used to define a build rule that determines if a step and its children will be built or skipped.  This is a powerful capability that allows selective execution of project steps based on the value of macros, script, or environment variables.

 

 

On Step Failure

 

This section of the dialog can be used to configure the action(s) to perform if the step fails to build.

 

Build failure steps: If this item is checked, the specified Failure steps subroutine (or all failure steps if blank) will be built if this step fails to build.

 

Continue building: If this option is checked, the build will continue with the following step (after any failure steps have been built if specified in the previous field) if this step fails to build.

 

 

Disable logging of action output: If checked, any logging the step's action performs (to a file or the Output pane) will be ignored and not logged.  Logging from any of the step's script events will not be suppressed.

 

 

Buttons on the Dialog

 

Notes:

Bracket characters [ and ] normally denote a script expression to be inserted into a field; to insert literal brackets, use two bracket characters [[ or ]].
The percent sign character % is normally used around a macro name for its value to be expanded within the field; to insert a literal percent character, use two percent characters %%.
To copy the current field's expanded value (with all macros expanded) to the clipboard, type Ctrl+M. Ctrl+C copies the value without expansion.  Ctrl+Shift+M copies with macros and expanded and with script evaluated.