Referência de elemento FIELD (definição)
Você usa o FIELD elemento (definição) para definir um campo de item de trabalho e especificar as regras e condições que se aplicam a ele. Os atributos que você atribui a um campo determina o tipo de dados e se está disponível para inclusão nos relatórios.
Dica
Para obter informações sobre o FIELD elemento (fluxo de trabalho), que é usada para especificar regras e condições para campos durante uma transição de estado de alterações ou fluxo de trabalho, consulte Referência de elemento FIELD (fluxo de trabalho).
Hierarquia de esquema
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>
Atributos e elementos
As seções a seguir descrevem atributos, elementos filho e elementos pai.
Atributos
Atributo |
Descrição |
||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
name |
Obrigatório. O nome amigável do campo que aparece nos menus suspensos das consultas de item de trabalho. O nome amigável deve ser exclusivo entre todos os campos que são definidos em um projeto de equipe. Além disso, o nome amigável pode diferir do rótulo que aparece ao lado do campo no formulário de item de trabalho. Para obter mais informações, consulte Referência do elemento XML de controle. O tipo de atributo é typelib:FieldName. Comprimento mínimo: 1; comprimento máximo: 128. Valor do padrão: ^ [^ \. \[\]]+$ Exemplo de valor padrão: atribuído a |
||||||||||||||||||||
refname |
Obrigatório. O rótulo exclusivo que distingue um campo de todos os outros campos são definidos na coleção de projeto de equipe. Para outros requisitos e restrições em nomes amigáveis e nomes de referência, consulte As convenções de nomenclatura para objetos de rastreamento de Item de trabalho. O tipo de atributo é typelib:ReferenceFieldName. Comprimento mínimo: 1; comprimento máximo: 70. Valor do padrão: ^[a-zA-Z_][a-zA-Z0-9_]* (\. [a-zA-Z0-9 _] +) + $ Exemplo de valor padrão: Company.IssueType |
||||||||||||||||||||
type |
Obrigatório. Especifica o tipo de dados que o campo aceita. Dica Campos em diferentes coleções que têm o mesmo do projeto reportingrefname deve ter o mesmo valor para type.Se os valores forem diferentes, podem ocorrer conflitos de dados quando o data warehouse é processado.Para obter mais informações, consulte Resolver conflitos de esquema que estão ocorrendo no data warehouse. A tabela a seguir lista os valores válidos para esse atributo:
|
||||||||||||||||||||
syncnamechanges |
Opcional. Especifica se o campo de item de trabalho é usado para armazenar os nomes que você deseja atualizada à medida que forem feitas alterações no Active Directory ou um grupo de trabalho. Essa opção só é válida quando type="String". O tipo de atributo é xs:boolean. Especifique true para habilitar a sincronização do campo de dados, especifique false para desabilitar a sincronização para o campo de dados. |
||||||||||||||||||||
reportable |
Opcional. Especifica se os dados do campo estão disponíveis para inclusão nos relatórios. Os campos com o valor padrão de None não são exportados para o data warehouse relacional nem processados para o SQL Server cubo do Analysis Services. Para obter mais informações sobre campos de relatório, consulte Adicionar ou modificar campos de itens de trabalho para oferecer suporte a relatórios. Dica Campos em diferentes projetos coleções que têm o mesmo valor para o reportingrefname devem ter o mesmo valor para reportable.Se os valores forem diferentes, podem ocorrer conflitos de dados quando o data warehouse é processado.Para obter mais informações, consulte Resolver conflitos de esquema que estão ocorrendo no data warehouse. A tabela a seguir lista os valores válidos para esse atributo:
|
||||||||||||||||||||
formula |
Opcional. O tipo de agregação para o measure tipo reportable. O único valor válido é sum, que retorna a soma de todos os valores no conjunto. |
||||||||||||||||||||
reportingname |
Opcional. Especifica o nome que aparece em relatórios. Se você não especificar um valor, o valor atribuído para a name atributo será usado. Dica Campos em diferentes coleções que têm o mesmo do projeto reportingrefname deve ter o mesmo valor para o reportingname.Se os valores forem diferentes, podem ocorrer conflitos de dados quando o data warehouse é processado.Para obter mais informações, consulte Resolver conflitos de esquema que estão ocorrendo no data warehouse. O tipo de atributo é typelib:FieldName. Comprimento mínimo: 1; comprimento máximo: 128. Valor do padrão: ^ [^ \. \[\]]+$ Exemplo de valor padrão: atribuído a |
||||||||||||||||||||
reportingrefname |
Opcional. Especifica o nome de referência que é usado quando um campo reportable é processado. Se você não especificar um valor, o valor atribuído para a refname atributo será usado. Você pode usar esse atributo para mesclar ou divergem campos que são processados no data warehouse. Para mesclar dois campos que tenham nomes distintos de referência e que são definidos em coleções de projetos diferentes, atribua o mesmo reportingrefname a ambos. Para uma diferenciação dois campos que têm o mesmo nome de referência, mas que são definidos em coleções de projetos diferentes, você atribuir outro reportingrefname a cada campo. Você deve mesclar campos sempre que possível para minimizar o número de campos no depósito e manter no limite máximo de 1024 campos de relatório. Você pode gerar relatórios de grupo cruzado com campos mesclados. O tipo de atributo é typelib:ReferenceFieldName. Comprimento mínimo: 1; comprimento máximo: 70. Valor do padrão: ^[a-zA-Z_][a-zA-Z0-9_]* (\. [a-zA-Z0-9 _] +) + $ Exemplo de valor padrão: Company.IssueType |
Elementos filho
Elemento |
Descrição |
|---|---|
Opcional. Define uma lista de valores permitidos para o campo. Os valores permitidos são valores que estão disponíveis para seleção em uma lista de campos nos formulários de itens de trabalho e no construtor de consultas. Você deve selecionar um desses valores. |
|
Opcional. Define o campo para permitir que os valores existentes. Esse elemento permite que os valores de campo já existentes para ser usado, mesmo que eles não são válidos. Todos os novos valores de campo devem ser válidos. |
|
Opcional. Define o campo não pode perder valor. Esse elemento mantém o valor do campo atual e não pode ser desmarcado ou ficaram vazia. |
|
Opcional. Especifica outro campo que contém um valor a ser copiado no campo atual. |
|
Opcional. Define um valor padrão para o campo. |
|
Opcional. Define o campo como vazio. |
|
Opcional. Define o campo como congelado. Um campo congelado não pode ser alterado para qualquer valor não vazio, depois que as alterações são confirmadas. No entanto, limpar o campo manualmente, salve o item de trabalho e, em seguida, especifique um valor diferente. |
|
Opcional. Define o texto exibido na dica de ferramenta para o campo. |
|
Opcional. Define um padrão para o campo que deve coincidir com o valor do campo. |
|
Opcional. Especifica outro campo, o valor que não pode ser idêntico ao valor do campo atual. |
|
Opcional. Define uma lista de valores do campo proibidos. |
|
Opcional. Define o campo como somente leitura. |
|
Opcional. Define o campo conforme necessário. |
|
Opcional. Especifica um componente de servidor que fornecerá o valor do campo. |
|
Opcional. Define uma lista de valores sugeridos para o campo. Valores sugeridos são valores que estão disponíveis para seleção em uma lista de campos nos formulários de itens de trabalho e no construtor de consultas. Você pode inserir outros valores adicionalmente na lista. |
|
Opcional. Especifica que a lista de valores permitidos deve consistir apenas de usuários válidos do sistema. |
|
Opcional. Especifica uma ou mais regras para aplicar ao campo atual quando outro campo tem um valor específico. |
|
Opcional. Aplica-se uma ou mais regras para o campo atual quando valor de um campo específico é alterado. |
|
Opcional. Aplica-se uma ou mais regras para o campo atual quando outro campo não tem um valor específico. |
|
Opcional. Aplica-se uma ou mais regras para o campo atual quando um determinado valor de campo não é alterado. |
Elementos pai
Elemento |
Descrição |
|---|---|
Obrigatório. Contém as definições de campo de tipo de item de trabalho. |
Comentários
FIELD (Definição) é um elemento filho obrigatório do FIELDS (definição).
Para obter uma visão geral de todos os campos predefinidos que são definidos para os modelos de processo do TFS e sistema, consulte Referência de campo de item de trabalho do Visual Studio ALM.
Você não pode definir um campo personalizado que começa com o System. prefixo. Você pode definir um campo usando o Microsoft. do prefixo, no entanto, essa prática não é recomendável porque ele pode impedir Team Foundation Server funcionalidade.
Para outros requisitos e restrições em nomes de campo amigáveis e referência, consulte As convenções de nomenclatura para objetos de rastreamento de Item de trabalho.
Enquanto você pode renomear o nome amigável do campo, você não pode renomear nomes de referência do campo. Você pode listar campos e alterar vários atributos de campo usando o witadmin de linha de comando toolSee Gerenciar campos de item de trabalho [witadmin].
Você pode definir os campos de item de trabalho no máximo 1.024 na mesma coleção de projetos de equipe, e você pode definir no máximo 1.024 campos como reportable em todas as coleções de projetos de equipe.
Todos os campos definidos em todos os tipos de item de trabalho (WITs) para todos os projetos de equipe definidos para uma coleção de projeto são para uma coleção de projetos de equipe. Portanto, os atributos que você atribui aos campos que são definidos em um WIT devem ser compatíveis entre todos os WITs de todos os projetos de equipe em uma coleção. Além disso, todos os campos de relatório de todas as coleções são exportados para os bancos de dados do data warehouse.
Para obter informações sobre como campos de rótulo para fins de relatório, consulte Adicionar ou modificar campos de itens de trabalho para oferecer suporte a relatórios.
Quando você adiciona um campo existente para um WIT diferente, o qualquer explicitamente define os atributos de relatórios a ser o mesmo que a definição atual do campo ou deixá-los padrão para esses valores.
Podem ocorrer conflitos de esquema se atributos de relatórios diferentes forem atribuídos ao mesmo campo em diferentes WITs ou os WITs mesmos em diferentes projetos de equipe. Para resolver esses conflitos, consulte Resolver conflitos de esquema que estão ocorrendo no data warehouse.
Para entender como os campos são usados para oferecer suporte a consultas, relatórios e acompanhamento do item de trabalho, consulte Modificar ou adicionar um campo para dar suporte a consultas, relatórios e fluxos de trabalho.
Para obter uma visão geral de como aplicar restrições ou condições em uma FIELD usando elementos filho, consulte Aplicar uma regra a um campo do item de trabalho.
Exemplo
<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>
Consulte também
Referência
Gerenciar campos de item de trabalho [witadmin]
Conceitos
As convenções de nomenclatura para objetos de rastreamento de Item de trabalho
Referência de campo de item de trabalho do Visual Studio ALM
Personalizar objetos de acompanhamento de trabalho para dar suporte aos processos da sua equipe
Definir e modificar campos do item de trabalho
Outros recursos
Acompanhamento do item de trabalho: indexar em definições de elementos XML