Table of Contents |
---|
Tip |
---|
Scope
Use unique names for Workflow Inputs, Variables and any user defined Plugin Input or Outputs to avoid any confusion. |
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.
...
Field | Required | Description |
---|---|---|
Workflow Name | Yes | The name of the workflow. |
Workflow Type | Yes | The type of workflow (Build, Deploy, Test Definition, Utility or Other). Other is reserved for workflows that will be invoked exclusively by parent workflows. |
Workflow Group | Yes | Used to categorize workflows into folders. |
Workflow Subgroup | Yes | Used to further categorize workflows into subfolders. |
Active Version | No | Indicates the active version of this workflow (read-only). |
Description | No | An optional description for the workflow. |
Workflow Properties
The Workflow Properties section provides the ability to add workflow scoped properties. These properties will then be available for setting values on either the referencing project or environment instance (depending on the selected 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.
...
Field | Required | Description |
---|---|---|
Active | N/A | Property is always active, whether it is part of Workflow property list or not is what matters. |
Code | Yes | User-defined code that identifies this property, which is used in the workflow and/or plugin execution. Note: CODE attribute only allows CAPITAL LETTERS, NUMBERS, and UNDERSCORE |
Display Name | No | Display name, which is used on the property pages, etc. |
Property Scope | Yes | Whether the property scope is Environment Instance or Project. Default is Environment Instance. |
Description | No | A description for the property. |
Data Type | Yes | The property's data type. Default is String. |
Sub Data Type | No | Allows the user to get additional validation for Directories, JDBC URLs, and URLs. |
Encrypted | No | Whether the property is encrypted or not. Encrypted property values will not display on the screen or be readable in any of the logs. Default is No. |
Display Details | ||
Rows | No | Display attribute that defines the number of rows in the input field on the Property page. |
Columns | No | Display attribute that defines the number of columns in the input field on the Property page. |
List Data CSV | No | Allows the user to define a comma-separated list of values that will be displayed in the Workflow Request page. If given, a Drop-down component will be displayed on the Property page. |
Multi Select | No | Determines if multiple of the List Data CSV values can be selected. |
Validation Details | ||
Required | No | Whether the Property is required or not. Defaults to No. |
Length | No | For String data type, this controls length of value being entered. |
Min Value | No | User can control the minimum value for data types such as Integer, Float, Double and Long. |
Max Value | No | User can control the maximum value for data types such as Integer, Float, Double and Long. |
Default Value | No | Default value can be entered as Groovy script or literal. When using Groovy script, following Groovy variables are available:
|
Validation Groovy Script | No | Enter Groovy script to define validation for property value. The script should return true or false to indicate validation success or failure.
|
Updated By | N/A | The user who last updated the property (read-only). |
Updated On | N/A | The date/time in which the property was last updated (read-only). |
Actions | N/A | Contains the icon to remove the property. |
...
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.
...
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.
Field | Required | Description |
---|---|---|
Step Name | Yes | The display name of the step to appear in the workflow editor. |
To (left operand) | Yes | The workflow variable to assign a value to. |
From (right operand) | Yes | The value of an assignment can be one of the following:
|
...
Tip |
---|
A shortcut to using the generic InvokePlugin workflow operation is to drag the specific plugin operation you want to invoke from the Plugin Operations pane in the lower-right-hand side onto the workflow editor. In this case the Plugin Name and Plugin Operation will be pre-selected. |
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.
...
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.
...