Adicionar ou modificar campos de itens de trabalho para oferecer suporte a relatórios

Artigo
06/10/2015

Você usa campos de item de trabalho para acompanhar dados para um tipo de item de trabalho, para definir os critérios de filtragem para consultas, e para usar em relatórios. Qualquer campo, exceto campos do sistema, que você deseja que apareça em um relatório deve ser definido no arquivo de definição para os tipos de itens de trabalho que o campo rastreará. Os campos do sistema são definidos automaticamente para cada tipo de item de trabalho. No entanto, elas devem ser incluídas no formulário de itens de trabalho para oferecer suporte à entrada de dados.

Para oferecer suporte a relatórios, você pode adicionar campos ou alterar os atributos dos campos existentes. Ao adicionar ou alterar campos, é necessário aplicar as convenções de nomenclatura sistemáticas para certificar-se de que os dados sejam agrupados logicamente nas pastas no cubo do Analysis Services SQL Server.

Neste tópico

Práticas recomendadas
Use um campo existente
Lista os campos que estão definidos para uma coleção de projeto de equipe
Atributos de Campo Reportáveis
Alterar um atributo reportável para um campo
Adicione os campos ao relatório de suporte
Verificar alterações feitas aos atributos de campo reportáveis
Práticas recomendadas ao atribuir nomes de referência de relatório

Para obter uma lista de campos reportáveis definidos nos modelos de processo padrão, consulte Referência de campos de relatório para o Visual Studio ALM.

Práticas recomendadas

Antes de adicionar ou modificar um campo, revise as seguintes práticas recomendadas:

Determine se você pode usar um campo que já esteja definido na coleção de projetos de equipe que contém seu projeto de equipe. Uso de um campo existente com suporte para relatórios entre projeto.
Determine se você pode usar um campo que já esteja definido em outra coleção de projetos na implantação do Visual Studio Team Foundation Server. Uso de um campo existente com suporte para relatórios entre projeto.
Você não pode ter mais de 1.024 campos em cada coleção de projeto, e não mais que 1.024 campos reportáveis únicos em todas as coleções de projetos durante uma implantação do Team Foundation Server. Os campos mesclados contam como um campo reportável.
Institua um procedimento padrão e examine o processo para adicionar e modificar campos nos modelos de processo, projetos de equipe ou em coleções de projetos.
Use convenções de nomenclatura sistemáticas quando você rotular campos para relatório. Quando você atribui nomes de referência em uma maneira sistemática através de qualquer coleção de projeto de equipe em uma implantação de Team Foundation Server, você garante um esquema mais consistente e mais útil de armazenamento e do cubo, e evita conflitos de esquema no depósito. Para obter mais informações, consulte Resolver conflitos de esquema que estão ocorrendo no data warehouse.

Você pode atribuir até quatro atributos de rótulo a um campo de item de trabalho:

Dica

Os campos que são definidos nos modelos de processo para o Microsoft Solutions Framework não obtêm um nome de relatório ou um nome de referência de relatório.Por padrão, o nome da referência e atributos de nome são usados.
- name. O nome amigável do campo que aparece nos menus suspensos de consultas de item de trabalho. O nome amigável deve ser exclusivo em todos os campos definidos em um projeto de equipe. Além disso, o nome amigável pode ser diferente do rótulo exibido que é atribuído ao campo no formulário de item de trabalho. Para obter mais informações, consulte Referência do elemento XML de controle.
- refname. O rótulo exclusivo que é atribuído ao campo que o distingue de todos os outros campos definidos na coleção de projeto de equipe. O valor que é atribuído a refname não pode ser alterado.
  
  Para requisitos e restrições em nomes amigáveis e nomes de referência para campos, consulte As convenções de nomenclatura para objetos de rastreamento de Item de trabalho.
- reportingname. Atributo opcional. O nome que é usado para identificar um campo nos relatórios. Quando não definido explicitamente, o valor que está atribuído ao atributo de name é usado.
- reportingrefname. Atributo opcional. O rótulo exclusivo que é atribuído a um campo reportável que o distingue de todos os outros campos reportáveis que são definidos em todas as coleções do projeto de equipe. Quando não definido explicitamente, o valor que está atribuído ao atributo de refname é usado. Para convenções de nomenclatura recomendadas, consulte Práticas recomendadas ao atribuir nomes de referência de relatório posteriormente neste tópico.
  
  Dica
  
  Os nomes de referência de relatório são visíveis somente de um relatório de Tabela Dinâmica ou do cubo do Analysis Services.

Use um campo existente

Você deve usar um campo que já está definido se o campo coincidir com as informações que você deseja controlar fazer relatórios. Para usar um campo existente, execute as seguintes etapas:

Identifique o campo que você deseja usar. Use o comando witadmin listfields para identificar os campos e seus atributos que são definidos para todas as coleções de projeto. Para obter mais informações, consulte Listar os campos definidos para uma coleção de projetos da equipe posteriormente neste tópico.
Determine se o campo é reportável e se os atributos reportáveis atendem às suas necessidades de emissão de relatórios.
Se não for reportável, use witadmin changefield para alterar o atributo reportável para as coleções de projeto em que ele é usado. Para obter mais informações, consulte Alterar um atributo reportável para um campo posteriormente neste tópico.
Para a coleção de projetos onde o campo não é definido, adicione-o a arquivos de definição XML para os tipos de item de trabalho que você deseja usar para controlar dados. Para obter mais informações, consulte Adicionar campos a relatórios de suporte posteriormente neste tópico.

Lista os campos que estão definidos para uma coleção de projeto de equipe

É possível usar o comando witadmin listfields para listar campos e seus atributos. Você pode listar um campo especificado ou todos os campos que são definidos em uma coleção de projeto. O comando witadmin listfields possui a seguinte sintaxe:

witadmin listfields /collection:CollectionURL /n:RefName

Para obter mais informações, consulte Gerenciar campos de item de trabalho [witadmin].

Atributos de Campo Reportáveis

Os campos reportáveis têm um valor de atributo reportable de Detail, Dimension ou Measure. Os seguintes atributos determinam como os campos de item de trabalho são exportados e processados para os bancos de dados de data warehouse:

reportingtype. Para incluir um campo nos relatórios, você deve atribuir um dos seguintes valores para o atributo de reportable:
- Atribua Detail para exportar o campo ao banco de dados relacional de warehouse, mas não ao cubo. Conforme mostra o exemplo a seguir, use o tipo Detail somente para campos Integer, Double, String ou DateTime:
```
<FIELD refname="MyCorp.Summary" name="Summary" type="String" reportable="detail">
```
- Atribua Dimension para exportar o campo ao banco de dados relacional de warehouse e ao cubo. Conforme mostra o exemplo a seguir, use Dimension somente para campos Integer, String ou DateTime. Esse valor é útil para incluir os campos usados para filtrar relatórios (por exemplo, os campos que possuem listas de valores válidos).
```
<FIELD refname="MyCorp.Category" name="Category" type="String" reportable="dimension">
```
- Atribua Measure para oferecer suporte ao processamento de valores pré-calculados no cubo. Use o tipo Measure somente para os campos Integer e Double.
  
  Quando você atribui a medida como reportingtype, você deve atribuir sum como formula, como mostra o exemplo a seguir:
```
<FIELD refname="MyCorp.Cost" name="Cost" type="Integer" reportable="measure" formula="sum">
```
reportingrefname. Você pode atribuir um nome diferente de referência a um campo que está marcado como reportável. Se nenhum valor for especificado, o valor designado ao atributo refname será usado.

Você pode usar este atributo para mesclar ou divergir os campos que são incluídos nos relatórios. Para mesclar dois campos que possuem nomes distintos de referência e que estão definidos em coleções diferentes de projeto, atribua o mesmo reportingrefname a ambos. Para divergir dois campos com o mesmo nome de referência mas que estejam definidos em coleções de projeto diferentes, atribua um reportingrefname diferente para cada campo.

Você deve mesclar campos sempre que possível para minimizar o número de campos no depósito e para manter no limite máximo de 1024 campos reportáveis. É possível gerar relatórios de grupo cruzado com campos mesclados.
reportingname. Você pode atribuir um rótulo diferente a um campo que é usado para exibir dados nos relatórios. Se nenhum valor for especificado, o nome amigável designado ao atributo name será usado. O valor que é atribuído a reportingname aparece no cubo. O valor que é atribuído a reportingrefname não aparece.

Importante

Você deve usar práticas recomendadas para rotular campos de relatório de modo que sejam agrupados nos relatórios de tabela dinâmica.Para obter mais informações, consulte Práticas recomendadas ao atribuir nomes de referência de relatório.

Alterar um atributo reportável para um campo Item de Trabalho

Você pode fazer um campo existente reportável alterando as atribuições de atributo de campo que são definidas para uma coleção de projeto. Um campo existente é definido em uma ou mais definições de tipo de item de trabalho. Além disso, você pode alterar quaisquer atributos que determinam como um campo é processado nos depósitos de dados.

Você pode usar a seguinte sequência de etapas para alterar a atribuição de atributo de um campo:

Você pode usar o comando witadmin changefield para alterar uma atribuição a um campo. Você exercita este comando para uma coleção de projeto de equipe. Use a seguinte sintaxe:
```
witadmin changefield /collection:CollectionURL /n:RefName [/name:NewName] [/syncnamechanges:true | false] [/reportingname:ReportingName] [/reportingrefname:ReportingRefName] [/reportingtype:Type] [/reportingformula:Formula] [/noprompt]
```
Para fazer um campo existente reportável, altere o reportingtype. Por exemplo, para disponibilizar o campo AW.Common.TeamPriority para filtragem de relatórios, atribua o valor de Dimensão a ele:
```
witadmin changefield /collection:http://AdventureWorksServer:8080/AWTeam/Collection1 /n:AW.Common.TeamPriority /reportingtype:dimension 
```
Para obter mais informações, consulte Gerenciar campos de item de trabalho [witadmin].
(Opcional) Se você tiver mais de uma coleção de projeto, convém fazer alterações semelhantes ao campo de item de trabalho que é definido nessa coleção. Para evitar conflitos de esquema quando você exportar e processar dados para bancos de dados de depósito de dados, você deve atribuir os mesmos valores a esses atributos em todas as coleções:
- Tipo de campo (o valor deste campo não pode ser alterado para um campo existente).
- Tipo de relatório.
- Nome de relatório.
Para obter mais informações, consulte Resolver conflitos de esquema que estão ocorrendo no data warehouse.
Após você fazer todas as alterações nos campos de item de trabalho que você deseja usar na emissão de relatórios, será necessário processar os bancos de dados do depósito de dados. Você pode usar os serviços Web de ProcessWarehouse e de ProcessAnalysis , que estão disponíveis com WarehouseControlWebService.

Essa etapa verifica se as pessoas que usam relatórios não veem um erro quando você altera os atributos de campo.

Para obter mais informações, consulte Gerenciar campos de item de trabalho [witadmin].

Adicione os campos ao relatório de suporte

Você pode adicionar campos à definição de um tipo ou tipos de item de trabalho. Ao adicionar o campo, você deve adicionar a mesma definição de elemento do campo para todos os tipos de itens de trabalho para os quais o campo suportará o relatório. Se você desejar que o campo dê suporte à criação de relatórios entre projetos, o campo deverá ser adicionado a todos os tipos de item de trabalho em todos os projetos de equipe em que serão relatados.

Para obter mais informações, consulte Definir e modificar campos do item de trabalho.

Verificar alterações feitas aos atributos de campo reportáveis

Você pode verificar as alterações feitas aos atributos de campo reportáveis processando as warehouses de dados sob demanda e então verificando os relatórios para observar se eles estão atualizados. Ou você pode esperar até a execução dos trabalhos do adaptador do depósito. Por padrão, a base de dados relacional é processada a cada poucos minutos. No entanto, o cubo é processado a cada duas horas por padrão.

Dica

Para obter mais informações sobre WarehouseControlWebService, consulte Processar manualmente o cubo de data warehouse e do Analysis Services para o Team Foundation Server.

Processar o data warehouse relacional sob demanda usando o ProcessWarehouse WarehouseControlWebService.
Processar o cubo sob demanda usando o ProcessAnalysisDatabase WarehouseControlWebService.
Verifique se os relatórios estão sendo atualizados. Exibir um relatório através do painel ou do Gerenciador de Relatórios. Para obter mais informações, consulte Painéis ou Relatórios (SQL Server Reporting Services).

Práticas recomendadas ao atribuir nomes de referência de relatório

Para relatar nomes de referência, você deseja atribuir rótulos de modo que possa localizar facilmente os campos no relatório de Tabela Dinâmica e no cubo. Você pode obter esse aplicando convenções de nomenclatura sistemáticas de modo que os campos sejam agrupados em uma sequência lógica. Além disso, se os campos não estiverem agrupados de uma maneira útil, você poderá alterar o nome de referência de relatórios de um campo.

A aplicação de uma convenção de nomenclatura sistemática se torna muito importante por que todos os dados reportáveis de todos os projetos de equipe que são definidos em todas as coleções de projeto são gravados em um único depósito de dados relacional. Em seguida, os dados desse depósito são processados e gravados no cubo. Como os campos de item de trabalho são gerenciados distintamente para cada coleção de projeto, rótulos diferentes podem ser aplicadas e podem resultar em um conjunto de campos que não é bem organizado para oferecer suporte a relatórios de criação.

Campos de item de trabalho que têm um tipo reportável de dimensão correspondem aos atributos de dimensão no cubo. Atributos de dimensão são organizados em pastas que são baseadas no nome da referência de relatório atribuído na definição de tipo de item de trabalho ou de modelo de processo. Os seguintes tipos de mapeamento ocorrem:

Os campos com o prefixo "Sistema" são intrínsecos e estão listados diretamente sob a dimensão Item de Trabalho, com "Item de Trabalho" como prefixo.
Outros campos são colocados nas pastas cujos nomes correspondem aos prefixos em seus nomes de referência. Por exemplo, campos que têm o prefixo "Microsoft.VSTS.Common" são listados na pasta rotulada "Microsoft VSTS Common."

Conforme mostra a ilustração a seguir, uma pasta é adicionada para cada grupo de prefixos de campos que compartilham um prefixo comum:

Estrutura de pastas no cubo de dados OLAP

A tabela a seguir lista os campos cujos nomes de referência começam com “Sistema” e que são listados no relatório de Tabela Dinâmica com o prefixo “Item de Trabalho”. Esses campos são colocados diretamente na dimensão de Item de Trabalho. Todos os outros campos são colocados em pastas cujos nomes correspondem aos prefixos em seus nomes de referência.

Dica

As implantações que não usam a versão Enterprise do SQL Server Analysis Services não têm acesso aos recursos de tradução fornecidos por aquela versão.Nessas implantações, os campos são identificados por seu nome de referência completo no cubo, com '.' substituído por '_' (por exemplo, "System_Id" e "System_Title").

Nome no relatório de Tabela Dinâmica e no cubo	Nome de referência	Tipo de dados
Caminho de área do item de trabalho	System.AreaPath	TreeType
Item de trabalho atribuído a	System.AssignedTo	Cadeia de caracteres
Item de trabalho alterado por	System.ChangedBy	Cadeia de caracteres
Data de alteração do item de trabalho	System.ChangedDate	DateTime
Work Item.Created By	System.Created By	Cadeia de caracteres
Data de criação do item de trabalho	System.CreatedDate	DateTime
Work Item.ID	System.Id	Integer
Caminho de iteração do item de trabalho	System.IterationPath	TreeType
Estado anterior do item de trabalho	System.PreviousState	Cadeia de caracteres
Razão do item de trabalho	System.Reason	Cadeia de caracteres
Work Item.Rev	System.Rev	Integer
Estado do item de trabalho	System.State	Cadeia de caracteres
Título do item de trabalho	System.Title	Cadeia de caracteres
Work Item.Work Item Type	System.WorkItemType	Cadeia de caracteres

A tabela a seguir lista os campos que aparecem no relatório de Tabela Dinâmica na pasta que é rotulada “Microsoft.VSTS.Common” na dimensão de Item de Trabalho. Esses campos têm nomes de referência que começam com “Microsoft.VSTS.Common”.

Nome no relatório de Tabela Dinâmica e no cubo	Nome de referência	Tipo de dados
Item de trabalho ativado por	Microsoft.VSTS.Common.ActivatedBy	Cadeia de caracteres
Data de ativação do item de trabalho	Microsoft.VSTS.Common.ActivatedDate	DateTime
Item de trabalho fechado por	Microsoft.VSTS.Common.ClosedBy	Cadeia de caracteres
Data de fechamento do item de trabalho	Microsoft.VSTS.Common.ClosedDate	DateTime
Work Item.Created By	Microsoft.VSTS.Common.CreatedBy	Cadeia de caracteres
Data de criação do item de trabalho	Microsoft.VSTS.Common.CreatedDate	DateTime
Work Item.Resolved By	Microsoft.VSTS.Common.ResolvedBy	Cadeia de caracteres
Data de solução do item de trabalho	Microsoft.VSTS.Common.ResolvedDate	DateTime
Razão de solução do item de trabalho	Microsoft.VSTS.Common.ResolvedReason	Cadeia de caracteres
Prioridade do item de trabalho	Microsoft.VSTS.Common.Priority	Integer
Severidade do item de trabalho	Microsoft.VSTS.Common.Severity	Cadeia de caracteres
Classificação em pilha do item de trabalho	Microsoft.VSTS.Common.StackRank	Double

Consulte também

Compartilhar via