Versions Compared

Old Version 55

changes.mady.by.user Erick Jones

Saved on

compared with

New Version 56

changes.mady.by.user Erick Jones

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

...

In addition to members, a role defined within a pipeline also establishes default permissions.  When a release consumes the pipeline, it inherits the roles role's default permissions, but can override them for that particular role.  In other words, a role may have different permissions from release to release if necessary.

...

Field

Description

Active

Indicates whether the pipeline property is active.  Inactive properties will not appear on the release.
CodeA 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 TypeThe data type for this property. Valid types are Boolean, Double, Integer, String.
SubtypeNot currently used.
Default ValueA default value to assign to the property if not specified on the release.
RowsDefines the height of the component to display when capturing the value from the user.
ColumnsDefines the length of the component to display when capturing the value from the user.
Display NameA 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)
EncryptedWhether or not to encrypt the value, not display on screen or in the logs.  Only applicable for String data type.
MultiselectWhether multiple values can be selected from the List Data.  Only applicable for String data type, and when List Data is provided.
LengthThe maximum allowed length of the property value.  Optional, and only applicable for String data type.
RequiredWhether or not a value is required for this property.
Min ValueMinimum allowed value.  Optional, and only applicable for Integer and Double data types.
Max ValueMaximum 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,

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


Validator2Optional Groovy Script to validate provided value.  See Validator1.
Validator3Optional Groovy Script to validate provided value.  See Validator1.
Validator4Optional Groovy Script to validate provided value.  See Validator1.
Validator5Optional 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.

...

Snapshot variables provide state for the life of a snapshot.  Such state afford affords the ability to store some data as part of a step or gate in one stage, and consume it or make decisions in a later stage.  One classic example is to store off a CMS ticket which was entered or created in one stage, and feed it into another stage which will use the same ticket.  The pipeline defines the metadata for any snapshot variables which are available, and values can be set or retrieved using Custom Gates or Custom Steps.

Image RemovedImage Added

To create a Snapshot Variable, click on the  icon.  Enter the required information and click Save.

Image RemovedImage Added

The display name for the variable.
FieldDescription
CodeThe identifier which is used to access the variable from Groovy
ActiveWhether the variable is active or not.  Defaults to true.
DescriptionA description for the variable.
Data TypeThe data type of the variable.  Allowed types are Boolean, Integer, Double, or String. Display Name

Project Groups

Project Groups provide categorization tags for release content.  As such, pipelines define the tags, and deploy segments of the content based on those tags.  Releases consuming the pipeline can then tag its content as belonging to those groups.

...