Verwalten von Arbeitselementfeldern

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

Das Befehlszeilentool witadmin bietet leistungsstarke Funktionen zum Verwalten von Arbeitsaufgabenfeldern in Ihrer Projektsammlung. Unabhängig davon, ob Sie Felder umbenennen, Datentypen anpassen oder die Synchronisierung mit Identitätsanbietern konfigurieren müssen, bieten ihnen diese Befehle eine präzise Kontrolle über Ihre Arbeitsverfolgungserfahrung.

Was Sie mit witadmin-Feldbefehlen tun können

Verwenden Sie die folgenden witadmin-Befehle , um Felder in allen Arbeitsaufgabentypen und Projekten in Ihrer Sammlung zu verwalten:

• changefield: Ändern von Feldattributen, die sammlungsweit angewendet werden, einschließlich:
  • Datentypkonvertierung zwischen PlainText und HTML Formaten

  Wichtig

  Wenn Sie Azure DevOps Server aktualisieren, wird das Beschreibungsfeld (System.Description) automatisch in PlainTextHTML. Verwenden Sie den changefield Befehl, um dies bei Bedarf wiederhergestellt zu können.

  • Anzeigenamen , die in Arbeitsaufgabenabfragen angezeigt werden (können sich von Formularbeschriftungen unterscheiden)
  • Berichterstellungsattribute für die Data Warehouse-Integration
  • Identitätssynchronisierung mit Microsoft Entra ID oder Active Directory
• deletefield: Entfernen nicht verwendeter Felder aus ihrer Sammlung
• listfields: Anzeigen von Feldattributen und -verwendungen in Projekten

Ausführen des witadmin Befehlszeilentools

Um das witadmin Befehlszeilentool auszuführen, öffnen Sie ein Eingabeaufforderungsfenster, in dem Visual Studio installiert ist. Das witadmin Befehlszeilentool wird mit einer beliebigen Version von Visual Studio installiert. Sie können auf dieses Tool zugreifen, indem Sie die kostenlose Version von Visual Studio Community oder Visual Studio Team Explorer installieren.

Für Visual Studio 2022

%programfiles(x86)%\Microsoft Visual Studio\2022\Community\Common7\IDE\CommonExtensions\Microsoft\TeamFoundation\Team Explorer

oder ProfessionalEnterprise anstelle von Community, abhängig von der Version, die Sie installiert haben.

Für Visual Studio 2019

%programfiles(x86)%\Microsoft Visual Studio\2019\Community\Common7\IDE\CommonExtensions\Microsoft\TeamFoundation\Team Explorer

oder ProfessionalEnterprise anstelle von Community, abhängig von der Version, die Sie installiert haben.

Visual Studio 2017

%programfiles(x86)%\Microsoft Visual Studio\2017\Enterprise\Common7\IDE\CommonExtensions\Microsoft\TeamFoundation\Team Explorer

oder TeamExplorerProfessional anstelle von Enterprise, abhängig von der Version, die Sie installiert haben.

Ersetzen Sie in einer 32-Bit-Edition von Windows %programfiles(x86)% durch %programfiles%. Sie können Visual Studio Community (die Zugriff auf Team Explorer bietet) oder Visual Studio Team Explorer 2017 kostenlos installieren.

Eine Übersicht über die felder, die in einer Standardprozessvorlage definiert sind, finden Sie unter Arbeitselementfeldindex.

Voraussetzungen

Weitere Informationen finden Sie unter Ändern von Berechtigungen auf Projektsammlungsebene.

Syntax

Verwenden Sie die folgenden Befehlssyntaxmuster, um Arbeitsaufgabenfelder mit dem Witadmin-Tool zu verwalten:

witadmin changefield /collection:CollectionURL /n:RefName   [/name:NewName]    [/syncnamechanges:true | false]   [/reportingname:ReportingName]    [/reportingrefname:ReportingRefName]   [/reportingtype:Type]   [/reportingformula:Formula]   [/type:PlainText | HTML]   [/noprompt]  

witadmin deletefield /collection:CollectionURL /n:RefName [/noprompt]  
  
witadmin listfields /collection:CollectionURL /n:RefName [/unused]  

Parameter

Synchronisieren von Personennamen mit Microsoft Entra-ID und Active Directory

Konfigurieren Sie benutzerdefinierte Personennamenfelder so, dass sie automatisch aktualisiert werden, wenn sich Benutzernamen in Ihrem Identitätsanbieter ändern.

Wann soll die Synchronisierung aktiviert werden?

Nur benutzerdefinierte Felder: Sie müssen die Synchronisierung für alle benutzerdefinierten Arbeitsaufgabenfelder, die zum Zuweisen von Personennamen verwendet werden, manuell aktivieren.

Systemfelder: Alle integrierten Personennamenfelder haben automatisch die Synchronisierung aktiviert:

• System.AssignedTo
• System.ChangedBy
• System.CreatedBy

Unterstützung für Identitätsanbieter

Funktionsweise der Synchronisierung

Einschränkungen für Gruppennamen

Wenn Sie das syncnamechanges Attribut für ein Zeichenfolgenfeld aktivieren, akzeptiert es gültige Benutzernamen, lässt jedoch keine Gruppennamen zu, wenn eine dieser Bedingungen zutrifft:

• VALIDUSER Regel , die für alle Arbeitsaufgabentypen angegeben ist
• VALIDUSER Regel für einen bestimmten Arbeitsaufgabentyp angegeben
• ALLOWEDVALUES Mit Filterkriterien angegebene Regel, die Gruppen ausschließt

Konfigurationsumfang

Weitere Informationen finden Sie unter:

• Zuordnungen und Workflowfelder
• Alle FIELD-Elemente.

Attribute, die Sie für jeden Arbeitsaufgabentyp ändern können

Sie ändern die folgenden Attribute oder Werte, die für ein Feld definiert sind, indem Sie die Arbeitsaufgabentypdefinition ändern, in der das Feld angezeigt wird:

• Name , der im Arbeitsaufgabenformular angezeigt wird. Siehe WebLayout- und Control-Elemente oder Steuerelement-XML-Elementreferenz.
• Hilfetext. Siehe Regeln und Regelauswertung.
• Zulässige Werte oder Elemente in einer Auswahlliste oder einem Dropdownmenü. Siehe ALLOWEDVALUES, SUGGESTEDVALUES und ALLOWEDVALUES XML-Elemente.

Beispiele

Sofern nicht anders angegeben, gelten die folgenden Werte in jedem Beispiel:

• URI für die Projektsammlung: http://AdventureWorksServer:8080/tfs/DefaultCollection
• Name des Arbeitselementfelds: AdventureWorks.Field
• Standardcodierung: UTF-8

Listenfelder

Dient witadmin listfields zum Anzeigen der verwendeten Felder, um einen Feldtyp auszuwählen, der einem Arbeitsaufgabentyp hinzugefügt werden soll. Darüber hinaus können Sie die für ein bestimmtes Feld definierten Attributzuweisungen auflisten und bestimmen, welche Felder von welchen Projekten verwendet werden.

Anzeigen der Attribute eines Arbeitselementfelds

Geben Sie den folgenden Befehl ein, um die attribute auflisten, die für ein angegebenes Feld definiert sind, z Microsoft.VSTS.Common.Issue. B. .

witadmin listfields /collection:http://AdventureWorksServer:8080/tfs/DefaultCollection /n:Microsoft.VSTS.Common.Issue  

Die Feld- und Attributinformationen werden für das benannte Feld, wie im folgenden Beispiel dargestellt, angezeigt.

Field: Microsoft.VSTS.Common.Issue  
    Name: Issue  
    Type: String  
    Reportable As: dimension  
    Use: Adventure Works (Shared Steps), AW Future (Shared Steps), AW Current (Shared Steps)  
    Indexed: False  

Der Use-Parameter gibt den Namen der einzelnen Projekte und den Arbeitselementtyp an, in dem das Feld verwendet wird. Weitere Informationen zu Feldattributen finden Sie unter Index der Arbeitsaufgabenfelder.

Auflisten aller Felder in einer Projektsammlung

Geben Sie den folgenden Befehl ein, um alle felder anzuzeigen, die für eine Projektsammlung definiert sind.

witadmin listfields /collection:http://AdventureWorksServer:8080/tfs/DefaultCollection  

Feldinformationen für alle Felder für die benannte Projektauflistung werden angezeigt. Siehe Index der Arbeitsaufgabenfelder.

Listenfelder, die nicht verwendet werden

Geben Sie den folgenden Befehl ein, um die Felder auflisten, die in der Projektauflistung nicht mehr von einem Arbeitsaufgabentyp verwendet werden.

witadmin listfields /collection:http://AdventureWorksServer:8080/tfs/DefaultCollection /unused  

Feld- und Attributinformationen werden für jedes Feld angezeigt, das nicht verwendet wird, wie in diesem Beispiel gezeigt.

    Field: Microsoft.VSTS.CMMI.TaskType  
    Name: Task Type  
    Type: String  
    Reportable As: dimension  
    Use: Not In Use  
    Indexed: False  

    Field: Microsoft.VSTSUE.Common.Flag  
    Name: Flag  
    Type: String  
    Reportable As: dimension  
    Use: Not In Use  
    Indexed: False  

    Field: Microsoft.VSTSUE.Common.Progress  
    Name: Progress  
    Type: String  
    Reportable As: dimension  
    Use: Not In Use  
    Indexed: False  

Umbenennen eines Felds

Sie können den Anzeigenamen eines Arbeitselementfelds ändern, um die von Ihrem Team verwendeten Benennungskonventionen zu erfüllen. Der neue Name wird auf alle Arbeitsaufgabentypen angewendet, die auf das geänderte Feld in allen Projekten in der Projektsammlung verweisen. Der Anzeigename wird angezeigt, wenn Sie Filterkriterien in einer Arbeitsaufgabenabfrage definieren. Der Name, der in einem Arbeitsaufgabenformular angezeigt wird, unterscheidet sich möglicherweise von dem für das Feld definierten Anzeigenamen.

So benennen Sie ein Arbeitsaufgabenfeld um

1. Geben Sie den folgenden Befehl ein, um den Anzeigenamen umzubenennen, der dem wichtigen Rang zugewiesen Microsoft.VSTS.Common.Rank ist.

   witadmin changefield /collection:http://AdventureWorksServer:8080/tfs/DefaultCollection /n:Microsoft.VSTS.Common.Rank /name:"Important Rank"  
   

2. Geben Sie an der Bestätigungsaufforderung die y EINGABETASTE ein, und wählen Sie dann die EINGABETASTE aus. Warten Sie, bis Sie die folgende Nachricht erhalten:

   Feld umbenannt.

So überprüfen Sie änderungen, die in ein einzelnes Projekt importiert wurden

1. Wählen Sie im Team-Explorer "Aktualisieren" aus.

   Die neuesten Updates werden vom Server heruntergeladen, einschließlich der Änderungen, die Sie soeben am Feldnamen vorgenommen haben. Warten Sie mehrere Sekunden, bis die Aktualisierung abgeschlossen ist.

2. Wählen Sie "Neue Abfrage " aus, um eine Abfrage zu erstellen.

3. Wählen Sie im Abfrage-Editor den Klick hier aus, um einen Abschnittslink hinzuzufügen , um eine Zeile hinzuzufügen, wählen Sie die leere Feldzelle aus, und geben Sie Rankin die Zelle ein. Die folgende Meldung, die oberhalb der Ergebnisliste angezeigt wird. Diese Meldung gibt an, dass der Rang nicht gefunden werden kann.

   Führen Sie die Abfrage aus, um die Abfrageergebnisse anzuzeigen. TF51005: Die Abfrage verweist auf ein Feld, das nicht vorhanden ist. Der Fehler wird durch <\<Rank>>.

4. Löschen Sie den Wert "Rang" aus der Zelle "Feld ", und geben Sie ihn in die Zelle ein Important Rank .

5. Wählen Sie in der Zelle <> aus, und geben Sie 1 die Zelle "Wert" ein.

6. Wählen Sie auf der Run QueryIcon_runQueryAbfragesymbolleiste "Ausführen" aus.

7. Öffnen Sie das Kontextmenü für eine beliebige Zeile in den Ergebnissen, und wählen Sie "Spaltenoptionen" aus. Scrollen Sie in der Liste " Verfügbare Spalten " nach unten. Beachten Sie, dass das Feld "Rang" nicht mehr vorhanden ist, aber das Feld "Wichtiger Rang " vorhanden ist.

8. Wählen Sie im Feld "Verfügbare Spalten" die Option "Wichtiger Rang" aus, und wählen Sie dann die > Schaltfläche aus (ausgewählte Spalten hinzufügen). Wählen Sie OK aus.

   Beachten Sie, dass der Anzeigename für Microsoft.VSTS.Common. Der Rang wird innerhalb des Abfrage-Generators und der Ergebnisliste von "Rang" in " Wichtiger Rang " umbenannt.

9. Schließen Sie die Abfrage. Wählen Sie "Nein " aus, wenn Sie aufgefordert werden, die Abfrage zu speichern.

10. Erstellen Sie eine neue Arbeitsaufgabe "Aufgabe". Wählen Sie den Link "Neue Arbeitsaufgaben" und dann "Aufgabe" aus.

    Diese Arbeitsaufgabe wird aus dem Arbeitsaufgabentyp erstellt, den Sie geändert und importiert haben.

11. Beachten Sie, dass die Beschriftung für das umbenannte Feld "Rang" im Feld "Status" nicht geändert wurde. Die Feldbeschriftungen in den Arbeitsaufgabenformularen sind auf das übergeordnete Projekt ausgerichtet und sind unabhängig vom angegebenen serverweiten Feldnamen.

    Hinweis

    Weitere Informationen zum Ändern von Feldbeschriftungen in Arbeitsaufgabenformularen finden Sie unter Steuerelement-XML-Elementreferenz.

12. Schließen Sie den neuen Vorgang, und wählen Sie "Nein " aus, wenn Sie aufgefordert werden, die Arbeitsaufgabe zu speichern.

Ändern des Berichts als Wert für ein Feld

Der folgende Befehl gibt die Möglichkeit an, den Typ des DateTime-Felds "AdventureWorks.CreatedOn" zu melden. Die Daten dieses Felds geben die Warehouse- und Analysis Services-Datenbanken ein, damit sie zum Filtern von Berichten verwendet werden kann.

witadmin changefield /collection:http://AdventureWorksServer:8080/tfs/DefaultCollection /n:AdventureWorks.CreatedOn /reportingtype:dimension  

Der folgende Befehl gibt die Möglichkeit an, den Typ des zu messenden Double-Felds "AdventureWorks.Field" zu melden. Alle Measures aggregieren nach Summe.

witadmin reportfield /collection:http://AdventureWorksServer:8080/tfs/DefaultCollection /n:AdventureWorks.Field /reportingtype:measure  

Aktivieren der Synchronisierung eines benutzerdefinierten Personennamenfelds

Mit dem folgenden Befehl wird die Synchronisierung für das Arbeitsaufgabenfeld AW aktiviert. CustomerName defined for Collection1 on the AdventureWorksServer.

Überprüfen des Datentyps des Zu konvertierenden Felds

Überprüfen Sie den Datentyp, der dem Feld zugewiesen ist, z. B. "MyCompany.CustomerName", das Sie synchronisieren möchten, indem Sie den folgenden Befehl eingeben:

witadmin listfields /collection:http://AdventureWorksServer:8080/tfs/DefaultCollection /n:MyCompany.CustomerName  

Aktivieren der Synchronisierung

1. Wenn Sie die Synchronisierung für ein Feld mit Personennamen aktivieren möchten, geben Sie den folgenden Befehl ein, und ersetzen Sie die Daten für die hier gezeigten Argumente:

   witadmin changefield /collection:http://AdventureWorksServer:8080/tfs/DefaultCollection /n:MyCompany.CustomerName /syncnamechanges:true  
   

2. Die folgende Bestätigungsaufforderung wird angezeigt:

   Dadurch werden die Eigenschaften für das Feld {0} auf dem Azure DevOps Server geändert. Möchten Sie fortfahren?

3. Geben Sie die Eingabetaste 0 ein, um zu bestätigen, dass Sie das Feld ändern möchten, oder 1 um die Anforderung abzubrechen.

   Wenn die Änderungsanforderung erfolgreich ist, wird die folgende Bestätigungsmeldung angezeigt:

   Das Feld wurde aktualisiert.

   Wenn die Änderungsanforderung fehlschlägt, wird eine Fehlermeldung angezeigt. Die häufigsten Fehler, die vorgenommen werden können, sind der Versuch, ein Systemreferenzfeld zu ändern, oder versuchen, ein Feld eines anderen Datentyps als Zeichenfolge zu ändern. Diese Vorgänge werden nicht unterstützt.

Löschen eines Felds

Stellen Sie vor dem Löschen eines Felds sicher, dass das Feld nicht verwendet wird. Wenn das Feld verwendet wird, müssen Sie zuerst das Feld aus den Arbeitsaufgabentypen entfernen, die es verwenden, bevor Sie es aus der Projektauflistung löschen. Mit dem folgenden Befehl wird das Feld AdventureWorks.Field aus Collection1 gelöscht:

witadmin deletefield /collection:http://AdventureWorksServer:8080/tfs/DefaultCollection /n:AdventureWorks.Field  

Überprüfen, ob ein Feld nicht verwendet wird

1. Geben Sie den folgenden Befehl ein, der den Verweisnamen für das Arbeitselementfeld angibt, z MyCompany.MyProcess.MyField. B. .

   witadmin listfields /collection:http://AdventureWorksServer:8080/tfs/DefaultCollection /n:MyCompany.MyProcess.MyField  
   

   Vergewissern Sie sich in den für das Feld angezeigten Informationen, dass der Wert für "Nicht verwendet" wie im folgenden Beispiel lautet.

   Field: MyCompany.MyProcess.MyField  
   Name: MyField  
   Type: String  
   Reportable As: dimension  
   Use: Not In Use  
   Indexed: False  
   

2. Wenn das Feld "Use " angibt, dass das Feld verwendet wird, müssen Sie es aus jedem Arbeitsaufgabentyp für jedes Projekt löschen, das aufgelistet ist. Das Feld gibt beispielsweise an, Microsoft.VSTS.TCM.SystemInfo dass es von den Arbeitsaufgabentypen "Bug" und "Code Defect" für vier Projekte verwendet wird: Arroyo, Desert, Palm und Springs.

   Field: Microsoft.VSTS.TCM.SystemInfo  
   Name: System Info  
   Type: Html  
   Reportable As: None  
   Use: Arroyo (Bug), Desert (Bug), Palm (Bug), Springs (Bug, Code Defect)  
   Indexed: False  
   

   Bevor Sie dieses Feld löschen können, müssen Sie es aus den einzelnen Arbeitsaufgabentypen entfernen, die für jedes Projekt aufgeführt sind, für das es definiert ist. Um das Feld zu entfernen, ändern Sie die Definition für den Arbeitsaufgabentyp, indem Sie die Elemente FIELD löschen, die Control den Feldverweisnamen enthalten. Siehe Importieren, Exportieren und Verwalten von Arbeitsaufgabentypen, FIELD (Definition)-Elementverweis und Steuerelement.

Löschen eines Felds aus einer Projektsammlung

Geben Sie den folgenden Befehl ein, um das MyCompany.MyProcess.MyField Feld zu löschen, und wählen Sie dann die EINGABETASTE aus.

witadmin deletefield /collection:http://AdventureWorksServer:8080/tfs/DefaultCollection /n:RefName  

Geben Sie y an der Bestätigungsaufforderung ein, um diesen Schritt abzuschließen.

Verwandte Artikel

• Anpassen ihrer Arbeitsverfolgungserfahrung
• Feldindex des Workitems
• witAdmin: Anpassen und Verwalten von Objekten für die Arbeitsnachverfolgung