Select Workflows from the menu. To create a new workflow, click the plus icon in the Workflows navigation tree. The grid icon will change the navigation tree to sorted flat view.

In the workflow editor, you will see two sections titled Workflow Details and Workflow Properties. The Workflow Details section provides the basic definition for the workflow, as described in the table below.

Workflow Properties

Workflow Properties section provides ability to add custom properties for workflow. Plugins generally provide most of the properties, but it is useful to have custom properties specifically when using plugins like Shell, Groovy, Jython etc. These properties will then be available for setting values on either the referencing project or environment instance (depending on the selected scope). For example, you need to define a reusable workflow that deploys files to specific folder depending on what project is being deployed, in that case you can add property to define DEPLOY_FOLDER at Project scope.

To create a new workflow property, click the Add button. There are two options, creating a New Property or sharing an Existing Property from another workflow. When sharing an existing property you can also select a property defined by a plugin, as a means of convenience. In this case the referenced plugin property is read-only and cannot be modified.

Choosing Existing Property will display a popup with a drop down menu of available properties.

Selecting a plugin property will add a row to the table populated with the data for that property. Property will not be editable if plugin property is added. You can add custom existing property that was created with other workflow here as well, in which case that property is editable from both workflows as it is being shared.

Choosing New Property will produce an empty row on the table, populate the values using the table below.

Added by and Added On columns indicate user that added property to workflow properties list.

Enter values for the workflow property as described in the table below. Some property definition values are available in popup (click Pencil icon to access all details of property).

Click the Save button to save the changes. Note that the Definition tab is now enabled. Click the Definition tab to begin modelling the workflow, which is covered in detail in subsequent sections.

Once finished configuring the workflow definition click the Save button to save the changes. To activate the workflow version, making it the live version upon execution, click the Activate button. Note that once you activate a workflow version it is locked from any further edits. To make changes you will first need to create a new version by clicking the Make Copy button.

Workflow Variables

A workflow variable is transient to a workflow execution, and is used to hold any required intermediate state. Example usages for workflow variables include loop counters, assigning error codes, or holding the value of a plugin output. Note these are available within the workflow only, and are not available for use by plugins.

To access the workflow variables, click the  button in workflow definition toolbar. Click the Create button to create a variable.

Enter values as described in the table below.

To delete a workflow variable, select an existing variable and click the Delete button.

Workflow Inputs

A Workflow Input is used to pass user defined data into a workflow. When a workflow request is submitted by a user they will be prompted to enter values for the configured inputs. If a workflow is invoked by a parent workflow the values for the inputs must be configured at development time. An example usage for a workflow input would be allowing the user or parent workflow to specify the branch or tag to use for an SCM operation. Note these are available within the workflow only, and are not available for use by plugins.

To access the workflow inputs, click the  button in workflow definition toolbar. Click the Create button to create a new input.

Enter values as described in table below.

To delete a workflow input, select an existing input and click the Delete button.

Workflow Steps

The workflow editor provides a drag-n-drop interface for constructing build and deploy processes, which can be composed of plugin operations, other sub-workflows, and basic workflow operations such and variable assignments, conditionals, and looping constructs.

The main workflow editor is displayed in the center of the screen. The FlexDeploy workflows are available in the Workflows navigation tree on the left. The basic Workflow Operations are available in the upper right-hand pane. The available Plugin Operations are available on the lower right-hand pane.

To add a new step to the workflow, drag a workflow or plugin operation onto the workflow editor and drop it on the arrow located between the two steps where you want to place it. Configure the fields in the subsequent workflow step editor and click the OK button to save. See subsequent sections for specific instructions pertaining to each workflow operation type.

Lookup Script 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.

Assign

The Assign step provides the ability to assign a value to a workflow variable or a property. Drag the Assign workflow operation onto the workflow editor, and configure its parameters as depicted in the table below. Property values that are overridden will keep the new value for the rest of the workflow execution.

¹ Properties from another instance can be qualified by using instance code followed by a "_", prior to the property name (e.g. INST1_MY_PROPERTY).
² Groovy Script expressions may include variables, inputs, or properties as defined above (e.g. FName + ' ' + LName).

Wait

The Wait step provides the ability to halt the workflow for the specified number of milliseconds. Drag the Wait workflow operation onto the workflow editor, and configure its parameters as depicted in the table below.

RaiseFault

The RaiseFault step provides the ability to force a failure within the workflow. This can be useful when validating some condition and forcing a failure if that condition is not met. Drag the RaiseFault workflow operation onto the workflow editor, and configure its parameters as depicted in the table below.

InvokeWorkflow

The InvokeWorkflow step provides the ability to invoke a child workflow. This can be useful when identifying commonality you wish to share across many workflows. Drag the InvokeWorkflow workflow operation onto the workflow editor, and configure its parameters as depicted in the table below.

InvokePlugin

The InvokePlugin step provides the ability to invoke plugin operations. Drag the InvokePlugin workflow operation onto the workflow editor, and configure its parameters as depicted in the table below.

Some plugin operations, such as the execute operation on the Shell and Windows Shell plugins (See Plugin Guide for complete details), allow the definition of user defined inputs and outputs. User defined inputs and outputs allow the workflow developer to define which inputs flow into the plugin operation and which outputs are returned from the operation. Once defined the invoke plugin step can make use of the defined inputs and must return the defined outputs. When applicable User Input and User Output tabs will be present.

To create a new input, click the New button under the User Inputs section and enter values for the fields described in the table below.

To create a new output, click the New button under the User Outputs section and enter values for the fields described in the table below.

To delete a User Input or User Output select the object you wish to delete and click the associated Delete button.

InvokeTest

The InvokeTest step provides the ability to invoke a group of tests as defined by the strategy for that environment, instance, and stream. This group can be subsetted by specifying specific Test Type, Test Set, and/or Test Definition. Drag the InvokeTest workflow operation onto the workflow editor, and configure its parameters as depicted in the table below.

If

The If step provides the ability to conditionally invoke other steps. Drag the If workflow operation onto the workflow editor, and configure its parameters as depicted in the table below.

¹All references to variables, inputs, or properties are done with just the variable name (e.g. MY_VARIABLE).
² Properties from another instance can be qualified by using instance code followed by a '_', prior to the property name (e.g. INST1_MY_PROPERTY). 

You can add one or more Else If conditions to the If workflow operation by clicking the Else If button. Similarly, you can add an Else condition to the If workflow operation by click the Else button. You can then drag other workflow operations or plugin operations inside of the If/Else blocks of the If workflow operation.
To edit the If condition portion either click on the  icon for the If workflow operation, or click on the icon in the upper-right-hand side of the first condition block. To edit an Else If condition click on the  icon in the upper-right-hand side of the condition block.

While

The While step provides the ability to loop through the execution of other steps. Drag the While workflow operation onto the workflow editor, and configure its parameters as depicted in the table below.

¹All references to variables, inputs, or properties are done with just the variable name (e.g. MY_VARIABLE).
² Properties from another instance can be qualified by using instance code followed by a "_", prior to the property name (e.g. INST1_MY_PROPERTY). 

You can drag other workflow operations or plugin operations inside of the While block. To edit the While, condition click on the  icon for the workflow operation.

Deleting a Workflow Step

To delete a workflow step, right-click on the step and select Delete. Click the OK button on the Delete Confirmation dialog to confirm.