Work Items can be customized from the Administration page to better fit your business needs. Navigate to the main work item screen and find the Administration section in the table header. Work item types, statuses, and fields will be configurable there.

Table of Contents

minLevel	1
maxLevel	6
outline	false
type	list
printable	false

Work Item Types

Work item type is a container for the work item. You can use types to group your work items together in a way that makes sense for your team or company. By default, FlexDeploy will come with “Feature”, “Bug”, “Debt”, and “Risk” types out of the box. You can choose to use to keep using those types or scrap them and create your own.

For example:

A single small unit of work from the users perspective is typically called a “Story” work item - This is not a default Type and therefore would need to be created by the FlexDeploy user if desired.
A defect in a code base is typically called a “Bug” work item
A collection of “Stories” is typically called a “Feature” work item
A collection of “Features” which requires a larger group effort is typically called a “Epic” work item - This is not a default Type and therefore would need to be created by the FlexDeploy user if desired.

Image Removed

Image Added

Work Item Status

The work item status indicates its current place in the project’s development cycle. Users can click and select an option from the dropdown to change the status of the work item. You can also configure FlexDeploy to change the status automatically on a build or deployment execution.

Image Removed

Image Added

A work item status is essentially a label with name and description.

Image Removed

Image Added

Work Item Fields

Work Item Fields are used to provide additional information to your work item. The “Details” work item field group is created by default. To create a field:

Select a Work Item Field Group or create a new one. The name of the field group will display after the “Commits” section when viewing a work item.
Create a new field.
Customize the field with various parameters and/or groovy validations. This is the definition of the field, while the value is set on the work item.

Image Removed

Image Added

Edit Field Definition

Work item fields containing the following properties:

Property Name

Required

Description

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:

Code Block

language	groovy

// 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

Code Block

language	groovy

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:

Code Block

// 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 is a groovy script allowing for more complex validations beyond simple UI validations like isRequired or min/max value.

Example Date based Validation script:

Code Block

language	groovy

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

Field Script Objects and Variables

Definition, List Data, and Validation Script have access to the following variables and methods which can used to retrieve values of other fields, set the value of the current field, and other functions to achieve your business requirement.

Objects	Type	Description
form	java.util.Map	Allows access to other fields value and work item value for title, description, status, type, assignee and tags
field	flexagon.fd.model2.pojo.common.FieldDataObject	Set current field value and override properties value for required, hidden, disabled, maxValue, minValue and precision.
currentUser	flexagon.fd.model2.pojo.common.CurrentUser	Returns CurrentUser object with methods - getUserId(), getUserName(), getFirstName(), getLastName(), getEmail() and getRoles()
FLEXDEPLOY	flexagon.fd.services.groovy.functions.IFlexDeployFunctions	Functions for performing actions in FlexDeploy.
EMAIL	flexagon.fd.services.groovy.functions.EmailFunctions	Functions for formatting and sending emails.
REST	flexagon.fd.services.groovy.functions.RestFunctions	Object exposing REST functions. For more info see Using the REST object.
TOPOLOGY	flexagon.fd.services.groovy.functions.TopologyFunctions	Allows access to Integration Accounts(such as Source Control, Change Management, Cloud, or other tools) properties.

Variables for the form object

Variables	Type	Description
form.title	java.lang.String	Returns the value of the Title for the work item.
form.description	java.lang.String	Returns the value of the Description for the work item.
form.changeField	java.lang.String	Property key name of changed field for the current work item, available when one field value is changed.
form.status	java.lang.String	Returns the value of the Status name for the work item.
form.type	java.lang.String	Returns the value of the Type code for the work item.
form.tags	java.util.List	Returns the value of the Tags for the work item.
form.<keycode>	java.io.Serializable	<keycode> represent code of field. All fields of work item can be referenced this way.
form.assignee	java.lang.String	Returns the value of the Assignee for the work item.

Updating state or value of field from Groovy script.

Variables

Type

Description

field.name

java.lang.String

Returns the current field name.

field.datatype

java.lang.String

Returns the current field data type.

field.value

java.io.Serializable

Updates the current field value

Code Block

language	groovy

if (field.value == '' || field.value == null) {
   if (form.type.equalsIgnoreCase("Emergency")) {
      field.value = "Priority 1"
   }
   else {
     field.value = "Priority 2"
   }
 }

field.state.required

java.lang.Boolean

Overrides the current field required property. True or False.

Code Block

language	groovy

if (form.DOWN_TIME_REQUIRED!= null &&  form.DOWN_TIME_REQUIRED== true) {
    field.state.required= true;
}

field.state.disabled

java.lang.Boolean

Overrides the current field disabled property. True or False.

Code Block

language	groovy

if (field.value != '' && field.value != null) {
    field.state.disabled= true;
}

field.state.hidden

java.lang.Boolean

Overrides the current field hidden property. True or False.

Code Block

language	groovy

// Hide field based on other field value.
if (form.VENDOR_NOT_FOUND != null &&  form.VENDOR_NOT_FOUND == false) {
      field.state.hidden = true      
}

field.state.maxValue

java.lang.Long

Overrides the current field maxValue property.

Code Block

language	groovy

  field.state.maxValue = 10000

field.state.minValue

java.lang.Long

Overrides the current field minValue property.

Code Block

language	groovy

  field.state.minValue= 100

field.state.precision

java.lang.Long

Overrides the current field precision(Max Length) property.

Code Block

language	groovy

  field.state.precision= 255

Versions Compared

Old Version 11

New Version 12

Key

Work Item Types

Work Item Status

Work Item Fields

Edit Field Definition

Field Script Objects and Variables

Page Comparison

Versions Compared

Old Version 11

New Version 12

Key

Work Item Types

Work Item Status

Work Item Fields

Edit Field Definition

Field Script Objects and Variables