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 | ||
|---|---|---|---|---|
Active | Yes | Whether this property is active or not. Defaults to Yes. | ||
Code | YesThe | name of the propertyUser-defined code that identifies this property, which is used in the workflow. | ||
| Display Name | No | Display name, which is used on the property page, etc. | ||
Property Scope | Yes | Whether the property scope is Environment Instance or Project. Default is Environment Instance. | ||
Description | No | A description for the property. | ||
Datatype | Yes | The property's data type. Default is String. | ||
Subtype | No | Reserved for future use. | Required | YesAllows the user to get additional validation for Directories, JDBC URLs, and URLs. |
Encrypted | No | Whether the property is required encrypted or not. Defaults to Yes. | Encrypted | Whether the property is encrypted or not. Encrypted Encrypted property values will not display on the screen or be readable in any of the logs. Default is No. |
| Display Details | ||||
| No | Display attribute that defines the number of rows in the input field on the Property page. | ||
| No | Display attribute that defines the number of columns in the input field on the Property page. | ||
| No |
| No | |
| Validation Details |
| No |
| No |
| No |
| No |
| No |
| No |
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 |
...
| Allows the user to define a comma-separated list of values that will be displayed in the Workflow Request page. If given, a Dropdown component will be displayed on the Property page. | ||
| No | Determines if multiple of the List Data CSV values can be selected. |
| Validation Details | ||
| No | Whether the Property is required or not. Defaults to No. |
| No | For String data type, this controls length of value being entered. |
| No | User can control the minimum value for data types such as Integer, Float, Double and Long. |
| No | User can control the maximum value for data types such as Integer, Float, Double and Long. |
| No | Enter Groovy script to define default values for the FlexField. |
| No | Enter Groovy script to define validation for the FlexField. The script should return true or false to indicate validation success or failure. See an example. |
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. |
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 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.
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
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.
Field | Required | Description |
|---|---|---|
Code | Yes | The name of the workflow variable. |
Data Type | Yes | The data type of the workflow variable. |
| Encrypted | Yes | Whether the variable is encrypted or not. Encrypted variables values will not display on the screen or be readable in any of the logs. Default is No. |
Initial Value | No | An optional default initial value for the workflow variable. |
Return as Output | Yes | Indicates whether the value of this variable should be returned as an output. Used exclusively by child workflows to return a value to its parent. Default is No. |
Constant | Yes | If a variable is marked as constant its value cannot be changed. Any attempt to set the value of a constant variable will result in an error. |
To delete a workflow variable, select an existing variable and click the Delete button.
| Anchor | ||
|---|---|---|
|
...
|
...
|
...
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 variablesinputs, click the 
button in workflow definition toolbar. Click the Create button to create a variablenew input.
Enter values as described in the table below.
Field | Required | Description | ||||
|---|---|---|---|---|---|---|
Code | Yes | User-defined code that identifies this input, which is used in the workflow. | ||||
| Display Name | Yes | The name of the workflow variable. | No | Display name . | ||
| Description | No | A description for the input. | ||||
Data Type | Yes | The data type of the workflow variableinput.Initial Value | ||||
| Encrypted | No | An optional default initial value for the workflow variable. | Return as Output | Yes | Indicates whether the value of this variable should be returned as an output. Used exclusively by child workflows to return a value to its parentYes | Whether the input is encrypted or not. Encrypted input values will not display on the screen or be readable in any of the logs. Default is No. |
| Display Details | Yes | If a variable is marked as constant its value cannot be changed. Any attempt to set the value of a constant variable will result in an error. | ||||
...
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.
...
Field | Required | Description | ||
|---|---|---|---|---|
Code | Yes | The name of the workflow input. | Display Name | Description |
Data Type | Yes | The data type of the workflow input. | Encrypted | |
| Display Details |
|
|
|
|
| Validation Details |
|
|
|
|
Initial Value | No | An optional default initial value for the workflow input. | ||
Validation Groovy Script | No | An optional description for the workflow input.
| Display attribute that defines the number of rows in the input field on the Property page. | |
| Display attribute that defines the number of columns in the input field on the Property page. | |||
| Allows the user to define a comma-separated list of values that will be displayed in the Workflow Request page. If given, a Dropdown component will be displayed on the Property page. | |||
| Determines if multiple of the List Data CSV values can be selected. | |||
| Validation Details | ||||
| Whether the Property is required or not. Defaults to No. | |||
| For String data type, this controls length of value being entered. | |||
| User can control the minimum value for data types such as Integer, Float, Double and Long. | |||
| User can control the maximum value for data types such as Integer, Float, Double and Long. | |||
Initial Value | No | An optional default initial value for the workflow input. | ||
Validation Groovy Script | No | Enter Groovy script to define validation for the FlexField. The script should return true or false to indicate validation success or failure. See an example. | ||
To delete a workflow input, select an existing input and click the Delete button.
...