FIELD(定义)元素引用
使用 FIELD(定义)元素,可以定义工作项字段和指定应用于它的规则和条件。 分配给字段的特性确定其数据类型以及其是否可用于包含在报表中。
备注
有关用于在状态更改或工作流转换期间指定字段规则和条件的 FIELD(工作流)元素的信息,请参阅FIELD(工作流)元素参考。
架构层次结构
FIELD
<FIELD name="fieldDisplayName"
refname="fieldReferenceName"
type="String | Integer | Double | DateTime | PlainText | HTML | History | TreePath | GUID"
syncnamechanges ="true | false"
reportable="Dimension | Detail | Measure"
formula="sum"
reportingname="ReportingDisplayName"
reportingrefname="ReportingReferenceName" >
<ALLOWEDVALUES> . . . </ALLOWEDVALUES>
<ALLOWEXISTINGVALUE />
<CANNOTLOSEVALUE />
<COPY />
<DEFAULT />
<EMPTY />
<FROZEN />
<HELPTEXT> . . . </HELPTEXT>
<MATCH />
<NOTSAMEAS />
<PROHIBITEDVALUES /> . . . </PROHIBITEDVALUES>
<READONLY />
<REQUIRED />
<SERVERDEFAULT />
<SUGGESTEDVALUES /> . . . </SUGGESTEDVALUES>
<VALIDUSER />
<WHEN> . . . </WHEN>
<WHENNOT> . . . </WHENNOT>
<WHENCHANGED> . . . </WHENCHANGED>
<WHENNOTCHANGED> . . . </WHENNOTCHANGED>
</FIELD>
特性和元素
下列各节描述了特性、子元素和父元素。
特性
特性 |
描述 |
||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
name |
必需。 工作项查询的下拉菜单中显示的字段的友好名称。 友好名称在团队项目中定义的所有字段中必须是唯一的。 此外,友好名称可能与工作项窗体上字段旁显示的标签不同。 有关详细信息,请参阅控件 XML 元素引用。 特性类型为 typelib:FieldName。 最小长度:1;最大长度:128。 模式值:^[^\。 \[\]]+$ 模式值示例:Assigned To |
||||||||||||||||||||
refname |
必需。 唯一标签,用于将字段与在团队项目集合中定义的所有其他字段区分开来。 有关友好名称和引用名称的其他要求和限制,请参阅工作项跟踪对象的命名约定。 特性类型为 typelib:ReferenceFieldName。 最小长度:1;最大长度:70。 模式值:^[a-zA-Z_][a-zA-Z0-9_]*(\.[a-zA-Z0-9_]+)+$ 模式值示例:Company.IssueType |
||||||||||||||||||||
type |
必需。 指定字段接受的数据类型。 备注 必须为具有相同 reportingrefname 的不同项目集合中的字段分配相同的 type 值。如果这些值不同,则在处理数据仓库时可能发生数据冲突。有关详细信息,请参阅解决数据仓库中发生的架构冲突。 下表列出了此特性的有效值:
|
||||||||||||||||||||
syncnamechanges |
可选。 指定是否将工作项字段用于存储在 Active Directory 或一个工作组中做出更改后要进行更新的名称。 此选项仅当 type="String" 时有效。 特性类型为 xs:boolean。 指定 true 可启用数据字段同步,指定 false 可禁用数据字段同步。 |
||||||||||||||||||||
reportable |
可选。 指定字段中的数据是否可用于包含在报表中。 具有默认值 None 的字段既不导出到关系型数据仓库中,也不针对 SQL Server Analysis Services 多维数据集进行处理。 有关可报告字段的详细信息,请参阅添加或修改工作项字段以支持报告。 备注 必须为具有相同 reportingrefname 值的不同项目集合中的字段分配相同的 reportable 值。如果这些值不同,则在处理数据仓库时可能发生数据冲突。有关详细信息,请参阅解决数据仓库中发生的架构冲突。 下表列出了此特性的有效值:
|
||||||||||||||||||||
formula |
可选。 measure 可报告类型的聚合类型。 唯一有效的值为 sum,其将基于设置返回所有值的和。 |
||||||||||||||||||||
reportingname |
可选。 指定在报表中显示的名称。 如果您未指定值,则将使用分配给 name 特性的值。 备注 必须为具有相同 reportingrefname 的不同项目集合中的字段分配相同的 reportingname 值。如果这些值不同,则在处理数据仓库时可能发生数据冲突。有关详细信息,请参阅解决数据仓库中发生的架构冲突。 特性类型为 typelib:FieldName。 最小长度:1;最大长度:128。 模式值:^[^\。 \[\]]+$ 模式值示例:Assigned To |
||||||||||||||||||||
reportingrefname |
可选。 指定处理可报告字段时使用的引用名称。 如果您未指定值,则将使用分配给 refname 特性的值。 您可使用此特性来合并或分离将处理到数据仓库中的字段。 若要合并两个具有不同引用名称且在不同项目集合中定义的字段,请为这两个字段分配相同的 reportingrefname。 若要分离两个具有相同的引用名称但在不同的项目集合中定义的字段,请为每个字段分配一个不同的 reportingrefname。 您应尽可能合并字段以最大程度地减少仓库中的字段数,并遵循 1024 个可报告字段的最大限制。 您可以生成带合并字段的跨组报表。 特性类型为 typelib:ReferenceFieldName。 最小长度:1;最大长度:70。 模式值:^[a-zA-Z_][a-zA-Z0-9_]*(\.[a-zA-Z0-9_]+)+$ 模式值示例:Company.IssueType |
子元素
元素 |
描述 |
---|---|
可选。 为字段定义允许值的列表。 允许的值指工作项窗体上以及查询生成器中的字段列表中可供选择的值。 您必须从其中选择一个值。 |
|
可选。 定义此字段以允许使用现有值。 此元素允许使用已存在的字段值,即使这些值无效也是如此。 所有新的字段值都必须有效。 |
|
可选。 将此字段定义为不能失去值。 此元素保留当前字段值,无法将其清除或留空。 |
|
可选。 指定另一个包含的值将要复制到当前字段的字段。 |
|
可选。 为字段定义默认值。 |
|
可选。 将此字段定义为空。 |
|
可选。 将此字段定义为冻结。 提交更改后,冻结字段无法更改为任何非空值。 但是,您可手动清除此字段,保存工作项,然后指定其他值。 |
|
可选。 定义此字段在工具提示中显示的文本。 |
|
可选。 为此字段定义字段值必须匹配的模式。 |
|
可选。 另指定一个值不能与当前字段值相同的字段。 |
|
可选。 为此字段定义禁止值的列表。 |
|
可选。 将此字段定义为只读。 |
|
可选。 将此字段定义为必填字段。 |
|
可选。 指定将为此字段提供值的服务器组件。 |
|
可选。 为此字段定义建议值的列表。 建议的值指工作项窗体上以及查询生成器中的字段列表中可供选择的值。 您可输入列表中可用值以外的其他值。 |
|
可选。 指定允许值的列表必须仅包含系统中有效用户的值。 |
|
可选。 指定在另一个字段具有特定值时要应用于当前字段的一个或多个规则。 |
|
可选。 当特定字段的值发生更改时,将一个或多个规则应用于当前字段。 |
|
可选。 当另一个字段没有特定值时,将一个或多个规则应用于当前字段。 |
|
可选。 当特定字段的值未发生更改时,将一个或多个规则应用于当前字段。 |
父元素
元素 |
描述 |
---|---|
必需。 包含工作项类型字段定义。 |
备注
FIELD(定义)是 FIELDS(定义)必需的子元素。
有关为 TFS 过程模板定义的所有系统字段和预定义字段的概述,请参阅Visual Studio ALM 的工作项字段参考。
无法定义以 System. 前缀开头的自定义字段。 您可通过使用 Microsoft. 前缀定义一个字段,但是,强烈反对这种做法,因为它可能妨碍Team Foundation Server功能。
有关字段友好名称和引用名称的其他要求和限制,请参阅工作项跟踪对象的命名约定。
虽然你可以重命名字段的友好名称,但你不能重命名字段的引用名称。 可以使用 witadmin 命令行工具列出字段并更改几个字段特性,请参阅管理工作项字段 [witadmin]。
您可在同一个团队项目集合中定义不超过 1,024 个的工作项字段,并可在所有团队项目集合中将不超过 1,024 个的字段设置为可报告。
在针对项目集合定义的所有团队项目的所有工作项类型 (WIT) 中定义的所有字段均适用于团队项目集合。 因此,分配给在一个 WIT 中定义的字段的特性必须与集合中所有团队项目的所有 WIT 匹配。 此外,所有集合中的所有可报告字段将导出到数据仓库数据库中。
有关如何标记字段以进行报告的信息,请参阅添加或修改工作项字段以支持报告。
将现有字段添加到其他 WIT 时,可将报表特性显式设置为与当前字段定义相同,也可让它们默认等于这些值。
如果对不同 WIT 中的相同字段或不同团队项目中的相同 WIT 分配了不同的报表特性,则可能发生架构冲突。 若要解决这些冲突,请参阅解决数据仓库中发生的架构冲突。
若要了解如何使用字段以支持查询、报表和工作项跟踪,请参阅修改或添加字段以支持查询、报告和工作流。
有关如何通过使用子元素,应用 FIELD 上的约束和条件的概述信息,请参阅将规则应用到工作项字段。
示例
<FIELD name="Activity" refname="Microsoft.VSTS.Common.Activity" type="String" reportable="dimension">
<HELPTEXT>Type of work involved</HELPTEXT>
<SUGGESTEDVALUES>
<LISTITEM value="Development"/>
<LISTITEM value="Testing"/>
<LISTITEM value="Requirements"/>
<LISTITEM value="Design"/>
<LISTITEM value="Deployment"/>
<LISTITEM value="Documentation"/>
</SUGGESTEDVALUES>
</FIELD>