FIELD (Workflow) element reference
Azure DevOps Server 2022 - Azure DevOps Server 2019 | TFS 2018 - TFS 2013
Important
This article applies to project customization for On-premises XML process models. For an overview of process models, see Customize your work tracking experience.
You use the FIELD (Workflow) element to specify the rules and conditions that apply to a field during a state change or workflow transition. The rule is applied based on where the FIELD (Workflow) element appears under the STATE, TRANSITION, DEFAULTREASON, or REASON element of which its parent FIELDS element is a child. To learn more, see Q: Where should I apply a field rule?
Note
For information about the FIELD (Definition) element, which you use to define fields for a type of work item, see FIELD (Definition) element reference.
Syntax
<FIELD refname="fieldReferenceName">
<ALLOWEDVALUES> . . . </ALLOWEDVALUES>
<ALLOWEXISTINGVALUE />
<CANNOTLOSEVALUE />
<COPY />
<DEFAULT />
<EMPTY />
<FROZEN />
<MATCH />
<NOTSAMEAS />
<PROHIBITEDVALUES /> . . . </PROHIBITEDVALUES>
<READONLY />
<REQUIRED />
<SERVERDEFAULT />
<SUGGESTEDVALUES /> . . . </SUGGESTEDVALUES>
<VALIDUSER />
<WHEN> . . . </WHEN>
<WHENNOT> . . . </WHENNOT>
<WHENCHANGED> . . . </WHENCHANGED>
<WHENNOTCHANGED> . . . </WHENNOTCHANGED>
<FIELD>
Attributes and elements
The following sections describe attributes, child elements, and parent elements.
Attributes
| Attribute | Description |
|---|---|
refname |
Required. The reference name of the field where the rules and conditions are applied. The reference name must match the reference name defined in the field definition's FIELD (Definition) element. For more information, see FIELD (Definition) element reference. |
Child elements
| Element | Description |
|---|---|
| ALLOWEDVALUES | Optional. Defines a list of allowed values for the field. Allowed values are values that are available for selection in a field list on work item forms and in the query builder. You must select from one of these values. |
| ALLOWEXISTINGVALUE | Optional. Defines the field to allow existing values. This element allows the field values that already exist to be used, even if they are not valid. All new field values must be valid. |
| CANNOTLOSEVALUE | Optional. Defines the field as cannot lose value. This element keeps the current field value and it cannot be cleared or made empty. |
| COPY | Optional. Specifies another field that contains a value to be copied into the current field. |
| DEFAULT | Optional. Defines a default value for the field. |
| EMPTY | Optional. Defines the field as empty. |
| FROZEN | Optional. Defines the field as frozen. A frozen field cannot be changed to any non-empty value after changes are committed. However, you can manually clear the field, save the work item, and then specify a different value. |
| MATCH | Optional. Defines a pattern for the field that the field value must match. |
| NOTSAMEAS | Optional. Specifies another field, the value of which cannot be identical to the value of the current field. |
| PROHIBITEDVALUES | Optional. Defines a list of prohibited values for the field. |
| READONLY | Optional. Defines the field as read-only. |
| REQUIRED | Optional. Defines the field as required. |
| SERVERDEFAULT | Optional. Specifies a server component that will provide the value for the field. |
| SUGGESTEDVALUES | Optional. Defines a list of suggested values for the field. Suggested values are values that are available for selection in a field list on work item forms and in the query builder. You can enter other values additionally to the ones in the list. |
| VALIDUSER | Optional. Specifies that the list of allowed values must consist only of valid users of the system. |
| WHEN | Optional. Specifies one or more rules to apply to the current field when another field has a specific value. |
| WHENCHANGED | Optional. Applies one or more rules to the current field when a specific field's value is changed. |
| WHENNOT | Optional. Applies one or more rules to the current field when another field does not have a specific value. |
| WHENNOTCHANGED | Optional. Applies one or more rules to the current field when a specific field's value is not changed. |
Parent elements
| Element | Description |
|---|---|
| FIELDS | A collection of FIELD (Workflow) elements that reference a field that is defined for a type of work item and that specify the rules and conditions that apply to the field. The reference is based on the STATE, TRANSITION, DEFAULTREASON, or REASON element of which its parent FIELDS element is a child. |
Remarks
You must define at least one child element for the FIELD (Workflow) element.
FIELD (Workflow) is a required child element of FIELDS (Workflow).