Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

To create a new pipeline, navigate to the Search Pipelines screen using the PiplelinesPipelines menu, and click on the Create button.  To edit an existing pipeline, click on the Pipeline Name column of the target pipeline in the search results, or select the row and click the Edit button.

...

Field

Description

Active

Indicates whether the pipeline property is active.  Inactive properties will not appear on the release.

Code

A code for the property, as appropriate for variables within Groovy or Shell scripts.  (e.g. no spaces or special characters other than underscore.)

Description

A meaningful description for the property.  

Data Type

The data type for this property. Valid types are Boolean, Double, Integer, String.

Subtype

Not currently used.

Default Value

A default value to assign to the property if not specified on the release.

Rows

Defines the height of the component to display when capturing the value from the user.

Columns

Defines the length of the component to display when capturing the value from the user.

Display Name

A meaningful name for the property used for display.

List Data

A list of valid values for the property.  Optional, and only applicable for String data type.  Allowed formats:

  • Value1,Value2,Value3

  • Key1,Value1##Key2,Value2##Key3,Value3       (e.g. Key1 will be what is displayed, Value1 will be the actual value when selected)

  • ,Value1,Value2       (e.g. Note comma in the front - will result in empty item in list)

  • ##,Key2,Value2       (e.g. Empty item in list)

Encrypted

Whether or not to encrypt the value, not display on screen or in the logs.  Only applicable for String data type.

Multiselect

Whether multiple values can be selected from the List Data.  Only applicable for String data type, and when List Data is provided.

Length

The maximum allowed length of the property value.  Optional, and only applicable for String data type.

Required

Whether or not a value is required for this property.

Min Value

Minimum allowed value.  Optional, and only applicable for Integer and Double data types.

Max Value

Maximum allowed value.  Optional, and only applicable for Integer and Double data types.

Validator1

Optional Groovy Script to validate provided value.  The script should return true if the value is valid, and false otherwise.  The user specified value is available to the script in the Value variable.  If not valid, the ValidationMessage is displayed to the user.

For example,

Example
Code Block
languagegroovy
if ("BAD".equals(Value)) {ValidationMessage="Bad value!!"; return false;} else {return true;}


Validator2

Optional Groovy Script to validate provided value.  See Validator1.

Validator3

Optional Groovy Script to validate provided value.  See Validator1.

Validator4

Optional Groovy Script to validate provided value.  See Validator1.

Validator5

Optional Groovy Script to validate provided value.  See Validator1.


Click the  button to save the changes to the property (be sure to also save the pipeline, or changes will be lost), or  to revert any unsaved changes.

...