Dodawanie i modyfikowanie pól elementów roboczych w celu obsługi raportowania
Pól elementu roboczego używa się do śledzenia danych typu elementu roboczego, definiowania kryteriów filtrowania zapytań i korzystania z raportów. Dowolne pole, oprócz pól systemu, które ma być wyświetlane w raporcie, musi być określone w pliku definicji dla typów elementów roboczych, które to pole będzie śledziło. Pola systemowe są definiowane automatycznie dla każdego typu elementu roboczego. Jednak muszą być uwzględnione w formularza elementu roboczego, aby obsługiwać wprowadzanie danych.
Aby obsługiwać raportowanie, można dodawać pola lub zmieniać atrybuty istniejących pól. Podczas dodawania lub zmiany pól, należy zastosować systematyczne konwencje nazewnictwa, aby upewnić się, że dane są logicznie pogrupowane w foldery w module SQL Server usług Analysis Services.
W tym temacie
Najważniejsze wskazówki
Użyj istniejącego pola
Pola listy definiowane dla kolekcji projektów zespołowych
Raportowalne atrybuty pola
Zmień atrybut objętych obowiązkiem sprawozdawczym dla pola
Dodaj pola do obsługi raportowania
Sprawdź zmiany wprowadzone do atrybutów pola objętych obowiązkiem sprawozdawczym
Najważniejsze wskazówki podczas przypisywania nazw odniesień raportowania
Aby uzyskać wykaz pól sprawozdawczych zdefiniowanych w domyślnych szablonach procesów, zobacz Odwołanie pól do raportowania dla Visual Studio ALM.
Najważniejsze wskazówki
Przed dodaniem lub zmodyfikowaniem pola, należy rozważyć następujące wskazówki:
Określ, czy można użyć pola, które jest już zdefiniowane w innej kolekcji projektów zespołu, która zawiera projekt zespołu. Użycie istniejącego pola obsługuje raportowanie między projektami.
Określ, czy można użyć pola, które jest już zdefiniowane w innej kolekcji projektów, przy wdrażaniu Visual Studio Team Foundation Server. Użycie istniejącego pola obsługuje raportowanie między projektami.
Możesz mieć nie więcej niż 1024 pola elementów roboczych w każdej kolekcji projektu i nie więcej niż 1024 unikalne pola raportowalne we wszystkich kolekcjach projektu dla wdrożenia Team Foundation Server. Scalone pola liczą się jako jedno pole sprawozdawcze.
Utwórz standardową procedurę i proces przeglądu w celu dodawania i modyfikowania pól w szablonach procesów, projektach zespołowych lub kolekcjach projektów.
Użyj systematycznych konwencji nazewnictwa do etykietowania pól do raportowania. Podczas przypisywania nazw odniesienia w sposób systematyczny przez wszystkie kolekcje projektu zespołowego w danym wdrożeniu Team Foundation Server, gwarantujesz bardziej spójny i użyteczny magazyn i schemat modułu, i unikasz konfliktów schematów w magazynie. Aby uzyskać więcej informacji, zobacz Rozwiązywanie konfliktów dotyczących schematów, które pojawiają się w magazynie danych.
Możesz przypisać maksymalnie cztery atrybuty etykiety do pola elementu roboczego:
Uwaga
Pola, które są zdefiniowane w szablonach procesu dla oprogramowania Microsoft Solutions Framework, nie mają przypisanej nazwy raportowania lub nazwy odniesienia raportowania.Domyślnie nazwa odwołania i atrybuty nazwy są używane.
name. Przyjazna nazwa pola wyświetlanego w rozwijanych menu zapytań elementu roboczego. Przyjazna nazwa musi być unikatowa we wszystkich polach, które są zdefiniowane w projekcie zespołu. Ponadto przyjazna nazwa może się różnić od wyświetlanej etykiety, przypisanej do pola formularza elementu roboczego. Aby uzyskać więcej informacji, zobacz Element formantu XML — Odwołanie.
refname. Unikalna etykieta przypisana do pola, wyróżniająca pole ze wszystkich innych pól zdefiniowanych w kolekcji projektu zespołowego. Wartość, która jest przypisana do refname nie może być zmieniana.
Dodatkowe wymagania i ograniczenia dotyczące nazw przyjaznych dla pola i nazw odniesień, zobacz: Konwencje nazewnictwa dla elementu pracy śledzenia obiektów.
reportingname. Opcjonalny atrybut. Nazwa, która służy do identyfikacji pola w raportach. Jeśli nie określisz tego wyraźnie, zostanie użyta wartość, którą przypisano do atrybutu name.
reportingrefname. Opcjonalny atrybut. Unikalna etykieta przypisana do pola objętego obowiązkiem sprawozdawczym odróżniającym od wszystkich innych pól objętych obowiązkiem sprawozdawczym, które zostały zdefiniowane we wszystkich kolekcjach projektu zespołowego. Jeśli nie określisz tego wyraźnie, zostanie użyta wartość, którą przypisano do atrybutu refname. Aby uzyskać zalecane konwencje nazewnictwa, zobacz Najważniejsze wskazówki podczas przypisywania nazw odniesień raportowania później w tym temacie.
Uwaga
Nazwy odniesień raportowania są widoczne tylko z raportu tabeli przestawnej lub modułu Analysis Services.
Użyj istniejącego pola
Powinieneś użyć pola, które jest już zdefiniowana, jeśli pole to pasuje do informacji, które chcesz śledzić i raportować. Aby użyć istniejącego pola, wykonaj następujące kroki:
Określ pole, którego chcesz użyć. Użyj polecenia witadmin listfields, aby określić pola i ich atrybuty, które są zdefiniowane dla wszystkich kolekcji projektu. Aby uzyskać więcej informacji, zobacz Wyświetlanie listy pól zdefiniowanych dla kolekcji projektów zespołowych później w tym temacie.
Określ, czy pole jest objęte obowiązkiem sprawozdawczym i czy te atrybuty odpowiadają Twoim potrzebom w zakresie raportowania.
Jeśli nie jest sprawozdawcze, użyj narzędzia witadmin changefield, aby zmienić atrybut sprawozdawczości dla kolekcji projektów, w których jest używane. Aby uzyskać więcej informacji, zobacz Zmiana atrybutu sprawozdawczego dla pola później w tym temacie.
Dla kolekcji projektów, gdzie pole nie jest zdefiniowane, należy ją dodać do plików definicji XML dla typów elementów roboczych, których chcesz użyć do śledzenia danych. Aby uzyskać więcej informacji, zobacz Dodawanie pól w celu obsługi raportowania później w tym temacie.
Pola listy definiowane dla kolekcji projektów zespołowych
Możesz użyć polecenia witadmin listfields, aby wymienić pola i ich atrybuty. Możesz wymienić określone pole lub wszystkie pola, które są zdefiniowane w kolekcji projektu. Polecenie witadmin listfields następującą składnię:
witadmin listfields /collection:CollectionURL /n:RefName
Aby uzyskać więcej informacji, zobacz Zarządzanie polami elementów pracy [witadmin].
Raportowalne atrybuty pola
W przypadku raportowalnych pól wartość atrybutu reportable wynosi Detail, Dimension, lub Measure. Następujące atrybuty określają, jak pola elementu roboczych są eksportowane i przetwarzane do baz danych magazynu danych:
reportingtype. Aby dołączyć pola w raportach, należy przypisać jedną z następujących wartości do atrybutu reportable:
Przypisz Detail, aby wyeksportować pole do magazynu relacyjnej bazy danych, ale nie do modułu. Jak pokazano na poniższym przykładzie, użyj typu Detail tylko dla liczby całkowitej, podwójnej, ciągu lub pól DateTime:
<FIELD refname="MyCorp.Summary" name="Summary" type="String" reportable="detail">
Przypisz Dimension, aby wyeksportować pole zarówno do magazynu relacyjnej bazy danych, jak i do modułu. Jak pokazano na poniższym przykładzie, użyj Dimension tylko dla liczby całkowitej, ciągu lub pól DateTime. Ta wartość jest przydatna podczas dołączania pól, które są używane do filtrowania raportów (na przykład pola zawierające listy prawidłowych wartości).
<FIELD refname="MyCorp.Category" name="Category" type="String" reportable="dimension">
Przypisz Measure, aby obsługiwać przetwarzanie obliczonych wcześniej wartości w module. Użyj typu Measure tylko dla liczby całkowitej, double, ciągu lub pól Double.
Podczas przypisywania Środek jako reportingtype, musisz przypisać sum jako formula, jak w poniższym przykładzie:
<FIELD refname="MyCorp.Cost" name="Cost" type="Integer" reportable="measure" formula="sum">
reportingrefname. Możesz przypisać inną nazwę odwołania do pola, które jest oznaczone jako objęte obowiązkiem sprawozdawczym. Jeśli nie określisz żadnej wartości, zostanie użyta wartość, którą przypisano do atrybutu refname.
Użyj tego atrybutu, aby scalić lub rozdzielić pola zawarte w raportach. Aby scalić dwa pola, które posiadają określone nazwy odniesień i które są definiowane w innych kolekcjach projektu, przypisz te same reportingrefname do obu. Aby rozróżnić dwa pola, które posiadają tę samą nazwę odniesienia, ale są definiowane w innych kolekcjach projektu, przypisz różne reportingrefname do każdego pola.
Tam gdzie jest to możliwe powinno się scalać pola w celu zminimalizowania liczby pól w magazynie i utrzymania tej liczby poniżej maksymalnego limitu 1024 raportowalnych pól. Możesz generować raporty przekrojowe grup ze scalonymi polami.
reportingname. Można przypisać inną etykietę do pola, które jest używane, gdy dane są wyświetlane w raportach. Jeśli nie określono żadnej wartości, zostanie użyta przyjazna nazwa, którą przypisano do atrybutu name. Wartość, która jest przypisana do reportingname pojawia się w module. Wartość, która jest przypisana do reportingrefname nie pojawia się.
Ważne
Powinieneś używać najlepszych praktyk do etykietowania zgłaszanych pól, dzięki czemu są one zgrupowane razem w raportach tabeli przestawnej.Aby uzyskać więcej informacji, zobacz Najważniejsze wskazówki podczas przypisywania nazw odniesień raportowania.
Zmień atrybut objętych obowiązkiem sprawozdawczym dla pola elementu roboczego
Możesz uczynić istniejące pole podlegającym raportowaniu zmieniając przydziały atrybutu pola, które są zdefiniowane dla kolekcji projektu. Istniejące pole jest zdefiniowane w jednej lub większej liczbie definicji typu elementów roboczych. Ponadto można zmienić wszystkie atrybuty, które określają sposób przetwarzania pola w hurtowni danych.
Możesz użyć poniższej sekwencji czynności, aby zmienić przypisanie atrybutu pola:
Możesz użyć polecenia witadmin changefield, aby zmienić przypisanie atrybutu pola. Wykonujesz to polecenie dla kolekcja projektu zespołowego. Użyj następującej składni:
witadmin changefield /collection:CollectionURL /n:RefName [/name:NewName] [/syncnamechanges:true | false] [/reportingname:ReportingName] [/reportingrefname:ReportingRefName] [/reportingtype:Type] [/reportingformula:Formula] [/noprompt]
Aby objąć istniejące pole obowiązkiem raportowania, zmień reportingtype. Na przykład aby udostępnić pole AW.Common.TeamPriority do filtrowania raportów, przypisz wartość Wymiar do niego:
witadmin changefield /collection:http://AdventureWorksServer:8080/AWTeam/Collection1 /n:AW.Common.TeamPriority /reportingtype:dimension
Aby uzyskać więcej informacji, zobacz Zarządzanie polami elementów pracy [witadmin].
(Opcjonalnie) Jeśli masz więcej niż jedną kolekcję projektu, możesz wprowadzić zmiany podobne do pola elementu pracy zdefiniowanego w tej kolekcji. Aby uniknąć konfliktów schematu podczas eksportowania i przekazywania danych procesu do baz danych magazynu, musisz przypisywać te same wartości do tych atrybutów we wszystkich kolekcjach:
Typ pola (wartości tego pola nie można zmienić dla istniejącego pola).
Typ raportowania.
Nazwa raportowania.
Aby uzyskać więcej informacji, zobacz Rozwiązywanie konfliktów dotyczących schematów, które pojawiają się w magazynie danych.
Po wprowadzeniu wszystkich zmian do pól elementów roboczych, których chcesz użyć do raportowania, musisz przetworzyć bazy danych z magazynem danych. Możesz użyć usług sieci Web ProcessWarehouse i ProcessAnalysis, które są dostępne za pośrednictwem WarehouseControlWebService.
Ten krok pozwala się upewnić, że osoby korzystające z raportów nie zobaczą błędu po wprowadzeniu przez Ciebie zmian w atrybutach pola.
Aby uzyskać więcej informacji, zobacz Zarządzanie polami elementów pracy [witadmin].
Dodaj pola do obsługi raportowania
Możesz dodać pola do definicji typu elementu roboczego lub typów. Podczas dodawania pola powinieneś dodawać tę samą definicję elementu pola do wszystkich typów elementów roboczych, dla których pole będzie obsługiwało raportowanie. Jeśli chcesz, aby pole obsługiwało raportowanie między projektami, należy dodać pole do wszystkich typów elementów roboczych we wszystkich projektach zespołowych, które będą objęte raportowaniem.
Aby uzyskać więcej informacji, zobacz Definiowanie i modyfikowanie pól elementu roboczego.
Sprawdź zmiany wprowadzone do atrybutów pola objętych obowiązkiem sprawozdawczym
Możesz zweryfikować zmiany dokonane w atrybutach pól objętych obowiązkiem sprawozdawczym przetwarzając magazyny danych na żądanie a następnie sprawdzając raporty, aby się upewnić, czy są one aktualizowane. Lub możesz poczekać do czasu uruchomienia zadań adaptera hurtowni danych. Domyślnie relacyjna baza danych jest przetwarzana co kilka minut. Jednak moduł jest przetwarzany co dwie godziny domyślnie.
Uwaga
Aby uzyskać więcej informacji o usłudze WarehouseControlWebService, zobacz Ręczne przetwarzanie modułu hurtowni danych i usług Analysis Services dla programu Team Foundation Server.
Przetwarzaj relacyjną hurtownię danych na żądanie za pomocą obiektu ProcessWarehouse WarehouseControlWebService.
Przetwarzaj moduł na żądanie za pomocą obiektu ProcessAnalysisDatabase WarehouseControlWebService.
Sprawdź, czy raporty są aktualizowane. Wyświetl raport za pośrednictwem pulpitu nawigacyjnego lub Menedżera raportów. Aby uzyskać więcej informacji, zobacz Pulpity nawigacyjne portalu projektu lub Raporty (SQL Server Reporting Services ).
Najważniejsze wskazówki podczas przypisywania nazw odniesień raportowania
Dla nazw odniesień raportowania chcesz przypisać etykiety, dzięki czemu można łatwo znaleźć pola w raporcie tabeli przestawnej i module. Możesz to osiągnąć dzięki zastosowaniu systematycznych konwencji nazewnictwa tak, aby pola były grupowane w logicznej kolejności. Dodatkowo jeśli pola nie są zgrupowane w użyteczny sposób, można zmienić nazwę odniesienia raportowania pola.
Stosowanie systematycznych konwencji nazewnictwa staje się coraz ważniejsze, ponieważ wszystkie dane objęte obowiązkiem sprawozdawczym dla wszystkich projektów zespołowych określonych we wszystkich kolekcjach projektów są zapisywane do pojedynczego magazynu danych relacyjnych. Dane z tego magazynu są następnie przetwarzane i zapisywane w module. Ponieważ pola elementu roboczego są wyraźnie zarządzane dla każdej kolekcji projektów, mogą być stosowane różne etykiety i mogą prowadzić do zestawu pól, które nie są dobrze zorganizowane do obsługi tworzenia raportów.
Pola elementów roboczych, które mają objęty obowiązkiem sprawozdawczym typ wymiaru odpowiadają atrybutom wymiaru w module. Atrybuty wymiaru są zorganizowane w foldery bazujące na raportowaniu nazwy odniesienia, która jest przypisana w szablonie procesu lub w definicji typu elementu roboczego. Występują następujące typy mapowania:
Pola, które mają prefiks „System”, są wewnętrzne i wyświetlane bezpośrednio w wymiarze Element roboczy z przedrostkiem „Element roboczy”.
Inne pola są umieszczane w folderach, których nazwy odpowiadają prefiksom nazw pól odwołania. Na przykład pola, które mają prefiks „Microsoft.VSTS.Common”, pojawiają się na liście w folderze o nazwie „Microsoft.VSTS.Common”.
Jak pokazano na poniższej ilustracji, folder jest dodawany dla każdej grupy prefiks pól, które współużytkują wspólny prefiks:
Poniższa tabela zawiera listę pól, których nazwy odniesienia zaczynają się słowem "System" i które są wymienione w raporcie tabeli przestawnej z prefiksem "Element roboczy". Te pola są umieszczane bezpośrednio pod wymiarem Element roboczy. Wszystkie inne pola są umieszczane w folderach, których nazwy odpowiadają prefiksom nazw pól odwołania.
Uwaga
Wdrożenia, które nie korzystają z wersji Enterprise usług Analysis Services SQL Server, nie mają dostępu do funkcji translacji, które są dostarczane przez tę wersję.W tych wdrożeniach pola są identyfikowane przez ich nazwy pełne odwołań w module, z elementem „.” zastąpionym elementem „_” (na przykład „System_Id” i „System_Title”).
Nazwa w raporcie tabeli przestawnej i module |
Nazwa odwołania |
Typ danych |
---|---|---|
Work Item.Area Path |
System.AreaPath |
TreeType |
Work Item.Assigned To |
System.AssignedTo |
Ciąg |
Work Item.Changed By |
System.ChangedBy |
Ciąg |
Work Item.Changed Date |
System.ChangedDate |
DataGodzina |
Work Item.Created By |
System.Created By |
Ciąg |
Work Item.Created Date |
System.CreatedDate |
DataGodzina |
Work Item.ID |
System.Id |
Liczba całkowita |
Work Item.Iteration Path |
System.IterationPath |
TreeType |
Work Item.Previous State |
System.PreviousState |
Ciąg |
Work Item.Reason |
System.Reason |
Ciąg |
Work Item.Rev |
System.Rev |
Liczba całkowita |
Work Item.State |
System.State |
Ciąg |
Work Item.Title |
System.Title |
Ciąg |
Element roboczy.Typ elementu roboczego |
System.WorkItemType |
Ciąg |
Poniższa tabela zawiera listę pól, które pojawiają się w raporcie tabeli przestawnej, w folderze o nazwie "Microsoft.VSTS.Common" w wymiarze Element roboczy. Te pola mają nazwy odniesienia, zaczynające się od "Microsoft.VSTS.Common".
Nazwa w raporcie tabeli przestawnej i module |
Nazwa odwołania |
Typ danych |
---|---|---|
Work Item.Activated By |
Microsoft.VSTS.Common.ActivatedBy |
Ciąg |
Work Item.Activated Date |
Microsoft.VSTS.Common.ActivatedDate |
DataGodzina |
Work Item.Closed By |
Microsoft.VSTS.Common.ClosedBy |
Ciąg |
Work Item.Closed Date |
Microsoft.VSTS.Common.ClosedDate |
DataGodzina |
Work Item.Created By |
Microsoft.VSTS.Common.CreatedBy |
Ciąg |
Work Item.Created Date |
Microsoft.VSTS.Common.CreatedDate |
DataGodzina |
Work Item.Resolved By |
Microsoft.VSTS.Common.ResolvedBy |
Ciąg |
Work Item.Resolved Date |
Microsoft.VSTS.Common.ResolvedDate |
DataGodzina |
Work Item.Resolved Reason |
Microsoft.VSTS.Common.ResolvedReason |
Ciąg |
Work Item.Priority |
Microsoft.VSTS.Common.Priority |
Liczba całkowita |
Work Item.Severity |
Microsoft.VSTS.Common.Severity |
Ciąg |
Work Item.Stack Rank |
Microsoft.VSTS.Common.StackRank |
Wartość dwubajtowa |
Zobacz też
Informacje
Zarządzanie polami elementów pracy [witadmin]
Koncepcje
Rozwiązywanie konfliktów dotyczących schematów, które pojawiają się w magazynie danych
Odwołania pola elementu pracy dla Visual Studio ALM
Wykresy, pulpity nawigacyjne i raporty dla rozwiązania Visual Studio ALM
Inne zasoby
Modyfikowanie lub dodawanie pola do obsługi zapytań, raportów i przepływu pracy