Wyświetlanie listy pól i atrybutów elementów roboczych

Azure DevOps Services | Azure DevOps Server | Azure DevOps Server 2022 | Azure DevOps Server 2020

Pola zadań roboczych śledzą informacje w usłudze Azure DevOps. System definiuje te pola na poziomie organizacji i udostępnia je we wszystkich projektach w organizacji. Aby przejrzeć pola zdefiniowane dla organizacji, możesz użyć jednego z następujących dwóch narzędzi, które są dostępne dla modeli procesów Dziedziczone i Hostowane XML:

• Strona internetowa Pola przetwarzania >
• Eksplorator pól zadania

Opis każdego pola zdefiniowanego w procesie systemowym można znaleźć w temacie Indeks pola elementu roboczego.

Dlaczego pola elementów roboczych mają znaczenie

Pola elementów roboczych obsługują kilka krytycznych funkcji w usłudze Azure DevOps:

• Śledzenie danych: przechwytywanie i przechowywanie podstawowych informacji o elementach roboczych
• Funkcje zapytań: włączanie zaawansowanych funkcji wyszukiwania i filtrowania
• Raportowanie: obsługa tworzenia analiz i pulpitów nawigacyjnych
• Zarządzanie przepływem pracy: przejścia stanów i reguły biznesowe
• Integracja: łączenie z zewnętrznymi narzędziami i systemami

Zrozumienie atrybutów pól pomoże ci:

• Optymalizowanie zapytań: wybieranie odpowiednich pól na potrzeby wydajnych wyszukiwań
• Dostosowania planu: Omówienie ograniczeń i możliwości
• Rozwiązywanie problemów: Diagnozowanie problemów z działaniem pola
• Procesy projektowania: tworzenie efektywnych typów elementów roboczych i przepływów pracy

Prerequisites

Category	Requirements
Permissions	Aby wyświetlić pola zdefiniowane dla organizacji lub kolekcji: członek grupy aplikacji Project Collection Valid Users lub uprawnienie View instance-level information ustawione na Zezwalaj dla organizacji lub kolekcji.

Lista lub przegląd pól

Aby wyświetlić listę lub przejrzeć pola, użyj jednego z następujących narzędzi opartych na modelu procesu — dziedziczonego, hostowanego kodu XML lub lokalnego kodu XML. Aby uzyskać indeks pól zdefiniowanych w procesach domyślnych, zobacz Indeks pola elementu roboczego.

Tool	Inheritance	Hostowany kod XML	Lokalny kod XML
Portal internetowy: lista pól dziedziczonych i zdefiniowanych przez użytkownika	✔️	✔️1
Eksplorator pól elementu roboczego	✔️	✔️	✔️
narzędzie wiersza polecenia witadmin listfields	✔️	✔️	✔️

Note

1. Obsługiwane tylko w przypadku procesów domyślnych (Agile, CMMI, Scrum).

Typy i nazwy danych pól

Każdy typ elementu roboczego określa pola zawarte w elementach roboczych tego typu. Każde pole ma wiele atrybutów, z których wiele jest zdefiniowanych przez system i niezmiennych.

Trzy kluczowe atrybuty definiują pola:

• Typ danych: wskazuje rodzaj danych, które można wprowadzić w polu, takie jak Wartość logiczna, Podwójna, Liczba całkowita, HTML lub Ciąg. Aby uzyskać szczegółowe opisy poszczególnych typów danych, zobacz Pola zapytań, operatory i makra.
• Przyjazna nazwa: przyjazna dla użytkownika nazwa przypisana do pola używana podczas wybierania pola w klauzuli zapytania. Ta nazwa może różnić się od nazwy wyświetlanej w formularzu elementu roboczego.
• Nazwa odwołania: identyfikator używany podczas tworzenia zapytań WIQL, szablonów elementów roboczych, wykonywania poleceń interfejsu API REST lub definiowania definicji typów elementów roboczych XML. Nazwa odwołania jest stała i nie można jej zmienić po ustawieniu.

Aby uzyskać szczegółowy opis każdego atrybutu pola i instrukcje dotyczące ich wyświetlania, zobacz Atrybuty pola i Atrybuty pól listy w dalszej części tego artykułu. Aby zapoznać się z omówieniem typów elementów roboczych (WIT) i elementów roboczych, zobacz Śledzenie pracy z historiami użytkowników, problemami, usterkami, funkcjami i epikami.

Co to jest pole? Jak działają nazwy pól?

Każdy typ elementu roboczego zawiera 31 pól systemowych i kilka pól specyficznych dla typu. Elementy robocze ułatwiają planowanie i śledzenie projektu.

Każde pole przechwytuje określone informacje o pracy do wykonania. Wartości przypisywane do tych pól są przechowywane w magazynie danych śledzenia pracy, umożliwiając tworzenie zapytań określających stan i trendy.

Odnośnie opisów i sposobów użycia każdego pola określonego dla podstawowych procesów systemowych — Agile, Basic, Scrum i CMMI— odwołaj się do indeksu pól Elementu roboczego Work item field index.

Wymagania dotyczące nazewnictwa pól

Nazwa pola elementu roboczego jednoznacznie identyfikuje każde pole elementu roboczego. Upewnij się, że nazwy pól są zgodne z następującymi wytycznymi:

• Unikatowość: nazwy pól muszą być unikatowe w ramach konta lub kolekcji projektów.
• Długość: nazwy pól muszą zawierać 128 znaków Unicode lub mniej.
• Odstępy: nazwy pól nie mogą mieć spacji wiodących ani końcowych ani zawierać dwóch lub więcej kolejnych spacji.
• Kompozycja: Nazwy pól muszą zawierać co najmniej jeden znak alfabetyczny.
• Niedozwolone znaki: nazwy pól nie mogą zawierać następujących znaków: .,;':~/*|?" &%$!+=()[]{}<>'.

Ponieważ system definiuje pola niestandardowe na poziomie organizacji lub kolekcji, nie można dodać pola niestandardowego o tej samej nazwie do wielu procesów.

Aby uzyskać więcej informacji, zobacz Ograniczenia i konwencje nazewnictwa.

Pola systemowe i wstępnie zdefiniowane

System definiuje pola elementów roboczych z określonymi wymaganiami dotyczącymi nazewnictwa i struktury w celu zapewnienia spójności i funkcjonalności:

• Unikatowość: nazwy pól muszą być unikatowe w ramach konta lub kolekcji projektów.
• Długość: nazwy pól muszą zawierać maksymalnie 128 znaków Unicode.
• Odstępy: nazwy pól nie mogą mieć spacji wiodących ani końcowych, ani zawierać wielu kolejnych spacji.
• Kompozycja: Nazwy pól muszą zawierać co najmniej jeden znak alfabetyczny.
• Niedozwolone znaki: nazwy pól nie mogą zawierać następujących znaków: .,;':~/*|?" &%$!+=()[]{}<>'.

Ponieważ system definiuje pola niestandardowe na poziomie organizacji lub kolekcji, nie można dodać pola niestandardowego o tej samej nazwie do wielu procesów.

Aby uzyskać więcej informacji, zobacz Ograniczenia i konwencje nazewnictwa.

Pola niestandardowe

Ponieważ system definiuje pola niestandardowe na poziomie organizacji lub kolekcji projektów, nie można dodać pola niestandardowego o tej samej nazwie do wielu procesów.

Podczas dodawania pól niestandardowych zwróć uwagę na następujące limity:

• Maksymalna liczba pól na typ elementu roboczego (WIT): 64
• Maksymalna liczba pól na proces: 512

Typ danych pola określa rodzaj i rozmiar danych, które można przechowywać w polu. Każde pole może mieć tylko jeden typ zdefiniowany w kolekcji projektów, zachęcając do używania typowych pól w różnych projektach i typach elementów roboczych.

Po dodaniu pola niestandardowego do dziedziczonego procesu, Azure DevOps przypisuje nazwę odwołania z prefiksem Custom i nazwą pola bez spacji. Na przykład dodanie pola o nazwie DevOps Triage powoduje wyświetlenie nazwy referencyjnej Custom.DevOpsTriage. Spacje nie są dozwolone w nazwach odwołań.

Aby uzyskać więcej informacji, zobacz Ograniczenia i konwencje nazewnictwa.

Jak określić typ danych pola?

Typ danych pól zdefiniowanych dla organizacji można wyświetlić, otwierając stronę Pola procesu>.

Przeglądanie listy pól

Aby przejrzeć listę pól zdefiniowanych dla organizacji lub kolekcji, wykonaj następujące kroki:

1. Wybierz logo usługi Azure DevOps, aby otworzyć pozycję Projekty. Następnie wybierz pozycję Ustawienia organizacji.

   

2. Wybierz Proces.

   

3. Wybierz Pola.

   Pola wymienione odpowiadają wszystkim polam zdefiniowanym dla organizacji lub kolekcji, które obejmują wszystkie pola niestandardowe i pola zdefiniowane dla procesów systemowych.

   

   Note

   Jeśli nie widzisz pola, kolekcja używa lokalnego procesu XML. Strona Pola nie jest obsługiwana dla tego procesu.

   Opisy, użycie i nazwy odwołań dla każdego pola można znaleźć w indeksie pola Element roboczy. Ponadto można pobrać nazwy odwołań do pól przy użyciu interfejsu API REST Work Item Types Field - List.

Eksplorator pól zadania roboczego

Używając narzędzia Eksplorator pól elementów roboczych, można przeglądać przypisania atrybutów pól.

Aby uzyskać dostęp do Eksploratora pól elementu roboczego, zainstaluj narzędzie Edytor procesów. Na podstawie zainstalowanej wersji programu Visual Studio pobierz narzędzie edytora procesów z jednego z następujących rozszerzeń.

• Program Visual Studio 2019 i 2022: aktualnie nie ma dostępnego rozszerzenia edytora szablonów procesowych. Można jednak nadal dostosowywać szablony procesów przy użyciu innych narzędzi, takich jak dowolny edytor tekstów lub edytor XML. Możesz również użyć portalu internetowego usługi Azure DevOps w celu dostosowania, szczególnie w przypadku procesów dziedziczynych.
• Visual Studio 2017: Edytor szablonów procesu TFS. Możesz również użyć tej wersji edytora procesów, aby zmodyfikować formularze elementów roboczych w starym stylu. Nie można jej używać do edytowania formularzy skojarzonych z nowymi formularzami internetowymi.
• Visual Studio 2015: TFS Power Tools.

Atrybuty pola

Dla każdego pola elementu roboczego istnieje wiele atrybutów niezmienialnych i ukrytych. Następująca tabela zawiera opis każdego atrybutu. Atrybuty mają różne nazwy w zależności od tego, czy pobierasz je za pośrednictwem interfejsu API REST — Pobierz, czy wyświetlasz je za pomocą narzędzia Eksplorator pól elementów roboczych (WIFE).

Atrybuty przypisane do pola zależą od używanej platformy i wersji. Na przykład niektóre atrybuty nie są obsługiwane w procesie dziedziczenia. Aby znaleźć nazwę referencyjną pola, zobacz Indeks pól elementów roboczych.

Attribute

Typ atrybutu

Description

---

REST:
ŻONA: AllowedValues

kolekcja

Pobiera kolekcję prawidłowych wartości dla pola zawierającego wartości listy wyboru. Możesz to zmienić, określając listę wyboru lub listę globalną (lokalną).
Czy można zmienić?=Tak

REST: canSortBy
ŻONA: CanSortBy

boolean

Wskazuje, czy wyniki zapytania można sortować za pomocą tego pola.
Czy można zmienić?=Nie

REST: opis
ŻONA: HelpText

ciąg

Określa opis pola, który definiuje również tekst pomocy wyświetlany po umieszczeniu wskaźnika myszy na polu w formularzu elementu roboczego.
Czy można zmienić?=Tak

REST:
ŻONA: ID

Integer

Określa wewnętrzny identyfikator pola.
Czy można zmienić?=Nie

REST:
ŻONA: IsCloneable

boolean

Wskazuje, czy system kopiuje wartość zdefiniowaną dla pola, gdy użytkownik zdecyduje się skopiować element roboczy. Na przykład system kopiuje pola Tytuł, Tagi i Opis , ale nie kopiuje pól Identyfikator i Historia .
Czy można zmienić?=Nie

REST:
ŻONA: IsComputed

boolean

Wskazuje, czy system oblicza wartość zestawów pól (Prawda) lub nie (Fałsz). Przykłady obliczonych pól to te, które ustawiają system, takie jak identyfikator, poprawiona data, data zmiany i liczba linków zewnętrznych.
Czy można zmienić?=Nie

REST:
ŻONA: IsCoreField

boolean

Wskazuje, czy to pole jest określone dla wszystkich typów elementów roboczych.
Czy można zmienić?=Nie

REST:
ŻONA: IsEditable

boolean

Wskazuje, czy użytkownicy mogą modyfikować to pole (Prawda) lub nie (Fałsz). Przykładowe pola nieedytowalne to te, które ustawiają system, takie jak identyfikator, poprawka, utworzone przez i zmienione przez pola
Czy można zmienić?=Nie

REST: isIdentity
ŻONA: IsIdentity

boolean

Wskazuje, czy to pole jest polem Identity. Pola tożsamości to pola ciągów używane do przechowywania tożsamości użytkowników.
Czy można zmienić?=Nie

REST:
ŻONA: IsIndexed¹

boolean

Wskazuje, czy to pole jest indeksowane w celu obsługi wyszukiwania.
Czy można zmienić?=Nie

REST:
ŻONA: IsLongText

boolean

Wskazuje, że pole może zawierać więcej niż 255 znaków, na przykład w przypadku pól przypisanych do typu danych PlainText, HTML lub History.
Czy można zmienić?=Nie

REST: isPicklist² ŻONA:

logiczny

Wskazuje, czy pole kojarzy się z listą wyboru. System ustawia wartość True podczas definiowania pola niestandardowego dla usługi Azure DevOps i wybrania typu Lista wyboru (ciąg) lub Lista wyboru (Liczba całkowita). System ustawia wartość False dla dziedziczych pól, które definiują listy wyboru.
Czy można zmienić?=Nie

REST: isPicklistSuggested² ŻONA:

logiczny

Wskazuje, czy pole umożliwia użytkownikom wprowadzanie własnych wartości dla listy wyboru. System ustawia wartość True podczas definiowania pola niestandardowego dla usługi Azure DevOps, wybierz pozycję Lista wyboru (ciąg) lub Typ listy wyboru (liczba całkowita) i zaznacz pole wyboru Zezwalaj użytkownikom na ustawianie własnych wartości.
Czy można zmienić?=Tak

REST: isQueryable
ŻONA: IsQueryable

boolean

Wskazuje, czy dane pole pojawia się wśród pól, które można dodać do filtrowania zapytania elementu roboczego (Prawda) czy nie (Fałsz). Większość pól jest zapytaniowa.
Czy można zmienić?=Nie

REST:
ŻONA: IsReportable ³

boolean

Wskazuje, czy atrybut możliwy do raportowania jest zdefiniowany lub ustawiony na coś innego niż Brak. Ten atrybut można zmienić dla środowisk lokalnych.
Czy można zmienić?=Tak

REST:
ŻONA: IsUsedInGlobalWorkflow

boolean

Wskazuje, czy pole jest zdefiniowane w globalnym przepływie pracy.
Czy można zmienić?=Nie

REST:
ŻONA: IsUserNameField

boolean

Wskazuje, czy pole jest używane do wyświetlania pola tożsamości.
Czy można zmienić?=Nie

REST: nazwa
ŻONA: Imię i nazwisko

ciąg

Przyjazna nazwa przypisana do pola. Nie można zmienić przyjaznej nazwy usługi Azure DevOps, ale możesz ją zmienić lokalnie przy użyciu polecenia witadmin changefield .
Czy można zmienić?=tylko lokalnie

REST: picklistId
ŻONA: HelpText

GUID

Jeśli pole jest listą wyboru, identyfikator skojarzonej listy wyboru, w przeciwnym razie ma wartość null. System przypisuje unikatową wartość identyfikatora GUID podczas definiowania pola niestandardowego dla usługi Azure DevOps i wybrania typu Lista wyboru (ciąg) lub Lista wyboru (Liczba całkowita).
Czy można zmienić?=Nie

REST:
WIFE: ZabronioneWartości

kolekcja

Pobiera kolekcję niedozwolonych wartości dla pola, które określa takie wartości. Niedozwolone wartości można definiować tylko dla wdrożeń lokalnych.
Czy można zmienić?=tylko lokalnie

REST: readOnly
WIFE:

logiczny

Wskazuje, czy pole jest ustawione na tylko do odczytu. W przypadku usług Azure DevOps Services można zmienić tylko pola niestandardowe na tylko do odczytu. Nie można modyfikować pól systemowych.
Czy można zmienić?=Tak

REST: referenceName
ŻONA: ReferenceName

ciąg

Określa nazwę referencyjną pola.
Czy można zmienić?=Nie

REST:
ŻONA: ReportingAttributes³

Określa szczegóły, wymiar lub miarę, w zależności od tego, czy i w jaki sposób pole ma być uwzględnione w raportach. System eksportuje dane z pól, które mają wartość inną niż Brak dla tego atrybutu do magazynu danych i mogą zawierać je w raportach SQL.
Czy można zmienić?=tylko lokalnie

REST:
ŻONA: ReportingName³

ciąg

Określa etykietę pola, gdy dane są wyświetlane w raportach SQL. Jeśli nie określisz wartości, system użyje przyjaznej nazwy pola.
Czy można zmienić?=tylko lokalnie

REST:
ŻONA: ReportingReferenceName³

ciąg

Określa inną nazwę odwołania do pola używanego przez system podczas eksportowania danych do relacyjnego magazynu danych. Jeśli nie określisz wartości, system używa nazwy odwołania do pól.
Czy można zmienić?=tylko lokalnie

REST: obsługiwaneOperacje
WIFE:

set

Kolekcja operatorów zapytań, które są prawidłowe do użycia podczas odwoływania się do tego pola. Aby zapoznać się z krótkim omówieniem obsługiwanych operacji opartych na typie danych, zobacz Szybkie informacje o zapytaniach, Operatory i makra obsługiwane dla każdego typu danych.
Czy można zmienić?=Nie

REST:
ŻONA: SupportsTextQuery

boolean

Wskazuje, czy pole obsługuje zapytania tekstowe, takie jak Zawiera słowa, Nie zawiera wyrazów.
Czy można zmienić?=Nie

REST:
ŻONA: SystemType

ciąg

Określa typ danych pola, odwołując się do nazwy systemu, takiej jak System.DateTime lub System.String.
Czy można zmienić?=Nie

REST: typ
ŻONA: FieldType

ciąg

Określa typ danych pola, na przykład wartość logiczna, data/godzina, liczba całkowita, napis itd. Aby uzyskać pełną listę i opisy, zobacz Pola zapytań, operatory i makra.
Czy można zmienić?=Nie

REST: użycie
WIFE: Użycie

ciąg

Określa, czy pole jest przeznaczone do użytku z elementami roboczymi (WorkItem) lub obiektami linku elementu roboczego (WorkItemLink). Zastosowanie większości pól to WorkItem. Aby uzyskać pełną listę wartości użycia, odwołaj się do Get Fields, FieldUsage.
Czy można zmienić?=Nie

Note

1. W przypadku wdrożeń lokalnych można włączyć indeksowanie dla pola, aby poprawić czasy odpowiedzi zapytania podczas filtrowania w polu. Aby uzyskać więcej informacji, zobacz Pola indeksowane w dalszej części tego artykułu.
2. System przypisuje atrybut isPicklist i isPicklistSuggested tylko do pól niestandardowych zdefiniowanych dla dziedziczonego procesu. Model procesów dziedziczony obsługuje program Azure DevOps Server 2020 i nowsze wersje. Aby uzyskać więcej informacji, zobacz Dziedziczony model procesu.
3. Wszystkie atrybuty raportowania są prawidłowe tylko w przypadku wdrożeń lokalnych, których projekty zostały skonfigurowane do obsługi raportowania programu SQL Server i usług SQL Server Analysis Services.

Atrybuty pól listy

Aby wymienić atrybuty przypisane do pola, użyj interfejsu API REST Fields - Get. Zastąp ciąg OrganizationName rzeczywistą nazwą organizacji.

https://dev.azure.com/OrganizationName/_apis/wit/fields/FieldReferenceName

Aby wyświetlić atrybuty dla ścieżki iteracji, użyj nazwy odwołania System.IterationPath dla organizacji fabrikam.

https://dev.azure.com/fabrikam/_apis/wit/fields/System.IterationPath

Zwrócone dane:

{
"name": "Iteration Path",
"referenceName": "System.IterationPath",
"description": "The iteration within which this bug will be fixed",
"type": "treePath",
"usage": "workItem",
"readOnly": false,
"canSortBy": true,
"isQueryable": true,
"supportedOperations": [
{
"referenceName": "SupportedOperations.Under",
"name": "Under"
},
{
"referenceName": "SupportedOperations.NotUnder",
"name": "Not Under"
},
{
"referenceName": "SupportedOperations.Equals",
"name": "="
},
{
"referenceName": "SupportedOperations.NotEquals",
"name": "<>"
},
{
"referenceName": "SupportedOperations.In",
"name": "In"
},
{
"name": "Not In"
}
],
"isIdentity": false,
"isPicklist": false,
"isPicklistSuggested": false,
"url": "https://dev.azure.com/mseng/_apis/wit/fields/System.IterationPath"
}

Najlepsze praktyki dotyczące pracy z polami

Podczas pracy z polami elementów roboczych należy wziąć pod uwagę następujące zalecenia:

Wybór i projekt pola

• Wybierz znaczące nazwy: użyj nazw pól opisowych, które wyraźnie wskazują ich przeznaczenie
• Standaryzacja nazewnictwa: ustanawianie spójnych konwencji nazewnictwa w całej organizacji
• Ograniczanie pól niestandardowych: rozważnie dodaj pola niestandardowe, aby uniknąć przeciążania użytkowników
• Rozważ typy danych: wybierz odpowiednie typy danych dla informacji, które przechowujesz

Optymalizacja wydajności

• Użyj pól indeksowanych: w przypadku wdrożeń lokalnych rozważ indeksowanie często zapytanych pól niestandardowych
• Unikaj dużych zapytań: należy pamiętać o wydajności zapytań podczas korzystania z wielu filtrów pól
• Optymalizowanie list wyboru: Utrzymuj wartości list wyboru w rozsądnej liczbie i dobrze zorganizowane

Konserwacja i nadzór

• Użycie pola dokumentu: Utrzymanie dokumentacji wyjaśniającej przeznaczenie i użycie pól niestandardowych
• Regularnie przeglądaj: okresowo przeglądaj pola niestandardowe w celu identyfikowania nieużywanych lub nadmiarowych pól
• Planowanie zmian: rozważ wpływ zmian pól na istniejące elementy robocze i zapytania
• Modyfikacje testowe: Zawsze najpierw testuj zmiany pól w środowisku programistycznym

Dodawanie i modyfikowanie pól

Aby dodać pola do procesu, należy dodać je do co najmniej jednego typu elementu roboczego. Aby uzyskać więcej informacji, zobacz Dostosowywanie procesu dziedziczenia.

Rozwiązywanie problemów w terenie

Typowe problemy i rozwiązania podczas pracy z polami elementów roboczych:

Problemy z widocznością pól

• Pole nie jest wyświetlane: Sprawdź, czy pole zostało dodane do układu typu elementu roboczego
• Problemy z uprawnieniami: Sprawdź, czy masz odpowiednie uprawnienia do wyświetlania lub edytowania pól
• Różnice procesów: upewnij się, że pole istnieje w bieżącym procesie

Problemy z zapytaniami i wyszukiwaniem

• Pole nie jest zapytanialne: Sprawdź atrybut IsQueryable dla pola
• Problemy z wydajnością: Rozważ indeksowanie często odpytywanych pól niestandardowych (lokalnie)
• Ograniczenia operatorów: sprawdź, które operatory są obsługiwane dla typu danych pola

Wprowadzanie i walidacja danych

• Nieprawidłowe wartości: Sprawdź, czy pole ma ograniczone dozwolone wartości lub reguły sprawdzania poprawności
• Pola tylko do odczytu: Weryfikowanie atrybutu IsEditable pola
• Wymagania dotyczące formatu: Upewnij się, że dane są zgodne z oczekiwanym typem danych pola

Treści powiązane

• Szybkie odniesienie dla zapytań aby szybko zrozumieć składnię i użycie zapytań.
• Indeks pola elementu roboczego , aby wyświetlić wszystkie dostępne pola elementów roboczych.
• Dodaj pola dla dziedziczonego procesu i zarządzaj nimi, aby dostosować pola zgodnie z wymaganiami dotyczącymi dziedziczonego procesu.
• Dokumentacja metadanych dla usługi Azure Boards Analytics w celu zrozumienia funkcji metadanych analizy i raportowania.