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:

• Text Field

• Text Area

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

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

• Checkbox - True / False boolean field

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

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

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

• URL - UI validation expects a valid URL

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

• Directory

• User Select (Username or User Id) - 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) - 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

Work item definition script. This is a groovy script to set various values like defaults or basic validations.

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

// empty check
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"
   }
}

Example definition script to hide field based on another field

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 list data script. This is a groovy script which defines a set of options the user can choose from for this fields value. List Data Script will only apply to String based fields i.e. TextField and not DateTime.

The script is expecting one of 3 return types:

// 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
  private String mLabel;
  private String mValue;
  private String mDescription;

  // ListValueDataObject has the following constructors
  public ListValueDataObject()
  {

   super();
  }

  public ListValueDataObject(String pLabel, String pValue, String pDescription)
  {
    mLabel = pLabel;
   
mValue = pValue;
    mDescription = pDescription;
  }

  public ListValueDataObject(String pLabel, String pValue)
  {
    mLabel
= pLabel;     mValue = pValue;
  }

  public ListValueDataObject(String pValue)
  {
    mLabel = pValue;
    mValue = pValue;
  }

  // ListValueDataObject has the following methods
  public void setLabel(String pLabel)
  {
    this.mLabel = pLabel;
  }

  public String getLabel()
  {
    return mLabel;
  }

  public void setValue(String pValue)
  {
    this.mValue = pValue;
  }

  public String getValue()
  {
    return mValue;
  }

  public void setDescription(String pDescription)
  {
    this.mDescription = pDescription;
  }

  public String getDescription()
  {
    return mDescription;
  }

Validation Script

No

Work item validation script. This is a groovy script allowing for more complex validations beyond simple UI validations like isRequired or min/max value.

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

This script is executed when the status of a work item is changed. Status change will not go through if the validation script fails.

form

Allows access to other property in the field i.e. title, keyname, status, value, etc..

field

Set field value or definition values.

currentUser

The current user details flexagon.fd.model2.pojo.common.CurrentUser.

setUserId(Long userId)

Sets the user id on the object.

public Long getUserId()

Returns the user id as type Long.setUserName(String userName)

Set the username on the object.

getUserName()

Returns the username as a String.

setFirstName(String firstName)

Sets the first name on the object.

getFirstName()

Returns the first name as a String.setLastName(String lastName)

Sets the last name on the object.

getLastName()

Returns the last name as a String.setEmail( String email)Sets the email on the object.

getEmail()

Returns the email as a String.

setRoles(Collection<String> roles)

Sets the roles on the object.

getRoles()

Returns the roles as a list of String.