Work Item Administration

Work Items can be customized from the main 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.

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.

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.

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

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.

Edit Field

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.

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

Variables for the form object

Variables	Description
form.title	Title of the field for the work item.
form.description	Description of the field for the work item.
form.changeField	Property key name of changed field for the current work item, available when one field value is changed.
form.status	Status name of the field for the work item.
form.type	Work item type of the field for the work item.
form.tags	Tags for the work item.
form.keyname	Keyname for the work item.
form.assignee	Assignee for the work item.

Variables for the field object

Variables	Description
field.value	Returns the current field value
field.state	Returns a map containing state information
field.state.required	Returns the value of the required property. True or False.
field.state.disabled	Returns the value of the disabled property. True or False.
field.state.hidden	Return the value of the hidden property. True or False.
field.state.maxValue	Return the value of the maxValue property. Integer.
field.state.minValue	Return the value of the minValue property. Integer.
field.state.precision	Return the value of the precision property. Integer.

Methods for the currentUser object

Method	Description
setUserId(Long userId)	Sets the user id on the object.
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.