FlexDeploy Variables Guide

FlexDeploy Workflow editor and certain Plugins support use of Variables, Project and Environment Instance Properties, which helps build dynamic steps in Build / Deploy processes. This document provides details of available variables and their meaning. In addition to Shell script, FlexDeploy also supports Groovy, Ant, and WLST (Jython) scripts, which allows access to additional Java object variables.

Many workflow steps allow the user to enter expressions, often these expressions require using varibles, inputs or properties, but it can be difficult to remember the exact variable, input ot property.  Just click on the Lookup Script Variables icon:

The following window will open.  As you type the script variable, it will filter the entire list of available inputs, properties, and variables to only those that contain the string you entered. Select one variable from suggestions. Press the Copy and Return button to make the variable name be available to paste (Ctrl + V) into the expression.

Variable Scope

Overall, it makes sense to use unique names for any user defined variable to avoid confusion.

  • Project, Environment/Instance, Instance Properties
    • Scope is entire workflow execution.
    • Ideally you should not modify these properties during workflow execution, but it can be modified to influence execution if necessary.
  • FlexFields
    • Scope of FlexField value is entire workflow execution, which may be build/deploy/utility.
    • Note that build request FlexFields are associated with Project Version created by build, hence those values are available during deploy execution as well for project version.
    • Do not modify during course of workflow execution.
  • Workflow Inputs
    • Scope is entire workflow execution.
    • Do not modify during course of workflow execution.
  • Workflow Variables
    • Scope is entire workflow execution.
    • You can modify value for variables during workflow execution and use it to pass various values to plugin inputs or capture plugin outputs.
  • Plugin Inputs
    • Scope is specific plugin execution for endpoint.
  • User defined Plugin Inputs and Outputs
    • Scope is specific plugin execution for endpoint.
  • Use unique names for Workflow Inputs, Variables and any user defined Plugin Input or Outputs to avoid any confusion.

Variable Details