Versions Compared

Key

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

...

...

...

...

...

...

...

...

Table of Contents

Tip

Scope

  • Workflow Inputs - entire workflow execution. Do not modify during course of workflow execution.
  • Workflow Variables - entire workflow execution. You can modify value for variables during workflow execution.
  • User defined Plugin Inputs and Outputs - specific plugin execution for endpoint.

Use unique names for Workflow Inputs, Variables and any user defined Plugin Input or Outputs to avoid any confusion.

...

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

For custom property it makes sense to prefix with company name like COMPANY1, COMPANY2 etc. Flexagon Plugin properties are prefixed with FD.

Display NameNoDisplay 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.

If you select Project scope, then value for property is defined for each Project on project properties screen.

If you select Environment Instance scope, then value for property is defined on topology differently for applicable 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

Yes

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

NoDisplay attribute that defines the number of rows in the input field on the Property page.

Columns

NoDisplay attribute that defines the number of columns in the input field on the Property page.

List Data CSV

NoAllows 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

NoDetermines if multiple of the List Data CSV values can be selected.
Validation Details

Required

YesWhether the Property is required or not. Defaults to No.

Length

NoFor String data type, this controls length of value being entered.

Min Value

NoUser can control the minimum value for data types such as Integer, Float, Double and Long.

Max Value

NoUser 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:

  • FD_PROJECT_NAME
  • FD_APPLICATION_NAME
  • FD_ENVIRONMENT_CODE
  • FD_INSTANCE_CODE

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.
Groovy script can use these variables:

  • Value – value entered by user for property.
  • ValidationMessage – script can set specific error message in attribute, only used if script returns false.

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).

ActionsN/AContains the icon to remove and edit the property.

...