Code

Yes

Work item field code. Uniquely identifies the field.

Display Name

No

Work item display name.

Description

No

Work item description.

Work Item Types

Yes

The work item types this field will apply to. In other words, if a field is assigned the “Feature” Work Item Type, then all Work Items of type “Feature” will display that field. One or more Work Item Types can be set.

Field Group

Yes

Work item field group. The group which contains the current field. The field group name will appear as a section on the work item.

Field Data Type

Yes

Work item field data type sets the visual format of the field on UI along with simple validation. For more complex validation see “Validation Script”.

The following data types are supported: Script data type is provided in parentheses.

• Text Field (String)

• Text Area (String)

• Number (Long) - UI validation will only allow integers / whole numbers

• Decimal (Double) - UI validation will allow both integers and floating point numbers

• Checkbox (Boolean) - True / False boolean field

• Duration (Long) - Duration is the measure of time. Ui validation will only allow unit of measure formats. I.E. +2d or -3w

• Date (Date) - UI validation expects mm/dd/yyyy format

• DateTime (TimeStamp) - UI validation expects mm/dd/yyyy hh:mm am/pm. The date time is selectable from a calendar for ease of use.

• URL (String) - UI validation expects a valid URL

• JBDCURL (String) - UI validation expects a valid JDBC URL. See packageDeploy (JDBC) for examples of valid JBDC url.

• Directory (String)

• User Select (Username or User Id) (String or Long) - UI provides a selection from FlexDeploy users. Value passed to the work item can be username or user id.

• Group Select (Group name or Group ID) (String or Long) - UI provides a selection from FlexDeploy groups. Value passed to the work item can be name or id.

Example of how each input would display on the work item

Definition Script

No

Definition script is a groovy script that is used to initialize or update value for the field. Additionally, you can set or override basic validations like required, disabled, hidden, maxValue, minValue, maxLength etc. For example, if field is required only based on certain value of other field then you can achieve that by using definition script. You can also make field disabled based on current user’s roles using definition script.

Note that there is no return data from this script, but you will set field.value or field.state.

When you change field value, definition script is executed for all other fields, which allows you to reset value for other fields if necessary. Keep in mind that field.value setting will adjust value of the field on new work item as well as when work item is being updated. If you do not want to adjust the value once it is set then it must be accounted for in definition script, see empty check in example below.

Example definition script to set default value for the property based on work item type:

// empty check - in this example we will not set field value once it has been initialized
if (field.value == '' || field.value == null) 
{
   if (form.type.equalsIgnoreCase("Emergency")) 
   {
      field.value = "Priority 1"
   }
   else  if (form.type.equalsIgnoreCase("Expedite")) 
   {
      field.value = "Priority 2"
   }
   else  if (form.type.equalsIgnoreCase("Normal")) 
   {
      field.value = "Priority 3"
   } 
   else 
   {
      field.value = "Priority 4"
   }
}

Definition script evaluates for all fields when value is changed for any field. You can set field.value in Definition script to adjust the value.

Example definition script to hide field based on another field. Note that field.state in only available in Definition script.

// Hide Field based on other field value
if (form.OTHER_FIELD_CODE.equals("SOME_VALUE")) 
{
  field.state.hidden = true
}

List Data Script

No

Work item definition list data script. This is a groovy script which defines a set of options the user can choose from for this field value. List Data Script will only apply to String based fields i.e. TextField and not DateTime.

You can return list data in 3 different ways (see below):

// An array of values
return ["PROD", "NON-PROD"]

// A comma separated string
return "Break Fix,Enhancement,Problem,Project,request,Risk remediation"

// An array of ListValueDataObject
// Use the constructor or setters on the ListValueDataObject objects to set

 appropriate values
return [new ListValueDataObject("value1"),  new ListValueDataObject("label2", "value2"), new ListValueDataObject("label3", "value3", "Description")]


////////////////////////////////////////////////////////////////////////////////////
// ListValueDataObject has the following variables
  public ListValueDataObject(String pLabel, String pValue, String pDescription)
  public ListValueDataObject(String pLabel, String pValue)
  public ListValueDataObject(String pValue)

Validation Script

No

Work item validation script. This groovy script allows for more complex validations beyond simple UI validations like required or min/max value etc.

Return false to indicate validation failure. In addition set ValidationMessage variable with custom error message which will be displayed for user.

Example Date based Validation script:

// Validation script must return or true or false
// ValidationMessage is a variable specific to this script which will be display on the UI if this script returns false
if (form.PLANNEDSTART != null && form.PLANNEDEND != null) 
{   
  if (form.PLANNEDEND.before(form.PLANNEDSTART)) 
  {
    ValidationMessage = "Planned end date is not before start date."
    return false
  }
}
return true

When field value is changed,

• this script is executed for the field being updated, and if it returns false then value change is not allowed.

• validation script is executed for all other fields as well, field value change will still be allowed if any validation failure occurs for other fields, and screen will show updated error messages.

When work item status is changed,

• This script is executed is execution for all fields and if any script returns false then status update will not be allowed.

form

Allows access to other property in the field i.e. title, keynameform details displayed on work item page. For example, field values and work item details like title, description, status, valuetype, etc..assignee and tags.

see details below in form section

field

Set field value or definition values.

currentUser

The current user details flexagon.fd.model2.pojo.common.CurrentUserRepresents current field value and allows for override of required, hidden, disabled, maxValue, minValue and maxLength.

see details below in field section

currentUser

Returns CurrentUser object with methods - getUserId(), getUserName(), getFirstName(), getLastName(), getEmail() and getRoles()

FLEXDEPLOY

Provides various methods to retrieve data from FlexDeploy.

EMAIL

Functions for formatting and sending emails.

REST

Object exposing REST functions. For more info see Using the REST object. You can use this to invoke external systems for gathering details and/or validations.

TOPOLOGY

Allows access to Integration Accounts (such as Source Control, Change Management, Cloud, or other tools) properties. You can use this in conjunction with REST function to invoke external systems APIs.